org.refcodes.io.impls

Class BidirectionalStreamByteTransceiverImpl

java.lang.Object

org.refcodes.io.impls.BidirectionalStreamByteTransceiverImpl

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, ByteBlockConsumer, ByteBlockProvider, ByteBlockReceiver, ByteBlockSender, ByteConsumer, ByteDatagramConsumer, ByteDatagramProvider, ByteDatagramReceiver, ByteDatagramSender, ByteProvider, ByteReceiver, ByteSender, ByteTransceiver, Receivable, Sendable, org.refcodes.mixin.Releaseable

public class BidirectionalStreamByteTransceiverImpl
extends Object
implements ByteTransceiver

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

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

Constructor Summary

Constructors

Constructor and Description
BidirectionalStreamByteTransceiverImpl(InputStream aInputStream, OutputStream aOutputStream)

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()
byte	readDatagram() Reads (receives) the next byte passed from a DatagramSender counterpart.
byte[]	readDatagrams() Caution: Reads till an OpenException (or an InterruptedException in case of blocking till more data is available) occurs.
void	releaseAll()
void	writeDatagram(byte aDatagram) Writes (sends) a byte.
void	writeDatagrams(byte[] aDatagram) Writes (sends) a byte block.
void	writeDatagrams(byte[] aDatagram, int aOffset, int aLength) Writes (sends) a byte block.

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

readDatagrams

Methods inherited from interface org.refcodes.component.Closable

closeIn, closeQuietly

Constructor Detail

BidirectionalStreamByteTransceiverImpl

public BidirectionalStreamByteTransceiverImpl(InputStream aInputStream,
                                              OutputStream aOutputStream)
                                       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 byte[] readDatagrams()
                     throws org.refcodes.component.OpenException,
                            InterruptedException

Description copied from interface: ByteProvider

Caution: Reads till an OpenException (or an InterruptedException in case of blocking till more data is available) occurs.

Specified by:

readDatagrams in interface ByteBlockProvider

Specified by:

readDatagrams in interface ByteProvider

Specified by:

readDatagrams in interface ByteReceiver

Returns:

The next byte 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 byte readDatagram()
                  throws org.refcodes.component.OpenException,
                         InterruptedException

Description copied from interface: ByteDatagramProvider

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 #hasDatagram() method to test beforehand whether a byte is available (in a multi-threaded usage scenario, #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 ByteDatagramProvider

Returns:

The next byte sent from the ByteDatagramSender 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(byte[] aDatagram)
                    throws org.refcodes.component.OpenException

Description copied from interface: ByteBlockConsumer

Writes (sends) a byte block.

Specified by:

writeDatagrams in interface ByteBlockConsumer

Specified by:

writeDatagrams in interface ByteConsumer

Parameters:

aDatagram - The byte to be pushed.

Throws:

org.refcodes.component.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 org.refcodes.component.OpenException

Description copied from interface: ByteBlockConsumer

Writes (sends) a byte block.

Specified by:

writeDatagrams in interface ByteBlockConsumer

Specified by:

writeDatagrams in interface ByteSender

Parameters:

aDatagram - The byte to be pushed.

aOffset - The offset from which to take the data.

aLength - The number of elements to push starting at the given offset.

Throws:

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

writeDatagram

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

Description copied from interface: ByteDatagramConsumer

Writes (sends) a byte.

Specified by:

writeDatagram in interface ByteConsumer

Specified by:

writeDatagram in interface ByteDatagramConsumer

Parameters:

aDatagram - The byte to be pushed.

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

Specified by:

flush in interface ByteSender

Throws:

org.refcodes.component.OpenException

isClosable

public boolean isClosable()

Specified by:

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