org.refcodes.io.impls

Class PrefetchBidirectionalStreamTransceiverImpl<DATA extends Serializable>

java.lang.Object

org.refcodes.io.impls.PrefetchBidirectionalStreamTransceiverImpl<DATA>

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.OpenedAccessor, BlockReceiver<DATA>, BlockSender<DATA>, DatagramReceiver<DATA>, DatagramSender<DATA>, DatagramTransceiver<DATA>, Receivable, Receiver<DATA>, Sendable, Sender<DATA>, Transceiver<DATA>, org.refcodes.mixin.Releaseable

public class PrefetchBidirectionalStreamTransceiverImpl<DATA extends Serializable>
extends Object
implements Transceiver<DATA>

Author:

steiner

Nested Class Summary

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

org.refcodes.component.ConnectableComponent.ConnectableAutomaton

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

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

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

org.refcodes.component.Closable.CloseAutomaton

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.ConnectionStatusAccessor

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

Constructor Summary

Constructors

Constructor and Description
PrefetchBidirectionalStreamTransceiverImpl(InputStream aInputStream, OutputStream aOutputStream)
PrefetchBidirectionalStreamTransceiverImpl(InputStream aInputStream, OutputStream aOutputStream, ExecutorService aExecutorService)

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
org.refcodes.component.ConnectionStatus	getConnectionStatus()
boolean	hasDatagram() Determines whether a datagram is available from a DatagramSender and can be retrieved via the #readDatagram() method.
boolean	isClosable()
boolean	isClosed()
boolean	isOpened()
DATA	readDatagram() Reads (receives) the next datagram passed from a DatagramSender counterpart.
DATA[]	readDatagrams() Reads (receives) the next datagram block passed from a BlockSender or DatagramSender counterpart.
void	releaseAll()
void	writeDatagram(DATA aDatagram) Writes (sends) a datagram to a listening DatagramReceiver.
void	writeDatagrams(DATA[] aDatagram) Writes (sends) a datagram block to a listening DatagramReceiver or BlockReceiver.
void	writeDatagrams(DATA[] aDatagram, int aOffset, int aLength)

Methods inherited from class java.lang.Object

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

Constructor Detail

PrefetchBidirectionalStreamTransceiverImpl

public PrefetchBidirectionalStreamTransceiverImpl(InputStream aInputStream,
                                                  OutputStream aOutputStream)
                                           throws org.refcodes.component.OpenException

Throws:

org.refcodes.component.OpenException

PrefetchBidirectionalStreamTransceiverImpl

public PrefetchBidirectionalStreamTransceiverImpl(InputStream aInputStream,
                                                  OutputStream aOutputStream,
                                                  ExecutorService aExecutorService)
                                           throws org.refcodes.component.OpenException

Throws:

org.refcodes.component.OpenException

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.OpenedAccessor

hasDatagram

public boolean hasDatagram()
                    throws org.refcodes.component.OpenException

Description copied from interface: Receivable

Determines whether a datagram is available from a DatagramSender and can be retrieved via the #readDatagram() method.

Specified by:

hasDatagram in interface Receivable

Returns:

True in case there is a datagram ready to be retrieved via the #readDatagram() method.

Throws:

org.refcodes.component.OpenException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

readDatagrams

public DATA[] readDatagrams()
                     throws org.refcodes.component.OpenException,
                            InterruptedException

Description copied from interface: BlockReceiver

Reads (receives) the next datagram block passed from a BlockSender or DatagramSender counterpart. In case none datagram block is available, then this method blocks until one is available. To prevent blocking, use the Receivable.hasDatagram() method to test beforehand whether a datagram is available (in a multi threaded usage scenario, #hasBlock() 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:

readDatagrams in interface BlockReceiver<DATA extends Serializable>

Specified by:

readDatagrams in interface Receiver<DATA extends Serializable>

Returns:

The next datagram block sent from the BlockSender or DatagramReceiver counterpart.

Throws:

org.refcodes.component.OpenException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

InterruptedException - Thrown when a Thread is waiting, sleeping, or otherwise occupied, and the Thread is interrupted, either before or during the activity.

getConnectionStatus

public org.refcodes.component.ConnectionStatus getConnectionStatus()

Specified by:

getConnectionStatus in interface org.refcodes.component.ConnectionStatusAccessor

releaseAll

public void releaseAll()

Specified by:

releaseAll in interface org.refcodes.mixin.Releaseable

close

public void close()
           throws org.refcodes.component.CloseException

Specified by:

close in interface org.refcodes.component.Closable

Throws:

org.refcodes.component.CloseException

readDatagram

public DATA readDatagram()
                  throws org.refcodes.component.OpenException,
                         InterruptedException

Description copied from interface: DatagramReceiver

Reads (receives) the next datagram passed from a DatagramSender counterpart. In case none datagram is available, then this method blocks until one is available. To prevent blocking, use the Receivable.hasDatagram() method to test beforehand whether a datagram is available (in a multi threaded usage scenario, Receivable.hasDatagram() 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:

readDatagram in interface DatagramReceiver<DATA extends Serializable>

Returns:

The next datagram sent from the DatagramSender counterpart.

Throws:

org.refcodes.component.OpenException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

InterruptedException - Thrown when a Thread is waiting, sleeping, or otherwise occupied, and the Thread is interrupted, either before or during the activity.

writeDatagrams

public void writeDatagrams(DATA[] aDatagram)
                    throws org.refcodes.component.OpenException

Description copied from interface: BlockSender

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

Specified by:

writeDatagrams in interface BlockSender<DATA extends Serializable>

Specified by:

writeDatagrams in interface Sender<DATA extends Serializable>

Parameters:

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

Throws:

org.refcodes.component.OpenException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

writeDatagrams

public void writeDatagrams(DATA[] aDatagram,
                           int aOffset,
                           int aLength)
                    throws org.refcodes.component.OpenException

Specified by:

writeDatagrams in interface BlockSender<DATA extends Serializable>

Specified by:

writeDatagrams in interface Sender<DATA extends Serializable>

Throws:

org.refcodes.component.OpenException

writeDatagram

public void writeDatagram(DATA aDatagram)
                   throws org.refcodes.component.OpenException

Description copied from interface: DatagramSender

Writes (sends) a datagram to a listening DatagramReceiver.

Specified by:

writeDatagram in interface DatagramSender<DATA extends Serializable>

Parameters:

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

Throws:

org.refcodes.component.OpenException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

flush

public void flush()
           throws org.refcodes.component.OpenException

Specified by:

flush in interface Flushable

Throws:

org.refcodes.component.OpenException

isClosable

public boolean isClosable()

Specified by:

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