DatagramSender (sellcom-java 1.1.0)

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

All Implemented Interfaces:

NetworkEndPoint, NetworkSender
```
public class DatagramSender
extends Object
implements NetworkSender
```
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 DatagramSender`	`create(ProtocolFamily protocolFamily)` Creates a datagram sender.
`InetAddress`	`getLocalAddress()` Returns the local address of this end point.
`InetSocketAddress`	`getLocalEndPoint()` Returns the local end point of this sender.
`int`	`getLocalPort()` Returns the local port of this end point.
`NetworkInterface`	`getNetworkInterface()` Returns the network interface associated with this end point.
`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.
`DatagramSender`	`withLocalAddressAndPort(InetAddress localAddress, int localPort)` Sets the local address and port of this sender.
`DatagramSender`	`withLocalPort(int localPort)` Sets the local port of this sender.
`DatagramSender`	`withMulticast(NetworkInterface networkInterface)` Enables multicast on this sender over the given network interface.
`DatagramSender`	`withSendBufferSize(int bufferSize)` Sets the send buffer size of this sender.
`DatagramSender`	`withSenderThreadPriority(int threadPriority)` Sets the priority of the sender threads in this sender.
`DatagramSender`	`withSenderThreads(int threads)` Sets the number of the sender threads in this sender.
`DatagramSender`	`withSendRepeatCount(int repeatCount)` Sets the send repeat count of this sender.
`DatagramSender`	`withSendRepeatInterval(int repeatInterval)` Sets the send repeat interval (in milliseconds) of this sender.
`DatagramSender`	`withTimeToLive(int timeToLive)` Sets the TTL of multicast packets sent by this sender.
`DatagramSender`	`withTrafficClass(TrafficClass trafficClass)` Sets the traffic class of datagrams sent by this sender.

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

- Method Detail
  - create
```
public static DatagramSender create(ProtocolFamily protocolFamily)
```
    Creates a datagram sender.
    
    Throws:
    
    IllegalArgumentException - if protocolFamily is null
    
    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: NetworkSender
    
    Returns the local end point of this sender.
    
    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
  - 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
  - withLocalAddressAndPort
```
public DatagramSender withLocalAddressAndPort(InetAddress localAddress,
                                              int localPort)
```
    Sets the local address and port of this sender.
    
    Throws:
    
    IllegalArgumentException - if localAddress is null
    
    IllegalArgumentException - if localPort is invalid
    
    IllegalStateException - if this sender has already been started
    
    Since:
    
    1.0
  - withLocalPort
```
public DatagramSender withLocalPort(int localPort)
```
    Sets the local port of this sender.
    
    Throws:
    
    IllegalArgumentException - if localPort is invalid
    
    IllegalStateException - if this sender has already been started
    
    Since:
    
    1.0
  - withMulticast
```
public DatagramSender withMulticast(NetworkInterface networkInterface)
```
    Enables multicast on this sender over the given network interface.
    
    Throws:
    
    IllegalArgumentException - if networkInterface is null
    
    IllegalStateException - if this sender has already been started
    
    Since:
    
    1.0
  - withSendBufferSize
```
public DatagramSender withSendBufferSize(int bufferSize)
```
    Sets the send buffer size of this sender.
    
    Throws:
    
    IllegalArgumentException - if bufferSize is negative
    
    IllegalStateException - if this sender has already been started
    
    Since:
    
    1.0
  - withSendRepeatCount
```
public DatagramSender withSendRepeatCount(int repeatCount)
```
    Sets the send repeat count of this sender.
    
    Throws:
    
    IllegalArgumentException - if repeatCount is negative
    
    IllegalStateException - if this sender has already been started
    
    Since:
    
    1.0
  - withSendRepeatInterval
```
public DatagramSender withSendRepeatInterval(int repeatInterval)
```
    Sets the send repeat interval (in milliseconds) of this sender.
    
    Throws:
    
    IllegalArgumentException - if repeatInterval is negative
    
    IllegalStateException - if this sender has already been started
    
    Since:
    
    1.0
  - withSenderThreadPriority
```
public DatagramSender withSenderThreadPriority(int threadPriority)
```
    Sets the priority of the sender threads in this sender.
    
    Throws:
    
    IllegalArgumentException - if threadPriority is not valid
    
    IllegalStateException - if this sender has already been started
    
    Since:
    
    1.0
    
    See Also:
    
    Thread.MAX_PRIORITY, Thread.MIN_PRIORITY
  - withSenderThreads
```
public DatagramSender withSenderThreads(int threads)
```
    Sets the number of the sender threads in this sender.
    
    Throws:
    
    IllegalArgumentException - if threads is not positive
    
    IllegalStateException - if this sender has already been started
    
    Since:
    
    1.0
  - withTimeToLive
```
public DatagramSender withTimeToLive(int timeToLive)
```
    Sets the TTL of multicast packets sent by this sender.
    
    Throws:
    
    IllegalArgumentException - if timeToLive is not positive
    
    IllegalStateException - if this sender has already been started
    
    Since:
    
    1.0
  - withTrafficClass
```
public DatagramSender withTrafficClass(TrafficClass trafficClass)
```
    Sets the traffic class of datagrams sent by this sender.
    
    Throws:
    
    IllegalArgumentException - if trafficClass is null
    
    IllegalStateException - if this sender has already been started
    
    Since:
    
    1.0

Class DatagramSender

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

getLocalAddress

getLocalEndPoint

getLocalPort

getNetworkInterface

getSendBufferSize

getSendRepeatCount

getSendRepeatInterval

getSenderThreadPriority

getSenderThreads

getState

getTimeToLive

getTrafficClass

sendDelayed

sendImmediately

start

stop

withLocalAddressAndPort

withLocalPort

withMulticast

withSendBufferSize

withSendRepeatCount

withSendRepeatInterval

withSenderThreadPriority

withSenderThreads

withTimeToLive

withTrafficClass