Class DatagramSocket
- All Implemented Interfaces:
Closeable,AutoCloseable
- Direct Known Subclasses:
MulticastSocket
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
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.
The DatagramSocket class defines convenience
methods to set and get several socket options. This class also
defines the setOption
and getOption methods to set
and query socket options.
A DatagramSocket supports the following socket options:
Option Name Description SO_SNDBUFThe size of the socket send buffer in bytes SO_RCVBUFThe size of the socket receive buffer in bytes SO_REUSEADDRRe-use address SO_BROADCASTAllow transmission of broadcast datagrams IP_TOSThe Type of Service (ToS) octet in the Internet Protocol (IP) header
In addition, the DatagramSocket class defines methods to join and leave a multicast group, and
supports multicast options which
are useful when joining,
leaving, or sending datagrams
to a multicast group.
The following multicast options are supported:
An implementation may also support additional options.
Option Name Description IP_MULTICAST_IFThe network interface for Internet Protocol (IP) multicast datagrams IP_MULTICAST_TTLThe time-to-live for Internet Protocol (IP) multicast datagrams IP_MULTICAST_LOOPLoopback for Internet Protocol (IP) multicast datagrams
- API Note:
- Multicasting with DatagramSocket
DatagramChannelimplements theMulticastChannelinterface and provides an alternative API for sending and receiving multicast datagrams. TheMulticastChannelAPI supports both any-source and source-specific multicast. Consider usingDatagramChannelfor multicasting.DatagramSocketcan be used directly for multicasting. However, contrarily toMulticastSocket,DatagramSocketdoesn't call thesetReuseAddress(boolean)method to enable the SO_REUSEADDR socket option by default. If creating aDatagramSocketintended to later join a multicast group, the caller should consider explicitly enabling the SO_REUSEADDR option.An instance of
DatagramSocketcan 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 usingsetOptionandStandardSocketOptions.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 of
DatagramSocketcan also be used to receive multicast datagram packets. ADatagramSocketthat is created with the intent of receiving multicast datagrams should be created unbound. 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);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:
- Contrarily to
DatagramChannel, the constructors ofDatagramSocketdo not allow to specify theProtocolFamilyof the underlying socket. Consequently, the protocol family of the underlying socket may not correspond to the protocol family of the multicast groups that theDatagramSocketwill attempt to join.
There is no guarantee that aDatagramSocketwith 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 aDatagramSocketto an IPv6 socket can join an IPv4 multicast group and receive multicast datagrams sent to the group. - Before joining a multicast group, the
DatagramSocketshould 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. - 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.
- Contrarily to
- Since:
- 1.0
- See Also:
-
Constructor Summary
ConstructorsModifierConstructorDescriptionConstructs a datagram socket and binds it to any available port on the local host machine.DatagramSocket(int port) Constructs a datagram socket and binds it to the specified port on the local host machine.DatagramSocket(int port, InetAddress laddr) Creates a datagram socket, bound to the specified local address.protectedCreates an unbound datagram socket with the specified DatagramSocketImpl.DatagramSocket(SocketAddress bindaddr) Creates a datagram socket, bound to the specified local socket address. -
Method Summary
Modifier and TypeMethodDescriptionvoidbind(SocketAddress addr) Binds this DatagramSocket to a specific address and port.voidclose()Closes this datagram socket.voidconnect(InetAddress address, int port) Connects the socket to a remote address for this socket.voidconnect(SocketAddress addr) Connects this socket to a remote socket address (IP address + port number).voidDisconnects the socket.booleanTests if SO_BROADCAST is enabled.Returns the uniqueDatagramChannelobject associated with this datagram socket, if any.Returns the address to which this socket is connected.Gets the local address to which the socket is bound.intReturns the port number on the local host to which this socket is bound.Returns the address of the endpoint this socket is bound to.<T> TgetOption(SocketOption<T> name) Returns the value of a socket option.intgetPort()Returns the port number to which this socket is connected.intGet value of the SO_RCVBUF option for thisDatagramSocket, that is the buffer size, in bytes, used by the platform for input on thisDatagramSocket.Returns the address of the endpoint this socket is connected to, ornullif it is unconnected.booleanTests if SO_REUSEADDR is enabled.intGet value of the SO_SNDBUF option for thisDatagramSocket, that is the buffer size, in bytes, used by the platform for output on thisDatagramSocket.intRetrieve setting for SO_TIMEOUT. 0 returns implies that the option is disabled (i.e., timeout of infinity).intGets traffic class or type-of-service in the IP datagram header for packets sent from this DatagramSocket.booleanisBound()Returns the binding state of the socket.booleanisClosed()Returns whether the socket is closed or not.booleanReturns the connection state of the socket.voidjoinGroup(SocketAddress mcastaddr, NetworkInterface netIf) Joins a multicast group.voidleaveGroup(SocketAddress mcastaddr, NetworkInterface netIf) Leave a multicast group on a specified local interface.voidReceives a datagram packet from this socket.voidSends a datagram packet from this socket.voidsetBroadcast(boolean on) Enable/disable SO_BROADCAST.static voidDeprecated.<T> DatagramSocketsetOption(SocketOption<T> name, T value) Sets the value of a socket option.voidsetReceiveBufferSize(int size) Sets the SO_RCVBUF option to the specified value for thisDatagramSocket.voidsetReuseAddress(boolean on) Enable/disable the SO_REUSEADDR socket option.voidsetSendBufferSize(int size) Sets the SO_SNDBUF option to the specified value for thisDatagramSocket.voidsetSoTimeout(int timeout) Enable/disable SO_TIMEOUT with the specified timeout, in milliseconds.voidsetTrafficClass(int tc) Sets traffic class or type-of-service octet in the IP datagram header for datagrams sent from this DatagramSocket.Set<SocketOption<?>> Returns a set of the socket options supported by this socket.
-
Constructor Details
-
DatagramSocket
Constructs a datagram socket and binds it to any available port on the local host machine. The socket will be bound to thewildcardaddress.- Throws:
SocketException- if the socket could not be opened, or the socket could not be bound.
-
DatagramSocket
Creates an unbound datagram socket with the specified DatagramSocketImpl.- Parameters:
impl- an instance of a DatagramSocketImpl the subclass wishes to use on the DatagramSocket.- Since:
- 1.4
-
DatagramSocket
Creates a datagram socket, bound to the specified local socket address.If the address is
nullan unbound socket will be created.- Parameters:
bindaddr- local socket address to bind, ornullfor an unbound socket.- Throws:
SocketException- if the socket could not be opened, or the socket could not bind to the specified local port.IllegalArgumentException- if bindaddr is a SocketAddress subclass not supported by this socket.- Since:
- 1.4
-
DatagramSocket
Constructs a datagram socket and binds it to the specified port on the local host machine. The socket will be bound to thewildcardaddress.- 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.IllegalArgumentException- if port is out of range.
-
DatagramSocket
Creates a datagram socket, bound to the specified local address.The local port must be between 0 and 65535 inclusive. A port number of
zerowill let the system pick up an ephemeral port in abindoperation.If the IP address is a
wildcardaddress, or isnull, the socket will be bound to the wildcard address.- 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.IllegalArgumentException- if port is out of range.- Since:
- 1.1
-
-
Method Details
-
bind
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.- 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 or is closed.IllegalArgumentException- if addr is a SocketAddress subclass not supported by this socket.- Since:
- 1.4
-
connect
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 the
bindmethod 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 this socket is already connected, then this method will attempt to connect to the given address. If this connect fails then the state of this socket is unknown - it may or may not be connected to the address that it was previously connected to.
When the socket is connected, the send method checks that the packet's address matches the remote address that the socket is connected to. A socket connected to a multicast address may only be used to send packets. Datagrams in the socket's socket receive buffer, which have not been received before invoking this method, may be discarded.
- Parameters:
address- the remote address for the socketport- the remote port for the socket.- Throws:
IllegalArgumentException- if the address is null, or the port is out of range.UncheckedIOException- if the port is 0 or connect fails, for example, if the destination address is non-routable- Since:
- 1.2
- See Also:
-
connect
Connects this socket to a remote socket address (IP address + port number).If given an
InetSocketAddress, this method behaves as if invokingconnect(InetAddress,int)with the given socket addresses IP address and port number, except that theSocketExceptionthat may be raised is not wrapped in anUncheckedIOException. Datagrams in the socket's socket receive buffer, which have not been received before invoking this method, may be discarded.If this socket is already connected, then this method will attempt to connect to the given address. If this connect fails then the state of this socket is unknown - it may or may not be connected to the address that it was previously connected to.
- Parameters:
addr- The remote address.- Throws:
SocketException- if the connect failsIllegalArgumentException- ifaddrisnull, oraddris a SocketAddress subclass not supported by this socket- 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 being
closed, then this method will continue to returntrueafter 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 being
closed, then this method will continue to returntrueafter the socket is closed.- Returns:
- true if the socket successfully connected to a server
- Since:
- 1.4
-
getInetAddress
Returns the address to which this socket is connected. Returnsnullif the socket is not connected.If the socket was connected prior to being
closed, 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-1if the socket is not connected.If the socket was connected prior to being
closed, 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
Returns the address of the endpoint this socket is connected to, ornullif it is unconnected.If the socket was connected prior to being
closed, then this method will continue to return the connected address after the socket is closed.- Returns:
- a
SocketAddressrepresenting the remote endpoint of this socket, ornullif it is not connected yet. - Since:
- 1.4
- See Also:
-
getLocalSocketAddress
Returns the address of the endpoint this socket is bound to.If the socket was initially bound to the wildcard address and is now
connected, 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:
- a
SocketAddressrepresenting the local endpoint of this socket, ornullif it is closed or not bound yet. - Since:
- 1.4
- See Also:
-
send
Sends a datagram packet from this socket. TheDatagramPacketincludes information indicating the data to be sent, its length, the IP address of the remote host, and the port number on the remote host.- Parameters:
p- theDatagramPacketto be sent.- Throws:
IOException- if an I/O error occurs, or the socket is closed.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 is out of range.- See Also:
-
receive
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. Thelengthfield 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 is interruptible in the following circumstances:
- The datagram socket is associated
with a
DatagramChannel. In that case, interrupting a thread receiving a datagram packet will close the underlying channel and cause this method to throwClosedByInterruptExceptionwith the interrupt status set. - The datagram socket uses the system-default socket implementation and
a virtual 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 throw
SocketExceptionwith the interrupt status set.
- Parameters:
p- theDatagramPacketinto which to place the incoming data.- Throws:
IOException- if an I/O error occurs, or the socket is closed.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:
- The datagram socket is associated
with a
-
getLocalAddress
Gets the local address to which the socket is bound.If the socket was initially bound to the wildcard address and is now
connected, 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.- Returns:
- the local address to which the socket is bound,
nullif the socket is closed, or anInetAddressrepresentingwildcardaddress if the socket is not bound - Since:
- 1.1
-
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,
-1if the socket is closed, or0if it is not bound yet.
-
setSoTimeout
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, a java.net.SocketTimeoutException is raised, though the DatagramSocket is still valid. A timeout of zero is interpreted as an infinite timeout. The option must 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, or the socket is closed.IllegalArgumentException- iftimeoutis negative- Since:
- 1.1
- See Also:
-
getSoTimeout
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, or the socket is closed.- Since:
- 1.1
- See Also:
-
setSendBufferSize
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 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(DatagramPacket)is used to send aDatagramPacketthat is larger than the setting of SO_SNDBUF then it is implementation specific if the packet is sent or discarded.- API Note:
- If
size > 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, or the socket is closed.IllegalArgumentException- if the value is 0 or is negative.- Since:
- 1.2
- See Also:
-
getSendBufferSize
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 calling
getOption(StandardSocketOptions.SO_SNDBUF). - Returns:
- the value of the SO_SNDBUF option for this
DatagramSocket - Throws:
SocketException- if there is an error in the underlying protocol, such as an UDP error, or the socket is closed.- Since:
- 1.2
- See Also:
-
setReceiveBufferSize
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 call
getReceiveBufferSize().Increasing SO_RCVBUF may allow the network implementation to buffer multiple packets when packets arrive faster than are being received using
receive(DatagramPacket).Note: It is implementation specific if a packet larger than SO_RCVBUF can be received.
- API Note:
- If
size > 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, or the socket is closed.IllegalArgumentException- if the value is 0 or is negative.- Since:
- 1.2
- See Also:
-
getReceiveBufferSize
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 calling
getOption(StandardSocketOptions.SO_RCVBUF). - Returns:
- the value of the SO_RCVBUF option for this
DatagramSocket - Throws:
SocketException- if there is an error in the underlying protocol, such as an UDP error, or the socket is closed.- Since:
- 1.2
- See Also:
-
setReuseAddress
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
MulticastSocket). TheSO_REUSEADDRsocket option allows multiple sockets to be bound to the same socket address if theSO_REUSEADDRsocket 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 then
getReuseAddress()will always returnfalse.When a
DatagramSocketis created the initial setting ofSO_REUSEADDRis disabled.The behaviour when
SO_REUSEADDRis enabled or disabled after a socket is bound (SeeisBound()) is not defined.- API Note:
- This method is equivalent to calling
setOption(StandardSocketOptions.SO_REUSEADDR, on). - Parameters:
on- whether to enable or disable the- Throws:
SocketException- if an error occurs enabling or disabling theSO_REUSEADDRsocket option, or the socket is closed.- Since:
- 1.4
- See Also:
-
getReuseAddress
Tests if SO_REUSEADDR is enabled.- API Note:
- This method is equivalent to calling
getOption(StandardSocketOptions.SO_REUSEADDR). - Returns:
- a
booleanindicating whether or not SO_REUSEADDR is enabled. - Throws:
SocketException- if there is an error in the underlying protocol, such as an UDP error, or the socket is closed.- Since:
- 1.4
- See Also:
-
setBroadcast
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 calling
setOption(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, or the socket is closed.- Since:
- 1.4
- See Also:
-
getBroadcast
Tests if SO_BROADCAST is enabled.- API Note:
- This method is equivalent to calling
getOption(StandardSocketOptions.SO_BROADCAST). - Returns:
- a
booleanindicating whether or not SO_BROADCAST is enabled. - Throws:
SocketException- if there is an error in the underlying protocol, such as an UDP error, or the socket is closed.- Since:
- 1.4
- See Also:
-
setTrafficClass
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 <= 255or 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
tcis the value that would be placed into the sin6_flowinfo field of the IP header.- API Note:
- This method is equivalent to calling
setOption(StandardSocketOptions.IP_TOS, tc). - Parameters:
tc- anintvalue for the bitset.- Throws:
SocketException- if there is an error setting the traffic class or type-of-service, or the socket is closed.- Since:
- 1.4
- See Also:
-
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
setTrafficClass(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 calling
getOption(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, or the socket is closed.- Since:
- 1.4
- See Also:
-
close
public void close()Closes this datagram socket.Any thread currently blocked in
receive(java.net.DatagramPacket)upon this socket will throw aSocketException.If this socket has an associated channel then the channel is closed as well.
Once closed, several of the methods defined by this class will throw an exception if invoked on the closed socket.
- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable
-
isClosed
public boolean isClosed()Returns whether the socket is closed or not.- Returns:
- true if the socket has been closed
- Since:
- 1.4
-
getChannel
Returns the uniqueDatagramChannelobject 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
DatagramChannel.openmethod.- Returns:
- the datagram channel associated with this datagram socket,
or
nullif this socket was not created for a channel - Since:
- 1.4
-
setDatagramSocketImplFactory
@Deprecated(since="17") public static void setDatagramSocketImplFactory(DatagramSocketImplFactory fac) throws IOException Deprecated.UseDatagramChannel, or subclassDatagramSocketdirectly.
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, aDatagramSocketcan be created to use a custom implementation by extendingDatagramSocketand using the protected constructor that takes an implementation 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's
createDatagramSocketImplmethod is called to create the actual datagram socket implementation.Passing
nullto the method is a no-op unless the factory was already set.- 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.- Since:
- 1.3
- See Also:
-
setOption
Sets the value of a socket option.- Type Parameters:
T- The type of the socket option value- Parameters:
name- The socket optionvalue- The value of the socket option. A value ofnullmay 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.NullPointerException- if name isnull- Since:
- 9
-
getOption
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- Since:
- 9
-
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
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 local network interface to receive multicast packets from.
- The
mcastaddrargument indicates the IP address of the multicast group to join. For historical reasons this is specified as aSocketAddress. The default implementation only supportsInetSocketAddressand theportinformation is ignored. - The
netIfargument specifies the local interface to receive multicast datagram packets, ornullto 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, an
IOExceptionwill be thrown.- API Note:
- The default interface for sending outgoing multicast datagrams
can be configured with
setOption(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, or the socket is closedIllegalArgumentException- if mcastaddr isnullor is a SocketAddress subclass not supported by this socket- Since:
- 17
- See Also:
- The
-
leaveGroup
Leave a multicast group on a specified local interface.- API Note:
- The
mcastaddrandnetIfarguments should identify a multicast group that was previously joined 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, an
IOExceptionwill be thrown. - Parameters:
mcastaddr- is the multicast address to leave. This should contain the same IP address than that used for joining the group.netIf- specifies the local interface ornullto 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, or the socket is closed.IllegalArgumentException- if mcastaddr isnullor is a SocketAddress subclass not supported by this socket.- Since:
- 17
- See Also:
-
DatagramChannel, or subclassDatagramSocketdirectly.