Module org.refcodes.io

Package org.refcodes.io

Class LoopbackShortsTransmitter

java.lang.Object

org.refcodes.component.AbstractConnectableAutomaton

org.refcodes.io.AbstractShortsTransmitter

org.refcodes.io.LoopbackShortsTransmitter

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<LoopbackShortsReceiver>, org.refcodes.component.ConnectionComponent.ConnectionAutomaton<LoopbackShortsReceiver>, org.refcodes.component.ConnectionOpenable<LoopbackShortsReceiver>, org.refcodes.component.ConnectionOpenable.ConnectionOpenAutomaton<LoopbackShortsReceiver>, org.refcodes.component.ConnectionStatusAccessor, org.refcodes.component.Flushable, org.refcodes.component.OpenedAccessor, ConnectionShortsTransmitter<LoopbackShortsReceiver>, ShortSource, ShortsSource, ShortsTransmitter, ShortTransmitter, Transmittable

public class LoopbackShortsTransmitter
extends AbstractShortsTransmitter
implements ConnectionShortsTransmitter<LoopbackShortsReceiver>

A LoopbackShortsTransmitter is a DatagramTransmitter connected directly within the same JVM with a LoopbackBytesReceiver; 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
LoopbackShortsTransmitter()

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
boolean	isOpenable(LoopbackShortsReceiver aLoopbackReceiver)
void	open(LoopbackShortsReceiver aLoopbackReceiver)
void	transmitAllShorts(short[] aShorts)	Writes (sends) a short block.
void	transmitShort(short aShort)	Writes (sends) a short.
void	transmitShorts(short[] aShorts, int aOffset, int aLength)	Writes (sends) a short block.

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

LoopbackShortsTransmitter

public LoopbackShortsTransmitter()

Method Details

isOpenable

public boolean isOpenable(LoopbackShortsReceiver aLoopbackReceiver)

Specified by:

isOpenable in interface org.refcodes.component.ConnectionOpenable.ConnectionOpenAutomaton<LoopbackShortsReceiver>

open

public void open(LoopbackShortsReceiver aLoopbackReceiver)
          throws IOException

Specified by:

open in interface org.refcodes.component.ConnectionOpenable<LoopbackShortsReceiver>

Throws:

IOException

transmitShort

public void transmitShort(short aShort)
                   throws IOException

Writes (sends) a short.

Specified by:

transmitShort in interface ShortSource

Specified by:

transmitShort in interface ShortsSource

Parameters:

aShort - The short to be pushed.

Throws:

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

transmitShorts

public void transmitShorts(short[] aShorts,
 int aOffset,
 int aLength)
                    throws IOException

Writes (sends) a short block.

Specified by:

transmitShorts in interface ShortsSource

Specified by:

transmitShorts in interface ShortsTransmitter

Parameters:

aShorts - The short to be pushed.

aOffset - The offset from which to take the data.

aLength - The number of elements to push starting at the given offset.

Throws:

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

transmitAllShorts

public void transmitAllShorts(short[] aShorts)
                       throws IOException

Writes (sends) a short block.

Specified by:

transmitAllShorts in interface ShortsSource

Parameters:

aShorts - The short to be pushed.

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 Flushable

Specified by:

flush in interface org.refcodes.component.Flushable

Specified by:

flush in interface ShortTransmitter

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