Class PrefetchBidirectionalStreamByteTransceiver

java.lang.Object

org.refcodes.io.PrefetchBidirectionalStreamByteTransceiver

All Implemented Interfaces:

Flushable, Closable, Closable.CloseAutomaton, ClosedAccessor, ConnectableComponent, ConnectableComponent.ConnectableAutomaton, ConnectionStatusAccessor, Flushable, OpenedAccessor, Availability, ByteDestination, ByteReceiver, BytesDestination, ByteSource, BytesReceiver, BytesSource, BytesTransceiver, BytesTransmitter, ByteTransceiver, ByteTransmitter, Receivable, Skippable, TimeoutInputStreamAccessor, Transmittable, InputStreamAccessor, OutputStreamAccessor

public class PrefetchBidirectionalStreamByteTransceiver
extends Object
implements BytesTransceiver

The Class PrefetchBidirectionalStreamByteTransceiver.

Nested Class Summary

Nested classes/interfaces inherited from interface BytesReceiver

BytesReceiver.ReceiverInputStream

Nested classes/interfaces inherited from interface BytesTransmitter

BytesTransmitter.TransmitterOutputStream

Nested classes/interfaces inherited from interface Closable

Closable.CloseAutomaton, Closable.CloseBuilder<B>

Nested classes/interfaces inherited from interface ClosedAccessor

ClosedAccessor.ClosedMutator, ClosedAccessor.ClosedProperty

Nested classes/interfaces inherited from interface ConnectableComponent

ConnectableComponent.ConnectableAutomaton

Nested classes/interfaces inherited from interface ConnectionStatusAccessor

ConnectionStatusAccessor.ConnectionStatusMutator, ConnectionStatusAccessor.ConnectionStatusProperty

Nested classes/interfaces inherited from interface Flushable

Flushable.FlushBuilder<B>

Nested classes/interfaces inherited from interface InputStreamAccessor

InputStreamAccessor.InputStreamBuilder<B>, InputStreamAccessor.InputStreamMutator, InputStreamAccessor.InputStreamProperty

Nested classes/interfaces inherited from interface OpenedAccessor

OpenedAccessor.OpenedMutator, OpenedAccessor.OpenedProperty

Nested classes/interfaces inherited from interface OutputStreamAccessor

OutputStreamAccessor.OutputStreamBuilder<B>, OutputStreamAccessor.OutputStreamMutator, OutputStreamAccessor.OutputStreamProperty

Nested classes/interfaces inherited from interface TimeoutInputStreamAccessor

TimeoutInputStreamAccessor.TimeoutInputStreamBuilder<B>, TimeoutInputStreamAccessor.TimeoutInputStreamMutator, TimeoutInputStreamAccessor.TimeoutInputStreamProperty

Constructor Summary

Constructors

Constructor	Description
PrefetchBidirectionalStreamByteTransceiver(InputStream aInputStream, OutputStream aOutputStream)	Instantiates a new prefetch bidirectional stream byte transceiver impl.

Method Summary

Modifier and Type	Method	Description
int	available()	Determines the number of available datagram from a DatagramTransmitter.
void	close()
void	flush()	Flush.
ConnectionStatus	getConnectionStatus()
boolean	isClosable()
boolean	isClosed()
boolean	isOpened()
byte[]	receiveAllBytes()	Reads (receives) the all currently available data.
byte	receiveByte()	Reads (receives) the next byte, in case none byte is available, then this method blocks until one is available.
void	transmitByte(byte aByte)	Write datagram.
void	transmitBytes(byte[] aDatagram)	Write datagrams.
void	transmitBytes(byte[] aDatagram, int aOffset, int aLength)	Write datagrams.

Methods inherited from class Object

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

Methods inherited from interface Availability

hasAvailable

Methods inherited from interface BytesDestination

receiveBytes

Methods inherited from interface BytesReceiver

getInputStream, getInputStream, receiveBytes, receiveBytesWithin, receiveBytesWithin, receiveByteWithin, skip

Methods inherited from interface BytesTransmitter

getOutputStream

Methods inherited from interface Closable

closeIn, closeQuietly, closeUnchecked

Methods inherited from interface Flushable

flushUnchecked, isFlushable

Methods inherited from interface Skippable

skipAvailable, skipAvailableExcept, skipAvailableTill, skipAvailableTillSilenceFor, skipAvailableTillSilenceFor, skipAvailableWithin, skipAvailableWithin, skipAvailableWithin

Constructor Details

PrefetchBidirectionalStreamByteTransceiver

public PrefetchBidirectionalStreamByteTransceiver(InputStream aInputStream,
 OutputStream aOutputStream)
                                           throws IOException

Instantiates a new prefetch bidirectional stream byte transceiver impl.

Parameters:

aInputStream - the input stream

aOutputStream - the output stream

Throws:

IOException - the open exception

Method Details

isClosed

public boolean isClosed()

Specified by:

isClosed in interface ClosedAccessor

isOpened

public boolean isOpened()

Specified by:

isOpened in interface ConnectionStatusAccessor

Specified by:

isOpened in interface 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

Specified by:

available in interface Skippable

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.

receiveAllBytes

public byte[] receiveAllBytes()
                       throws IOException

Reads (receives) the all currently available data.

Specified by:

receiveAllBytes in interface BytesDestination

Specified by:

receiveAllBytes in interface BytesReceiver

Returns:

The according data.

Throws:

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

getConnectionStatus

public ConnectionStatus getConnectionStatus()

Specified by:

getConnectionStatus in interface ConnectionStatusAccessor

close

public void close()
           throws IOException

Specified by:

close in interface Closable

Throws:

IOException

receiveByte

public byte receiveByte()
                 throws IOException

Reads (receives) the next byte, in case none byte is available, then this method blocks until one is available.

Specified by:

receiveByte in interface ByteDestination

Specified by:

receiveByte in interface BytesDestination

Returns:

The next byte available .

Throws:

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

transmitBytes

public void transmitBytes(byte[] aDatagram)
                   throws IOException

Write datagrams.

Specified by:

transmitBytes in interface BytesSource

Parameters:

aDatagram - the datagram

Throws:

IOException - the open exception

transmitBytes

public void transmitBytes(byte[] aDatagram,
 int aOffset,
 int aLength)
                   throws IOException

Write datagrams.

Specified by:

transmitBytes in interface BytesSource

Specified by:

transmitBytes in interface BytesTransmitter

Parameters:

aDatagram - the datagram

aOffset - the offset

aLength - the length

Throws:

IOException - the open exception

transmitByte

public void transmitByte(byte aByte)
                  throws IOException

Write datagram.

Specified by:

transmitByte in interface ByteSource

Specified by:

transmitByte in interface BytesSource

Parameters:

aByte - the datagram

Throws:

IOException - the open exception

flush

public void flush()
           throws IOException

Flush.

Specified by:

flush in interface ByteTransmitter

Specified by:

flush in interface Flushable

Specified by:

flush in interface Flushable

Throws:

IOException - the open exception

isClosable

public boolean isClosable()

Specified by:

isClosable in interface Closable.CloseAutomaton