org.refcodes.connection

Interface LoopbackReceiver<DATA extends Serializable>

Type Parameters:

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

All Superinterfaces:

Closable, Closable.CloseAutomaton, ClosedAccessor, ConnectableComponent, ConnectableComponent.ConnectableAutomaton, ConnectionComponent<LoopbackSender<DATA>>, ConnectionComponent.ConnectionAutomaton<LoopbackSender<DATA>>, ConnectionOpenable<LoopbackSender<DATA>>, ConnectionOpenable.ConnectionOpenAutomaton<LoopbackSender<DATA>>, ConnectionReceiver<DATA,LoopbackSender<DATA>>, ConnectionStatusAccessor, OpenedAccessor, 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 Receiver 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.ConnectableComponent

ConnectableComponent.ConnectableAutomaton

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

Closable.CloseAutomaton

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

ClosedAccessor.ClosedMutator, ClosedAccessor.ClosedProperty

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

ConnectionStatusAccessor.ConnectionStatusMutator, ConnectionStatusAccessor.ConnectionStatusProperty

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

ConnectionComponent.ConnectionAutomaton<CON>

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

ConnectionOpenable.ConnectionOpenAutomaton<CON>

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

OpenedAccessor.OpenedMutator, OpenedAccessor.OpenedProperty

Method Summary

Modifier and Type	Method and Description
void	pushDatagram(DATA aDatagram) Pushes a datagram into the LoopbackReceiver.

Methods inherited from interface org.refcodes.connection.Receiver

hasDatagram, readDatagram

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

isClosable

Methods inherited from interface org.refcodes.component.Closable

close

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

isOpenable

Methods inherited from interface org.refcodes.component.ConnectionOpenable

open

Methods inherited from interface org.refcodes.component.OpenedAccessor

isOpened

Method Detail

pushDatagram

void pushDatagram(DATA aDatagram)
           throws OpenException

Pushes a datagram into the LoopbackReceiver. Them datagrams can be retrieved via Receiver.readDatagram(): use Receiver.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 Receiver.readDatagram() method.

Throws:

OpenException