Module org.refcodes.io

Package org.refcodes.io

Interface DatagramsSource<DATA extends Serializable>

Type Parameters:

DATA - The type of the datagram block (array) to be operated with. Do not provide an array type as the methods use to generic type for defining an array argument.

All Superinterfaces:

DatagramSource<DATA>

All Known Subinterfaces:

BidirectionalConnectionTransceiver<DATA,INPUT,OUTPUT>, BidirectionalStreamConnectionTransceiver<DATA>, ConnectionDatagramsTransceiver<DATA,CON>, ConnectionDatagramsTransmitter<DATA,CON>, DatagramsTransceiver<DATA>, DatagramsTransmitter<DATA>

All Known Implementing Classes:

AbstractDatagramsTransmitter, BidirectionalStreamConnectionTransceiverImpl, BidirectionalStreamTransceiver, LoopbackDatagramsTransceiver, LoopbackDatagramsTransmitter, OutputStreamConnectionDatagramsTransmitter, OutputStreamDatagramsTransmitter, PrefetchBidirectionalStreamConnectionTransceiver, PrefetchBidirectionalStreamTransceiver, TransmitterDecorator

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface DatagramsSource<DATA extends Serializable>
extends DatagramSource<DATA>

The DatagramsSource is used to send datagram blocks (arrays) in a unified way.

Method Summary

Modifier and Type	Method	Description
default void	transmit(DATA aDatagram)	Writes (sends) a datagram to a listening DatagramReceiver.
void	transmit(DATA[] aDatagram, int aOffset, int aLength)	Write datagrams.
default void	transmitAll(DATA[] aDatagram)	Writes (sends) a datagram block to a listening DatagramReceiver or DatagramsReceiver.

Method Details

transmit

default void transmit(DATA aDatagram)
               throws IOException

Writes (sends) a datagram to a listening DatagramReceiver.

Specified by:

transmit in interface DatagramSource<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.

transmitAll

default void transmitAll(DATA[] aDatagram)
                  throws IOException

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

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.

transmit

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

Write datagrams.

Parameters:

aDatagram - the datagram

aOffset - the offset

aLength - the length

Throws:

IOException - the open exception