org.refcodes.io

Class LoopbackReceiverImpl<DATA extends Serializable>

java.lang.Object

org.refcodes.component.AbstractConnectableAutomaton

org.refcodes.io.AbstractReceiver<DATA>

org.refcodes.io.LoopbackReceiverImpl<DATA>

Type Parameters:

DATA - The type of the datagram to be operated with.

All Implemented Interfaces:

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.ConnectionComponent<LoopbackSender<DATA>>, org.refcodes.component.ConnectionComponent.ConnectionAutomaton<LoopbackSender<DATA>>, org.refcodes.component.ConnectionOpenable<LoopbackSender<DATA>>, org.refcodes.component.ConnectionOpenable.ConnectionOpenAutomaton<LoopbackSender<DATA>>, org.refcodes.component.ConnectionStatusAccessor, org.refcodes.component.OpenedAccessor, BlockProvider<DATA>, BlockReceiver<DATA>, ConnectionReceiver<DATA,LoopbackSender<DATA>>, DatagramProvider<DATA>, DatagramReceiver<DATA>, LoopbackReceiver<DATA>, Provider<DATA>, Receivable, Receiver<DATA>, org.refcodes.mixin.Releaseable

public class LoopbackReceiverImpl<DATA extends Serializable>
extends AbstractReceiver<DATA>
implements LoopbackReceiver<DATA>

Implementation of the LoopbackReceiver interface.

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

Nested classes/interfaces inherited from interface org.refcodes.component.ConnectionComponent

org.refcodes.component.ConnectionComponent.ConnectionAutomaton<CON>, org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<CON,B extends org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<CON,B>>

Nested classes/interfaces inherited from interface org.refcodes.component.ConnectionOpenable

org.refcodes.component.ConnectionOpenable.ConnectionOpenAutomaton<CON>, org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder<CON,B extends org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder<CON,B>>

Field Summary

Fields inherited from class org.refcodes.io.AbstractReceiver

DATAGRAM_QUEUE_SIZE

Constructor Summary

Constructors

Constructor and Description
LoopbackReceiverImpl() Instantiates a new loopback receiver impl.
LoopbackReceiverImpl(int aCapacity) Instantiates a new loopback receiver impl.

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	isOpenable(LoopbackSender<DATA> aLoopbackSender)
void	open(LoopbackSender<DATA> aLoopbackSender)
void	pushDatagram(DATA aDatagram) Pushes a datagram into the receiver and puts it into the blocking queue containing the so far received datagrams.
void	pushDatagrams(DATA[] aDatagrams) Pushes datagrams into the receiver and puts them into the blocking queue containing the so far received datagrams.
void	pushDatagrams(DATA[] aDatagrams, int aOffset, int aLength) Pushes datagrams into the receiver and puts them into the blocking queue containing the so far received datagrams.

Methods inherited from class org.refcodes.io.AbstractReceiver

hasDatagram, readDatagram, readDatagrams, releaseAll

Methods inherited from class org.refcodes.component.AbstractConnectableAutomaton

getConnectionStatus, isClosable, isClosed, isOpenable, isOpened, open, setConnectionStatus

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

readDatagrams, readDatagrams

Methods inherited from interface org.refcodes.io.DatagramProvider

readDatagram

Methods inherited from interface org.refcodes.io.Receivable

hasDatagram

Methods inherited from interface org.refcodes.component.OpenedAccessor

isOpened

Methods inherited from interface org.refcodes.component.Closable.CloseAutomaton

isClosable

Methods inherited from interface org.refcodes.component.Closable

closeIn, closeQuietly, closeUnchecked

Methods inherited from interface org.refcodes.component.ClosedAccessor

isClosed

Methods inherited from interface org.refcodes.component.ConnectionStatusAccessor

getConnectionStatus

Methods inherited from interface org.refcodes.mixin.Releaseable

releaseAll

Methods inherited from interface org.refcodes.component.ConnectionOpenable

openUnchecked

Constructor Detail

LoopbackReceiverImpl

public LoopbackReceiverImpl()

Instantiates a new loopback receiver impl.

LoopbackReceiverImpl

public LoopbackReceiverImpl(int aCapacity)

Instantiates a new loopback receiver impl.

Parameters:

aCapacity - the a capacity

Method Detail

isOpenable

public boolean isOpenable(LoopbackSender<DATA> aLoopbackSender)

Specified by:

isOpenable in interface org.refcodes.component.ConnectionOpenable.ConnectionOpenAutomaton<LoopbackSender<DATA extends Serializable>>

open

public void open(LoopbackSender<DATA> aLoopbackSender)
          throws org.refcodes.component.OpenException

Specified by:

open in interface org.refcodes.component.ConnectionOpenable<LoopbackSender<DATA extends Serializable>>

Throws:

org.refcodes.component.OpenException

pushDatagram

public void pushDatagram(DATA aDatagram)
                  throws org.refcodes.component.OpenException

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 AbstractReceiver.readDatagram(): use AbstractReceiver.hasDatagram() to test beforehand whether there is a datagram available.

Specified by:

pushDatagram in interface LoopbackReceiver<DATA extends Serializable>

Overrides:

pushDatagram in class AbstractReceiver<DATA extends Serializable>

Parameters:

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

Throws:

org.refcodes.component.OpenException - the open exception

pushDatagrams

public void pushDatagrams(DATA[] aDatagrams)
                   throws org.refcodes.component.OpenException

Pushes datagrams into the receiver and puts them into the blocking queue containing the so far received datagrams. Them datagrams can be retrieved via AbstractReceiver.readDatagram(): use AbstractReceiver.hasDatagram() to test beforehand whether there is a datagram available.

Specified by:

pushDatagrams in interface LoopbackReceiver<DATA extends Serializable>

Overrides:

pushDatagrams in class AbstractReceiver<DATA extends Serializable>

Parameters:

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

Throws:

org.refcodes.component.OpenException - the open exception

pushDatagrams

public void pushDatagrams(DATA[] aDatagrams,
                          int aOffset,
                          int aLength)
                   throws org.refcodes.component.OpenException

Pushes datagrams into the receiver and puts them into the blocking queue containing the so far received datagrams. Them datagrams can be retrieved via AbstractReceiver.readDatagram(): use AbstractReceiver.hasDatagram() to test beforehand whether there is a datagram available.

Specified by:

pushDatagrams in interface LoopbackReceiver<DATA extends Serializable>

Overrides:

pushDatagrams in class AbstractReceiver<DATA extends Serializable>

Parameters:

aDatagrams - The datagrams to be pushed at the end of the blocking queue; to be retrieved with the AbstractReceiver.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.

Throws:

org.refcodes.component.OpenException - the open exception

close

public void close()
           throws org.refcodes.component.CloseException

Specified by:

close in interface org.refcodes.component.Closable

Overrides:

close in class AbstractReceiver<DATA extends Serializable>

Throws:

org.refcodes.component.CloseException