public abstract class AbstractByteReceiver extends org.refcodes.component.impls.AbstractConnectableAutomaton implements ByteReceiver
AbstractByteReceiver
is a base abstract implementation of the
ByteReceiver
interface providing common functionality for concrete
real live ByteDatagramReceiver
and ByteBlockReceiver
(=
ByteReceiver
) implementations.
A blocking queue is used internally to which received datagrams are put via
#pushDatagram(Serializable)
and which can be retrieved via
readDatagram()
. The pushDatagram(byte)
method is your hook
when extending this class.
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(byte) to the queue is blocked until elements are taken
from the queue via {@link #readDatagram()}. So cautions are taken to prevent
a memory leak.org.refcodes.component.ConnectableComponent.ConnectableAutomaton
org.refcodes.component.OpenedAccessor.OpenedMutator, org.refcodes.component.OpenedAccessor.OpenedProperty
org.refcodes.component.Closable.CloseAutomaton, org.refcodes.component.Closable.CloseBuilder<B extends org.refcodes.component.Closable.CloseBuilder<B>>
Modifier and Type | Field and Description |
---|---|
protected LinkedBlockingQueue<Byte> |
_datagramQueue |
static int |
DATAGRAM_QUEUE_SIZE |
Constructor and Description |
---|
AbstractByteReceiver()
Constructs a
AbstractByteReceiver 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. |
AbstractByteReceiver(int aCapacity)
Constructs a
AbstractByteReceiver 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. |
Modifier and Type | Method and Description |
---|---|
void |
close() |
boolean |
hasDatagram()
Determines whether a datagram is available from a
DatagramSender
and can be retrieved via the #readDatagram() method. |
protected void |
pushDatagram(byte aDatagram)
Pushes a datagram into the receiver and puts it into the blocking queue
containing the so far received datagrams.
|
protected void |
pushDatagrams(byte[] aDatagrams)
Pushes datagrams into the receiver and puts them into the blocking queue
containing the so far received datagrams.
|
protected void |
pushDatagrams(byte[] aDatagrams,
int aOffset,
int aLength)
Pushes datagrams into the receiver and puts them into the blocking queue
containing the so far received datagrams.
|
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. |
byte[] |
readDatagrams(int aBlockSize)
Similar to
ByteBlockProvider.readDatagrams() though at maximum the amount of data
as provided by the block-size is returned. |
void |
releaseAll() |
getConnectionStatus, isClosable, isClosed, isOpenable, isOpened, open, setConnectionStatus
public static final int DATAGRAM_QUEUE_SIZE
protected LinkedBlockingQueue<Byte> _datagramQueue
public AbstractByteReceiver()
AbstractByteReceiver
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(Serializable)
to the queue is blocked until
elements are taken from the queue via readDatagram()
.public AbstractByteReceiver(int aCapacity)
AbstractByteReceiver
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(Serializable)
to the queue is blocked until
elements are taken from the queue via readDatagram()
.aCapacity
- The capacity of the queue holding the received
datagrams.public byte readDatagram() throws org.refcodes.component.OpenException, InterruptedException
ByteDatagramProvider
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.readDatagram
in interface ByteDatagramProvider
ByteDatagramSender
counterpart.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.public byte[] readDatagrams() throws org.refcodes.component.OpenException, InterruptedException
ByteProvider
OpenException
(or an
InterruptedException
in case of blocking till more data is
available) occurs.readDatagrams
in interface ByteBlockProvider
readDatagrams
in interface ByteProvider
readDatagrams
in interface ByteReceiver
BlockSender
or
DatagramReceiver
counterpart.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.public byte[] readDatagrams(int aBlockSize) throws org.refcodes.component.OpenException, InterruptedException
ByteBlockProvider
ByteBlockProvider.readDatagrams()
though at maximum the amount of data
as provided by the block-size is returned.readDatagrams
in interface ByteBlockProvider
readDatagrams
in interface ByteProvider
readDatagrams
in interface ByteReceiver
aBlockSize
- 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 ByteBlockProvider.readDatagrams()
.BlockSender
or
DatagramReceiver
counterpart.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.public boolean hasDatagram() throws org.refcodes.component.OpenException
Receivable
DatagramSender
and can be retrieved via the #readDatagram()
method.hasDatagram
in interface Receivable
#readDatagram()
method.org.refcodes.component.OpenException
- Thrown in case opening or accessing an open line
(connection, junction, link) caused problems.public void close() throws org.refcodes.component.CloseException
close
in interface org.refcodes.component.Closable
close
in class org.refcodes.component.impls.AbstractConnectableAutomaton
org.refcodes.component.CloseException
public void releaseAll()
releaseAll
in interface org.refcodes.mixin.Releaseable
protected void pushDatagram(byte aDatagram) throws org.refcodes.component.OpenException
readDatagram()
: use hasDatagram()
to test
beforehand whether there is a datagram available.aDatagram
- The datagram to be pushed at the end of the blocking
queue; to be retrieved with the readDatagram()
method.org.refcodes.component.OpenException
protected void pushDatagrams(byte[] aDatagrams) throws org.refcodes.component.OpenException
readDatagram()
: use hasDatagram()
to test
beforehand whether there is a datagram available.aDatagrams
- The datagrams to be pushed at the end of the blocking
queue; to be retrieved with the readDatagram()
method.org.refcodes.component.OpenException
protected void pushDatagrams(byte[] aDatagrams, int aOffset, int aLength) throws org.refcodes.component.OpenException
readDatagram()
: use hasDatagram()
to test
beforehand whether there is a datagram available.aDatagrams
- The datagrams to be pushed at the end of the blocking
queue; to be retrieved with the readDatagram()
method.aOffset
- The offset to start taking data from to be pushed.aLength
- The number of elements to be pushed from the offset
onwards.org.refcodes.component.OpenException
Copyright © 2017. All rights reserved.