DatagramSenderAndReceiver (sellcom-java 1.1.0)

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

All Implemented Interfaces:

NetworkEndPoint, NetworkReceiver, NetworkSender
```
public class DatagramSenderAndReceiver
extends Object
implements NetworkReceiver, NetworkSender
```
Combined receiver and sender 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 DatagramSenderAndReceiver`	`create(ProtocolFamily protocolFamily)` Creates a datagram sender/receiver.
`Set<InetAddress>`	`getGroups()` Returns the multicast groups associated with this sender/receiver.
`int`	`getHandlerThreadPriority()` Returns the priority of the handler threads in this sender/receiver.
`int`	`getHandlerThreads()` Returns the number of the handler threads in this sender/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 sender/receiver.
`int`	`getReceiverThreads()` Returns the number of the receiver threads in this sender/receiver.
`int`	`getSendBufferSize()` Returns the send buffer size of this sender.
`int`	`getSenderThreadPriority()` Returns the priority of the sender threads in this sender.
`int`	`getSenderThreads()` Returns the number of the sender threads in this sender.
`int`	`getSendRepeatCount()` Returns the send repeat count of this sender.
`long`	`getSendRepeatInterval()` Returns the send repeat interval (in milliseconds) of this sender.
`NetworkEndPoint.State`	`getState()` Returns the state of this end point.
`int`	`getTimeToLive()` Returns the TTL of multicast packets sent by this sender.
`TrafficClass`	`getTrafficClass()` Returns the traffic class of datagrams sent by this sender.
`void`	`sendDelayed(NetworkMessage message, long initialDelay, TimeUnit unit)` Sends the given message after the given initial delay.
`void`	`sendImmediately(NetworkMessage message)` Sends the given message immediately.
`void`	`start()` Starts this end point.
`void`	`stop()` Stops this end point.
`DatagramSenderAndReceiver`	`withGroups(Set<InetAddress> groups)` Sets the multicast groups associated with this sender/receiver.
`DatagramSenderAndReceiver`	`withHandlerThreadPriority(int threadPriority)` Sets the priority of the handler threads in this sender/receiver.
`DatagramSenderAndReceiver`	`withHandlerThreads(int threads)` Sets the number of the handler threads in this sender/receiver.
`DatagramSenderAndReceiver`	`withLocalAddressAndPort(InetAddress localAddress, int localPort)` Sets the local address and port of this sender/receiver.
`DatagramSenderAndReceiver`	`withLocalPort(int localPort)` Sets the local port of this sender/receiver.
`DatagramSenderAndReceiver`	`withMessageConsumer(Consumer<NetworkMessage> messageConsumer)` Sets the message consumer of this sender/receiver.
`DatagramSenderAndReceiver`	`withMulticast(NetworkInterface networkInterface)` Enables multicast on this sender/receiver over the given network interface.
`DatagramSenderAndReceiver`	`withNetworkInterface(NetworkInterface networkInterface)` Sets the network interface associated with this sender/receiver.
`DatagramSenderAndReceiver`	`withReceiveBufferSize(int bufferSize)` Sets the receive buffer size of this sender/receiver.
`DatagramSenderAndReceiver`	`withReceiverThreadPriority(int threadPriority)` Sets the priority of the receiver threads in this receiver.
`DatagramSenderAndReceiver`	`withReceiverThreads(int threads)` Sets the number of the receiver threads in this receiver.
`DatagramSenderAndReceiver`	`withSendBufferSize(int bufferSize)` Sets the send buffer size of this sender/receiver.
`DatagramSenderAndReceiver`	`withSenderThreadPriority(int threadPriority)` Sets the priority of the sender threads in this sender/receiver.
`DatagramSenderAndReceiver`	`withSenderThreads(int threads)` Sets the number of the sender threads in this sender/receiver.
`DatagramSenderAndReceiver`	`withSendRepeatCount(int repeatCount)` Sets the send repeat count of this sender/receiver.
`DatagramSenderAndReceiver`	`withSendRepeatInterval(int repeatInterval)` Sets the send repeat interval (in milliseconds) of this sender/receiver.
`DatagramSenderAndReceiver`	`withTimeToLive(int timeToLive)` Sets the TTL of multicast packets sent by this sender/receiver.
`DatagramSenderAndReceiver`	`withTrafficClass(TrafficClass trafficClass)` Sets the traffic class of datagrams sent by this sender/receiver.

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

- Method Detail
  - create
```
public static DatagramSenderAndReceiver create(ProtocolFamily protocolFamily)
```
    Creates a datagram sender/receiver.
    
    Throws:
    
    IllegalArgumentException - if protocolFamily is null
    
    Since:
    
    1.0
  - getGroups
```
public Set<InetAddress> getGroups()
```
    Returns the multicast groups associated with this sender/receiver.
    
    Since:
    
    1.0
  - getHandlerThreadPriority
```
public int getHandlerThreadPriority()
```
    Returns the priority of the handler threads in this sender/receiver.
    
    Since:
    
    1.0
  - getHandlerThreads
```
public int getHandlerThreads()
```
    Returns the number of the handler threads in this sender/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
    
    Specified by:
    
    getLocalEndPoint in interface NetworkSender
  - 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 sender/receiver.
    
    Since:
    
    1.0
  - getReceiverThreads
```
public int getReceiverThreads()
```
    Returns the number of the receiver threads in this sender/receiver.
    
    Since:
    
    1.0
  - getSendBufferSize
```
public int getSendBufferSize()
```
    Description copied from interface: NetworkSender
    
    Returns the send buffer size of this sender.
    
    Specified by:
    
    getSendBufferSize in interface NetworkSender
  - getSendRepeatCount
```
public int getSendRepeatCount()
```
    Returns the send repeat count of this sender.
    
    Since:
    
    1.0
  - getSendRepeatInterval
```
public long getSendRepeatInterval()
```
    Returns the send repeat interval (in milliseconds) of this sender.
    
    Since:
    
    1.0
  - getSenderThreadPriority
```
public int getSenderThreadPriority()
```
    Returns the priority of the sender threads in this sender.
    
    Since:
    
    1.0
  - getSenderThreads
```
public int getSenderThreads()
```
    Returns the number of the sender threads in this sender.
    
    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
  - getTimeToLive
```
public int getTimeToLive()
```
    Returns the TTL of multicast packets sent by this sender.
    
    Since:
    
    1.0
  - getTrafficClass
```
public TrafficClass getTrafficClass()
```
    Returns the traffic class of datagrams sent by this sender.
    
    Since:
    
    1.0
  - sendDelayed
```
public void sendDelayed(NetworkMessage message,
                        long initialDelay,
                        TimeUnit unit)
```
    Description copied from interface: NetworkSender
    
    Sends the given message after the given initial delay.
    
    Specified by:
    
    sendDelayed in interface NetworkSender
  - sendImmediately
```
public void sendImmediately(NetworkMessage message)
```
    Description copied from interface: NetworkSender
    
    Sends the given message immediately.
    
    Specified by:
    
    sendImmediately in interface NetworkSender
  - 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 DatagramSenderAndReceiver withHandlerThreadPriority(int threadPriority)
```
    Sets the priority of the handler threads in this sender/receiver.
    
    Throws:
    
    IllegalArgumentException - if threadPriority is not valid
    
    IllegalStateException - if this sender/receiver has already been started
    
    Since:
    
    1.0
    
    See Also:
    
    Thread.MAX_PRIORITY, Thread.MIN_PRIORITY
  - withGroups
```
public DatagramSenderAndReceiver withGroups(Set<InetAddress> groups)
```
    Sets the multicast groups associated with this sender/receiver.
    
    Throws:
    
    IllegalArgumentException - if groups are null
    
    IllegalStateException - if this sender/receiver has already been started
    
    Since:
    
    1.0
  - withHandlerThreads
```
public DatagramSenderAndReceiver withHandlerThreads(int threads)
```
    Sets the number of the handler threads in this sender/receiver.
    
    Throws:
    
    IllegalArgumentException - if threads is not positive
    
    IllegalStateException - if this sender/receiver has already been started
    
    Since:
    
    1.0
  - withLocalAddressAndPort
```
public DatagramSenderAndReceiver withLocalAddressAndPort(InetAddress localAddress,
                                                         int localPort)
```
    Sets the local address and port of this sender/receiver.
    
    Throws:
    
    IllegalArgumentException - if localAddress is null
    
    IllegalArgumentException - if localPort is invalid
    
    IllegalStateException - if this sender/receiver has already been started
    
    Since:
    
    1.0
  - withLocalPort
```
public DatagramSenderAndReceiver withLocalPort(int localPort)
```
    Sets the local port of this sender/receiver.
    
    Throws:
    
    IllegalArgumentException - if localPort is invalid
    
    IllegalStateException - if this sender/receiver has already been started
    
    Since:
    
    1.0
  - withMessageConsumer
```
public DatagramSenderAndReceiver withMessageConsumer(Consumer<NetworkMessage> messageConsumer)
```
    Sets the message consumer of this sender/receiver.
    
    Throws:
    
    IllegalArgumentException - if messageConsumer is null
    
    IllegalStateException - if this sender/receiver has already been started
    
    Since:
    
    1.0
  - withMulticast
```
public DatagramSenderAndReceiver withMulticast(NetworkInterface networkInterface)
```
    Enables multicast on this sender/receiver over the given network interface.
    
    Throws:
    
    IllegalArgumentException - if networkInterface is null
    
    IllegalStateException - if this sender/receiver has already been started
    
    Since:
    
    1.0
  - withNetworkInterface
```
public DatagramSenderAndReceiver withNetworkInterface(NetworkInterface networkInterface)
```
    Sets the network interface associated with this sender/receiver.
    
    Throws:
    
    IllegalArgumentException - if networkInterface is null
    
    IllegalStateException - if this sender/receiver has already been started
    
    Since:
    
    1.0
  - withReceiveBufferSize
```
public DatagramSenderAndReceiver withReceiveBufferSize(int bufferSize)
```
    Sets the receive buffer size of this sender/receiver.
    
    Throws:
    
    IllegalArgumentException - if bufferSize is negative
    
    IllegalStateException - if this sender/receiver has already been started
    
    Since:
    
    1.0
  - withReceiverThreadPriority
```
public DatagramSenderAndReceiver 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 DatagramSenderAndReceiver 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
  - withSendBufferSize
```
public DatagramSenderAndReceiver withSendBufferSize(int bufferSize)
```
    Sets the send buffer size of this sender/receiver.
    
    Throws:
    
    IllegalArgumentException - if bufferSize is negative
    
    IllegalStateException - if this sender/receiver has already been started
    
    Since:
    
    1.0
  - withSendRepeatCount
```
public DatagramSenderAndReceiver withSendRepeatCount(int repeatCount)
```
    Sets the send repeat count of this sender/receiver.
    
    Throws:
    
    IllegalArgumentException - if repeatCount is negative
    
    IllegalStateException - if this sender/receiver has already been started
    
    Since:
    
    1.0
  - withSendRepeatInterval
```
public DatagramSenderAndReceiver withSendRepeatInterval(int repeatInterval)
```
    Sets the send repeat interval (in milliseconds) of this sender/receiver.
    
    Throws:
    
    IllegalArgumentException - if repeatInterval is negative
    
    IllegalStateException - if this sender/receiver has already been started
    
    Since:
    
    1.0
  - withSenderThreadPriority
```
public DatagramSenderAndReceiver withSenderThreadPriority(int threadPriority)
```
    Sets the priority of the sender threads in this sender/receiver.
    
    Throws:
    
    IllegalArgumentException - if threadPriority is not valid
    
    IllegalStateException - if this sender/receiver has already been started
    
    Since:
    
    1.0
    
    See Also:
    
    Thread.MAX_PRIORITY, Thread.MIN_PRIORITY
  - withSenderThreads
```
public DatagramSenderAndReceiver withSenderThreads(int threads)
```
    Sets the number of the sender threads in this sender/receiver.
    
    Throws:
    
    IllegalArgumentException - if threads is not positive
    
    IllegalStateException - if this sender/receiver has already been started
    
    Since:
    
    1.0
  - withTimeToLive
```
public DatagramSenderAndReceiver withTimeToLive(int timeToLive)
```
    Sets the TTL of multicast packets sent by this sender/receiver.
    
    Throws:
    
    IllegalArgumentException - if timeToLive is not positive
    
    IllegalStateException - if this sender/receiver has already been started
    
    Since:
    
    1.0
  - withTrafficClass
```
public DatagramSenderAndReceiver withTrafficClass(TrafficClass trafficClass)
```
    Sets the traffic class of datagrams sent by this sender/receiver.
    
    Throws:
    
    IllegalArgumentException - if trafficClass is null
    
    IllegalStateException - if this sender/receiver has already been started
    
    Since:
    
    1.0

Class DatagramSenderAndReceiver

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

getSendBufferSize

getSendRepeatCount

getSendRepeatInterval

getSenderThreadPriority

getSenderThreads

getState

getTimeToLive

getTrafficClass

sendDelayed

sendImmediately

start

stop

withHandlerThreadPriority

withGroups

withHandlerThreads

withLocalAddressAndPort

withLocalPort

withMessageConsumer

withMulticast

withNetworkInterface

withReceiveBufferSize

withReceiverThreadPriority

withReceiverThreads

withSendBufferSize

withSendRepeatCount

withSendRepeatInterval

withSenderThreadPriority

withSenderThreads

withTimeToLive

withTrafficClass