Package org.refcodes.io

Interface LoopbackReceiver<DATA extends Serializable>

Type Parameters:

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

All Superinterfaces:

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

All Known Implementing Classes:

LoopbackReceiverImpl

public interface LoopbackReceiver<DATA extends Serializable>
extends ConnectionReceiver<DATA,LoopbackSender<DATA>>

A LoopbackReceiver is a DatagramReceiver connected directly within the same JVM with a LoopbackSender; 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.OpenedAccessor

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

Method Summary

Modifier and Type	Method	Description
void	pushDatagram(DATA aDatagram)	Pushes a datagram into the LoopbackReceiver.
default void	pushDatagrams(DATA[] aDatagrams)	Pushes the datagrams into the LoopbackByteReceiver.
default void	pushDatagrams(DATA[] aDatagrams, int aOffset, int aLength)	Pushes the according number of datagrams beginning at the given offset into the LoopbackByteReceiver.

Methods inherited from interface org.refcodes.component.Closable

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

open, openUnchecked

Methods inherited from interface org.refcodes.component.ConnectionOpenable.ConnectionOpenAutomaton

isOpenable

Methods inherited from interface org.refcodes.component.ConnectionStatusAccessor

getConnectionStatus, isConnectionOpened

Methods inherited from interface org.refcodes.io.DatagramProvider

readDatagram

Methods inherited from interface org.refcodes.component.OpenedAccessor

isOpened

Methods inherited from interface org.refcodes.io.Receivable

hasDatagram

Methods inherited from interface org.refcodes.io.Receiver

readDatagrams, readDatagrams

Methods inherited from interface org.refcodes.mixin.Releaseable

releaseAll

Method Detail

pushDatagram

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

Pushes a datagram into the LoopbackReceiver. Them datagrams can be retrieved via DatagramProvider.readDatagram(): use Receivable.hasDatagram() to test beforehand whether there is a datagram available.

Parameters:

aDatagram - The datagram to be pushed into the LoopbackReceiver; to be retrieved with the DatagramProvider.readDatagram() method.

Throws:

org.refcodes.component.OpenException - the open exception

pushDatagrams

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

Pushes the datagrams into the LoopbackByteReceiver. Them datagrams can be retrieved via DatagramProvider.readDatagram(): use Receivable.hasDatagram() to test beforehand whether there is a datagram available.

Parameters:

aDatagrams - The datagrams to be pushed into the LoopbackByteReceiver; to be retrieved with the DatagramProvider.readDatagram() method.

Throws:

org.refcodes.component.OpenException - the open exception

pushDatagrams

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

Pushes the according number of datagrams beginning at the given offset into the LoopbackByteReceiver. Them datagrams can be retrieved via DatagramProvider.readDatagram(): use Receivable.hasDatagram() to test beforehand whether there is a datagram available.

Parameters:

aDatagrams - The datagrams to be pushed into the LoopbackByteReceiver; to be retrieved with the DatagramProvider.readDatagram() method.

aOffset - The offset from which to begin pushing.

aLength - The number of elements to be pushed.

Throws:

org.refcodes.component.OpenException - the open exception