Package org.refcodes.io

Interface ByteDatagramProvider

All Known Subinterfaces:

BidirectionalConnectionByteTransceiver<INPUT,OUTPUT>, BidirectionalStreamConnectionByteTransceiver, ByteArrayProvider, ByteArrayReceiver, ByteDatagramReceiver, ByteDatagramTransceiver, ByteProvider, ByteReceiver, ByteTransceiver, ConnectionByteReceiver<CON>, ConnectionByteTransceiver<CON>, InputStreamConnectionByteReceiver, LoopbackByteReceiver, LoopbackByteTransceiver

All Known Implementing Classes:

AbstractByteProvider, AbstractByteReceiver, AbstractInputStreamByteReceiver, AbstractPrefetchInputStreamByteReceiver, BidirectionalStreamByteTransceiverImpl, BidirectionalStreamConnectionByteTransceiverImpl, ByteArrayProviderImpl, ByteArrayReceiverImpl, ByteReceiverDecorator, InputStreamByteReceiverImpl, InputStreamConnectionByteReceiverImpl, LoopbackByteReceiverImpl, LoopbackByteTransceiverImpl, PrefetchBidirectionalStreamByteTransceiverImpl, PrefetchBidirectionalStreamConnectionByteTransceiverImpl, PrefetchInputStreamByteReceiverImpl, PrefetchInputStreamConnectionByteReceiverImpl

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ByteDatagramProvider

The ByteDatagramProvider is used to receive bytes in a unified way. The readDatagram() method provides the next available byte from the counterpart DatagramSender; in case there is none available, then this method halts until one is available.

Method Summary

Modifier and Type	Method	Description
byte	readDatagram()	Reads (receives) the next byte passed from a DatagramSender counterpart.

Method Detail

readDatagram

byte readDatagram()
           throws org.refcodes.component.OpenException,
                  java.lang.InterruptedException

Reads (receives) the next byte passed from a DatagramSender counterpart. In case none byte is available, then this method blocks until one is available. To prevent blocking, use the ByteDatagramReceiver extension's Receivable.hasDatagram() method to test beforehand whether a byte is available (in a multi-threaded usage scenario, Receivable.hasDatagram() 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 sent from the ByteDatagramSender counterpart.

Throws:

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

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