Module org.refcodes.io

Package org.refcodes.io

Class PrefetchBidirectionalStreamTransceiver<DATA extends Serializable>

java.lang.Object

org.refcodes.io.PrefetchBidirectionalStreamTransceiver<DATA>

Type Parameters:

DATA - the generic type

All Implemented Interfaces:

Flushable, org.refcodes.component.Closable, org.refcodes.component.Closable.CloseAutomaton, org.refcodes.component.ClosedAccessor, org.refcodes.component.ConnectableComponent, org.refcodes.component.ConnectableComponent.ConnectableAutomaton, org.refcodes.component.ConnectionStatusAccessor, org.refcodes.component.Flushable, org.refcodes.component.OpenedAccessor, Availability, DatagramDestination<DATA>, DatagramReceiver<DATA>, DatagramsDestination<DATA>, DatagramSource<DATA>, DatagramsReceiver<DATA>, DatagramsSource<DATA>, DatagramsTransceiver<DATA>, DatagramsTransmitter<DATA>, DatagramTransceiver<DATA>, DatagramTransmitter<DATA>, Receivable, Transmittable

public class PrefetchBidirectionalStreamTransceiver<DATA extends Serializable>
extends Object
implements DatagramsTransceiver<DATA>

The Class PrefetchBidirectionalStreamTransceiver.

Author:

steiner

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.component.Closable

org.refcodes.component.Closable.CloseAutomaton, org.refcodes.component.Closable.CloseBuilder<B extends org.refcodes.component.Closable.CloseBuilder<B>>

Nested classes/interfaces inherited from interface org.refcodes.component.ClosedAccessor

org.refcodes.component.ClosedAccessor.ClosedMutator, org.refcodes.component.ClosedAccessor.ClosedProperty

Nested classes/interfaces inherited from interface org.refcodes.component.ConnectableComponent

org.refcodes.component.ConnectableComponent.ConnectableAutomaton

Nested classes/interfaces inherited from interface org.refcodes.component.ConnectionStatusAccessor

org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusMutator, org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusProperty

Nested classes/interfaces inherited from interface org.refcodes.component.Flushable

org.refcodes.component.Flushable.FlushBuilder<B extends org.refcodes.component.Flushable.FlushBuilder<B>>

Nested classes/interfaces inherited from interface org.refcodes.component.OpenedAccessor

org.refcodes.component.OpenedAccessor.OpenedMutator, org.refcodes.component.OpenedAccessor.OpenedProperty

Constructor Summary

Constructors

Constructor	Description
PrefetchBidirectionalStreamTransceiver(InputStream aInputStream, OutputStream aOutputStream)	Instantiates a new prefetch bidirectional stream transceiver impl.
PrefetchBidirectionalStreamTransceiver(InputStream aInputStream, OutputStream aOutputStream, ExecutorService aExecutorService)	Instantiates a new prefetch bidirectional stream transceiver impl.

Method Summary

Modifier and Type	Method	Description
int	available()	Determines the number of available datagram from a DatagramTransmitter.
void	close()
void	flush()
org.refcodes.component.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.
void	transmit(DATA aDatagram)	Writes (sends) a datagram to a listening DatagramReceiver.
void	transmit(DATA[] aDatagram, int aOffset, int aLength)	Write datagrams.
void	transmitAll(DATA[] aDatagram)	Writes (sends) a datagram block to a listening DatagramReceiver or DatagramsReceiver.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.io.Availability

hasAvailable

Methods inherited from interface org.refcodes.component.Closable

closeIn, closeQuietly, closeUnchecked

Methods inherited from interface org.refcodes.io.DatagramsDestination

receive

Methods inherited from interface org.refcodes.io.DatagramsReceiver

receive

Methods inherited from interface org.refcodes.component.Flushable

flushUnchecked, isFlushable

Constructor Detail

PrefetchBidirectionalStreamTransceiver

public PrefetchBidirectionalStreamTransceiver(InputStream aInputStream,
                                              OutputStream aOutputStream)
                                       throws IOException

Instantiates a new prefetch bidirectional stream transceiver impl.

Parameters:

aInputStream - the input stream

aOutputStream - the output stream

Throws:

IOException - the open exception

PrefetchBidirectionalStreamTransceiver

public PrefetchBidirectionalStreamTransceiver(InputStream aInputStream,
                                              OutputStream aOutputStream,
                                              ExecutorService aExecutorService)
                                       throws IOException

Instantiates a new prefetch bidirectional stream transceiver impl.

Parameters:

aInputStream - the input stream

aOutputStream - the output stream

aExecutorService - the executor service

Throws:

IOException - the open exception

Method Detail

isClosed

public boolean isClosed()

Specified by:

isClosed in interface org.refcodes.component.ClosedAccessor

isOpened

public boolean isOpened()

Specified by:

isOpened in interface org.refcodes.component.ConnectionStatusAccessor

Specified by:

isOpened in interface org.refcodes.component.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.

EOFException - Signals that an end of file or end of stream has been reached unexpectedly during input.

getConnectionStatus

public org.refcodes.component.ConnectionStatus getConnectionStatus()

Specified by:

getConnectionStatus in interface org.refcodes.component.ConnectionStatusAccessor

close

public void close()
           throws IOException

Specified by:

close in interface org.refcodes.component.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.

EOFException - Signals that an end of file or end of stream has been reached unexpectedly during input.

transmitAll

public void transmitAll(DATA[] aDatagram)
                 throws IOException

Writes (sends) a datagram block to a listening DatagramReceiver or DatagramsReceiver.

Specified by:

transmitAll in interface DatagramsSource<DATA extends Serializable>

Parameters:

aDatagram - The datagram to be pushed to the receiving DatagramReceiver or DatagramsReceiver.

Throws:

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

transmit

public void transmit(DATA[] aDatagram,
                     int aOffset,
                     int aLength)
              throws IOException

Write datagrams.

Specified by:

transmit in interface DatagramsSource<DATA extends Serializable>

Specified by:

transmit in interface DatagramsTransmitter<DATA extends Serializable>

Parameters:

aDatagram - the datagram

aOffset - the offset

aLength - the length

Throws:

IOException - the open exception

transmit

public void transmit(DATA aDatagram)
              throws IOException

Writes (sends) a datagram to a listening DatagramReceiver.

Specified by:

transmit in interface DatagramSource<DATA extends Serializable>

Specified by:

transmit in interface DatagramsSource<DATA extends Serializable>

Parameters:

aDatagram - The datagram to be pushed to the receiving DatagramSource.

Throws:

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

flush

public void flush()
           throws IOException

Specified by:

flush in interface DatagramTransmitter<DATA extends Serializable>

Specified by:

flush in interface Flushable

Specified by:

flush in interface org.refcodes.component.Flushable

Throws:

IOException

isClosable

public boolean isClosable()

Specified by:

isClosable in interface org.refcodes.component.Closable.CloseAutomaton