Package org.refcodes.io

Interface Receivable

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, org.refcodes.mixin.Releaseable

All Known Subinterfaces:

BidirectionalConnectionByteTransceiver<INPUT,OUTPUT>, BidirectionalConnectionTransceiver<DATA,INPUT,OUTPUT>, BidirectionalStreamConnectionByteTransceiver, BidirectionalStreamConnectionTransceiver<DATA>, BlockReceiver<DATA>, BlockTransceiver<DATA>, ByteArrayReceiver, ByteBlockReceiver, ByteBlockTransceiver, ByteDatagramReceiver, ByteDatagramTransceiver, ByteReceiver, ByteTransceiver, ConnectionByteReceiver<CON>, ConnectionByteTransceiver<CON>, ConnectionReceiver<DATA,CON>, ConnectionShortReceiver<CON>, ConnectionShortTransceiver<CON>, ConnectionTransceiver<DATA,CON>, DatagramReceiver<DATA>, DatagramTransceiver<DATA>, InputStreamConnectionByteReceiver, InputStreamConnectionReceiver<DATA>, LoopbackByteReceiver, LoopbackByteTransceiver, LoopbackReceiver<DATA>, LoopbackShortReceiver, LoopbackShortTransceiver, LoopbackTransceiver<DATA>, Receiver<DATA>, ShortBlockReceiver, ShortDatagramReceiver, ShortReceiver, ShortTransceiver, Transceiver<DATA>

All Known Implementing Classes:

AbstractByteReceiver, AbstractInputStreamByteReceiver, AbstractInputStreamReceiver, AbstractPrefetchInputStreamByteReceiver, AbstractPrefetchInputStreamReceiver, AbstractReceiver, AbstractShortReceiver, BidirectionalStreamByteTransceiverImpl, BidirectionalStreamConnectionByteTransceiverImpl, BidirectionalStreamConnectionTransceiverImpl, BidirectionalStreamTransceiverImpl, ByteArrayReceiverImpl, ByteReceiverDecorator, InputStreamByteReceiverImpl, InputStreamConnectionByteReceiverImpl, InputStreamConnectionReceiverImpl, InputStreamReceiverImpl, LoopbackByteReceiverImpl, LoopbackByteTransceiverImpl, LoopbackReceiverImpl, LoopbackShortReceiverImpl, LoopbackShortTransceiverImpl, LoopbackTransceiverImpl, PrefetchBidirectionalStreamByteTransceiverImpl, PrefetchBidirectionalStreamConnectionByteTransceiverImpl, PrefetchBidirectionalStreamConnectionTransceiverImpl, PrefetchBidirectionalStreamTransceiverImpl, PrefetchInputStreamByteReceiverImpl, PrefetchInputStreamConnectionByteReceiverImpl, PrefetchInputStreamConnectionReceiverImpl, PrefetchInputStreamReceiverImpl, ReceiverDecorator, ShortArrayReceiverImpl, ShortReceiverDecorator

public interface Receivable
extends org.refcodes.component.ConnectableComponent.ConnectableAutomaton, org.refcodes.mixin.Releaseable

The Interface Receivable.

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
boolean	hasDatagram()	Determines whether a datagram is available from a DatagramSender.

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.mixin.Releaseable

releaseAll

Method Detail

hasDatagram

boolean hasDatagram()
             throws org.refcodes.component.OpenException

Determines whether a datagram is available from a DatagramSender. Use the DatagramProvider extenison's DatagramProvider.readDatagram() method for retrieving the available datagram.

Returns:

True in case there is a datagram ready to be retrieved .

Throws:

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