ShortDatagramProvider (org.refcodes:refcodes-io 1.3.3 API)

All Known Subinterfaces:

ConnectionShortReceiver<CON>, ConnectionShortTransceiver<CON>, LoopbackShortReceiver, LoopbackShortTransceiver, ShortDatagramReceiver, ShortProvider, ShortReceiver, ShortTransceiver

All Known Implementing Classes:

AbstractShortReceiver, LoopbackShortReceiverImpl, LoopbackShortTransceiverImpl, ShortArrayReceiverImpl, ShortReceiverDecorator

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 ShortDatagramProvider
```
The ShortDatagramProvider is used to receive shorts in a unified way. The readDatagram() method provides the next available short from the counterpart DatagramSender; in case there is none available, then this method halts until one is available.

- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method Description
  
  short readDatagram()
  Reads (receives) the next short passed from a DatagramSender counterpart.

- Method Detail
  - readDatagram
```
short readDatagram()
            throws org.refcodes.component.OpenException,
                   java.lang.InterruptedException
```
    Reads (receives) the next short passed from a DatagramSender counterpart. In case none short is available, then this method blocks until one is available. To prevent blocking, use the ShortDatagramReceiver 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 short to be read and Thread.interrupt() is being called, then the operation is aborted and an InterruptedException is thrown.
    
    Returns:
    
    The next short sent from the ShortDatagramSender 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.