Package org.refcodes.io

Interface ShortReceiver

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.ConnectionStatusAccessor, org.refcodes.component.OpenedAccessor, Receivable, org.refcodes.mixin.Releaseable, ShortBlockProvider, ShortBlockReceiver, ShortDatagramProvider, ShortDatagramReceiver, ShortProvider

All Known Subinterfaces:

ConnectionShortReceiver<CON>, ConnectionShortTransceiver<CON>, LoopbackShortReceiver, LoopbackShortTransceiver, ShortTransceiver

All Known Implementing Classes:

AbstractShortReceiver, LoopbackShortReceiverImpl, LoopbackShortTransceiverImpl, ShortArrayReceiverImpl, ShortReceiverDecorator

public interface ShortReceiver
extends ShortProvider, ShortDatagramReceiver, ShortBlockReceiver

The Interface ShortReceiver.

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

org.refcodes.component.OpenedAccessor.OpenedMutator, org.refcodes.component.OpenedAccessor.OpenedProperty

Method Summary

Modifier and Type	Method	Description
default short[]	readDatagrams()	Caution: Reads till an OpenException (or an InterruptedException in case of blocking till more data is available) occurs.
default short[]	readDatagrams(int aBlockSize)	Similar to ShortBlockProvider.readDatagrams() though at maximum the amount of data as provided by the block-size is returned.

Methods inherited from interface org.refcodes.component.Closable

close, 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.ConnectionStatusAccessor

getConnectionStatus, isConnectionOpened

Methods inherited from interface org.refcodes.component.OpenedAccessor

isOpened

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

readDatagram

Method Detail

readDatagrams

default short[] readDatagrams()
                       throws org.refcodes.component.OpenException,
                              InterruptedException

Caution: Reads till an OpenException (or an InterruptedException in case of blocking till more data is available) occurs. Reads (receives) the next short block passed from a BlockSender or DatagramSender counterpart. In case none short block is available, then this method blocks until one is available. When a Thread is waiting for a short to be read and Thread.interrupt() is being called, then the operation is aborted and an InterruptedException is thrown.

Specified by:

readDatagrams in interface ShortBlockProvider

Specified by:

readDatagrams in interface ShortProvider

Returns:

The next short block sent from the BlockSender or DatagramReceiver counterpart.

Throws:

org.refcodes.component.OpenException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

InterruptedException - Thrown when a Thread is waiting, sleeping, or otherwise occupied, and the Thread is interrupted, either before or during the activity.

readDatagrams

default short[] readDatagrams(int aBlockSize)
                       throws org.refcodes.component.OpenException,
                              InterruptedException

Similar to ShortBlockProvider.readDatagrams() though at maximum the amount of data as provided by the block-size is returned.

Specified by:

readDatagrams in interface ShortBlockProvider

Specified by:

readDatagrams in interface ShortProvider

Parameters:

aBlockSize - The block-size which is not to exceeded by the returned data. A value of -1 specifies to retrieve all available datagrams (same behavior as method ShortBlockProvider.readDatagrams().

Returns:

The next short block sent from the BlockSender or DatagramReceiver counterpart.

Throws:

org.refcodes.component.OpenException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

InterruptedException - Thrown when a Thread is waiting, sleeping, or otherwise occupied, and the Thread is interrupted, either before or during the activity.