# DatagramSocket

public class **DatagramSocket** extends [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)  
implements [Closeable](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Closeable.html)

|---|---|---|
| Known Direct Subclasses [MulticastSocket](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/MulticastSocket.html) |---|---| | [MulticastSocket](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/MulticastSocket.html) | The multicast datagram socket class is useful for sending and receiving IP multicast packets. | |||

This class represents a socket for sending and receiving datagram packets.

A datagram socket is the sending or receiving point for a packet
delivery service. Each packet sent or received on a datagram socket
is individually addressed and routed. Multiple packets sent from
one machine to another may be routed differently, and may arrive in
any order.

Where possible, a newly constructed `DatagramSocket` has the
`https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketOptions.html#SO_BROADCAST` socket option enabled so as
to allow the transmission of broadcast datagrams. In order to receive
broadcast packets a DatagramSocket should be bound to the wildcard address.
In some implementations, broadcast packets may also be received when
a DatagramSocket is bound to a more specific address.


Example:
`DatagramSocket s = new DatagramSocket(null);
s.bind(new InetSocketAddress(8888));
`
Which is equivalent to:
`DatagramSocket s = new DatagramSocket(8888);
`
Both cases will create a DatagramSocket able to receive broadcasts on
UDP port 8888.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramPacket.html`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/DatagramChannel.html`

### Public Constructor Summary

|---|---|
|   | [DatagramSocket](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#DatagramSocket())() Constructs a datagram socket and binds it to any available port on the local host machine. |
|   | [DatagramSocket](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#DatagramSocket(java.net.SocketAddress))([SocketAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketAddress.html) bindaddr) Creates a datagram socket, bound to the specified local socket address. |
|   | [DatagramSocket](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#DatagramSocket(int))(int port) Constructs a datagram socket and binds it to the specified port on the local host machine. |
|   | [DatagramSocket](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#DatagramSocket(int,%20java.net.InetAddress))(int port, [InetAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/InetAddress.html) laddr) Creates a datagram socket, bound to the specified local address. |

### Protected Constructor Summary

|---|---|
|   | [DatagramSocket](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#DatagramSocket(java.net.DatagramSocketImpl))([DatagramSocketImpl](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocketImpl.html) impl) Creates an unbound datagram socket with the specified DatagramSocketImpl. |

### Public Method Summary

|---|---|
| synchronized void | [bind](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#bind(java.net.SocketAddress))([SocketAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketAddress.html) addr) Binds this DatagramSocket to a specific address and port. |
| void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#close())() Closes this datagram socket. |
| void | [connect](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#connect(java.net.InetAddress,%20int))([InetAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/InetAddress.html) address, int port) Connects the socket to a remote address for this socket. |
| void | [connect](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#connect(java.net.SocketAddress))([SocketAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketAddress.html) addr) Connects this socket to a remote socket address (IP address + port number). |
| void | [disconnect](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#disconnect())() Disconnects the socket. |
| synchronized boolean | [getBroadcast](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getBroadcast())() Tests if SO_BROADCAST is enabled. |
| [DatagramChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/DatagramChannel.html) | [getChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getChannel())() Returns the unique `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/DatagramChannel.html` object associated with this datagram socket, if any. |
| [InetAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/InetAddress.html) | [getInetAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getInetAddress())() Returns the address to which this socket is connected. |
| [InetAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/InetAddress.html) | [getLocalAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getLocalAddress())() Gets the local address to which the socket is bound. |
| int | [getLocalPort](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getLocalPort())() Returns the port number on the local host to which this socket is bound. |
| [SocketAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketAddress.html) | [getLocalSocketAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getLocalSocketAddress())() Returns the address of the endpoint this socket is bound to. |
| int | [getPort](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getPort())() Returns the port number to which this socket is connected. |
| synchronized int | [getReceiveBufferSize](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getReceiveBufferSize())() Get value of the SO_RCVBUF option for this `DatagramSocket`, that is the buffer size used by the platform for input on this `DatagramSocket`. |
| [SocketAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketAddress.html) | [getRemoteSocketAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getRemoteSocketAddress())() Returns the address of the endpoint this socket is connected to, or `null` if it is unconnected. |
| synchronized boolean | [getReuseAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getReuseAddress())() Tests if SO_REUSEADDR is enabled. |
| synchronized int | [getSendBufferSize](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getSendBufferSize())() Get value of the SO_SNDBUF option for this `DatagramSocket`, that is the buffer size used by the platform for output on this `DatagramSocket`. |
| synchronized int | [getSoTimeout](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getSoTimeout())() Retrieve setting for SO_TIMEOUT. |
| synchronized int | [getTrafficClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getTrafficClass())() Gets traffic class or type-of-service in the IP datagram header for packets sent from this DatagramSocket. |
| boolean | [isBound](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#isBound())() Returns the binding state of the socket. |
| boolean | [isClosed](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#isClosed())() Returns whether the socket is closed or not. |
| boolean | [isConnected](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#isConnected())() Returns the connection state of the socket. |
| synchronized void | [receive](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#receive(java.net.DatagramPacket))([DatagramPacket](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramPacket.html) p) Receives a datagram packet from this socket. |
| void | [send](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#send(java.net.DatagramPacket))([DatagramPacket](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramPacket.html) p) Sends a datagram packet from this socket. |
| synchronized void | [setBroadcast](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#setBroadcast(boolean))(boolean on) Enable/disable SO_BROADCAST. |
| synchronized static void | [setDatagramSocketImplFactory](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#setDatagramSocketImplFactory(java.net.DatagramSocketImplFactory))([DatagramSocketImplFactory](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocketImplFactory.html) fac) Sets the datagram socket implementation factory for the application. |
| synchronized void | [setReceiveBufferSize](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#setReceiveBufferSize(int))(int size) Sets the SO_RCVBUF option to the specified value for this `DatagramSocket`. |
| synchronized void | [setReuseAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#setReuseAddress(boolean))(boolean on) Enable/disable the SO_REUSEADDR socket option. |
| synchronized void | [setSendBufferSize](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#setSendBufferSize(int))(int size) Sets the SO_SNDBUF option to the specified value for this `DatagramSocket`. |
| synchronized void | [setSoTimeout](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#setSoTimeout(int))(int timeout) Enable/disable SO_TIMEOUT with the specified timeout, in milliseconds. |
| synchronized void | [setTrafficClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#setTrafficClass(int))(int tc) Sets traffic class or type-of-service octet in the IP datagram header for datagrams sent from this DatagramSocket. |

### Inherited Method Summary

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

From interface [java.io.Closeable](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Closeable.html)

|---|---|
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Closeable.html#close())() Closes this stream and releases any system resources associated with it. |

From interface [java.lang.AutoCloseable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/AutoCloseable.html)

|---|---|
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/AutoCloseable.html#close())() Closes this resource, relinquishing any underlying resources. |

## Public Constructors

#### public
**DatagramSocket**
()

Constructs a datagram socket and binds it to any available port
on the local host machine. The socket will be bound to the
`https://developers.google.com/j2objc/javadoc/jre/reference/java/net/InetAddress.html#isAnyLocalAddress()` address,
an IP address chosen by the kernel.

If there is a security manager,
its `checkListen` method is first called
with 0 as its argument to ensure the operation is allowed.
This could result in a SecurityException.

##### Throws

| [SocketException](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketException.html) | if the socket could not be opened, or the socket could not bind to the specified local port. |
| [SecurityException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityException.html) | if a security manager exists and its `checkListen` method doesn't allow the operation. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityManager.html#checkListen(int)`

#### public
**DatagramSocket**
([SocketAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketAddress.html) bindaddr)

Creates a datagram socket, bound to the specified local
socket address.


If, if the address is `null`, creates an unbound socket.

If there is a security manager,
its `checkListen` method is first called
with the port from the socket address
as its argument to ensure the operation is allowed.
This could result in a SecurityException.

##### Parameters

| bindaddr | local socket address to bind, or `null` for an unbound socket. |
|---|---|

##### Throws

| [SocketException](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketException.html) | if the socket could not be opened, or the socket could not bind to the specified local port. |
| [SecurityException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityException.html) | if a security manager exists and its `checkListen` method doesn't allow the operation. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityManager.html#checkListen(int)`

#### public
**DatagramSocket**
(int port)

Constructs a datagram socket and binds it to the specified port
on the local host machine. The socket will be bound to the
`https://developers.google.com/j2objc/javadoc/jre/reference/java/net/InetAddress.html#isAnyLocalAddress()` address,
an IP address chosen by the kernel.

If there is a security manager,
its `checkListen` method is first called
with the `port` argument
as its argument to ensure the operation is allowed.
This could result in a SecurityException.

##### Parameters

| port | port to use. |
|---|---|

##### Throws

| [SocketException](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketException.html) | if the socket could not be opened, or the socket could not bind to the specified local port. |
| [SecurityException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityException.html) | if a security manager exists and its `checkListen` method doesn't allow the operation. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityManager.html#checkListen(int)`

#### public
**DatagramSocket**
(int port, [InetAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/InetAddress.html) laddr)

Creates a datagram socket, bound to the specified local
address. The local port must be between 0 and 65535 inclusive.
If the IP address is 0.0.0.0, the socket will be bound to the
`https://developers.google.com/j2objc/javadoc/jre/reference/java/net/InetAddress.html#isAnyLocalAddress()` address,
an IP address chosen by the kernel.

If there is a security manager,
its `checkListen` method is first called
with the `port` argument
as its argument to ensure the operation is allowed.
This could result in a SecurityException.

##### Parameters

| port | local port to use |
| laddr | local address to bind |
|---|---|

##### Throws

| [SocketException](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketException.html) | if the socket could not be opened, or the socket could not bind to the specified local port. |
| [SecurityException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityException.html) | if a security manager exists and its `checkListen` method doesn't allow the operation. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityManager.html#checkListen(int)`

## Protected Constructors

#### protected
**DatagramSocket**
([DatagramSocketImpl](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocketImpl.html) impl)

Creates an unbound datagram socket with the specified
DatagramSocketImpl.

##### Parameters

| impl | an instance of a **DatagramSocketImpl** the subclass wishes to use on the DatagramSocket. |
|---|---|

## Public Methods

#### public synchronized void
**bind**
([SocketAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketAddress.html) addr)

Binds this DatagramSocket to a specific address and port.


If the address is `null`, then the system will pick up
an ephemeral port and a valid local address to bind the socket.

<br />

##### Parameters

| addr | The address and port to bind to. |
|---|---|

##### Throws

| [SocketException](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketException.html) | if any error happens during the bind, or if the socket is already bound. |
| [SecurityException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityException.html) | if a security manager exists and its `checkListen` method doesn't allow the operation. |
| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if addr is a SocketAddress subclass not supported by this socket. |
|---|---|

#### public void
**close**
()

Closes this datagram socket.


Any thread currently blocked in `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#receive(java.net.DatagramPacket)` upon this socket
will throw a `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketException.html`.

If this socket has an associated channel then the channel is closed
as well.

#### public void
**connect**
([InetAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/InetAddress.html) address, int port)

Connects the socket to a remote address for this socket. When a
socket is connected to a remote address, packets may only be
sent to or received from that address. By default a datagram
socket is not connected.

If the remote destination to which the socket is connected does not
exist, or is otherwise unreachable, and if an ICMP destination unreachable
packet has been received for that address, then a subsequent call to
send or receive may throw a PortUnreachableException. Note, there is no
guarantee that the exception will be thrown.

If a security manager has been installed then it is invoked to check
access to the remote address. Specifically, if the given `address`
is a `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/InetAddress.html#isMulticastAddress()`,
the security manager's `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityManager.html#checkMulticast(java.net.InetAddress)` method is invoked with the given `address`.
Otherwise, the security manager's `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityManager.html#checkConnect(java.lang.String,%20int)`
and `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityManager.html#checkAccept(java.lang.String,%20int)` methods
are invoked, with the given `address` and `port`, to
verify that datagrams are permitted to be sent and received
respectively.

When a socket is connected, `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#receive(java.net.DatagramPacket)` and
`https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#send(java.net.DatagramPacket)` **will not perform any security checks**
on incoming and outgoing packets, other than matching the packet's
and the socket's address and port. On a send operation, if the
packet's address is set and the packet's address and the socket's
address do not match, an `IllegalArgumentException` will be
thrown. A socket connected to a multicast address may only be used
to send packets.

##### Parameters

| address | the remote address for the socket |
| port | the remote port for the socket. |
|---|---|

##### Throws

| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if the address is null, or the port is out of range. |
| [SecurityException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityException.html) | if a security manager has been installed and it does not permit access to the given remote address |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#disconnect()`

#### public void
**connect**
([SocketAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketAddress.html) addr)

Connects this socket to a remote socket address (IP address + port number).

If given an `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/InetSocketAddress.html`, this method
behaves as if invoking `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#connect(java.net.InetAddress,%20int)`
with the the given socket addresses IP address and port number.

##### Parameters

| addr | The remote address. |
|---|---|

##### Throws

| [SocketException](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketException.html) | if the connect fails |
| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if `addr` is `null`, or `addr` is a SocketAddress subclass not supported by this socket |
| [SecurityException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityException.html) | if a security manager has been installed and it does not permit access to the given remote address |
|---|---|

#### public void
**disconnect**
()

Disconnects the socket. If the socket is closed or not connected,
then this method has no effect.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#connect(java.net.InetAddress,%20int)`

#### public synchronized boolean
**getBroadcast**
()

Tests if SO_BROADCAST is enabled.

##### Returns

- a `boolean` indicating whether or not SO_BROADCAST is enabled.

##### Throws

| [SocketException](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketException.html) | if there is an error in the underlying protocol, such as an UDP error. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#setBroadcast(boolean)`

#### public [DatagramChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/DatagramChannel.html)
**getChannel**
()

Returns the unique `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/DatagramChannel.html` object
associated with this datagram socket, if any.

A datagram socket will have a channel if, and only if, the channel
itself was created via the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/DatagramChannel.html#open()` method.

##### Returns

- the datagram channel associated with this datagram socket, or `null` if this socket was not created for a channel

#### public [InetAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/InetAddress.html)
**getInetAddress**
()

Returns the address to which this socket is connected. Returns
`null` if the socket is not connected.


If the socket was connected prior to being `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#close()`,
then this method will continue to return the connected address
after the socket is closed.

##### Returns

- the address to which this socket is connected.

#### public [InetAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/InetAddress.html)
**getLocalAddress**
()

Gets the local address to which the socket is bound.

If there is a security manager, its
`checkConnect` method is first called
with the host address and `-1`
as its arguments to see if the operation is allowed.

##### Returns

- the local address to which the socket is bound, `null` if the socket is closed, or an `InetAddress` representing `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/InetAddress.html#isAnyLocalAddress()` address if either the socket is not bound, or the security manager `checkConnect` method does not allow the operation

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityManager.html#checkConnect(java.lang.String,%20int)`

#### public int
**getLocalPort**
()

Returns the port number on the local host to which this socket
is bound.

##### Returns

- the port number on the local host to which this socket is bound, `-1` if the socket is closed, or `0` if it is not bound yet.

#### public [SocketAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketAddress.html)
**getLocalSocketAddress**
()

Returns the address of the endpoint this socket is bound to.

##### Returns

- a `SocketAddress` representing the local endpoint of this socket, or `null` if it is closed or not bound yet.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getLocalAddress()`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getLocalPort()`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#bind(java.net.SocketAddress)`

#### public int
**getPort**
()

Returns the port number to which this socket is connected.
Returns `-1` if the socket is not connected.


If the socket was connected prior to being `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#close()`,
then this method will continue to return the connected port number
after the socket is closed.

##### Returns

- the port number to which this socket is connected.

#### public synchronized int
**getReceiveBufferSize**
()

Get value of the SO_RCVBUF option for this `DatagramSocket`, that is the
buffer size used by the platform for input on this `DatagramSocket`.

##### Returns

- the value of the SO_RCVBUF option for this `DatagramSocket`

##### Throws

| [SocketException](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketException.html) | if there is an error in the underlying protocol, such as an UDP error. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#setReceiveBufferSize(int)`

#### public [SocketAddress](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketAddress.html)
**getRemoteSocketAddress**
()

Returns the address of the endpoint this socket is connected to, or
`null` if it is unconnected.


If the socket was connected prior to being `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#close()`,
then this method will continue to return the connected address
after the socket is closed.

##### Returns

- a `SocketAddress` representing the remote endpoint of this socket, or `null` if it is not connected yet.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getInetAddress()`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getPort()`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#connect(java.net.SocketAddress)`

#### public synchronized boolean
**getReuseAddress**
()

Tests if SO_REUSEADDR is enabled.

##### Returns

- a `boolean` indicating whether or not SO_REUSEADDR is enabled.

##### Throws

| [SocketException](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketException.html) | if there is an error in the underlying protocol, such as an UDP error. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#setReuseAddress(boolean)`

#### public synchronized int
**getSendBufferSize**
()

Get value of the SO_SNDBUF option for this `DatagramSocket`, that is the
buffer size used by the platform for output on this `DatagramSocket`.

##### Returns

- the value of the SO_SNDBUF option for this `DatagramSocket`

##### Throws

| [SocketException](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketException.html) | if there is an error in the underlying protocol, such as an UDP error. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#setSendBufferSize(int)`

#### public synchronized int
**getSoTimeout**
()

Retrieve setting for SO_TIMEOUT. 0 returns implies that the
option is disabled (i.e., timeout of infinity).

##### Returns

- the setting for SO_TIMEOUT

##### Throws

| [SocketException](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketException.html) | if there is an error in the underlying protocol, such as an UDP error. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#setSoTimeout(int)`

#### public synchronized int
**getTrafficClass**
()

Gets traffic class or type-of-service in the IP datagram
header for packets sent from this DatagramSocket.


As the underlying network implementation may ignore the
traffic class or type-of-service set using `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#setTrafficClass(int)`
this method may return a different value than was previously
set using the `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#setTrafficClass(int)` method on this
DatagramSocket.

##### Returns

- the traffic class or type-of-service already set

##### Throws

| [SocketException](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketException.html) | if there is an error obtaining the traffic class or type-of-service value. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#setTrafficClass(int)`

#### public boolean
**isBound**
()

Returns the binding state of the socket.


If the socket was bound prior to being `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#close()`,
then this method will continue to return `true`
after the socket is closed.

##### Returns

- true if the socket successfully bound to an address

#### public boolean
**isClosed**
()

Returns whether the socket is closed or not.

##### Returns

- true if the socket has been closed

#### public boolean
**isConnected**
()

Returns the connection state of the socket.


If the socket was connected prior to being `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#close()`,
then this method will continue to return `true`
after the socket is closed.

##### Returns

- true if the socket successfully connected to a server

#### public synchronized void
**receive**
([DatagramPacket](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramPacket.html) p)

Receives a datagram packet from this socket. When this method
returns, the `DatagramPacket`'s buffer is filled with
the data received. The datagram packet also contains the sender's
IP address, and the port number on the sender's machine.


This method blocks until a datagram is received. The
`length` field of the datagram packet object contains
the length of the received message. If the message is longer than
the packet's length, the message is truncated.


If there is a security manager, a packet cannot be received if the
security manager's `checkAccept` method
does not allow it.

##### Parameters

| p | the `DatagramPacket` into which to place the incoming data. |
|---|---|

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | if an I/O error occurs. |
| [SocketTimeoutException](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketTimeoutException.html) | if setSoTimeout was previously called and the timeout has expired. |
| [PortUnreachableException](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/PortUnreachableException.html) | may be thrown if the socket is connected to a currently unreachable destination. Note, there is no guarantee that the exception will be thrown. |
| [IllegalBlockingModeException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/IllegalBlockingModeException.html) | if this socket has an associated channel, and the channel is in non-blocking mode. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramPacket.html`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html`

#### public void
**send**
([DatagramPacket](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramPacket.html) p)

Sends a datagram packet from this socket. The
`DatagramPacket` includes information indicating the
data to be sent, its length, the IP address of the remote host,
and the port number on the remote host.

If there is a security manager, and the socket is not currently
connected to a remote address, this method first performs some
security checks. First, if `p.getAddress().isMulticastAddress()`
is true, this method calls the
security manager's `checkMulticast` method
with `p.getAddress()` as its argument.
If the evaluation of that expression is false,
this method instead calls the security manager's
`checkConnect` method with arguments
`p.getAddress().getHostAddress()` and
`p.getPort()`. Each call to a security manager method
could result in a SecurityException if the operation is not allowed.

##### Parameters

| p | the `DatagramPacket` to be sent. |
|---|---|

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | if an I/O error occurs. |
| [SecurityException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityException.html) | if a security manager exists and its `checkMulticast` or `checkConnect` method doesn't allow the send. |
| [PortUnreachableException](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/PortUnreachableException.html) | may be thrown if the socket is connected to a currently unreachable destination. Note, there is no guarantee that the exception will be thrown. |
| [IllegalBlockingModeException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/IllegalBlockingModeException.html) | if this socket has an associated channel, and the channel is in non-blocking mode. |
| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if the socket is connected, and connected address and packet address differ. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramPacket.html`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityManager.html#checkMulticast(java.net.InetAddress)`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityManager.html#checkConnect(java.lang.String,%20int)`

#### public synchronized void
**setBroadcast**
(boolean on)

Enable/disable SO_BROADCAST.

Some operating systems may require that the Java virtual machine be
started with implementation specific privileges to enable this option or
send broadcast datagrams.

##### Parameters

| on | whether or not to have broadcast turned on. |
|---|---|

##### Throws

| [SocketException](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketException.html) | if there is an error in the underlying protocol, such as an UDP error. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getBroadcast()`

#### public static synchronized void
**setDatagramSocketImplFactory**
([DatagramSocketImplFactory](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocketImplFactory.html) fac)

Sets the datagram socket implementation factory for the
application. The factory can be specified only once.


When an application creates a new datagram socket, the socket
implementation factory's `createDatagramSocketImpl` method is
called to create the actual datagram socket implementation.


Passing `null` to the method is a no-op unless the factory
was already set.

If there is a security manager, this method first calls
the security manager's `checkSetFactory` method
to ensure the operation is allowed.
This could result in a SecurityException.

##### Parameters

| fac | the desired factory. |
|---|---|

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | if an I/O error occurs when setting the datagram socket factory. |
| [SocketException](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketException.html) | if the factory is already defined. |
| [SecurityException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityException.html) | if a security manager exists and its `checkSetFactory` method doesn't allow the operation. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocketImplFactory.html#createDatagramSocketImpl()`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityManager.html#checkSetFactory()`

#### public synchronized void
**setReceiveBufferSize**
(int size)

Sets the SO_RCVBUF option to the specified value for this
`DatagramSocket`. The SO_RCVBUF option is used by the
the network implementation as a hint to size the underlying
network I/O buffers. The SO_RCVBUF setting may also be used
by the network implementation to determine the maximum size
of the packet that can be received on this socket.


Because SO_RCVBUF is a hint, applications that want to
verify what size the buffers were set to should call
`https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getReceiveBufferSize()`.


Increasing SO_RCVBUF may allow the network implementation
to buffer multiple packets when packets arrive faster than
are being received using `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#receive(java.net.DatagramPacket)`.


Note: It is implementation specific if a packet larger
than SO_RCVBUF can be received.

##### Parameters

| size | the size to which to set the receive buffer size. This value must be greater than 0. |
|---|---|

##### Throws

| [SocketException](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketException.html) | if there is an error in the underlying protocol, such as an UDP error. |
| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if the value is 0 or is negative. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getReceiveBufferSize()`

#### public synchronized void
**setReuseAddress**
(boolean on)

Enable/disable the SO_REUSEADDR socket option.


For UDP sockets it may be necessary to bind more than one
socket to the same socket address. This is typically for the
purpose of receiving multicast packets
(See `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/MulticastSocket.html`). The
`SO_REUSEADDR` socket option allows multiple
sockets to be bound to the same socket address if the
`SO_REUSEADDR` socket option is enabled prior
to binding the socket using `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#bind(java.net.SocketAddress)`.


Note: This functionality is not supported by all existing platforms,
so it is implementation specific whether this option will be ignored
or not. However, if it is not supported then
`https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getReuseAddress()` will always return `false`.


When a `DatagramSocket` is created the initial setting
of `SO_REUSEADDR` is disabled.


The behaviour when `SO_REUSEADDR` is enabled or
disabled after a socket is bound (See `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#isBound()`)
is not defined.

##### Parameters

| on | whether to enable or disable the |
|---|---|

##### Throws

| [SocketException](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketException.html) | if an error occurs enabling or disabling the `SO_RESUEADDR` socket option, or the socket is closed. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getReuseAddress()`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#bind(java.net.SocketAddress)`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#isBound()`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#isClosed()`

#### public synchronized void
**setSendBufferSize**
(int size)

Sets the SO_SNDBUF option to the specified value for this
`DatagramSocket`. The SO_SNDBUF option is used by the
network implementation as a hint to size the underlying
network I/O buffers. The SO_SNDBUF setting may also be used
by the network implementation to determine the maximum size
of the packet that can be sent on this socket.


As SO_SNDBUF is a hint, applications that want to verify
what size the buffer is should call `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getSendBufferSize()`.


Increasing the buffer size may allow multiple outgoing packets
to be queued by the network implementation when the send rate
is high.


Note: If `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#send(java.net.DatagramPacket)` is used to send a
`DatagramPacket` that is larger than the setting
of SO_SNDBUF then it is implementation specific if the
packet is sent or discarded.

##### Parameters

| size | the size to which to set the send buffer size. This value must be greater than 0. |
|---|---|

##### Throws

| [SocketException](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketException.html) | if there is an error in the underlying protocol, such as an UDP error. |
| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if the value is 0 or is negative. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getSendBufferSize()`

#### public synchronized void
**setSoTimeout**
(int timeout)

Enable/disable SO_TIMEOUT with the specified timeout, in
milliseconds. With this option set to a non-zero timeout,
a call to receive() for this DatagramSocket
will block for only this amount of time. If the timeout expires,
a **java.net.SocketTimeoutException** is raised, though the
DatagramSocket is still valid. The option **must** be enabled
prior to entering the blocking operation to have effect. The
timeout must be `> 0`.
A timeout of zero is interpreted as an infinite timeout.

##### Parameters

| timeout | the specified timeout in milliseconds. |
|---|---|

##### Throws

| [SocketException](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketException.html) | if there is an error in the underlying protocol, such as an UDP error. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getSoTimeout()`

#### public synchronized void
**setTrafficClass**
(int tc)

Sets traffic class or type-of-service octet in the IP
datagram header for datagrams sent from this DatagramSocket.
As the underlying network implementation may ignore this
value applications should consider it a hint.

The tc **must** be in the range `0 <= tc <=
255` or an IllegalArgumentException will be thrown.

Notes:

For Internet Protocol v4 the value consists of an
`integer`, the least significant 8 bits of which
represent the value of the TOS octet in IP packets sent by
the socket.
RFC 1349 defines the TOS values as follows:

- `IPTOS_LOWCOST (0x02)`
- `IPTOS_RELIABILITY (0x04)`
- `IPTOS_THROUGHPUT (0x08)`
- `IPTOS_LOWDELAY (0x10)`

The last low order bit is always ignored as this corresponds to the MBZ (must be zero) bit.


Setting bits in the precedence field may result in a
SocketException indicating that the operation is not
permitted.


for Internet Protocol v6 `tc` is the value that
would be placed into the sin6_flowinfo field of the IP header.

##### Parameters

| tc | an `int` value for the bitset. |
|---|---|

##### Throws

| [SocketException](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/SocketException.html) | if there is an error setting the traffic class or type-of-service |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/DatagramSocket.html#getTrafficClass()`