Interface IceDatagramSocket
-
Method Summary
Modifier and TypeMethodDescriptionvoidbind(SocketAddress addr) Binds this DatagramSocket to a specific address invalid input: '&' 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, ornullif it is not bound yet.intgetPort()Returns the port for this socket.intGet value of the SO_RCVBUF option for this DatagramSocket, that is the buffer size used by the platform for input on this DatagramSocket.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 this DatagramSocket, that is the buffer size used by the platform for output on this DatagramSocket.intRetrieve setting for SO_TIMEOUT.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.voidReceives a datagram packet from this socket.voidSends a datagram packet from this socket.voidsetBroadcast(boolean on) Enable/disable SO_BROADCAST.voidsetReceiveBufferSize(int size) Sets the SO_RCVBUF option to the specified value for this DatagramSocket.voidsetReuseAddress(boolean on) Enable/disable the SO_REUSEADDR socket option.voidsetSendBufferSize(int size) Sets the SO_SNDBUF option to the specified value for this DatagramSocket.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.
-
Method Details
-
bind
Binds this DatagramSocket to a specific address invalid input: '&' 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 invalid input: '&' 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 itscheckListenmethod doesn't allow the operation.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 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.
A caller's permission to send and receive datagrams to a given host and port are checked at connect time. When a socket is connected, receive and send will not perform any security checks on incoming and outgoing packets, other than matching the packet's and the socket's address and port. On a send operation, if the packet's address is set and the packet's address and the socket's address do not match, an IllegalArgumentException will be thrown. A socket connected to a multicast address may only be used to send packets.
- 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.SecurityException- if the caller is not allowed to send datagrams to and receive datagrams from the address and port.- See Also:
-
connect
Connects this socket to a remote socket address (IP address + port number).- Parameters:
addr- The remote address.- Throws:
SocketException- if the connect failsIllegalArgumentException- if addr is null or addr is a SocketAddress subclass not supported by this socket- Since:
- 1.4
- See Also:
-
disconnect
void disconnect()Disconnects the socket. This does nothing if the socket is not connected.- See Also:
-
isBound
boolean isBound()Returns the binding state of the socket.- Returns:
- true if the socket succesfuly bound to an address
- Since:
- 1.4
-
isConnected
boolean isConnected()Returns the connection state of the socket.- Returns:
- true if the socket succesfuly connected to a server
- Since:
- 1.4
-
getInetAddress
InetAddress getInetAddress()Returns the address to which this socket is connected. Returns null if the socket is not connected.- Returns:
- the address to which this socket is connected.
-
getPort
int getPort()Returns the port for this socket. Returns -1 if the socket is not connected.- Returns:
- the port to which this socket is connected.
-
getRemoteSocketAddress
SocketAddress getRemoteSocketAddress()Returns the address of the endpoint this socket is connected to, ornullif it is unconnected.- Returns:
- a
SocketAddressrepresenting the remote endpoint of this socket, ornullif it is not connected yet. - Since:
- 1.4
- See Also:
-
getLocalSocketAddress
SocketAddress getLocalSocketAddress()Returns the address of the endpoint this socket is bound to, ornullif it is not bound yet.- Returns:
- a
SocketAddressrepresenting the local endpoint of this socket, ornullif it is 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.If there is a security manager, and the socket is not currently connected to a remote address, this method first performs some security checks. First, if
p.getAddress().isMulticastAddress()is true, this method calls the security manager'scheckMulticastmethod withp.getAddress()as its argument. If the evaluation of that expression is false, this method instead calls the security manager'scheckConnectmethod 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- theDatagramPacketto be sent.- Throws:
IOException- if an I/O error occurs.SecurityException- if a security manager exists and itscheckMulticastorcheckConnectmethod 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.- See Also:
-
receive
Receives a datagram packet from this socket. 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.This method blocks until a datagram is received. The
lengthfield of the datagram packet object contains the length of the received message. If the message is longer than the packet's length, the message is truncated.If there is a security manager, a packet cannot be received if the security manager's
checkAcceptmethod does not allow it.- Parameters:
p- theDatagramPacketinto 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
InetAddress getLocalAddress()Gets the local address to which the socket is bound.If there is a security manager, its
checkConnectmethod is first called with the host address and-1as its arguments to see if the operation is allowed.- Returns:
- the local address to which the socket is bound, or an
InetAddressrepresenting any local address if either the socket is not bound, or the security managercheckConnectmethod does not allow the operation - Since:
- 1.1
- See Also:
-
getLocalPort
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.
-
setSoTimeout
Enable/disable SO_TIMEOUT with the specified timeout, in milliseconds. With this option set to a non-zero timeout, a call to receive() for this DatagramSocket will block for only this amount of time. If the timeout expires, a java.net.SocketTimeoutException is raised, though the DatagramSocket is still valid. The option must be enabled prior to entering the blocking operation to have effect. The timeout must be > 0. A timeout of zero is interpreted as an infinite timeout.- Parameters:
timeout- the specified timeout in milliseconds.- Throws:
SocketException- if there is an error in the underlying protocol, such as an UDP error.- Since:
- JDK1.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.- Since:
- JDK1.1
- See Also:
-
setSendBufferSize
Sets the SO_SNDBUF option to the specified value for this DatagramSocket. The SO_SNDBUF option is used by the network implementation as a hint to size the underlying network I/O buffers. The SO_SNDBUF setting may also be used by the network implementation to determine the maximum size of the packet that can be sent on this socket.As SO_SNDBUF is a hint, applications that want to verify what size the buffer is should call
getSendBufferSize().Increasing the buffer size may allow multiple outgoing packets to be queued by the network implementation when the send rate is high.
Note: If
send(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.- Parameters:
size- the size to which to set the send buffer size. 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.- See Also:
-
getSendBufferSize
Get value of the SO_SNDBUF option for this DatagramSocket, that is the buffer size used by the platform for output on this DatagramSocket.- 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.- See Also:
-
setReceiveBufferSize
Sets the SO_RCVBUF option to the specified value for this DatagramSocket. The SO_RCVBUF option is used by the 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.
- Parameters:
size- the size to which to set the receive buffer size. 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.- See Also:
-
getReceiveBufferSize
Get value of the SO_RCVBUF option for this DatagramSocket, that is the buffer size used by the platform for input on this DatagramSocket.- 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.- 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). The SO_REUSEADDR socket option allows multiple sockets to be bound to the same socket address if the SO_REUSEADDR socket option is enabled prior to binding the socket 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 DatagramSocket is created the initial setting of SO_REUSEADDR is disabled.
The behaviour when SO_REUSEADDR is enabled or disabled after a socket is bound (See
isBound()) is not defined.- Parameters:
on- whether to enable or disable the- Throws:
SocketException- if an error occurs enabling or disabling the SO_RESUEADDR socket option, or the socket is closed.- Since:
- 1.4
- See Also:
-
getReuseAddress
Tests if SO_REUSEADDR is enabled.- 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.- Since:
- 1.4
- See Also:
-
setBroadcast
Enable/disable SO_BROADCAST.- 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
Tests if SO_BROADCAST is enabled.- 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.- 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 invalid input: '<'= tc invalid input: '<'= 255or an IllegalArgumentException will be thrown.Notes:
for Internet Protocol v4 the value consists of an octet with precedence and TOS fields as detailed in RFC 1349. The TOS field is bitset created by bitwise-or'ing values such the following :-
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.- Parameters:
tc- anintvalue for the bitset.- Throws:
SocketException- if there is an error setting the traffic class or type-of-service- 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.- 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
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. revised 1.4 spec JSR-51
-
isClosed
boolean isClosed()Returns whether the socket is closed or not.- Returns:
- true if the socket has been closed
- Since:
- 1.4
-
getChannel
DatagramChannel 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 null if this socket was not created for a channel
- Since:
- 1.4 spec JSR-51
-