DatagramSocket

DatagramSocket

DatagramSocket()

Constructs a datagram socket and binds it to any available port on the local host machine. The socket will be bound to the wildcard 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.

DatagramSocket

DatagramSocket(bindaddr: SocketAddress!)

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.

DatagramSocket

DatagramSocket(port: Int)

Constructs a datagram socket and binds it to the specified port on the local host machine. The socket will be bound to the wildcard 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.

DatagramSocket

DatagramSocket(
    port: Int, 
    laddr: InetAddress!)

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 wildcard 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.

DatagramSocket

protected DatagramSocket(impl: DatagramSocketImpl!)

Creates an unbound datagram socket with the specified DatagramSocketImpl.

bind

open fun bind(addr: SocketAddress!): Unit

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.

close

open fun close(): Unit

Closes this datagram socket.

Any thread currently blocked in receive upon this socket will throw a SocketException.

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

connect

open fun connect(
    address: InetAddress!, 
    port: Int
): Unit

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 multicast address, the security manager's checkMulticast method is invoked with the given address. Otherwise, the security manager's checkConnect and checkAccept 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, receive and send 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.

connect

open fun connect(addr: SocketAddress!): Unit

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

If given an InetSocketAddress, this method behaves as if invoking connect(InetAddress,int) with the given socket addresses IP address and port number.

disconnect

open fun disconnect(): Unit

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

getBroadcast

open fun getBroadcast(): Boolean

Tests if SO_BROADCAST is enabled.

getChannel

open fun getChannel(): DatagramChannel!

Returns the unique 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 java.nio.channels.DatagramChannel#open method.

getInetAddress

open fun getInetAddress(): InetAddress!

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 #close, then this method will continue to return the connected address after the socket is closed.

getLocalAddress

open fun getLocalAddress(): InetAddress!

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.

getLocalPort

open fun getLocalPort(): Int

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

getLocalSocketAddress

open fun getLocalSocketAddress(): SocketAddress!

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

getOption

open fun <T : Any!> getOption(name: SocketOption<T>!): T

Returns the value of a socket option.

getPort

open fun getPort(): Int

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 #close, then this method will continue to return the connected port number after the socket is closed.

getReceiveBufferSize

open fun getReceiveBufferSize(): Int

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

getRemoteSocketAddress

open fun getRemoteSocketAddress(): SocketAddress!

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 #close, then this method will continue to return the connected address after the socket is closed.

getReuseAddress

open fun getReuseAddress(): Boolean

Tests if SO_REUSEADDR is enabled.

getSendBufferSize

open fun getSendBufferSize(): Int

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

getSoTimeout

open fun getSoTimeout(): Int

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

getTrafficClass

open fun getTrafficClass(): Int

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 setTrafficClass(int) this method may return a different value than was previously set using the setTrafficClass(int) method on this DatagramSocket.

isBound

open fun isBound(): Boolean

Returns the binding state of the socket.

If the socket was bound prior to being #close, then this method will continue to return true after the socket is closed.

isClosed

open fun isClosed(): Boolean

Returns whether the socket is closed or not.

isConnected

open fun isConnected(): Boolean

Returns the connection state of the socket.

If the socket was connected prior to being #close, then this method will continue to return true after the socket is closed.

receive

open fun receive(p: DatagramPacket!): Unit

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.

send

open fun send(p: DatagramPacket!): Unit

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.

setBroadcast

open fun setBroadcast(on: Boolean): Unit

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.

setDatagramSocketImplFactory

open static fun setDatagramSocketImplFactory(fac: DatagramSocketImplFactory!): Unit

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.

setOption

open fun <T : Any!> setOption(
    name: SocketOption<T>!, 
    value: T
): DatagramSocket!

Sets the value of a socket option.

setReceiveBufferSize

open fun setReceiveBufferSize(size: Int): Unit

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 getReceiveBufferSize().

Increasing SO_RCVBUF may allow the network implementation to buffer multiple packets when packets arrive faster than are being received using receive(java.net.DatagramPacket).

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

setReuseAddress

open fun setReuseAddress(on: Boolean): Unit

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 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 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 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 isBound()) is not defined.

setSendBufferSize

open fun setSendBufferSize(size: Int): Unit

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

setSoTimeout

open fun setSoTimeout(timeout: Int): Unit

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.

setTrafficClass

open fun setTrafficClass(tc: Int): Unit

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)

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.

supportedOptions

open fun supportedOptions(): MutableSet<SocketOption<*>!>!

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.