Added in API level 1

DatagramSocketImpl

abstract class DatagramSocketImpl : SocketOptions

kotlin.Any
↳	java.net.DatagramSocketImpl

Abstract datagram and multicast socket implementation base class.

Summary

Inherited constants

From class SocketOptions

`Int`	`IP_MULTICAST_IF` Set which outgoing interface on which to send multicast packets. Useful on hosts with multiple network interfaces, where applications want to use other than the system default. Takes/returns an InetAddress. Valid for Multicast: DatagramSocketImpl
`Int`	`IP_MULTICAST_IF2` Same as above. This option is introduced so that the behaviour with IP_MULTICAST_IF will be kept the same as before, while this new option can support setting outgoing interfaces with either IPv4 and IPv6 addresses. NOTE: make sure there is no conflict with this
`Int`	`IP_MULTICAST_LOOP` This option enables or disables local loopback of multicast datagrams. This option is enabled by default for Multicast Sockets.
`Int`	`IP_TOS` This option sets the type-of-service or traffic class field in the IP header for a TCP or UDP socket.
`Int`	`SO_BINDADDR` Fetch the local address binding of a socket (this option cannot be "set" only "gotten", since sockets are bound at creation time, and so the locally bound address cannot be changed). The default local address of a socket is INADDR_ANY, meaning any local address on a multi-homed host. A multi-homed host can use this option to accept connections to only one of its addresses (in the case of a ServerSocket or DatagramSocket), or to specify its return address to the peer (for a Socket or DatagramSocket). The parameter of this option is an InetAddress. This option must be specified in the constructor. Valid for: SocketImpl, DatagramSocketImpl
`Int`	`SO_BROADCAST` Sets SO_BROADCAST for a socket. This option enables and disables the ability of the process to send broadcast messages. It is supported for only datagram sockets and only on networks that support the concept of a broadcast message (e.g. Ethernet, token ring, etc.), and it is set by default for DatagramSockets.
`Int`	`SO_KEEPALIVE` When the keepalive option is set for a TCP socket and no data has been exchanged across the socket in either direction for 2 hours (NOTE: the actual value is implementation dependent), TCP automatically sends a keepalive probe to the peer. This probe is a TCP segment to which the peer must respond. One of three responses is expected: 1. The peer responds with the expected ACK. The application is not notified (since everything is OK). TCP will send another probe following another 2 hours of inactivity. 2. The peer responds with an RST, which tells the local TCP that the peer host has crashed and rebooted. The socket is closed. 3. There is no response from the peer. The socket is closed. The purpose of this option is to detect if the peer host crashes. Valid only for TCP socket: SocketImpl
`Int`	`SO_LINGER` Specify a linger-on-close timeout. This option disables/enables immediate return from a close() of a TCP Socket. Enabling this option with a non-zero Integer timeout means that a close() will block pending the transmission and acknowledgement of all data written to the peer, at which point the socket is closed gracefully. Upon reaching the linger timeout, the socket is closed forcefully, with a TCP RST. Enabling the option with a timeout of zero does a forceful close immediately. If the specified timeout value exceeds 65,535 it will be reduced to 65,535. Valid only for TCP: SocketImpl
`Int`	`SO_OOBINLINE` When the OOBINLINE option is set, any TCP urgent data received on the socket will be received through the socket input stream. When the option is disabled (which is the default) urgent data is silently discarded.
`Int`	`SO_RCVBUF` Set a hint the size of the underlying buffers used by the platform for incoming network I/O. When used in set, this is a suggestion to the kernel from the application about the size of buffers to use for the data to be received over the socket. When used in get, this must return the size of the buffer actually used by the platform when receiving in data on this socket. Valid for all sockets: SocketImpl, DatagramSocketImpl
`Int`	`SO_REUSEADDR` Sets SO_REUSEADDR for a socket. This is used only for MulticastSockets in java, and it is set by default for MulticastSockets. Valid for: DatagramSocketImpl
`Int`	`SO_REUSEPORT` Sets SO_REUSEPORT for a socket. This option enables and disables the ability to have multiple sockets listen to the same address and port. Valid for: SocketImpl, DatagramSocketImpl
`Int`	`SO_SNDBUF` Set a hint the size of the underlying buffers used by the platform for outgoing network I/O. When used in set, this is a suggestion to the kernel from the application about the size of buffers to use for the data to be sent over the socket. When used in get, this must return the size of the buffer actually used by the platform when sending out data on this socket. Valid for all sockets: SocketImpl, DatagramSocketImpl
`Int`	`SO_TIMEOUT` Set a timeout on blocking Socket operations: ServerSocket.accept(); SocketInputStream.read(); DatagramSocket.receive(); The option must be set prior to entering a blocking operation to take effect. If the timeout expires and the operation would continue to block, java.io.InterruptedIOException is raised. The Socket is not closed in this case. Valid for all sockets: SocketImpl, DatagramSocketImpl
`Int`	`TCP_NODELAY` Disable Nagle's algorithm for this connection. Written data to the network is not buffered pending acknowledgement of previously written data. Valid for TCP only: SocketImpl.

Public constructors
`DatagramSocketImpl()`

Protected methods
abstract Unit	`bind(lport: Int, laddr: InetAddress!)` Binds a datagram socket to a local port and address.
abstract Unit	`close()` Close the socket.
open Unit	`connect(address: InetAddress!, port: Int)` Connects a datagram socket to a remote destination.
abstract Unit	`create()` Creates a datagram socket.
open Unit	`disconnect()` Disconnects a datagram socket from its remote destination.
open FileDescriptor!	`getFileDescriptor()` Gets the datagram socket file descriptor.
open Int	`getLocalPort()` Gets the local port.
open T	`getOption(name: SocketOption<T>!)` Called to get a socket option.
abstract Byte	`getTTL()` Retrieve the TTL (time-to-live) option.
abstract Int	`getTimeToLive()` Retrieve the TTL (time-to-live) option.
abstract Unit	`join(inetaddr: InetAddress!)` Join the multicast group.
abstract Unit	`joinGroup(mcastaddr: SocketAddress!, netIf: NetworkInterface!)` Join the multicast group.
abstract Unit	`leave(inetaddr: InetAddress!)` Leave the multicast group.
abstract Unit	`leaveGroup(mcastaddr: SocketAddress!, netIf: NetworkInterface!)` Leave the multicast group.
abstract Int	`peek(i: InetAddress!)` Peek at the packet to see who it is from.
abstract Int	`peekData(p: DatagramPacket!)` Peek at the packet to see who it is from.
abstract Unit	`receive(p: DatagramPacket!)` Receive the datagram packet.
abstract Unit	`send(p: DatagramPacket!)` Sends a datagram packet.
open Unit	`setOption(name: SocketOption<T>!, value: T)` Called to set a socket option.
abstract Unit	`setTTL(ttl: Byte)` Set the TTL (time-to-live) option.
abstract Unit	`setTimeToLive(ttl: Int)` Set the TTL (time-to-live) option.
open MutableSet<SocketOption<*>!>!	`supportedOptions()` Returns a set of SocketOptions supported by this impl and by this impl's socket (DatagramSocket or MulticastSocket)

Inherited functions

From class SocketOptions

Any!

getOption(optID: Int)

Fetch the value of an option. Binary options will return java.lang.Boolean.TRUE if enabled, java.lang.Boolean.FALSE if disabled, e.g.:

SocketImpl s;
  ...
  Boolean noDelay = (Boolean)(s.getOption(TCP_NODELAY));
  if (noDelay.booleanValue()) {
      // true if TCP_NODELAY is enabled...
  ...
  }

For options that take a particular type as a parameter, getOption(int) will return the parameter's value, else it will return java.lang.Boolean.FALSE:

Object o = s.getOption(SO_LINGER);
  if (o instanceof Integer) {
      System.out.print("Linger time is " + ((Integer)o).intValue());
  } else {
    // the true type of o is java.lang.Boolean.FALSE;
  }

Unit

setOption(optID: Int, value: Any!)

Enable/disable the option specified by optID. If the option is to be enabled, and it takes an option-specific "value", this is passed in value. The actual type of value is option-specific, and it is an error to pass something that isn't of the expected type:

SocketImpl s;
  ...
  s.setOption(SO_LINGER, new Integer(10));
     // OK - set SO_LINGER w/ timeout of 10 sec.
  s.setOption(SO_LINGER, new Double(10));
     // ERROR - expects java.lang.Integer

If the requested option is binary, it can be set using this method by a java.lang.Boolean:

s.setOption(TCP_NODELAY, Boolean.TRUE);
     // OK - enables TCP_NODELAY, a binary option

Any option can be disabled using this method with a Boolean.FALSE:

s.setOption(TCP_NODELAY, Boolean.FALSE);
     // OK - disables TCP_NODELAY
  s.setOption(SO_LINGER, Boolean.FALSE);
     // OK - disables SO_LINGER

For an option that has a notion of on and off, and requires a non-boolean parameter, setting its value to anything other than Boolean.FALSE implicitly enables it.
Throws SocketException if the option is unrecognized, the socket is closed, or some low-level error occurred

Properties
FileDescriptor!	`fd` The file descriptor object.
Int	`localPort` The local port number.

Public constructors

DatagramSocketImpl

Added in API level 1

DatagramSocketImpl()

Protected methods

bind

Added in API level 1

protected abstract fun bind(
    lport: Int, 
    laddr: InetAddress!
): Unit

Binds a datagram socket to a local port and address.

Parameters
`lport`	Int: the local port
`laddr`	InetAddress!: the local address

Exceptions
`java.net.SocketException`	if there is an error in the underlying protocol, such as a TCP error.

close

Added in API level 1

protected abstract fun close(): Unit

Close the socket.

connect

Added in API level 1

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

Connects a datagram socket to a remote destination. This associates the remote address with the local socket so that datagrams may only be sent to this destination and received from this destination. This may be overridden to call a native system connect.

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.

Parameters
`address`	InetAddress!: the remote InetAddress to connect to
`port`	Int: the remote port number

Exceptions
`java.net.SocketException`	may be thrown if the socket cannot be connected to the remote destination

create

Added in API level 1

protected abstract fun create(): Unit

Creates a datagram socket.

Exceptions
`java.net.SocketException`	if there is an error in the underlying protocol, such as a TCP error.

disconnect

Added in API level 1

protected open fun disconnect(): Unit

Disconnects a datagram socket from its remote destination.

getFileDescriptor

Added in API level 1

protected open fun getFileDescriptor(): FileDescriptor!

Gets the datagram socket file descriptor.

Return
`FileDescriptor!`	a `FileDescriptor` object representing the datagram socket file descriptor

getLocalPort

Added in API level 1

protected open fun getLocalPort(): Int

Gets the local port.

Return
`Int`	an `int` representing the local port value

getOption

Added in API level 33

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

Called to get a socket option.

Parameters
`<T>`	The type of the socket option value
`name`	SocketOption<T>!: The socket option

Return
`T`	the socket option

Exceptions
`java.lang.UnsupportedOperationException`	if the DatagramSocketImpl does not support the option
`java.lang.NullPointerException`	if name is `null`
`java.io.IOException`	if an I/O problem occurs while attempting to set the option

getTTL

Added in API level 1
Deprecated in API level 15

protected abstract fun getTTL(): Byte

Deprecated: use getTimeToLive instead.

Retrieve the TTL (time-to-live) option.

Return
`Byte`	a byte representing the TTL value

Exceptions
`java.io.IOException`	if an I/O exception occurs while retrieving the time-to-live option

See Also

#setTTL(byte)

getTimeToLive

Added in API level 1

protected abstract fun getTimeToLive(): Int

Retrieve the TTL (time-to-live) option.

Return
`Int`	an `int` representing the time-to-live value

Exceptions
`java.io.IOException`	if an I/O exception occurs while retrieving the time-to-live option

See Also

#setTimeToLive(int)

join

Added in API level 1

protected abstract fun join(inetaddr: InetAddress!): Unit

Join the multicast group.

Parameters
`inetaddr`	InetAddress!: multicast address to join.

Exceptions
`java.io.IOException`	if an I/O exception occurs while joining the multicast group.

joinGroup

Added in API level 1

protected abstract fun joinGroup(
    mcastaddr: SocketAddress!, 
    netIf: NetworkInterface!
): Unit

Join the multicast group.

Parameters
`mcastaddr`	SocketAddress!: address to join.
`netIf`	NetworkInterface!: specifies the local interface to receive multicast datagram packets

Exceptions
`java.io.IOException`	if an I/O exception occurs while joining the multicast group

leave

Added in API level 1

protected abstract fun leave(inetaddr: InetAddress!): Unit

Leave the multicast group.

Parameters
`inetaddr`	InetAddress!: multicast address to leave.

Exceptions
`java.io.IOException`	if an I/O exception occurs while leaving the multicast group.

leaveGroup

Added in API level 1

protected abstract fun leaveGroup(
    mcastaddr: SocketAddress!, 
    netIf: NetworkInterface!
): Unit

Leave the multicast group.

Parameters
`mcastaddr`	SocketAddress!: address to leave.
`netIf`	NetworkInterface!: specified the local interface to leave the group at

Exceptions
`java.io.IOException`	if an I/O exception occurs while leaving the multicast group

peek

Added in API level 1

protected abstract fun peek(i: InetAddress!): Int

Peek at the packet to see who it is from. Updates the specified InetAddress to the address which the packet came from.

Parameters
`i`	InetAddress!: an InetAddress object

Return
`Int`	the port number which the packet came from.

Exceptions
`java.io.IOException`	if an I/O exception occurs
`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.

peekData

Added in API level 1

protected abstract fun peekData(p: DatagramPacket!): Int

Peek at the packet to see who it is from. The data is copied into the specified DatagramPacket. The data is returned, but not consumed, so that a subsequent peekData/receive operation will see the same data.

Parameters
`p`	DatagramPacket!: the Packet Received.

Return
`Int`	the port number which the packet came from.

Exceptions
`java.io.IOException`	if an I/O exception occurs
`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.

receive

Added in API level 1

protected abstract fun receive(p: DatagramPacket!): Unit

Receive the datagram packet.

Parameters
`p`	DatagramPacket!: the Packet Received.

Exceptions
`java.io.IOException`	if an I/O exception occurs while receiving the datagram packet.
`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.

send

Added in API level 1

protected abstract fun send(p: DatagramPacket!): Unit

Sends a datagram packet. The packet contains the data and the destination address to send the packet to.

Parameters
`p`	DatagramPacket!: the packet to be sent.

Exceptions
`java.io.IOException`	if an I/O exception occurs while sending the datagram packet.
`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.

setOption

Added in API level 33

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

Called to set a socket option.

Parameters
`<T>`	The type of the socket option value
`name`	SocketOption<T>!: The socket option
`value`	T: The value of the socket option. A value of `null` may be valid for some options.

Exceptions
`java.lang.UnsupportedOperationException`	if the DatagramSocketImpl does not support the option
`java.lang.NullPointerException`	if name is `null`
`java.io.IOException`	if an I/O problem occurs while attempting to set the option

setTTL

Added in API level 1
Deprecated in API level 15

protected abstract fun setTTL(ttl: Byte): Unit

Deprecated: use setTimeToLive instead.

Set the TTL (time-to-live) option.

Parameters
`ttl`	Byte: a byte specifying the TTL value

Exceptions
`java.io.IOException`	if an I/O exception occurs while setting the time-to-live option.

See Also

#getTTL()

setTimeToLive

Added in API level 1

protected abstract fun setTimeToLive(ttl: Int): Unit

Set the TTL (time-to-live) option.

Parameters
`ttl`	Int: an `int` specifying the time-to-live value

Exceptions
`java.io.IOException`	if an I/O exception occurs while setting the time-to-live option.

See Also

#getTimeToLive()

supportedOptions

Added in API level 33

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

Returns a set of SocketOptions supported by this impl and by this impl's socket (DatagramSocket or MulticastSocket)

Return
`MutableSet<SocketOption<*>!>!`	a Set of SocketOptions

Properties

fd

Added in API level 1

protected var fd: FileDescriptor!

The file descriptor object.

localPort

Added in API level 1

protected var localPort: Int

The local port number.