Added in API level 1

Summary: Inherited Constants | Fields | Ctors | Protected Methods | Inherited Methods

DatagramSocketImpl

public abstract class DatagramSocketImpl
extends Object implements SocketOptions

java.lang.Object
↳	java.net.DatagramSocketImpl

Abstract datagram and multicast socket implementation base class.

Summary

Inherited constants

From interface java.net.SocketOptions

`int`	`IP_MULTICAST_IF` Set which outgoing interface on which to send multicast packets.
`int`	`IP_MULTICAST_IF2` Same as above.
`int`	`IP_MULTICAST_LOOP` This option enables or disables local loopback of multicast datagrams.
`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).
`int`	`SO_BROADCAST` Sets SO_BROADCAST for a socket.
`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.
`int`	`SO_LINGER` Specify a linger-on-close timeout.
`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.
`int`	`SO_RCVBUF` Set a hint the size of the underlying buffers used by the platform for incoming network I/O.
`int`	`SO_REUSEADDR` Sets SO_REUSEADDR for a socket.
`int`	`SO_REUSEPORT` Sets SO_REUSEPORT for a socket.
`int`	`SO_SNDBUF` Set a hint the size of the underlying buffers used by the platform for outgoing network I/O.
`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.
`int`	`TCP_NODELAY` Disable Nagle's algorithm for this connection.

Fields
`protected FileDescriptor`	`fd` The file descriptor object.
`protected int`	`localPort` The local port number.

Public constructors
`DatagramSocketImpl()`

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

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(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`	`wait(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`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          java.net.SocketOptions

`abstract Object`	`getOption(int optID)` Fetch the value of an option.
`abstract void`	`setOption(int optID, Object value)` Enable/disable the option specified by optID.

Fields

fd

Added in API level 1

protected FileDescriptor fd

The file descriptor object.

localPort

Added in API level 1

protected int localPort

The local port number.

Public constructors

DatagramSocketImpl

Added in API level 1

public DatagramSocketImpl ()

Protected methods

bind

Added in API level 1

protected abstract void bind (int lport, 
                InetAddress laddr)

Binds a datagram socket to a local port and address.

Parameters
`lport`	`int`: the local port
`laddr`	`InetAddress`: the local address

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

close

Added in API level 1

protected abstract void close ()

Close the socket.

connect

Added in API level 1

protected void connect (InetAddress address, 
                int port)

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

Throws
`SocketException`	may be thrown if the socket cannot be connected to the remote destination

create

Added in API level 1

protected abstract void create ()

Creates a datagram socket.

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

disconnect

Added in API level 1

protected void disconnect ()

Disconnects a datagram socket from its remote destination.

getFileDescriptor

Added in API level 1

protected FileDescriptor getFileDescriptor ()

Gets the datagram socket file descriptor.

Returns
`FileDescriptor`	a `FileDescriptor` object representing the datagram socket file descriptor

getLocalPort

Added in API level 1

protected int getLocalPort ()

Gets the local port.

Returns
`int`	an `int` representing the local port value

getOption

Added in API level 33

protected T getOption (SocketOption<T> name)

Called to get a socket option.

Parameters
`name`	`SocketOption`: The socket option

Returns
`T`	the socket option

Throws
`UnsupportedOperationException`	if the DatagramSocketImpl does not support the option
`NullPointerException`	if name is `null`
`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 byte getTTL ()

This method was deprecated in API level 15.
use getTimeToLive instead.

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

Returns
`byte`	a byte representing the TTL value

Throws
`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 int getTimeToLive ()

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

Returns
`int`	an `int` representing the time-to-live value

Throws
`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 void join (InetAddress inetaddr)

Join the multicast group.

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

Throws
`IOException`	if an I/O exception occurs while joining the multicast group.

joinGroup

Added in API level 1

protected abstract void joinGroup (SocketAddress mcastaddr, 
                NetworkInterface netIf)

Join the multicast group.

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

Throws
`IOException`	if an I/O exception occurs while joining the multicast group

leave

Added in API level 1

protected abstract void leave (InetAddress inetaddr)

Leave the multicast group.

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

Throws
`IOException`	if an I/O exception occurs while leaving the multicast group.

leaveGroup

Added in API level 1

protected abstract void leaveGroup (SocketAddress mcastaddr, 
                NetworkInterface netIf)

Leave the multicast group.

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

Throws
`IOException`	if an I/O exception occurs while leaving the multicast group

peek

Added in API level 1

protected abstract int peek (InetAddress i)

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

Returns
`int`	the port number which the packet came from.

Throws
`IOException`	if an I/O exception occurs
`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 int peekData (DatagramPacket p)

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.

Returns
`int`	the port number which the packet came from.

Throws
`IOException`	if an I/O exception occurs
`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 void receive (DatagramPacket p)

Receive the datagram packet.

Parameters
`p`	`DatagramPacket`: the Packet Received.

Throws
`IOException`	if an I/O exception occurs while receiving the datagram packet.
`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 void send (DatagramPacket p)

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.

Throws
`IOException`	if an I/O exception occurs while sending the datagram packet.
`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 void setOption (SocketOption<T> name, 
                T value)

Called to set a socket option.

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

Throws
`UnsupportedOperationException`	if the DatagramSocketImpl does not support the option
`NullPointerException`	if name is `null`
`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 void setTTL (byte ttl)

This method was deprecated in API level 15.
use setTimeToLive instead.

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

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

Throws
`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 void setTimeToLive (int ttl)

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

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

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

See also:

getTimeToLive()

supportedOptions

Added in API level 33

protected Set<SocketOption<?>> supportedOptions ()

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

Returns
`Set<SocketOption<?>>`	a Set of SocketOptions