briar/src/net/sf/briar/api/plugins/simplex/SimplexTransportReader.java

package net.sf.briar.api.plugins.simplex;

import java.io.IOException;
import java.io.InputStream;

/**
 * An interface for reading data from a simplex transport. The reader is not
 * responsible for decrypting or authenticating the data before returning it.
 */
public interface SimplexTransportReader {

	/** Returns an input stream for reading from the transport. 
	 * @throws IOException */
	InputStream getInputStream() throws IOException;

	/**
	 * Closes the reader and disposes of any associated resources. The first
	 * argument indicates whether the reader is being closed because of an
	 * exception and the second argument indicates whether the connection was
	 * recognised, which may affect how resources are disposed of.
	 */
	void dispose(boolean exception, boolean recognised) throws IOException;
}