Module org.refcodes.io

Package org.refcodes.io

Class LoopbackDatagramsTransceiver<DATA extends Serializable>

java.lang.Object

org.refcodes.component.AbstractConnectableAutomaton

org.refcodes.io.AbstractDatagramsReceiver<DATA>

org.refcodes.io.LoopbackDatagramsTransceiver<DATA>

Type Parameters:

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

All Implemented Interfaces:

Flushable, 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<LoopbackDatagramsTransceiver<DATA>>, org.refcodes.component.ConnectionComponent.ConnectionAutomaton<LoopbackDatagramsTransceiver<DATA>>, org.refcodes.component.ConnectionOpenable<LoopbackDatagramsTransceiver<DATA>>, org.refcodes.component.ConnectionOpenable.ConnectionOpenAutomaton<LoopbackDatagramsTransceiver<DATA>>, org.refcodes.component.ConnectionStatusAccessor, org.refcodes.component.Flushable, org.refcodes.component.OpenedAccessor, Availability, ConnectionDatagramsReceiver<DATA,LoopbackDatagramsTransceiver<DATA>>, ConnectionDatagramsTransceiver<DATA,LoopbackDatagramsTransceiver<DATA>>, ConnectionDatagramsTransmitter<DATA,LoopbackDatagramsTransceiver<DATA>>, DatagramDestination<DATA>, DatagramReceiver<DATA>, DatagramsDestination<DATA>, DatagramSource<DATA>, DatagramsReceiver<DATA>, DatagramsSource<DATA>, DatagramsTransceiver<DATA>, DatagramsTransmitter<DATA>, DatagramTransceiver<DATA>, DatagramTransmitter<DATA>, Receivable, Transmittable, org.refcodes.mixin.Loggable

public class LoopbackDatagramsTransceiver<DATA extends Serializable>
extends AbstractDatagramsReceiver<DATA>
implements ConnectionDatagramsTransceiver<DATA,LoopbackDatagramsTransceiver<DATA>>

A LoopbackDatagramsTransceiver is a DatagramTransceiver connected directly within the same JVM with another LoopbackDatagramsTransceiver; a "loopback" connection is used for establishing the connection which cannot be accessed outside the JVM or the running machine.

Nested Class Summary

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

org.refcodes.component.Flushable.FlushBuilder<B extends org.refcodes.component.Flushable.FlushBuilder<B>>

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

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
LoopbackDatagramsTransceiver()	Instantiates a new loopback transceiver impl.
LoopbackDatagramsTransceiver(int aCapacity)	Instantiates a new loopback transceiver impl.

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
boolean	isOpenable(LoopbackDatagramsTransceiver<DATA> aLoopbackTransceiver)
void	open(LoopbackDatagramsTransceiver<DATA> aLoopbackTransceiver)
void	pushDatagram(DATA aDatagram)	Pushes a datagram into the LoopbackDatagramsReceiver.
void	transmit(DATA aDatagram)	Writes (sends) a datagram to a listening DatagramReceiver.

Methods inherited from class org.refcodes.io.AbstractDatagramsReceiver

available, pushDatagrams, pushDatagrams, receive, receiveAll

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

available, hasAvailable

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, isOpened

Methods inherited from interface org.refcodes.io.DatagramsDestination

receive, receive

Methods inherited from interface org.refcodes.io.DatagramsReceiver

receive, receiveAll

Methods inherited from interface org.refcodes.io.DatagramsSource

transmitAll

Methods inherited from interface org.refcodes.io.DatagramsTransmitter

transmit

Methods inherited from interface org.refcodes.component.Flushable

flushUnchecked, isFlushable

Methods inherited from interface org.refcodes.mixin.Loggable

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

Constructor Details

LoopbackDatagramsTransceiver

public LoopbackDatagramsTransceiver()

Instantiates a new loopback transceiver impl.

LoopbackDatagramsTransceiver

public LoopbackDatagramsTransceiver(int aCapacity)

Instantiates a new loopback transceiver impl.

Parameters:

aCapacity - the capacity

Method Details

isOpenable

public boolean isOpenable(LoopbackDatagramsTransceiver<DATA> aLoopbackTransceiver)

Specified by:

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

open

public void open(LoopbackDatagramsTransceiver<DATA> aLoopbackTransceiver)
          throws IOException

Specified by:

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

Throws:

IOException

transmit

public void transmit(DATA aDatagram)
              throws IOException

Writes (sends) a datagram to a listening DatagramReceiver.

Specified by:

transmit in interface DatagramSource<DATA extends Serializable>

Specified by:

transmit in interface DatagramsSource<DATA extends Serializable>

Parameters:

aDatagram - The datagram to be pushed to the receiving DatagramSource.

Throws:

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

pushDatagram

public void pushDatagram(DATA aDatagram)
                  throws IOException

Pushes a datagram into the LoopbackDatagramsReceiver. Them datagrams can be retrieved via AbstractDatagramsReceiver.receive(): use AbstractDatagramsReceiver.available() to test beforehand whether there is a datagram available.

Overrides:

pushDatagram in class AbstractDatagramsReceiver<DATA extends Serializable>

Parameters:

aDatagram - The datagram to be pushed into the LoopbackDatagramsReceiver; to be retrieved with the AbstractDatagramsReceiver.receive() method.

Throws:

IOException - the open exception

flush

public void flush()
           throws IOException

Specified by:

flush in interface DatagramTransmitter<DATA extends Serializable>

Specified by:

flush in interface Flushable

Specified by:

flush in interface org.refcodes.component.Flushable

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface org.refcodes.component.Closable

Overrides:

close in class AbstractDatagramsReceiver<DATA extends Serializable>

Throws:

IOException