org.refcodes.io

Interface ByteBlockReceiver

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

All Known Subinterfaces:

BidirectionalConnectionByteTransceiver<INPUT,OUTPUT>, BidirectionalStreamConnectionByteTransceiver, ByteBlockTransceiver, ByteReceiver, ByteTransceiver, ConnectionByteReceiver<CON>, ConnectionByteTransceiver<CON>, InputStreamConnectionByteReceiver

All Known Implementing Classes:

AbstractByteReceiver, AbstractInputStreamByteReceiver, AbstractPrefetchInputStreamByteReceiver, BidirectionalStreamByteTransceiverImpl, BidirectionalStreamConnectionByteTransceiverImpl, InputStreamByteReceiverImpl, InputStreamConnectionByteReceiverImpl, PrefetchBidirectionalStreamByteTransceiverImpl, PrefetchBidirectionalStreamConnectionByteTransceiverImpl, PrefetchInputStreamByteReceiverImpl, PrefetchInputStreamConnectionByteReceiverImpl

public interface ByteBlockReceiver
extends Receivable

The ByteBlockReceiver is used to receive byte blocks (arrays) in a unified way. The readDatagrams() method provides the next available byte block from the counterpart BlockSender or DatagramSender; in case there is none available, then this method halts until one is available or the ByteBlockReceiver is being shut down or the underlying connection is closed. The Receivable.hasDatagram() method returns true in case a next byte(s) can be fetched via the readDatagrams() method from the ByteBlockReceiver counterpart.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.component.ConnectableComponent

org.refcodes.component.ConnectableComponent.ConnectableAutomaton

Nested classes/interfaces inherited from interface org.refcodes.component.OpenedAccessor

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

Nested classes/interfaces inherited from interface org.refcodes.component.Closable

org.refcodes.component.Closable.CloseAutomaton

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

org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusMutator, org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusProperty

Method Summary

Modifier and Type	Method and Description
byte[]	readDatagrams() Reads (receives) the next byte block passed from a BlockSender or DatagramSender counterpart.

Methods inherited from interface org.refcodes.io.Receivable

hasDatagram

Methods inherited from interface org.refcodes.component.OpenedAccessor

isOpened

Methods inherited from interface org.refcodes.component.Closable.CloseAutomaton

isClosable

Methods inherited from interface org.refcodes.component.Closable

close

Methods inherited from interface org.refcodes.component.ClosedAccessor

isClosed

Methods inherited from interface org.refcodes.component.ConnectionStatusAccessor

getConnectionStatus

Methods inherited from interface org.refcodes.mixin.Releaseable

releaseAll

Method Detail

readDatagrams

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

Reads (receives) the next byte block passed from a BlockSender or DatagramSender counterpart. In case none byte block is available, then this method blocks until one is available. To prevent blocking, use the Receivable.hasDatagram() method to test beforehand whether a byte is available (in a multi threaded usage scenario, #hasBlock() is not a reliable indicator whether this method will block or not). When a Thread is waiting for a byte to be read and Thread.interrupt() is being called, then the operation is aborted and an InterruptedException is thrown.

Returns:

The next byte 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.