Module org.refcodes.io

Package org.refcodes.io

Class OutputStreamDatagramsTransmitter<DATA extends Serializable>

java.lang.Object

org.refcodes.io.OutputStreamDatagramsTransmitter<DATA>

Type Parameters:

DATA - the generic type

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.ConnectionStatusAccessor, org.refcodes.component.Flushable, org.refcodes.component.OpenedAccessor, DatagramSource<DATA>, DatagramsSource<DATA>, DatagramsTransmitter<DATA>, DatagramTransmitter<DATA>, Transmittable

public class OutputStreamDatagramsTransmitter<DATA extends Serializable>
extends Object
implements DatagramsTransmitter<DATA>

The Class OutputStreamDatagramsTransmitter.

Author:

steiner

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.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
OutputStreamDatagramsTransmitter(OutputStream aOutputStream)	Instantiates a new output stream sender impl.

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
org.refcodes.component.ConnectionStatus	getConnectionStatus()
boolean	isClosable()
boolean	isClosed()
boolean	isOpened()
void	transmit(DATA aDatagram)	Writes (sends) a datagram to a listening DatagramReceiver.
void	transmit(DATA[] aDatagram, int aOffset, int aLength)	Write datagrams.
void	transmitAll(DATA[] aDatagram)	Writes (sends) a datagram block to a listening DatagramReceiver or DatagramsReceiver.

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

flushUnchecked, isFlushable

Constructor Details

OutputStreamDatagramsTransmitter

public OutputStreamDatagramsTransmitter(OutputStream aOutputStream)
                                 throws IOException

Instantiates a new output stream sender impl.

Parameters:

aOutputStream - the output stream

Throws:

IOException - the open exception

Method Details

transmitAll

public void transmitAll(DATA[] aDatagram)
                 throws IOException

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

Specified by:

transmitAll in interface DatagramsSource<DATA extends Serializable>

Parameters:

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

isClosed

public boolean isClosed()

Specified by:

isClosed in interface org.refcodes.component.ClosedAccessor

isOpened

public boolean isOpened()

Specified by:

isOpened in interface org.refcodes.component.ConnectionStatusAccessor

Specified by:

isOpened in interface org.refcodes.component.OpenedAccessor

getConnectionStatus

public org.refcodes.component.ConnectionStatus getConnectionStatus()

Specified by:

getConnectionStatus in interface org.refcodes.component.ConnectionStatusAccessor

transmit

public void transmit(DATA[] aDatagram,
 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:

aDatagram - the datagram

aOffset - the offset

aLength - the length

Throws:

IOException - the open exception

close

public void close()
           throws IOException

Specified by:

close in interface org.refcodes.component.Closable

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.

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

isClosable

public boolean isClosable()

Specified by:

isClosable in interface org.refcodes.component.Closable.CloseAutomaton