Module org.refcodes.io

Package org.refcodes.io

Class AbstractShortsDestination

java.lang.Object

org.refcodes.io.AbstractShortsDestination

All Implemented Interfaces:

ShortDestination, ShortsDestination, org.refcodes.mixin.Loggable

Direct Known Subclasses:

AbstractShortsReceiver

public abstract class AbstractShortsDestination
extends Object
implements ShortsDestination, org.refcodes.mixin.Loggable

The AbstractShortsDestination is a base abstract implementation of the ShortsDestination interface providing common functionality for concrete real live implementations.

Field Summary

Fields

Modifier and Type	Field	Description
protected LinkedBlockingQueue<Short>	_datagramQueue
static int	DATAGRAM_QUEUE_SIZE

Fields inherited from interface org.refcodes.mixin.Loggable

RUNTIME_LOGGER_CLASS, RUNTIME_LOGGER_FACTORY_CLASS, RUNTIME_LOGGER_FACTORY_METHOD

Constructor Summary

Constructors

Constructor	Description
AbstractShortsDestination()	Constructs a AbstractShortsDestination with a default sized blocking queue enabling a maximum of DATAGRAM_QUEUE_SIZE datagrams. ------------------------------------------------------------------------- Make sure your code fetches the datagrams quick enough to prevent filling up of the queue.
AbstractShortsDestination(int aCapacity)	Constructs a AbstractShortsDestination with a custom sized blocking queue enabling a maximum of datagrams as specified by the capacity parameter. ------------------------------------------------------------------------- Make sure your code fetches the datagrams quick enough to prevent filling up of the queue.

Method Summary

Modifier and Type	Method	Description
protected void	pushDatagram(short aDatagram)	Pushes a datagram into the receiver and puts it into the blocking queue containing the so far received datagrams.
protected void	pushDatagrams(short[] aDatagrams)	Pushes datagrams into the receiver and puts them into the blocking queue containing the so far received datagrams.
protected void	pushDatagrams(short[] aDatagrams, int aOffset, int aLength)	Pushes datagrams into the receiver and puts them into the blocking queue containing the so far received datagrams.
short[]	receiveAllShorts()	Reads (receives) the all currently available data.
short	receiveShort()	Reads (receives) the next short available, in case none short is available, then this method blocks until one is available.
short[]	receiveShorts(int aMaxLength)	Similar to ShortsDestination.receiveAllShorts() though at maximum the amount of data as provided returned.

Methods inherited from interface org.refcodes.mixin.Loggable

alert, alert, critical, critical, debug, error, info, notice, panic, trace, warn, warn

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

receiveShorts

Field Detail

DATAGRAM_QUEUE_SIZE

public static final int DATAGRAM_QUEUE_SIZE

See Also:

Constant Field Values

_datagramQueue

protected LinkedBlockingQueue<Short> _datagramQueue

Constructor Detail

AbstractShortsDestination

public AbstractShortsDestination()

Constructs a AbstractShortsDestination with a default sized blocking queue enabling a maximum of DATAGRAM_QUEUE_SIZE datagrams. ------------------------------------------------------------------------- Make sure your code fetches the datagrams quick enough to prevent filling up of the queue. In case the queue is filled up, adding elements via pushDatagram(short) to the queue is blocked until elements are taken from the queue via receiveShort().

AbstractShortsDestination

public AbstractShortsDestination(int aCapacity)

Constructs a AbstractShortsDestination with a custom sized blocking queue enabling a maximum of datagrams as specified by the capacity parameter. ------------------------------------------------------------------------- Make sure your code fetches the datagrams quick enough to prevent filling up of the queue. In case the queue is filled up, adding elements via pushDatagram(short) to the queue is blocked until elements are taken from the queue via receiveShort().

Parameters:

aCapacity - The capacity of the queue holding the received datagrams.

Method Detail

receiveShort

public short receiveShort()
                   throws IOException

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

Specified by:

receiveShort in interface ShortDestination

Specified by:

receiveShort in interface ShortsDestination

Returns:

The next short sent from the ShortsTransmitter counterpart.

Throws:

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

receiveAllShorts

public short[] receiveAllShorts()
                         throws IOException

Reads (receives) the all currently available data.

Specified by:

receiveAllShorts in interface ShortsDestination

Returns:

The next short block sent from the DatagramsTransmitter or DatagramReceiver counterpart.

Throws:

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

receiveShorts

public short[] receiveShorts(int aMaxLength)
                      throws IOException

Similar to ShortsDestination.receiveAllShorts() though at maximum the amount of data as provided returned.

Specified by:

receiveShorts in interface ShortsDestination

Parameters:

aMaxLength - The block-size which is not to exceeded by the returned data. A value of -1 specifies to retrieve all available datagrams (same behavior as method ShortsDestination.receiveAllShorts().

Returns:

The next short block sent from the DatagramsTransmitter or DatagramReceiver counterpart.

Throws:

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

pushDatagram

protected void pushDatagram(short aDatagram)
                     throws IOException

Pushes a datagram into the receiver and puts it into the blocking queue containing the so far received datagrams. Them datagrams can be retrieved via receiveShort(): Use AbstractBytesReceiver extension's AbstractBytesReceiver.available() to test beforehand whether there is a datagram available.

Parameters:

aDatagram - The datagram to be pushed at the end of the blocking queue; to be retrieved with the receiveShort() method.

Throws:

IOException - the open exception

pushDatagrams

protected void pushDatagrams(short[] aDatagrams)
                      throws IOException

Pushes datagrams into the receiver and puts them into the blocking queue containing the so far received datagrams. Them datagrams can be retrieved via receiveShort(): Use AbstractBytesReceiver extension's AbstractBytesReceiver.available() to test beforehand whether there is a datagram available.

Parameters:

aDatagrams - The datagrams to be pushed at the end of the blocking queue; to be retrieved with the receiveShort() method.

Throws:

IOException - the open exception

pushDatagrams

protected void pushDatagrams(short[] aDatagrams,
                             int aOffset,
                             int aLength)
                      throws IOException

Pushes datagrams into the receiver and puts them into the blocking queue containing the so far received datagrams. Them datagrams can be retrieved via receiveShort(): Use AbstractBytesReceiver extension's AbstractBytesReceiver.available() to test beforehand whether there is a datagram available.

Parameters:

aDatagrams - The datagrams to be pushed at the end of the blocking queue; to be retrieved with the receiveShort() method.

aOffset - The offset to start taking data from to be pushed.

aLength - The number of elements to be pushed from the offset onwards.

Throws:

IOException - the open exception