Class DatagramSocket

java.lang.Object
java.net.DatagramSocket
All Implemented Interfaces:
Closeable,AutoCloseable
Direct Known Subclasses:
MulticastSocket
public classDatagramSocketextendsObjectimplementsCloseable
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 constructedDatagramSocket has theSO_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.

TheDatagramSocket class defines convenience methods to set and get several socket options. This class also defines thesetOption andgetOption methods to set and query socket options. ADatagramSocket supports the following socket options:

Socket options
Option NameDescription
SO_SNDBUF The size of the socket send buffer in bytes
SO_RCVBUF The size of the socket receive buffer in bytes
SO_REUSEADDR Re-use address
SO_BROADCAST Allow transmission of broadcast datagrams
IP_TOS The Type of Service (ToS) octet in the Internet Protocol (IP) header

In addition, theDatagramSocket class defines methods tojoin andleave a multicast group, and supportsmulticast options which are useful whenjoining,leaving, or sending datagrams to a multicast group. The following multicast options are supported:

Multicast options
Option NameDescription
IP_MULTICAST_IF The network interface for Internet Protocol (IP) multicast datagrams
IP_MULTICAST_TTL Thetime-to-live for Internet Protocol (IP) multicast datagrams
IP_MULTICAST_LOOP Loopback for Internet Protocol (IP) multicast datagrams
An implementation may also support additional options.
API Note:
Multicasting with DatagramSocket

DatagramChannel implements theMulticastChannel interface and provides an alternative API for sending and receiving multicast datagrams. TheMulticastChannel API supports bothany-source andsource-specific multicast. Consider usingDatagramChannel for multicasting.

DatagramSocket can be used directly for multicasting. However, contrarily toMulticastSocket,DatagramSocket doesn't call thesetReuseAddress(boolean) method to enable the SO_REUSEADDR socket option by default. If creating aDatagramSocket intended to later join a multicast group, the caller should consider explicitly enabling the SO_REUSEADDR option.

An instance ofDatagramSocket can be used to send or receive multicast datagram packets. It is not necessary to join a multicast group in order to send multicast datagrams. Before sending out multicast datagram packets however, the default outgoing interface for sending multicast datagram should first be configured usingsetOption andStandardSocketOptions.IP_MULTICAST_IF:

    DatagramSocket sender = new DatagramSocket(new InetSocketAddress(0));    NetworkInterface outgoingIf = NetworkInterface.getByName("en0");    sender.setOption(StandardSocketOptions.IP_MULTICAST_IF, outgoingIf);    // optionally configure multicast TTL; the TTL defines the scope of a    // multicast datagram, for example, confining it to host local (0) or    // link local (1) etc...    int ttl = ...; // a number between 0 and 255    sender.setOption(StandardSocketOptions.IP_MULTICAST_TTL, ttl);    // send a packet to a multicast group    byte[] msgBytes = ...;    InetAddress mcastaddr = InetAddress.getByName("228.5.6.7");    int port = 6789;    InetSocketAddress dest = new InetSocketAddress(mcastaddr, port);    DatagramPacket hi = new DatagramPacket(msgBytes, msgBytes.length, dest);    sender.send(hi);

An instance ofDatagramSocket can also be used to receive multicast datagram packets. ADatagramSocket that is created with the intent of receiving multicast datagrams should be createdunbound. Before binding the socket,setReuseAddress(true) should be configured:

    DatagramSocket socket = new DatagramSocket(null); // unbound    socket.setReuseAddress(true); // set reuse address before binding    socket.bind(new InetSocketAddress(6789)); // bind    // joinGroup 228.5.6.7    InetAddress mcastaddr = InetAddress.getByName("228.5.6.7");    InetSocketAddress group = new InetSocketAddress(mcastaddr, 0);    NetworkInterface netIf = NetworkInterface.getByName("en0");    socket.joinGroup(group, netIf);    byte[] msgBytes = new byte[1024]; // up to 1024 bytes    DatagramPacket packet = new DatagramPacket(msgBytes, msgBytes.length);    socket.receive(packet);    ....    // eventually leave group    socket.leaveGroup(group, netIf);

Platform dependencies

The multicast implementation is intended to map directly to the native multicasting facility. Consequently, the following items should be considered when developing an application that receives IP multicast datagrams:

  1. Contrarily toDatagramChannel, the constructors ofDatagramSocket do not allow to specify theProtocolFamily of the underlying socket. Consequently, the protocol family of the underlying socket may not correspond to the protocol family of the multicast groups that theDatagramSocket will attempt to join.
    There is no guarantee that aDatagramSocket with an underlying socket created in one protocol family can join and receive multicast datagrams when the address of the multicast group corresponds to another protocol family. For example, it is implementation specific if aDatagramSocket to an IPv6 socket can join an IPv4 multicast group and receive multicast datagrams sent to the group.
  2. Before joining a multicast group, theDatagramSocket should be bound to the wildcard address. If the socket is bound to a specific address, rather than the wildcard address then it is implementation specific if multicast datagrams are received by the socket.
  3. The SO_REUSEADDR option should be enabled prior to binding the socket. This is required to allow multiple members of the group to bind to the same address.
Since:
1.0
See Also:

  • Constructor Details

    • DatagramSocket

      public DatagramSocket() throwsSocketException
      Constructs a datagram socket and binds it to any available port on the local host machine. The socket will be bound to thewildcard address.

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

      Throws:
      SocketException - if the socket could not be opened, or the socket could not be bound.
      SecurityException - if a security manager exists and itscheckListen method doesn't allow the operation.
      See Also:

    • DatagramSocket

      protected DatagramSocket(DatagramSocketImpl impl)
      Creates an unbound datagram socket with the specified DatagramSocketImpl.
      Parameters:
      impl - an instance of aDatagramSocketImpl the subclass wishes to use on the DatagramSocket.
      Since:
      1.4

    • DatagramSocket

      public DatagramSocket(SocketAddress bindaddr) throwsSocketException
      Creates a datagram socket, bound to the specified local socket address.

      If the address isnull an unbound socket will be created.

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

      Parameters:
      bindaddr - local socket address to bind, ornull for an unbound socket.
      Throws:
      SocketException - if the socket could not be opened, or the socket could not bind to the specified local port.
      SecurityException - if a security manager exists and itscheckListen method doesn't allow the operation.
      IllegalArgumentException - if bindaddr is a SocketAddress subclass not supported by this socket.
      Since:
      1.4
      See Also:

    • DatagramSocket

      public DatagramSocket(int port) throwsSocketException
      Constructs a datagram socket and binds it to the specified port on the local host machine. The socket will be bound to thewildcard address.

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

      Parameters:
      port - local port to use in the bind operation.
      Throws:
      SocketException - if the socket could not be opened, or the socket could not bind to the specified local port.
      SecurityException - if a security manager exists and itscheckListen method doesn't allow the operation.
      IllegalArgumentException - if port is out of range.
      See Also:

    • DatagramSocket

      public DatagramSocket(int port,InetAddress laddr) throwsSocketException
      Creates a datagram socket, bound to the specified local address.

      The local port must be between 0 and 65535 inclusive. A port number ofzero will let the system pick up an ephemeral port in abind operation.

      If the IP address is awildcard address, or isnull, the socket will be bound to the wildcard address.

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

      Parameters:
      port - local port to use in the bind operation.
      laddr - local address to bind (can benull)
      Throws:
      SocketException - if the socket could not be opened, or the socket could not bind to the specified local port.
      SecurityException - if a security manager exists and itscheckListen method doesn't allow the operation.
      IllegalArgumentException - if port is out of range.
      Since:
      1.1
      See Also:

  • Method Details

    • bind

      public void bind(SocketAddress addr) throwsSocketException
      Binds this DatagramSocket to a specific address and port.

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

      Parameters:
      addr - The address and port to bind to.
      Throws:
      SocketException - if any error happens during the bind, or if the socket is already bound.
      SecurityException - if a security manager exists and itscheckListen method doesn't allow the operation.
      IllegalArgumentException - if addr is a SocketAddress subclass not supported by this socket.
      Since:
      1.4

    • connect

      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 socket is already closed, then this method has no effect.

      If this socket is not bound then this method will first cause the socket to be bound to an address that is assigned automatically, as if invoking thebind method with a parameter ofnull. 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 givenaddress is amulticast address, the security manager'scheckMulticast method is invoked with the givenaddress. Otherwise, the security manager'scheckConnect andcheckAccept methods are invoked, with the givenaddress andport, to verify that datagrams are permitted to be sent and received respectively.

      Care should be taken to ensure that a connected datagram socket is not shared with untrusted code. When a socket is connected,receive andsendwill 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, anIllegalArgumentException will be thrown. A socket connected to a multicast address may only be used to send packets. Datagrams in the socket'ssocket receive buffer, which have not beenreceived before invoking this method, may be discarded.

      Parameters:
      address - the remote address for the socket
      port - the remote port for the socket.
      Throws:
      IllegalArgumentException - if the address is null, or the port is out of range.
      SecurityException - if a security manager has been installed and it does not permit access to the given remote address
      UncheckedIOException - may be thrown if connect fails, for example, if the destination address is non-routable
      Since:
      1.2
      See Also:

    • connect

      public void connect(SocketAddress addr) throwsSocketException
      Connects this socket to a remote socket address (IP address + port number).

      If given anInetSocketAddress, this method behaves as if invokingconnect(InetAddress,int) with the given socket addresses IP address and port number, except that theSocketException that may be raised is not wrapped in anUncheckedIOException. Datagrams in the socket'ssocket receive buffer, which have not beenreceived before invoking this method, may be discarded.

      Parameters:
      addr - The remote address.
      Throws:
      SocketException - if the connect fails
      IllegalArgumentException - ifaddr isnull, oraddr is a SocketAddress subclass not supported by this socket
      SecurityException - if a security manager has been installed and it does not permit access to the given remote address
      Since:
      1.4

    • disconnect

      public void disconnect()
      Disconnects the socket. If the socket is closed or not connected, then this method has no effect.
      API Note:
      If this method throws an UncheckedIOException, the socket may be left in an unspecified state. It is strongly recommended that the socket be closed when disconnect fails.
      Throws:
      UncheckedIOException - may be thrown if disconnect fails to dissolve the association and restore the socket to a consistent state.
      Since:
      1.2
      See Also:

    • isBound

      public boolean isBound()
      Returns the binding state of the socket.

      If the socket was bound prior to beingclosed, then this method will continue to returntrue after the socket is closed.

      Returns:
      true if the socket successfully bound to an address
      Since:
      1.4

    • isConnected

      public boolean isConnected()
      Returns the connection state of the socket.

      If the socket was connected prior to beingclosed, then this method will continue to returntrue after the socket is closed.

      Returns:
      true if the socket successfully connected to a server
      Since:
      1.4

    • getInetAddress

      public InetAddress getInetAddress()
      Returns the address to which this socket is connected. Returnsnull if the socket is not connected.

      If the socket was connected prior to beingclosed, then this method will continue to return the connected address after the socket is closed.

      Returns:
      the address to which this socket is connected.
      Since:
      1.2

    • getPort

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

      Returns:
      the port number to which this socket is connected.
      Since:
      1.2

    • getRemoteSocketAddress

      public SocketAddress getRemoteSocketAddress()
      Returns the address of the endpoint this socket is connected to, ornull if it is unconnected.

      If the socket was connected prior to beingclosed, then this method will continue to return the connected address after the socket is closed.

      Returns:
      aSocketAddress representing the remote endpoint of this socket, ornull if it is not connected yet.
      Since:
      1.4
      See Also:

    • getLocalSocketAddress

      public SocketAddress getLocalSocketAddress()
      Returns the address of the endpoint this socket is bound to.

      If the socket was initially bound to the wildcard address and is nowconnected, then the address returned may be the local address selected as the source address for datagrams sent on this socket instead of the wildcard address. Whendisconnect() is called, the bound address reverts to the wildcard address.

      Returns:
      aSocketAddress representing the local endpoint of this socket, ornull if it is closed or not bound yet.
      Since:
      1.4
      See Also:

    • send

      public void send(DatagramPacket p) throwsIOException
      Sends a datagram packet from this socket. TheDatagramPacket 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, ifp.getAddress().isMulticastAddress() is true, this method calls the security manager'scheckMulticast method withp.getAddress() as its argument. If the evaluation of that expression is false, this method instead calls the security manager'scheckConnect method with argumentsp.getAddress().getHostAddress() andp.getPort(). Each call to a security manager method could result in a SecurityException if the operation is not allowed.

      Parameters:
      p - theDatagramPacket to be sent.
      Throws:
      IOException - if an I/O error occurs.
      SecurityException - if a security manager exists and itscheckMulticast orcheckConnect method doesn't allow the send.
      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.
      IllegalBlockingModeException - if this socket has an associated channel, and the channel is in non-blocking mode.
      IllegalArgumentException - if the socket is connected, and connected address and packet address differ, or if the socket is not connected and the packet address is not set or if its port isout of range.
      See Also:

    • receive

      public void receive(DatagramPacket p) throwsIOException
      Receives a datagram packet from this socket. This method blocks until a datagram is received. When this method returns, theDatagramPacket'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. Thelength 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.

      This method isinterruptible in the following circumstances:

      1. The datagram socket isassociated with aDatagramChannel. In that case, interrupting a thread receiving a datagram packet will close the underlying channel and cause this method to throwClosedByInterruptException with the interrupt status set.
      2. The datagram socket uses the system-default socket implementation and avirtual thread is receiving a datagram packet. In that case, interrupting the virtual thread will cause it to wakeup and close the socket. This method will then throwSocketException with the interrupt status set.

      If there is a security manager, and the socket is not currently connected to a remote address, a packet cannot be received if the security manager'scheckAccept method does not allow it. Datagrams that are not permitted by the security manager are silently discarded.

      Parameters:
      p - theDatagramPacket into which to place the incoming data.
      Throws:
      IOException - if an I/O error occurs.
      SocketTimeoutException - if setSoTimeout was previously called and the timeout has expired.
      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.
      IllegalBlockingModeException - if this socket has an associated channel, and the channel is in non-blocking mode.
      See Also:

    • getLocalAddress

      public InetAddress getLocalAddress()
      Gets the local address to which the socket is bound.

      If the socket was initially bound to the wildcard address and is nowconnected, then the address returned may be the local address selected as the source address for datagrams sent on the socket instead of the wildcard address. Whendisconnect() is called, the bound address reverts to the wildcard address.

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

      Returns:
      the local address to which the socket is bound,null if the socket is closed, or anInetAddress representingwildcard address if either the socket is not bound, or the security managercheckConnect method does not allow the operation
      Since:
      1.1
      See Also:

    • getLocalPort

      public int getLocalPort()
      Returns the port number on the local host to which this socket is bound.
      Returns:
      the port number on the local host to which this socket is bound,-1 if the socket is closed, or0 if it is not bound yet.

    • setSoTimeout

      public void setSoTimeout(int timeout) throwsSocketException
      Enable/disable SO_TIMEOUT with the specified timeout, in milliseconds. With this option set to a positive timeout value, a call to receive() for this DatagramSocket will block for only this amount of time. If the timeout expires, ajava.net.SocketTimeoutException is raised, though the DatagramSocket is still valid. A timeout of zero is interpreted as an infinite timeout. The optionmust be enabled prior to entering the blocking operation to have effect.
      Parameters:
      timeout - the specified timeout in milliseconds.
      Throws:
      SocketException - if there is an error in the underlying protocol, such as an UDP error.
      IllegalArgumentException - iftimeout is negative
      Since:
      1.1
      See Also:

    • getSoTimeout

      public int getSoTimeout() throwsSocketException
      Retrieve setting for SO_TIMEOUT. 0 returns implies that the option is disabled (i.e., timeout of infinity).
      Returns:
      the setting for SO_TIMEOUT
      Throws:
      SocketException - if there is an error in the underlying protocol, such as an UDP error.
      Since:
      1.1
      See Also:

    • setSendBufferSize

      public void setSendBufferSize(int size) throwsSocketException
      Sets the SO_SNDBUF option to the specified value for thisDatagramSocket. 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 callgetSendBufferSize().

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

      Note: Ifsend(DatagramPacket) is used to send aDatagramPacket that is larger than the setting of SO_SNDBUF then it is implementation specific if the packet is sent or discarded.

      API Note:
      Ifsize > 0, this method is equivalent to callingsetOption(StandardSocketOptions.SO_SNDBUF, size).
      Parameters:
      size - the size to which to set the send buffer size, in bytes. This value must be greater than 0.
      Throws:
      SocketException - if there is an error in the underlying protocol, such as an UDP error.
      IllegalArgumentException - if the value is 0 or is negative.
      Since:
      1.2
      See Also:

    • getSendBufferSize

      public int getSendBufferSize() throwsSocketException
      Get value of the SO_SNDBUF option for thisDatagramSocket, that is the buffer size, in bytes, used by the platform for output on thisDatagramSocket.
      API Note:
      This method is equivalent to callinggetOption(StandardSocketOptions.SO_SNDBUF).
      Returns:
      the value of the SO_SNDBUF option for thisDatagramSocket
      Throws:
      SocketException - if there is an error in the underlying protocol, such as an UDP error.
      Since:
      1.2
      See Also:

    • setReceiveBufferSize

      public void setReceiveBufferSize(int size) throwsSocketException
      Sets the SO_RCVBUF option to the specified value for thisDatagramSocket. 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 callgetReceiveBufferSize().

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

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

      API Note:
      Ifsize > 0, this method is equivalent to callingsetOption(StandardSocketOptions.SO_RCVBUF, size).
      Parameters:
      size - the size to which to set the receive buffer size, in bytes. This value must be greater than 0.
      Throws:
      SocketException - if there is an error in the underlying protocol, such as an UDP error.
      IllegalArgumentException - if the value is 0 or is negative.
      Since:
      1.2
      See Also:

    • getReceiveBufferSize

      public int getReceiveBufferSize() throwsSocketException
      Get value of the SO_RCVBUF option for thisDatagramSocket, that is the buffer size, in bytes, used by the platform for input on thisDatagramSocket.
      API Note:
      This method is equivalent to callinggetOption(StandardSocketOptions.SO_RCVBUF).
      Returns:
      the value of the SO_RCVBUF option for thisDatagramSocket
      Throws:
      SocketException - if there is an error in the underlying protocol, such as an UDP error.
      Since:
      1.2
      See Also:

    • setReuseAddress

      public void setReuseAddress(boolean on) throwsSocketException
      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 (SeeMulticastSocket). TheSO_REUSEADDR socket option allows multiple sockets to be bound to the same socket address if theSO_REUSEADDR socket option is enabled prior to binding the socket usingbind(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 thengetReuseAddress() will always returnfalse.

      When aDatagramSocket is created the initial setting ofSO_REUSEADDR is disabled.

      The behaviour whenSO_REUSEADDR is enabled or disabled after a socket is bound (SeeisBound()) is not defined.

      API Note:
      This method is equivalent to callingsetOption(StandardSocketOptions.SO_REUSEADDR, on).
      Parameters:
      on - whether to enable or disable the
      Throws:
      SocketException - if an error occurs enabling or disabling theSO_REUSEADDR socket option, or the socket is closed.
      Since:
      1.4
      See Also:

    • getReuseAddress

      public boolean getReuseAddress() throwsSocketException
      Tests if SO_REUSEADDR is enabled.
      API Note:
      This method is equivalent to callinggetOption(StandardSocketOptions.SO_REUSEADDR).
      Returns:
      aboolean indicating whether or not SO_REUSEADDR is enabled.
      Throws:
      SocketException - if there is an error in the underlying protocol, such as an UDP error.
      Since:
      1.4
      See Also:

    • setBroadcast

      public void setBroadcast(boolean on) throwsSocketException
      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.

      API Note:
      This method is equivalent to callingsetOption(StandardSocketOptions.SO_BROADCAST, on).
      Parameters:
      on - whether or not to have broadcast turned on.
      Throws:
      SocketException - if there is an error in the underlying protocol, such as an UDP error.
      Since:
      1.4
      See Also:

    • getBroadcast

      public boolean getBroadcast() throwsSocketException
      Tests if SO_BROADCAST is enabled.
      API Note:
      This method is equivalent to callinggetOption(StandardSocketOptions.SO_BROADCAST).
      Returns:
      aboolean indicating whether or not SO_BROADCAST is enabled.
      Throws:
      SocketException - if there is an error in the underlying protocol, such as an UDP error.
      Since:
      1.4
      See Also:

    • setTrafficClass

      public void setTrafficClass(int tc) throwsSocketException
      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 tcmust be in the range0 <= tc <= 255 or an IllegalArgumentException will be thrown.

      Notes:

      For Internet Protocol v4 the value consists of aninteger, 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 v6tc is the value that would be placed into the sin6_flowinfo field of the IP header.

      API Note:
      This method is equivalent to callingsetOption(StandardSocketOptions.IP_TOS, tc).
      Parameters:
      tc - anint value for the bitset.
      Throws:
      SocketException - if there is an error setting the traffic class or type-of-service
      Since:
      1.4
      See Also:

    • getTrafficClass

      public int getTrafficClass() throwsSocketException
      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 usingsetTrafficClass(int) this method may return a different value than was previously set using thesetTrafficClass(int) method on this DatagramSocket.

      API Note:
      This method is equivalent to callinggetOption(StandardSocketOptions.IP_TOS).
      Returns:
      the traffic class or type-of-service already set
      Throws:
      SocketException - if there is an error obtaining the traffic class or type-of-service value.
      Since:
      1.4
      See Also:

    • close

      public void close()
      Closes this datagram socket.

      Any thread currently blocked inreceive(java.net.DatagramPacket) upon this socket will throw aSocketException.

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

      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable

    • isClosed

      public boolean isClosed()
      Returns whether the socket is closed or not.
      Returns:
      true if the socket has been closed
      Since:
      1.4

    • getChannel

      public DatagramChannel getChannel()
      Returns the uniqueDatagramChannel 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 theDatagramChannel.open method.

      Returns:
      the datagram channel associated with this datagram socket, ornull if this socket was not created for a channel
      Since:
      1.4

    • setDatagramSocketImplFactory

      @Deprecated(since="17")public static void setDatagramSocketImplFactory(DatagramSocketImplFactory fac) throwsIOException
      Deprecated.
      UseDatagramChannel, or subclassDatagramSocket directly.
      This method provided a way in early JDK releases to replace the system wide implementation ofDatagramSocket. It has been mostly obsolete since Java 1.4. If required, aDatagramSocket can be created to use a custom implementation by extendingDatagramSocket and using theprotected constructor that takes animplementation as a parameter.
      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'screateDatagramSocketImpl method is called to create the actual datagram socket implementation.

      Passingnull 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'scheckSetFactory method to ensure the operation is allowed. This could result in a SecurityException.

      Parameters:
      fac - the desired factory.
      Throws:
      IOException - if an I/O error occurs when setting the datagram socket factory.
      SocketException - if the factory is already defined.
      SecurityException - if a security manager exists and itscheckSetFactory method doesn't allow the operation.
      Since:
      1.3
      See Also:

    • setOption

      public <T> DatagramSocket setOption(SocketOption<T> name, T value) throwsIOException
      Sets the value of a socket option.
      Type Parameters:
      T - The type of the socket option value
      Parameters:
      name - The socket option
      value - The value of the socket option. A value ofnull may be valid for some options.
      Returns:
      this DatagramSocket
      Throws:
      UnsupportedOperationException - if the datagram socket does not support the option.
      IllegalArgumentException - if the value is not valid for the option.
      IOException - if an I/O error occurs, or if the socket is closed.
      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.StandardSocketOptions do not require any security permission.
      NullPointerException - if name isnull
      Since:
      9

    • getOption

      public <T> T getOption(SocketOption<T> name) throwsIOException
      Returns the value of a socket option.
      Type Parameters:
      T - The type of the socket option value
      Parameters:
      name - The socket option
      Returns:
      The value of the socket option.
      Throws:
      UnsupportedOperationException - if the datagram socket does not support the option.
      IOException - if an I/O error occurs, or if the socket is closed.
      NullPointerException - if name isnull
      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.StandardSocketOptions do not require any security permission.
      Since:
      9

    • supportedOptions

      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.
      Returns:
      A set of the socket options supported by this socket. This set may be empty if the socket's DatagramSocketImpl cannot be created.
      Since:
      9

    • joinGroup

      public void joinGroup(SocketAddress mcastaddr,NetworkInterface netIf) throwsIOException
      Joins a multicast group.

      In order to join a multicast group, the caller should specify the IP address of the multicast group to join, and the localnetwork interface to receive multicast packets from.

      • Themcastaddr argument indicates the IP address of the multicast group to join. For historical reasons this is specified as aSocketAddress. The default implementation only supportsInetSocketAddress and theport information is ignored.
      • ThenetIf argument specifies the local interface to receive multicast datagram packets, ornull to defer to the interface set for outgoing multicast datagrams. Ifnull, and no interface has been set, the behaviour is unspecified: any interface may be selected or the operation may fail with aSocketException.

      It is possible to call this method several times to join several different multicast groups, or join the same group in several different networks. However, if the socket is already a member of the group, anIOException will be thrown.

      If there is a security manager, this method first calls itscheckMulticast method with themcastaddr argument as its argument.

      API Note:
      The default interface for sending outgoing multicast datagrams can be configured withsetOption(SocketOption, Object) withStandardSocketOptions.IP_MULTICAST_IF.
      Parameters:
      mcastaddr - indicates the multicast address to join.
      netIf - specifies the local interface to receive multicast datagram packets, ornull.
      Throws:
      IOException - if there is an error joining, or when the address is not a multicast address, or the platform does not support multicasting
      SecurityException - if a security manager exists and itscheckMulticast method doesn't allow the join.
      IllegalArgumentException - if mcastaddr isnull or is a SocketAddress subclass not supported by this socket
      Since:
      17
      See Also:

    • leaveGroup

      public void leaveGroup(SocketAddress mcastaddr,NetworkInterface netIf) throwsIOException
      Leave a multicast group on a specified local interface.

      If there is a security manager, this method first calls itscheckMulticast method with themcastaddr argument as its argument.

      API Note:
      Themcastaddr andnetIf arguments should identify a multicast group that was previouslyjoined by thisDatagramSocket.

      It is possible to call this method several times to leave multiple different multicast groups previously joined, or leave the same group previously joined in multiple different networks. However, if the socket is not a member of the specified group in the specified network, anIOException will be thrown.

      Parameters:
      mcastaddr - is the multicast address to leave. This should contain the same IP address than that used forjoining the group.
      netIf - specifies the local interface ornull to defer to the interface set for outgoing multicast datagrams. Ifnull, and no interface has been set, the behaviour is unspecified: any interface may be selected or the operation may fail with aSocketException.
      Throws:
      IOException - if there is an error leaving or when the address is not a multicast address.
      SecurityException - if a security manager exists and itscheckMulticast method doesn't allow the operation.
      IllegalArgumentException - if mcastaddr isnull or is a SocketAddress subclass not supported by this socket.
      Since:
      17
      See Also: