Package org.refcodes.io

Class BidirectionalStreamByteTransceiverImpl

java.lang.Object

org.refcodes.io.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.Flushable, 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

The Class BidirectionalStreamByteTransceiverImpl.

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
BidirectionalStreamByteTransceiverImpl(InputStream aInputStream, OutputStream aOutputStream)	Instantiates a new bidirectional stream byte transceiver impl.

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()	Flush.
org.refcodes.component.ConnectionStatus	getConnectionStatus()
boolean	hasDatagram()	Determines whether a datagram is available from a DatagramSender.
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)	Write datagram.
void	writeDatagrams(byte[] aDatagram)	Write datagrams.
void	writeDatagrams(byte[] aDatagram, int aOffset, int aLength)	Write datagrams.

Methods inherited from interface org.refcodes.io.ByteReceiver

readDatagrams

Methods inherited from interface org.refcodes.component.Closable

closeIn, closeQuietly, closeUnchecked

Methods inherited from interface org.refcodes.component.ConnectionStatusAccessor

isConnectionOpened

Methods inherited from interface org.refcodes.component.Flushable

flushUnchecked, isFlushable

Methods inherited from class java.lang.Object

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

Constructor Detail

BidirectionalStreamByteTransceiverImpl

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

Instantiates a new bidirectional stream byte transceiver impl.

Parameters:

aInputStream - the input stream

aOutputStream - the output stream

Throws:

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

hasDatagram

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

Determines whether a datagram is available from a DatagramSender. Use the DatagramProvider extenison's DatagramProvider.readDatagram() method for retrieving the available datagram.

Specified by:

hasDatagram in interface Receivable

Returns:

True in case there is a datagram ready to be retrieved .

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

Caution: Reads till an OpenException (or an InterruptedException in case of blocking till more data is available) occurs. 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. 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 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

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 ByteDatagramReceiver extension's 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 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

Write datagrams.

Specified by:

writeDatagrams in interface ByteBlockConsumer

Specified by:

writeDatagrams in interface ByteConsumer

Parameters:

aDatagram - the datagram

Throws:

org.refcodes.component.OpenException - the open exception

writeDatagrams

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

Write datagrams.

Specified by:

writeDatagrams in interface ByteBlockConsumer

Specified by:

writeDatagrams in interface ByteSender

Parameters:

aDatagram - the datagram

aOffset - the offset

aLength - the length

Throws:

org.refcodes.component.OpenException - the open exception

writeDatagram

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

Write datagram.

Specified by:

writeDatagram in interface ByteConsumer

Specified by:

writeDatagram in interface ByteDatagramConsumer

Parameters:

aDatagram - the datagram

Throws:

org.refcodes.component.OpenException - the open exception

flush

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

Flush.

Specified by:

flush in interface ByteSender

Specified by:

flush in interface Flushable

Specified by:

flush in interface org.refcodes.component.Flushable

Throws:

org.refcodes.component.OpenException - the open exception

isClosable

public boolean isClosable()

Specified by:

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