Package org.refcodes.io

Interface BlockReceiver<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:

BlockProvider<DATA>, 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

All Known Subinterfaces:

BidirectionalConnectionTransceiver<DATA,INPUT,OUTPUT>, BidirectionalStreamConnectionTransceiver<DATA>, BlockTransceiver<DATA>, ConnectionReceiver<DATA,CON>, ConnectionTransceiver<DATA,CON>, InputStreamConnectionReceiver<DATA>, LoopbackReceiver<DATA>, LoopbackTransceiver<DATA>, Receiver<DATA>, Transceiver<DATA>

All Known Implementing Classes:

AbstractInputStreamReceiver, AbstractPrefetchInputStreamReceiver, AbstractReceiver, BidirectionalStreamConnectionTransceiverImpl, BidirectionalStreamTransceiverImpl, InputStreamConnectionReceiverImpl, InputStreamReceiverImpl, LoopbackReceiverImpl, LoopbackTransceiverImpl, PrefetchBidirectionalStreamConnectionTransceiverImpl, PrefetchBidirectionalStreamTransceiverImpl, PrefetchInputStreamConnectionReceiverImpl, PrefetchInputStreamReceiverImpl, ReceiverDecorator

public interface BlockReceiver<DATA extends Serializable>
extends BlockProvider<DATA>, Receivable

The BlockReceiver is used to receive datagram blocks (arrays) in a unified way. The BlockProvider.readDatagrams() method provides the next available datagram block from the counterpart BlockSender or DatagramSender; in case there is none available, then this method halts until one is available or the BlockReceiver is being shut down or the underlying connection is closed. The Receivable.hasDatagram() method returns true in case a next datagram(s) can be fetched via the BlockProvider.readDatagrams() method from the BlockReceiver 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.BlockProvider

readDatagrams, readDatagrams

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