Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Ctors](https://developer.android.com/reference/java/net/DatagramSocket#pubctors) \| [Protected Ctors](https://developer.android.com/reference/java/net/DatagramSocket#proctors) \| [Methods](https://developer.android.com/reference/java/net/DatagramSocket#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/java/net/DatagramSocket#inhmethods)

# DatagramSocket

` public class DatagramSocket `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/java/io/Closeable `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | java.net.DatagramSocket |

Known direct subclasses [MulticastSocket](https://developer.android.com/reference/java/net/MulticastSocket) [MulticastSocket](https://developer.android.com/reference/java/net/MulticastSocket) 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://developer.android.com/reference/java/net/SocketOptions#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://developer.android.com/reference/java/net/DatagramPacket`
- `https://developer.android.com/reference/java/nio/channels/DatagramChannel`

## Summary

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/java/net/DatagramSocket#DatagramSocket()() ` Constructs a datagram socket and binds it to any available port on the local host machine. |
| ` https://developer.android.com/reference/java/net/DatagramSocket#DatagramSocket(int)(int port) ` Constructs a datagram socket and binds it to the specified port on the local host machine. |
| ` https://developer.android.com/reference/java/net/DatagramSocket#DatagramSocket(int,%20java.net.InetAddress)(int port, https://developer.android.com/reference/java/net/InetAddress laddr) ` Creates a datagram socket, bound to the specified local address. |
| ` https://developer.android.com/reference/java/net/DatagramSocket#DatagramSocket(java.net.SocketAddress)(https://developer.android.com/reference/java/net/SocketAddress bindaddr) ` Creates a datagram socket, bound to the specified local socket address. |

| ### Protected constructors ||
|---|---|
| ` https://developer.android.com/reference/java/net/DatagramSocket#DatagramSocket(java.net.DatagramSocketImpl)(https://developer.android.com/reference/java/net/DatagramSocketImpl impl) ` Creates an unbound datagram socket with the specified DatagramSocketImpl. |

| ### Public methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/java/net/DatagramSocket#bind(java.net.SocketAddress)(https://developer.android.com/reference/java/net/SocketAddress addr) ` Binds this DatagramSocket to a specific address and port. |
| ` void` | ` https://developer.android.com/reference/java/net/DatagramSocket#close()() ` Closes this datagram socket. |
| ` void` | ` https://developer.android.com/reference/java/net/DatagramSocket#connect(java.net.InetAddress,%20int)(https://developer.android.com/reference/java/net/InetAddress address, int port) ` Connects the socket to a remote address for this socket. |
| ` void` | ` https://developer.android.com/reference/java/net/DatagramSocket#connect(java.net.SocketAddress)(https://developer.android.com/reference/java/net/SocketAddress addr) ` Connects this socket to a remote socket address (IP address + port number). |
| ` void` | ` https://developer.android.com/reference/java/net/DatagramSocket#disconnect()() ` Disconnects the socket. |
| ` boolean` | ` https://developer.android.com/reference/java/net/DatagramSocket#getBroadcast()() ` Tests if SO_BROADCAST is enabled. |
| ` https://developer.android.com/reference/java/nio/channels/DatagramChannel` | ` https://developer.android.com/reference/java/net/DatagramSocket#getChannel()() ` Returns the unique `https://developer.android.com/reference/java/nio/channels/DatagramChannel` object associated with this datagram socket, if any. |
| ` https://developer.android.com/reference/java/net/InetAddress` | ` https://developer.android.com/reference/java/net/DatagramSocket#getInetAddress()() ` Returns the address to which this socket is connected. |
| ` https://developer.android.com/reference/java/net/InetAddress` | ` https://developer.android.com/reference/java/net/DatagramSocket#getLocalAddress()() ` Gets the local address to which the socket is bound. |
| ` int` | ` https://developer.android.com/reference/java/net/DatagramSocket#getLocalPort()() ` Returns the port number on the local host to which this socket is bound. |
| ` https://developer.android.com/reference/java/net/SocketAddress` | ` https://developer.android.com/reference/java/net/DatagramSocket#getLocalSocketAddress()() ` Returns the address of the endpoint this socket is bound to. |
| ` <T> T` | ` https://developer.android.com/reference/java/net/DatagramSocket#getOption(java.net.SocketOption<T>)(https://developer.android.com/reference/java/net/SocketOption<T> name) ` Returns the value of a socket option. |
| ` int` | ` https://developer.android.com/reference/java/net/DatagramSocket#getPort()() ` Returns the port number to which this socket is connected. |
| ` int` | ` https://developer.android.com/reference/java/net/DatagramSocket#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`. |
| ` https://developer.android.com/reference/java/net/SocketAddress` | ` https://developer.android.com/reference/java/net/DatagramSocket#getRemoteSocketAddress()() ` Returns the address of the endpoint this socket is connected to, or `null` if it is unconnected. |
| ` boolean` | ` https://developer.android.com/reference/java/net/DatagramSocket#getReuseAddress()() ` Tests if SO_REUSEADDR is enabled. |
| ` int` | ` https://developer.android.com/reference/java/net/DatagramSocket#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`. |
| ` int` | ` https://developer.android.com/reference/java/net/DatagramSocket#getSoTimeout()() ` Retrieve setting for SO_TIMEOUT. |
| ` int` | ` https://developer.android.com/reference/java/net/DatagramSocket#getTrafficClass()() ` Gets traffic class or type-of-service in the IP datagram header for packets sent from this DatagramSocket. |
| ` boolean` | ` https://developer.android.com/reference/java/net/DatagramSocket#isBound()() ` Returns the binding state of the socket. |
| ` boolean` | ` https://developer.android.com/reference/java/net/DatagramSocket#isClosed()() ` Returns whether the socket is closed or not. |
| ` boolean` | ` https://developer.android.com/reference/java/net/DatagramSocket#isConnected()() ` Returns the connection state of the socket. |
| ` void` | ` https://developer.android.com/reference/java/net/DatagramSocket#receive(java.net.DatagramPacket)(https://developer.android.com/reference/java/net/DatagramPacket p) ` Receives a datagram packet from this socket. |
| ` void` | ` https://developer.android.com/reference/java/net/DatagramSocket#send(java.net.DatagramPacket)(https://developer.android.com/reference/java/net/DatagramPacket p) ` Sends a datagram packet from this socket. |
| ` void` | ` https://developer.android.com/reference/java/net/DatagramSocket#setBroadcast(boolean)(boolean on) ` Enable/disable SO_BROADCAST. |
| ` static void` | ` https://developer.android.com/reference/java/net/DatagramSocket#setDatagramSocketImplFactory(java.net.DatagramSocketImplFactory)(https://developer.android.com/reference/java/net/DatagramSocketImplFactory fac) ` Sets the datagram socket implementation factory for the application. |
| ` <T> https://developer.android.com/reference/java/net/DatagramSocket` | ` https://developer.android.com/reference/java/net/DatagramSocket#setOption(java.net.SocketOption<T>,%20T)(https://developer.android.com/reference/java/net/SocketOption<T> name, T value) ` Sets the value of a socket option. |
| ` void` | ` https://developer.android.com/reference/java/net/DatagramSocket#setReceiveBufferSize(int)(int size) ` Sets the SO_RCVBUF option to the specified value for this `DatagramSocket`. |
| ` void` | ` https://developer.android.com/reference/java/net/DatagramSocket#setReuseAddress(boolean)(boolean on) ` Enable/disable the SO_REUSEADDR socket option. |
| ` void` | ` https://developer.android.com/reference/java/net/DatagramSocket#setSendBufferSize(int)(int size) ` Sets the SO_SNDBUF option to the specified value for this `DatagramSocket`. |
| ` void` | ` https://developer.android.com/reference/java/net/DatagramSocket#setSoTimeout(int)(int timeout) ` Enable/disable SO_TIMEOUT with the specified timeout, in milliseconds. |
| ` void` | ` https://developer.android.com/reference/java/net/DatagramSocket#setTrafficClass(int)(int tc) ` Sets traffic class or type-of-service octet in the IP datagram header for datagrams sent from this DatagramSocket. |
| ` https://developer.android.com/reference/java/util/Set<https://developer.android.com/reference/java/net/SocketOption<?>>` | ` https://developer.android.com/reference/java/net/DatagramSocket#supportedOptions()() ` Returns a set of the socket options supported by this socket. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/java/io/Closeable ` ` abstract void` ` https://developer.android.com/reference/java/io/Closeable#close()() `

Closes this stream and releases any system resources associated with it.
From interface ` https://developer.android.com/reference/java/lang/AutoCloseable ` ` abstract void` ` https://developer.android.com/reference/java/lang/AutoCloseable#close()() `

Closes this resource, relinquishing any underlying resources.

## Public constructors

### DatagramSocket

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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://developer.android.com/reference/java/net/InetAddress#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.

<br />

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/SecurityException` | if a security manager exists and its `checkListen` method doesn't allow the operation. |
| `https://developer.android.com/reference/java/net/SocketException` | if the socket could not be opened, or the socket could not bind to the specified local port. |

**See also:**

- `https://developer.android.com/reference/java/lang/SecurityManager#checkListen(int)`

### DatagramSocket

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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://developer.android.com/reference/java/net/InetAddress#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.

<br />

| Parameters ||
|---|---|
| `port` | `int`: port to use. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/SecurityException` | if a security manager exists and its `checkListen` method doesn't allow the operation. |
| `https://developer.android.com/reference/java/net/SocketException` | if the socket could not be opened, or the socket could not bind to the specified local port. |

**See also:**

- `https://developer.android.com/reference/java/lang/SecurityManager#checkListen(int)`

### DatagramSocket

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public DatagramSocket (int port, 
                InetAddress 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://developer.android.com/reference/java/net/InetAddress#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.

<br />

| Parameters ||
|---|---|
| `port` | `int`: local port to use <br /> |
| `laddr` | `InetAddress`: local address to bind <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/SecurityException` | if a security manager exists and its `checkListen` method doesn't allow the operation. |
| `https://developer.android.com/reference/java/net/SocketException` | if the socket could not be opened, or the socket could not bind to the specified local port. |

**See also:**

- `https://developer.android.com/reference/java/lang/SecurityManager#checkListen(int)`

### DatagramSocket

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public DatagramSocket (SocketAddress 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.

<br />

| Parameters ||
|---|---|
| `bindaddr` | `SocketAddress`: local socket address to bind, or `null` for an unbound socket. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/SecurityException` | if a security manager exists and its `checkListen` method doesn't allow the operation. |
| `https://developer.android.com/reference/java/net/SocketException` | if the socket could not be opened, or the socket could not bind to the specified local port. |

**See also:**

- `https://developer.android.com/reference/java/lang/SecurityManager#checkListen(int)`

## Protected constructors

### DatagramSocket

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
protected DatagramSocket (DatagramSocketImpl impl)
```

Creates an unbound datagram socket with the specified DatagramSocketImpl.

<br />

| Parameters ||
|---|---|
| `impl` | `DatagramSocketImpl`: an instance of a **DatagramSocketImpl** the subclass wishes to use on the DatagramSocket. <br /> |

## Public methods

### bind

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void bind (SocketAddress 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` | `SocketAddress`: The address and port to bind to. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if addr is a SocketAddress subclass not supported by this socket. |
| `https://developer.android.com/reference/java/lang/SecurityException` | if a security manager exists and its `checkListen` method doesn't allow the operation. |
| `https://developer.android.com/reference/java/net/SocketException` | if any error happens during the bind, or if the socket is already bound. |

### close

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void close ()
```

Closes this datagram socket.

Any thread currently blocked in `https://developer.android.com/reference/java/net/DatagramSocket#receive(java.net.DatagramPacket)` upon this socket will throw a `https://developer.android.com/reference/java/net/SocketException`.

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

<br />

### connect

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void connect (InetAddress 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://developer.android.com/reference/java/net/InetAddress#isMulticastAddress()`, the security manager's `https://developer.android.com/reference/java/lang/SecurityManager#checkMulticast(java.net.InetAddress)` method is invoked with the given `address`. Otherwise, the security manager's `https://developer.android.com/reference/java/lang/SecurityManager#checkConnect(java.lang.String,%20int)` and `https://developer.android.com/reference/java/lang/SecurityManager#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://developer.android.com/reference/java/net/DatagramSocket#receive(java.net.DatagramPacket)` and `https://developer.android.com/reference/java/net/DatagramSocket#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.

<br />

| Parameters ||
|---|---|
| `address` | `InetAddress`: the remote address for the socket <br /> |
| `port` | `int`: the remote port for the socket. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the address is null, or the port is out of range. |
| `https://developer.android.com/reference/java/lang/SecurityException` | if a security manager has been installed and it does not permit access to the given remote address |

**See also:**

- `https://developer.android.com/reference/java/net/DatagramSocket#disconnect()`

### connect

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void connect (SocketAddress addr)
```

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

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

<br />

| Parameters ||
|---|---|
| `addr` | `SocketAddress`: The remote address. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if `addr` is `null`, or `addr` is a SocketAddress subclass not supported by this socket |
| `https://developer.android.com/reference/java/lang/SecurityException` | if a security manager has been installed and it does not permit access to the given remote address |
| `https://developer.android.com/reference/java/net/SocketException` | if the connect fails |

### disconnect

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void disconnect ()
```

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

<br />

**See also:**

- `https://developer.android.com/reference/java/net/DatagramSocket#connect(java.net.InetAddress,%20int)`

### getBroadcast

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean getBroadcast ()
```

Tests if SO_BROADCAST is enabled.

<br />

| Returns ||
|---|---|
| `boolean` | a `boolean` indicating whether or not SO_BROADCAST is enabled. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/net/SocketException` | if there is an error in the underlying protocol, such as an UDP error. |

**See also:**

- `https://developer.android.com/reference/java/net/DatagramSocket#setBroadcast(boolean)`

### getChannel

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public DatagramChannel getChannel ()
```

Returns the unique `https://developer.android.com/reference/java/nio/channels/DatagramChannel` 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://developer.android.com/reference/java/nio/channels/DatagramChannel#open()` method.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/nio/channels/DatagramChannel` | the datagram channel associated with this datagram socket, or `null` if this socket was not created for a channel <br /> |

### getInetAddress

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public InetAddress 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://developer.android.com/reference/java/net/DatagramSocket#close()`, then this method will continue to return the connected address after the socket is closed.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/net/InetAddress` | the address to which this socket is connected. <br /> |

### getLocalAddress

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public InetAddress 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.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/net/InetAddress` | the local address to which the socket is bound, `null` if the socket is closed, or an `InetAddress` representing `https://developer.android.com/reference/java/net/InetAddress#isAnyLocalAddress()` address if either the socket is not bound, or the security manager `checkConnect` method does not allow the operation <br /> |

**See also:**

- `https://developer.android.com/reference/java/lang/SecurityManager#checkConnect(java.lang.String,%20int)`

### getLocalPort

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getLocalPort ()
```

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

<br />

| Returns ||
|---|---|
| `int` | 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. <br /> |

### getLocalSocketAddress

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public SocketAddress getLocalSocketAddress ()
```

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

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/net/SocketAddress` | a `SocketAddress` representing the local endpoint of this socket, or `null` if it is closed or not bound yet. <br /> |

**See also:**

- `https://developer.android.com/reference/java/net/DatagramSocket#getLocalAddress()`
- `https://developer.android.com/reference/java/net/DatagramSocket#getLocalPort()`
- `https://developer.android.com/reference/java/net/DatagramSocket#bind(java.net.SocketAddress)`

### getOption

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public T getOption (SocketOption<T> name)
```

Returns the value of a socket option.

<br />

| Parameters ||
|---|---|
| `name` | `SocketOption`: The socket option <br /> |

| Returns ||
|---|---|
| `T` | The value of the socket option. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/io/IOException` | if an I/O error occurs, or if the socket is closed. |
| `https://developer.android.com/reference/java/lang/NullPointerException` | if name is `null` |
| `https://developer.android.com/reference/java/lang/SecurityException` | if a security manager is set and if the socket option requires a security permission and if the caller does not have the required permission. `https://developer.android.com/reference/java/net/StandardSocketOptions` do not require any security permission. |
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException` | if the datagram socket does not support the option. |

### getPort

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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://developer.android.com/reference/java/net/DatagramSocket#close()`, then this method will continue to return the connected port number after the socket is closed.

<br />

| Returns ||
|---|---|
| `int` | the port number to which this socket is connected. <br /> |

### getReceiveBufferSize

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public 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`.

<br />

| Returns ||
|---|---|
| `int` | the value of the SO_RCVBUF option for this `DatagramSocket` <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/net/SocketException` | if there is an error in the underlying protocol, such as an UDP error. |

**See also:**

- `https://developer.android.com/reference/java/net/DatagramSocket#setReceiveBufferSize(int)`

### getRemoteSocketAddress

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public SocketAddress 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://developer.android.com/reference/java/net/DatagramSocket#close()`, then this method will continue to return the connected address after the socket is closed.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/net/SocketAddress` | a `SocketAddress` representing the remote endpoint of this socket, or `null` if it is not connected yet. <br /> |

**See also:**

- `https://developer.android.com/reference/java/net/DatagramSocket#getInetAddress()`
- `https://developer.android.com/reference/java/net/DatagramSocket#getPort()`
- `https://developer.android.com/reference/java/net/DatagramSocket#connect(java.net.SocketAddress)`

### getReuseAddress

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean getReuseAddress ()
```

Tests if SO_REUSEADDR is enabled.

<br />

| Returns ||
|---|---|
| `boolean` | a `boolean` indicating whether or not SO_REUSEADDR is enabled. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/net/SocketException` | if there is an error in the underlying protocol, such as an UDP error. |

**See also:**

- `https://developer.android.com/reference/java/net/DatagramSocket#setReuseAddress(boolean)`

### getSendBufferSize

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public 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`.

<br />

| Returns ||
|---|---|
| `int` | the value of the SO_SNDBUF option for this `DatagramSocket` <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/net/SocketException` | if there is an error in the underlying protocol, such as an UDP error. |

**See also:**

- `https://developer.android.com/reference/java/net/DatagramSocket#setSendBufferSize(int)`

### getSoTimeout

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getSoTimeout ()
```

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

<br />

| Returns ||
|---|---|
| `int` | the setting for SO_TIMEOUT <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/net/SocketException` | if there is an error in the underlying protocol, such as an UDP error. |

**See also:**

- `https://developer.android.com/reference/java/net/DatagramSocket#setSoTimeout(int)`

### getTrafficClass

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public 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://developer.android.com/reference/java/net/DatagramSocket#setTrafficClass(int)` this method may return a different value than was previously set using the `https://developer.android.com/reference/java/net/DatagramSocket#setTrafficClass(int)` method on this DatagramSocket.

<br />

| Returns ||
|---|---|
| `int` | the traffic class or type-of-service already set <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/net/SocketException` | if there is an error obtaining the traffic class or type-of-service value. |

**See also:**

- `https://developer.android.com/reference/java/net/DatagramSocket#setTrafficClass(int)`

### isBound

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isBound ()
```

Returns the binding state of the socket.

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

<br />

| Returns ||
|---|---|
| `boolean` | true if the socket successfully bound to an address <br /> |

### isClosed

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isClosed ()
```

Returns whether the socket is closed or not.

<br />

| Returns ||
|---|---|
| `boolean` | true if the socket has been closed <br /> |

### isConnected

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isConnected ()
```

Returns the connection state of the socket.

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

<br />

| Returns ||
|---|---|
| `boolean` | true if the socket successfully connected to a server <br /> |

### receive

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void receive (DatagramPacket 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.

<br />

| Parameters ||
|---|---|
| `p` | `DatagramPacket`: the `DatagramPacket` into which to place the incoming data. <br /> |

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

**See also:**

- `https://developer.android.com/reference/java/net/DatagramPacket`
- `https://developer.android.com/reference/java/net/DatagramSocket`

### send

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void send (DatagramPacket 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.

<br />

| Parameters ||
|---|---|
| `p` | `DatagramPacket`: the `DatagramPacket` to be sent. <br /> |

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

**See also:**

- `https://developer.android.com/reference/java/net/DatagramPacket`
- `https://developer.android.com/reference/java/lang/SecurityManager#checkMulticast(java.net.InetAddress)`
- `https://developer.android.com/reference/java/lang/SecurityManager#checkConnect(java.lang.String,%20int)`

### setBroadcast

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public 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.

<br />

| Parameters ||
|---|---|
| `on` | `boolean`: whether or not to have broadcast turned on. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/net/SocketException` | if there is an error in the underlying protocol, such as an UDP error. |

**See also:**

- `https://developer.android.com/reference/java/net/DatagramSocket#getBroadcast()`

### setDatagramSocketImplFactory

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static void setDatagramSocketImplFactory (DatagramSocketImplFactory 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.

<br />

| Parameters ||
|---|---|
| `fac` | `DatagramSocketImplFactory`: the desired factory. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/io/IOException` | if an I/O error occurs when setting the datagram socket factory. |
| `https://developer.android.com/reference/java/lang/SecurityException` | if a security manager exists and its `checkSetFactory` method doesn't allow the operation. |
| `https://developer.android.com/reference/java/net/SocketException` | if the factory is already defined. |

**See also:**

- `https://developer.android.com/reference/java/net/DatagramSocketImplFactory#createDatagramSocketImpl()`
- `https://developer.android.com/reference/java/lang/SecurityManager#checkSetFactory()`

### setOption

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public DatagramSocket setOption (SocketOption<T> name, 
                T value)
```

Sets the value of a socket option.

<br />

| Parameters ||
|---|---|
| `name` | `SocketOption`: The socket option <br /> |
| `value` | `T`: The value of the socket option. A value of `null` may be valid for some options. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/net/DatagramSocket` | this DatagramSocket <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/io/IOException` | if an I/O error occurs, or if the socket is closed. |
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the value is not valid for the option. |
| `https://developer.android.com/reference/java/lang/NullPointerException` | if name is `null` |
| `https://developer.android.com/reference/java/lang/SecurityException` | if a security manager is set and if the socket option requires a security permission and if the caller does not have the required permission. `https://developer.android.com/reference/java/net/StandardSocketOptions` do not require any security permission. |
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException` | if the datagram socket does not support the option. |

### setReceiveBufferSize

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void setReceiveBufferSize (int size)
```

Sets the SO_RCVBUF option to the specified value for this `DatagramSocket`. The SO_RCVBUF option is used by 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://developer.android.com/reference/java/net/DatagramSocket#getReceiveBufferSize()`.

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

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

<br />

| Parameters ||
|---|---|
| `size` | `int`: the size to which to set the receive buffer size. This value must be greater than 0. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the value is 0 or is negative. |
| `https://developer.android.com/reference/java/net/SocketException` | if there is an error in the underlying protocol, such as an UDP error. |

**See also:**

- `https://developer.android.com/reference/java/net/DatagramSocket#getReceiveBufferSize()`

### setReuseAddress

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public 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://developer.android.com/reference/java/net/MulticastSocket`). 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://developer.android.com/reference/java/net/DatagramSocket#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://developer.android.com/reference/java/net/DatagramSocket#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://developer.android.com/reference/java/net/DatagramSocket#isBound()`) is not defined.

<br />

| Parameters ||
|---|---|
| `on` | `boolean`: whether to enable or disable the <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/net/SocketException` | if an error occurs enabling or disabling the `SO_RESUEADDR` socket option, or the socket is closed. |

**See also:**

- `https://developer.android.com/reference/java/net/DatagramSocket#getReuseAddress()`
- `https://developer.android.com/reference/java/net/DatagramSocket#bind(java.net.SocketAddress)`
- `https://developer.android.com/reference/java/net/DatagramSocket#isBound()`
- `https://developer.android.com/reference/java/net/DatagramSocket#isClosed()`

### setSendBufferSize

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public 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://developer.android.com/reference/java/net/DatagramSocket#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://developer.android.com/reference/java/net/DatagramSocket#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.

<br />

| Parameters ||
|---|---|
| `size` | `int`: the size to which to set the send buffer size. This value must be greater than 0. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the value is 0 or is negative. |
| `https://developer.android.com/reference/java/net/SocketException` | if there is an error in the underlying protocol, such as an UDP error. |

**See also:**

- `https://developer.android.com/reference/java/net/DatagramSocket#getSendBufferSize()`

### setSoTimeout

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public 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.

<br />

| Parameters ||
|---|---|
| `timeout` | `int`: the specified timeout in milliseconds. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/net/SocketException` | if there is an error in the underlying protocol, such as an UDP error. |

**See also:**

- `https://developer.android.com/reference/java/net/DatagramSocket#getSoTimeout()`

### setTrafficClass

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public 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.

<br />

| Parameters ||
|---|---|
| `tc` | `int`: an `int` value for the bitset. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/net/SocketException` | if there is an error setting the traffic class or type-of-service |

**See also:**

- `https://developer.android.com/reference/java/net/DatagramSocket#getTrafficClass()`

### supportedOptions

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Set<SocketOption<?>> supportedOptions ()
```

Returns a set of the socket options supported by this socket. This method will continue to return the set of options even after the socket has been closed.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Set<https://developer.android.com/reference/java/net/SocketOption<?>>` | A set of the socket options supported by this socket. This set may be empty if the socket's DatagramSocketImpl cannot be created. <br /> |