jmtransfersession.java

JMule是一个基于Java开发

/*
 *  JMule - Java file sharing client
 *  Copyright (C) 2007-2008 JMule team ( [e-mail] / http://jmule.org )
 *
 *  Any parts of this program derived from other projects, or contributed
 *  by third-party developers are copyrighted by their respective authors.
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License
 *  as published by the Free Software Foundation; either version 2
 *  of the License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 */
package org.jmule.core.session;

import org.jmule.core.JMIterable;
import org.jmule.core.edonkey.impl.ED2KFileLink;
import org.jmule.core.edonkey.impl.FileHash;
import org.jmule.core.edonkey.impl.Peer;
import org.jmule.core.sharingmanager.SharedFile;

/**
 * 
 * @author binary256
 * @version $$Revision: 1.4 $$
 * Last changed by $$Author: binary256_ $$ on $$Date: 2008/08/26 19:15:46 $$
 */
public interface JMTransferSession {

	/**
	 * Get shared file which session is assigned
	 * @return shared file
	 */
	public SharedFile getSharedFile();
	
	/**
	 * Get transfer speed
	 * @return transfer speed
	 */
	public float getSpeed();
	   
	/**
	 * Get total bytes transfered in this session
	 * @return transfered bytes
	 */
	public long getTransferredBytes();
	   
	/** 
	 * Get File hash of file used by this session
	 * @return file hash
	 */
	public FileHash getFileHash();
	   
	/**
	 * Get sharing name of file used by this session
	 * @return sharing name
	 */
	public String getSharingName();
	   
	/**
	 * Get file size of file used by this session
	 * @return
	 */
	public long getFileSize();
	   
	/**
	 * Get all peers used by this session
	 */
	public JMIterable<Peer> getPeers();

	/**
	 * Get peers count 
	 */
	public int getPeersCount();

	/**
	 * Check if session has peer
	 * @param peer checked peer
	 * @return true - session has peer, false - session don't have peer
	 */
	public boolean hasPeer(Peer peer);
	   
	/**
	 * Get ED2K link of processed file 
	 * @return ED2K link of file
	 */
	public ED2KFileLink getED2KLink();
	   
	/**
	 * Get ETA : Estimated Time of Arrival
	 * @return return ETA in seconds or infinity(31536000)
	 */
	public long getETA();
}