Class InputStreamReceiver<DATA extends Serializable>

java.lang.Object

org.refcodes.io.InputStreamReceiver<DATA>

Type Parameters:

DATA - the generic type

All Implemented Interfaces:

Closable, Closable.CloseAutomaton, ClosedAccessor, ConnectableComponent, ConnectableComponent.ConnectableAutomaton, ConnectionStatusAccessor, OpenedAccessor, Availability, DatagramDestination<DATA>, DatagramReceiver<DATA>, DatagramsDestination<DATA>, DatagramsReceiver<DATA>, Receivable

public class InputStreamReceiver<DATA extends Serializable>
extends Object
implements DatagramsReceiver<DATA>

The Class InputStreamReceiver.

Nested Class Summary

Nested classes/interfaces inherited from interface Closable

Closable.CloseAutomaton, Closable.CloseBuilder<B>

Nested classes/interfaces inherited from interface ClosedAccessor

ClosedAccessor.ClosedMutator, ClosedAccessor.ClosedProperty

Nested classes/interfaces inherited from interface ConnectableComponent

ConnectableComponent.ConnectableAutomaton

Nested classes/interfaces inherited from interface ConnectionStatusAccessor

ConnectionStatusAccessor.ConnectionStatusMutator, ConnectionStatusAccessor.ConnectionStatusProperty

Nested classes/interfaces inherited from interface OpenedAccessor

OpenedAccessor.OpenedMutator, OpenedAccessor.OpenedProperty

Constructor Summary

Constructors

Constructor	Description
InputStreamReceiver(InputStream aInputStream)	Instantiates a new input stream receiver impl.

Method Summary

Modifier and Type	Method	Description
int	available()	Determines the number of available datagram from a DatagramTransmitter.
void	close()
ConnectionStatus	getConnectionStatus()
boolean	isClosable()
boolean	isClosed()
boolean	isOpened()
DATA	receive()	Reads (receives) the next datagram passed from a DatagramTransmitter counterpart.
DATA[]	receiveAll()	Reads (receives) the all currently available data.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Availability

hasAvailable

Methods inherited from interface Closable

closeIn, closeQuietly, closeUnchecked

Methods inherited from interface DatagramsDestination

receive

Methods inherited from interface DatagramsReceiver

receive

Constructor Details

InputStreamReceiver

public InputStreamReceiver(InputStream aInputStream)
                    throws IOException

Instantiates a new input stream receiver impl.

Parameters:

aInputStream - the input stream

Throws:

IOException - the open exception

Method Details

isClosed

public boolean isClosed()

Specified by:

isClosed in interface ClosedAccessor

isOpened

public boolean isOpened()

Specified by:

isOpened in interface ConnectionStatusAccessor

Specified by:

isOpened in interface OpenedAccessor

available

public int available()
              throws IOException

Determines the number of available datagram from a DatagramTransmitter. Use the DatagramDestination extenison's DatagramDestination.receive() method for retrieving available datagrams.

Specified by:

available in interface Availability

Returns:

The number of datagrams ready to be retrieved .

Throws:

IOException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

receiveAll

public DATA[] receiveAll()
                  throws IOException

Reads (receives) the all currently available data.

Specified by:

receiveAll in interface DatagramsDestination<DATA extends Serializable>

Specified by:

receiveAll in interface DatagramsReceiver<DATA extends Serializable>

Returns:

The next short block sent from the DatagramsTransmitter or DatagramReceiver counterpart.

Throws:

IOException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

getConnectionStatus

public ConnectionStatus getConnectionStatus()

Specified by:

getConnectionStatus in interface ConnectionStatusAccessor

close

public void close()
           throws IOException

Specified by:

close in interface Closable

Throws:

IOException

receive

public DATA receive()
             throws IOException

Reads (receives) the next datagram passed from a DatagramTransmitter counterpart. In case none datagram is available, then this method blocks until one is available. To prevent blocking, use the DatagramReceiver extension's Availability.available() method to test beforehand whether a byte is available (in a multi-threaded usage scenario, Availability.available() is not a reliable indicator whether this method will block or not). When a Thread is waiting for a datagram to be read and Thread.interrupt() is being called, then the operation is aborted and an InterruptedException is thrown.

Specified by:

receive in interface DatagramDestination<DATA extends Serializable>

Specified by:

receive in interface DatagramsDestination<DATA extends Serializable>

Returns:

The next datagram sent from the DatagramTransmitter counterpart.

Throws:

IOException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

isClosable

public boolean isClosable()

Specified by:

isClosable in interface Closable.CloseAutomaton