Module org.refcodes.io

Package org.refcodes.io

Interface DatagramReceiver<DATA extends Serializable>

Type Parameters:

DATA - The type of the datagram to be operated with. In case you wish to use array types, you might better use the DatagramsReceiver type.

All Superinterfaces:

Availability, 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, DatagramDestination<DATA>, org.refcodes.component.OpenedAccessor, Receivable

All Known Subinterfaces:

BidirectionalConnectionTransceiver<DATA,INPUT,OUTPUT>, BidirectionalStreamConnectionTransceiver<DATA>, ConnectionDatagramsReceiver<DATA,CON>, ConnectionDatagramsTransceiver<DATA,CON>, DatagramsReceiver<DATA>, DatagramsTransceiver<DATA>, DatagramTransceiver<DATA>, InputStreamConnectionReceiver<DATA>

All Known Implementing Classes:

AbstractDatagramsReceiver, AbstractInputStreamReceiver, AbstractPrefetchInputStreamReceiver, BidirectionalStreamConnectionTransceiverImpl, BidirectionalStreamTransceiver, DatagramsReceiverDecorator, InputStreamConnectionReceiverImpl, InputStreamReceiver, LoopbackDatagramsReceiver, LoopbackDatagramsTransceiver, PrefetchBidirectionalStreamConnectionTransceiver, PrefetchBidirectionalStreamTransceiver, PrefetchInputStreamConnectionReceiver, PrefetchInputStreamReceiver

public interface DatagramReceiver<DATA extends Serializable>
extends DatagramDestination<DATA>, Receivable

The DatagramReceiver is used to receive datagrams in a unified way. The DatagramDestination.receive() method provides the next available datagram from the counterpart DatagramTransmitter; in case there is none available, then this method halts until one is available or the DatagramReceiver is being shut down or the underlying connection is closed. The Availability.available() method returns true in case a next datagram can be fetched via the DatagramDestination.receive() method from the DatagramReceiver counterpart.

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

Methods inherited from interface org.refcodes.io.Availability

available, hasAvailable

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, isOpened

Methods inherited from interface org.refcodes.io.DatagramDestination

receive