Package org.refcodes.io

Class LoopbackByteReceiverImpl

java.lang.Object

org.refcodes.io.AbstractByteProvider

org.refcodes.io.AbstractByteReceiver

org.refcodes.io.LoopbackByteReceiverImpl

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<LoopbackByteSender>, org.refcodes.component.ConnectionComponent.ConnectionAutomaton<LoopbackByteSender>, org.refcodes.component.ConnectionOpenable<LoopbackByteSender>, org.refcodes.component.ConnectionOpenable.ConnectionOpenAutomaton<LoopbackByteSender>, org.refcodes.component.ConnectionStatusAccessor, org.refcodes.component.OpenedAccessor, ByteBlockProvider, ByteBlockReceiver, ByteDatagramProvider, ByteDatagramReceiver, ByteProvider, ByteReceiver, ConnectionByteReceiver<LoopbackByteSender>, LoopbackByteReceiver, Receivable, org.refcodes.mixin.Loggable, org.refcodes.mixin.Releaseable

public class LoopbackByteReceiverImpl
extends AbstractByteReceiver
implements LoopbackByteReceiver

Implementation of the LoopbackByteReceiver interface.

Nested Class Summary

Nested classes/interfaces inherited from class org.refcodes.io.AbstractByteReceiver

AbstractByteReceiver.ConnectableAutomaton

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

org.refcodes.component.ConnectionComponent.ConnectionAutomaton<CON extends Object>, org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<CON extends Object,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 extends Object>, org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder<CON extends Object,B extends org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder<CON,B>>

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

org.refcodes.component.OpenedAccessor.OpenedMutator, org.refcodes.component.OpenedAccessor.OpenedProperty

Field Summary

Fields inherited from class org.refcodes.io.AbstractByteProvider

_datagramQueue, DATAGRAM_QUEUE_SIZE

Fields inherited from class org.refcodes.io.AbstractByteReceiver

_automaton

Fields inherited from interface org.refcodes.mixin.Loggable

RUNTIME_LOGGER_CLASS, RUNTIME_LOGGER_FACTORY_CLASS, RUNTIME_LOGGER_FACTORY_METHOD

Constructor Summary

Constructors

Constructor	Description
LoopbackByteReceiverImpl()	Instantiates a new loopback byte receiver impl.
LoopbackByteReceiverImpl(int aCapacity)	Instantiates a new loopback byte receiver impl.

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	isOpenable(LoopbackByteSender aLoopbackSender)
void	open(LoopbackByteSender aLoopbackSender)
void	pushDatagram(byte aDatagram)	Pushes a datagram into the receiver and puts it into the blocking queue containing the so far received datagrams.
void	pushDatagrams(byte[] aDatagrams)	Pushes datagrams into the receiver and puts them into the blocking queue containing the so far received datagrams.
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.

Methods inherited from class org.refcodes.io.AbstractByteReceiver

getConnectionStatus, hasDatagram, isClosable, isClosed, isOpenable, isOpened, open, readDatagram, readDatagrams, readDatagrams, releaseAll, setConnectionStatus

Methods inherited from interface org.refcodes.io.ByteDatagramProvider

readDatagram

Methods inherited from interface org.refcodes.io.ByteReceiver

readDatagrams, readDatagrams

Methods inherited from interface org.refcodes.component.Closable

closeIn, closeQuietly, closeUnchecked

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

isClosable

Methods inherited from interface org.refcodes.component.ClosedAccessor

isClosed

Methods inherited from interface org.refcodes.component.ConnectionOpenable

openUnchecked

Methods inherited from interface org.refcodes.component.ConnectionStatusAccessor

getConnectionStatus, isConnectionOpened

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.component.OpenedAccessor

isOpened

Methods inherited from interface org.refcodes.io.Receivable

hasDatagram

Methods inherited from interface org.refcodes.mixin.Releaseable

releaseAll

Constructor Detail

LoopbackByteReceiverImpl

public LoopbackByteReceiverImpl()

Instantiates a new loopback byte receiver impl.

LoopbackByteReceiverImpl

public LoopbackByteReceiverImpl(int aCapacity)

Instantiates a new loopback byte receiver impl.

Parameters:

aCapacity - the capacity

Method Detail

isOpenable

public boolean isOpenable(LoopbackByteSender aLoopbackSender)

Specified by:

isOpenable in interface org.refcodes.component.ConnectionOpenable.ConnectionOpenAutomaton<LoopbackByteSender>

open

public void open(LoopbackByteSender aLoopbackSender)
          throws org.refcodes.component.OpenException

Specified by:

open in interface org.refcodes.component.ConnectionOpenable<LoopbackByteSender>

Throws:

org.refcodes.component.OpenException

pushDatagram

public void pushDatagram(byte 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 AbstractByteProvider.readDatagram(): Use AbstractByteReceiver extension's AbstractByteReceiver.hasDatagram() to test beforehand whether there is a datagram available.

Specified by:

pushDatagram in interface LoopbackByteReceiver

Overrides:

pushDatagram in class AbstractByteProvider

Parameters:

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

Throws:

org.refcodes.component.OpenException - the open exception

pushDatagrams

public void pushDatagrams(byte[] 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 AbstractByteProvider.readDatagram(): Use AbstractByteReceiver extension's AbstractByteReceiver.hasDatagram() to test beforehand whether there is a datagram available.

Specified by:

pushDatagrams in interface LoopbackByteReceiver

Overrides:

pushDatagrams in class AbstractByteProvider

Parameters:

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

Throws:

org.refcodes.component.OpenException - the open exception

pushDatagrams

public void pushDatagrams(byte[] 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 AbstractByteProvider.readDatagram(): Use AbstractByteReceiver extension's AbstractByteReceiver.hasDatagram() to test beforehand whether there is a datagram available.

Specified by:

pushDatagrams in interface LoopbackByteReceiver

Overrides:

pushDatagrams in class AbstractByteProvider

Parameters:

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

Throws:

org.refcodes.component.CloseException