Module org.refcodes.io

Package org.refcodes.io

Class LoopbackDatagramsTransmitter<DATA extends Serializable>

java.lang.Object

org.refcodes.component.AbstractConnectableAutomaton

org.refcodes.io.AbstractDatagramsTransmitter<DATA>

org.refcodes.io.LoopbackDatagramsTransmitter<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<LoopbackDatagramsReceiver<DATA>>, org.refcodes.component.ConnectionComponent.ConnectionAutomaton<LoopbackDatagramsReceiver<DATA>>, org.refcodes.component.ConnectionOpenable<LoopbackDatagramsReceiver<DATA>>, org.refcodes.component.ConnectionOpenable.ConnectionOpenAutomaton<LoopbackDatagramsReceiver<DATA>>, org.refcodes.component.ConnectionStatusAccessor, org.refcodes.component.Flushable, org.refcodes.component.OpenedAccessor, ConnectionDatagramsTransmitter<DATA,LoopbackDatagramsReceiver<DATA>>, DatagramSource<DATA>, DatagramsSource<DATA>, DatagramsTransmitter<DATA>, DatagramTransmitter<DATA>, Transmittable

public class LoopbackDatagramsTransmitter<DATA extends Serializable>
extends AbstractDatagramsTransmitter<DATA>
implements ConnectionDatagramsTransmitter<DATA,LoopbackDatagramsReceiver<DATA>>

A LoopbackDatagramsTransmitter is a DatagramTransmitter connected directly within the same JVM with a LoopbackDatagramsReceiver; 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

Constructor Summary

Constructors

Constructor	Description
LoopbackDatagramsTransmitter()

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
boolean	isOpenable(LoopbackDatagramsReceiver<DATA> aLoopbackReceiver)
void	open(LoopbackDatagramsReceiver<DATA> aLoopbackReceiver)
void	transmit(DATA aDatagram)	Writes (sends) a datagram to a listening DatagramReceiver.
void	transmit(DATA[] aDatagrams, int aOffset, int aLength)	Write datagrams.
void	transmitAll(DATA[] aDatagrams)	Writes (sends) a datagram block to a listening DatagramReceiver or DatagramsReceiver.

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

flushUnchecked, isFlushable

Constructor Details

LoopbackDatagramsTransmitter

public LoopbackDatagramsTransmitter()

Method Details

isOpenable

public boolean isOpenable(LoopbackDatagramsReceiver<DATA> aLoopbackReceiver)

Specified by:

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

open

public void open(LoopbackDatagramsReceiver<DATA> aLoopbackReceiver)
          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.

transmit

public void transmit(DATA[] aDatagrams,
 int aOffset,
 int aLength)
              throws IOException

Write datagrams.

Specified by:

transmit in interface DatagramsSource<DATA extends Serializable>

Specified by:

transmit in interface DatagramsTransmitter<DATA extends Serializable>

Parameters:

aDatagrams - the datagram

aOffset - the offset

aLength - the length

Throws:

IOException - the open exception

transmitAll

public void transmitAll(DATA[] aDatagrams)
                 throws IOException

Writes (sends) a datagram block to a listening DatagramReceiver or DatagramsReceiver.

Specified by:

transmitAll in interface DatagramsSource<DATA extends Serializable>

Parameters:

aDatagrams - The datagram to be pushed to the receiving DatagramReceiver or DatagramsReceiver.

Throws:

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

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 org.refcodes.component.AbstractConnectableAutomaton

Throws:

IOException