org.refcodes.io.impls

Class PrefetchBidirectionalStreamByteTransceiverImpl

java.lang.Object

org.refcodes.io.impls.PrefetchBidirectionalStreamByteTransceiverImpl

All Implemented Interfaces:

Flushable, Closable, Closable.CloseAutomaton, ClosedAccessor, ConnectableComponent, ConnectableComponent.ConnectableAutomaton, ConnectionStatusAccessor, OpenedAccessor, ByteBlockReceiver, ByteBlockSender, ByteDatagramReceiver, ByteDatagramSender, ByteReceiver, ByteSender, ByteTransceiver, Receivable, Sendable, org.refcodes.mixin.Releaseable

public class PrefetchBidirectionalStreamByteTransceiverImpl
extends Object
implements ByteTransceiver

Author:

steiner

Nested Class Summary

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

ConnectableComponent.ConnectableAutomaton

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

OpenedAccessor.OpenedMutator, OpenedAccessor.OpenedProperty

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

Closable.CloseAutomaton

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

ClosedAccessor.ClosedMutator, ClosedAccessor.ClosedProperty

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

ConnectionStatusAccessor.ConnectionStatusMutator, ConnectionStatusAccessor.ConnectionStatusProperty

Constructor Summary

Constructors

Constructor and Description
PrefetchBidirectionalStreamByteTransceiverImpl(InputStream aInputStream, OutputStream aOutputStream)

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
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()
byte	readDatagram() Reads (receives) the next byte passed from a DatagramSender counterpart.
byte[]	readDatagrams() Reads (receives) the next byte block passed from a BlockSender or DatagramSender counterpart.
void	releaseAll()
void	writeDatagram(byte aDatagram) Writes (sends) a byte to a listening DatagramReceiver.
void	writeDatagrams(byte[] aDatagram) Writes (sends) a byte block to a listening DatagramReceiver or BlockReceiver.
void	writeDatagrams(byte[] 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

PrefetchBidirectionalStreamByteTransceiverImpl

public PrefetchBidirectionalStreamByteTransceiverImpl(InputStream aInputStream,
                                                      OutputStream aOutputStream)
                                               throws OpenException

Throws:

OpenException

Method Detail

isClosed

public boolean isClosed()

Specified by:

isClosed in interface ClosedAccessor

isOpened

public boolean isOpened()

Specified by:

isOpened in interface OpenedAccessor

hasDatagram

public boolean hasDatagram()
                    throws 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:

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

readDatagrams

public byte[] readDatagrams()
                     throws OpenException,
                            InterruptedException

Description copied from interface: ByteBlockReceiver

Reads (receives) the next byte block passed from a BlockSender or DatagramSender counterpart. In case none byte block is available, then this method blocks until one is available. To prevent blocking, use the Receivable.hasDatagram() method to test beforehand whether a byte 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 byte to be read and Thread.interrupt() is being called, then the operation is aborted and an InterruptedException is thrown.

Specified by:

readDatagrams in interface ByteBlockReceiver

Specified by:

readDatagrams in interface ByteReceiver

Returns:

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

Throws:

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 ConnectionStatus getConnectionStatus()

Specified by:

getConnectionStatus in interface ConnectionStatusAccessor

releaseAll

public void releaseAll()

Specified by:

releaseAll in interface org.refcodes.mixin.Releaseable

close

public void close()
           throws CloseException

Specified by:

close in interface Closable

Throws:

CloseException

readDatagram

public byte readDatagram()
                  throws OpenException,
                         InterruptedException

Description copied from interface: ByteDatagramReceiver

Reads (receives) the next byte passed from a DatagramSender counterpart. In case none byte is available, then this method blocks until one is available. To prevent blocking, use the Receivable.hasDatagram() method to test beforehand whether a byte 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 byte to be read and Thread.interrupt() is being called, then the operation is aborted and an InterruptedException is thrown.

Specified by:

readDatagram in interface ByteDatagramReceiver

Returns:

The next byte sent from the ByteDatagramSender counterpart.

Throws:

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(byte[] aDatagram)
                    throws OpenException

Description copied from interface: ByteBlockSender

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

Specified by:

writeDatagrams in interface ByteBlockSender

Specified by:

writeDatagrams in interface ByteSender

Parameters:

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

Throws:

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

writeDatagrams

public void writeDatagrams(byte[] aDatagram,
                           int aOffset,
                           int aLength)
                    throws OpenException

Specified by:

writeDatagrams in interface ByteBlockSender

Specified by:

writeDatagrams in interface ByteSender

Throws:

OpenException

writeDatagram

public void writeDatagram(byte aDatagram)
                   throws OpenException

Description copied from interface: ByteDatagramSender

Writes (sends) a byte to a listening DatagramReceiver.

Specified by:

writeDatagram in interface ByteDatagramSender

Parameters:

aDatagram - The byte to be pushed to the receiving ByteDatagramSender.

Throws:

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

flush

public void flush()
           throws OpenException

Specified by:

flush in interface Flushable

Throws:

OpenException

isClosable

public boolean isClosable()

Specified by:

isClosable in interface Closable.CloseAutomaton