DatagramReceiver (sellcom-java 1.1.0)

java.lang.Object
- org.sellcom.core.net.DatagramReceiver

All Implemented Interfaces:

NetworkEndPoint, NetworkReceiver
```
public class DatagramReceiver
extends Object
implements NetworkReceiver
```
Receiver of UDP datagrams.

Since:

1.0

Nested Class Summary
- Nested classes/interfaces inherited from interface org.sellcom.core.net.NetworkEndPoint
  NetworkEndPoint.State

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DatagramReceiver`	`create(ProtocolFamily protocolFamily)` Creates a datagram receiver.
`Set<InetAddress>`	`getGroups()` Returns the multicast groups associated with this receiver.
`int`	`getHandlerThreadPriority()` Returns the priority of the handler threads in this receiver.
`int`	`getHandlerThreads()` Returns the number of the handler threads in this receiver.
`InetAddress`	`getLocalAddress()` Returns the local address of this end point.
`InetSocketAddress`	`getLocalEndPoint()` Returns the local end point of this receiver.
`int`	`getLocalPort()` Returns the local port of this end point.
`NetworkInterface`	`getNetworkInterface()` Returns the network interface associated with this end point.
`int`	`getReceiveBufferSize()` Returns the receive buffer size of this receiver.
`int`	`getReceiverThreadPriority()` Returns the priority of the receiver threads in this receiver.
`int`	`getReceiverThreads()` Returns the number of the receiver threads in this receiver.
`NetworkEndPoint.State`	`getState()` Returns the state of this end point.
`void`	`start()` Starts this end point.
`void`	`stop()` Stops this end point.
`DatagramReceiver`	`withGroups(Set<InetAddress> groups)` Sets the multicast groups associated with this receiver.
`DatagramReceiver`	`withHandlerThreadPriority(int threadPriority)` Sets the priority of the handler threads in this receiver.
`DatagramReceiver`	`withHandlerThreads(int threads)` Sets the number of the handler threads in this receiver.
`DatagramReceiver`	`withLocalAddressAndPort(InetAddress localAddress, int localPort)` Sets the local address and port of this receiver.
`DatagramReceiver`	`withLocalPort(int localPort)` Sets the local port of this receiver.
`DatagramReceiver`	`withMessageConsumer(Consumer<NetworkMessage> messageConsumer)` Sets the message consumer of this receiver.
`DatagramReceiver`	`withNetworkInterface(NetworkInterface networkInterface)` Sets the network interface associated with this receiver.
`DatagramReceiver`	`withReceiveBufferSize(int bufferSize)` Sets the receive buffer size of this receiver.
`DatagramReceiver`	`withReceiverThreadPriority(int threadPriority)` Sets the priority of the receiver threads in this receiver.
`DatagramReceiver`	`withReceiverThreads(int threads)` Sets the number of the receiver threads in this receiver.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static DatagramReceiver create(ProtocolFamily protocolFamily)
```
    Creates a datagram receiver.
    
    Throws:
    
    IllegalArgumentException - if protocolFamily is null
    
    Since:
    
    1.0
  - getGroups
```
public Set<InetAddress> getGroups()
```
    Returns the multicast groups associated with this receiver.
    
    Since:
    
    1.0
  - getHandlerThreadPriority
```
public int getHandlerThreadPriority()
```
    Returns the priority of the handler threads in this receiver.
    
    Since:
    
    1.0
  - getHandlerThreads
```
public int getHandlerThreads()
```
    Returns the number of the handler threads in this receiver.
    
    Since:
    
    1.0
  - getLocalAddress
```
public InetAddress getLocalAddress()
```
    Description copied from interface: NetworkEndPoint
    
    Returns the local address of this end point.
    
    Specified by:
    
    getLocalAddress in interface NetworkEndPoint
  - getLocalEndPoint
```
public InetSocketAddress getLocalEndPoint()
```
    Description copied from interface: NetworkReceiver
    
    Returns the local end point of this receiver.
    
    Specified by:
    
    getLocalEndPoint in interface NetworkReceiver
  - getLocalPort
```
public int getLocalPort()
```
    Description copied from interface: NetworkEndPoint
    
    Returns the local port of this end point.
    
    Specified by:
    
    getLocalPort in interface NetworkEndPoint
  - getNetworkInterface
```
public NetworkInterface getNetworkInterface()
```
    Description copied from interface: NetworkEndPoint
    
    Returns the network interface associated with this end point.
    
    Specified by:
    
    getNetworkInterface in interface NetworkEndPoint
  - getReceiveBufferSize
```
public int getReceiveBufferSize()
```
    Description copied from interface: NetworkReceiver
    
    Returns the receive buffer size of this receiver.
    
    Specified by:
    
    getReceiveBufferSize in interface NetworkReceiver
  - getReceiverThreadPriority
```
public int getReceiverThreadPriority()
```
    Returns the priority of the receiver threads in this receiver.
    
    Since:
    
    1.0
  - getReceiverThreads
```
public int getReceiverThreads()
```
    Returns the number of the receiver threads in this receiver.
    
    Since:
    
    1.0
  - getState
```
public NetworkEndPoint.State getState()
```
    Description copied from interface: NetworkEndPoint
    
    Returns the state of this end point.
    
    Specified by:
    
    getState in interface NetworkEndPoint
  - start
```
public void start()
           throws IOException
```
    Description copied from interface: NetworkEndPoint
    
    Starts this end point.
    
    Specified by:
    
    start in interface NetworkEndPoint
    
    Throws:
    
    IOException
  - stop
```
public void stop()
```
    Description copied from interface: NetworkEndPoint
    
    Stops this end point.
    
    Specified by:
    
    stop in interface NetworkEndPoint
  - withHandlerThreadPriority
```
public DatagramReceiver withHandlerThreadPriority(int threadPriority)
```
    Sets the priority of the handler threads in this receiver.
    
    Throws:
    
    IllegalArgumentException - if threadPriority is not valid
    
    IllegalStateException - if this receiver has already been started
    
    Since:
    
    1.0
    
    See Also:
    
    Thread.MAX_PRIORITY, Thread.MIN_PRIORITY
  - withGroups
```
public DatagramReceiver withGroups(Set<InetAddress> groups)
```
    Sets the multicast groups associated with this receiver.
    
    Throws:
    
    IllegalArgumentException - if groups are null
    
    IllegalStateException - if this receiver has already been started
    
    Since:
    
    1.0
  - withHandlerThreads
```
public DatagramReceiver withHandlerThreads(int threads)
```
    Sets the number of the handler threads in this receiver.
    
    Throws:
    
    IllegalArgumentException - if threads is not positive
    
    IllegalStateException - if this receiver has already been started
    
    Since:
    
    1.0
  - withLocalAddressAndPort
```
public DatagramReceiver withLocalAddressAndPort(InetAddress localAddress,
                                                int localPort)
```
    Sets the local address and port of this receiver.
    
    Throws:
    
    IllegalArgumentException - if localAddress is null
    
    IllegalArgumentException - if localPort is invalid
    
    IllegalStateException - if this receiver has already been started
    
    Since:
    
    1.0
  - withLocalPort
```
public DatagramReceiver withLocalPort(int localPort)
```
    Sets the local port of this receiver.
    
    Throws:
    
    IllegalArgumentException - if localPort is invalid
    
    IllegalStateException - if this receiver has already been started
    
    Since:
    
    1.0
  - withMessageConsumer
```
public DatagramReceiver withMessageConsumer(Consumer<NetworkMessage> messageConsumer)
```
    Sets the message consumer of this receiver.
    
    Throws:
    
    IllegalArgumentException - if messageConsumer is null
    
    IllegalStateException - if this receiver has already been started
    
    Since:
    
    1.0
  - withNetworkInterface
```
public DatagramReceiver withNetworkInterface(NetworkInterface networkInterface)
```
    Sets the network interface associated with this receiver.
    
    Throws:
    
    IllegalArgumentException - if networkInterface is null
    
    IllegalStateException - if this receiver has already been started
    
    Since:
    
    1.0
  - withReceiveBufferSize
```
public DatagramReceiver withReceiveBufferSize(int bufferSize)
```
    Sets the receive buffer size of this receiver.
    
    Throws:
    
    IllegalArgumentException - if bufferSize is negative
    
    IllegalStateException - if this receiver has already been started
    
    Since:
    
    1.0
  - withReceiverThreadPriority
```
public DatagramReceiver withReceiverThreadPriority(int threadPriority)
```
    Sets the priority of the receiver threads in this receiver.
    
    Throws:
    
    IllegalArgumentException - if threadPriority is not valid
    
    IllegalStateException - if this receiver has already been started
    
    Since:
    
    1.0
    
    See Also:
    
    Thread.MAX_PRIORITY, Thread.MIN_PRIORITY
  - withReceiverThreads
```
public DatagramReceiver withReceiverThreads(int threads)
```
    Sets the number of the receiver threads in this receiver.
    
    Throws:
    
    IllegalArgumentException - if threads is not positive
    
    IllegalStateException - if this receiver has already been started
    
    Since:
    
    1.0

Class DatagramReceiver

Nested Class Summary

Nested classes/interfaces inherited from interface org.sellcom.core.net.NetworkEndPoint

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

getGroups

getHandlerThreadPriority

getHandlerThreads

getLocalAddress

getLocalEndPoint

getLocalPort

getNetworkInterface

getReceiveBufferSize

getReceiverThreadPriority

getReceiverThreads

getState

start

stop

withHandlerThreadPriority

withGroups

withHandlerThreads

withLocalAddressAndPort

withLocalPort

withMessageConsumer

withNetworkInterface

withReceiveBufferSize

withReceiverThreadPriority

withReceiverThreads