org.refcodes.io

Interface LoopbackShortTransceiver

All Superinterfaces:

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<LoopbackShortTransceiver>, org.refcodes.component.ConnectionComponent.ConnectionAutomaton<LoopbackShortTransceiver>, org.refcodes.component.ConnectionOpenable<LoopbackShortTransceiver>, org.refcodes.component.ConnectionOpenable.ConnectionOpenAutomaton<LoopbackShortTransceiver>, ConnectionShortReceiver<LoopbackShortTransceiver>, ConnectionShortSender<LoopbackShortTransceiver>, ConnectionShortTransceiver<LoopbackShortTransceiver>, org.refcodes.component.ConnectionStatusAccessor, Flushable, org.refcodes.component.OpenedAccessor, Receivable, org.refcodes.mixin.Releaseable, Sendable, ShortBlockConsumer, ShortBlockProvider, ShortBlockReceiver, ShortBlockSender, ShortConsumer, ShortDatagramConsumer, ShortDatagramProvider, ShortDatagramReceiver, ShortDatagramSender, ShortProvider, ShortReceiver, ShortSender, ShortTransceiver

All Known Implementing Classes:

LoopbackShortTransceiverImpl

public interface LoopbackShortTransceiver
extends ConnectionShortTransceiver<LoopbackShortTransceiver>

A LoopbackShortTransceiver is a DatagramTransceiver connected directly within the same JVM with another LoopbackShortTransceiver; 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

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

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

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

Method Summary

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

Methods inherited from interface org.refcodes.io.ShortReceiver

readDatagrams, readDatagrams

Methods inherited from interface org.refcodes.io.ShortDatagramProvider

readDatagram

Methods inherited from interface org.refcodes.io.Receivable

hasDatagram

Methods inherited from interface org.refcodes.mixin.Releaseable

releaseAll

Methods inherited from interface org.refcodes.io.ShortSender

flush, writeDatagrams

Methods inherited from interface org.refcodes.io.ShortConsumer

writeDatagram, writeDatagrams

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

close, 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.component.Flushable

flushUnchecked

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

isOpenable

Methods inherited from interface org.refcodes.component.ConnectionOpenable

open, openUnchecked

Method Detail

pushDatagram

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

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

Throws:

org.refcodes.component.OpenException - the open exception