public final class DatagramPacket extends Object
This class represents a datagram packet.
Datagram packets are used to implement a connectionless packet delivery service. Each message is routed from one machine to another based solely on information contained within that packet. Multiple packets sent from one machine to another might be routed differently, and might arrive in any order. Packet delivery is not guaranteed.
public DatagramPacket(byte[] buf,
int offset,
int length) Constructs a DatagramPacket for receiving packets of length length, specifying an offset into the buffer.
The length argument must be less than or equal to buf.length.
buf - buffer for holding the incoming datagram.offset - the offset for the bufferlength - the number of bytes to read.public DatagramPacket(byte[] buf,
int length) Constructs a DatagramPacket for receiving packets of length length.
The length argument must be less than or equal to buf.length.
buf - buffer for holding the incoming datagram.length - the number of bytes to read.public DatagramPacket(byte[] buf,
int offset,
int length,
InetAddress address,
int port) Constructs a datagram packet for sending packets of length length with offset ioffsetto the specified port number on the specified host. The length argument must be less than or equal to buf.length.
buf - the packet data.offset - the packet data offset.length - the packet data length.address - the destination address.port - the destination port number.InetAddresspublic DatagramPacket(byte[] buf,
int offset,
int length,
SocketAddress address) Constructs a datagram packet for sending packets of length length with offset ioffsetto the specified port number on the specified host. The length argument must be less than or equal to buf.length.
buf - the packet data.offset - the packet data offset.length - the packet data length.address - the destination socket address.IllegalArgumentException - if address type is not supportedInetAddresspublic DatagramPacket(byte[] buf,
int length,
InetAddress address,
int port) Constructs a datagram packet for sending packets of length length to the specified port number on the specified host. The length argument must be less than or equal to buf.length.
buf - the packet data.length - the packet length.address - the destination address.port - the destination port number.InetAddresspublic DatagramPacket(byte[] buf,
int length,
SocketAddress address) Constructs a datagram packet for sending packets of length length to the specified port number on the specified host. The length argument must be less than or equal to buf.length.
buf - the packet data.length - the packet length.address - the destination address.IllegalArgumentException - if address type is not supportedInetAddresspublic InetAddress getAddress()
Returns the IP address of the machine to which this datagram is being sent or from which the datagram was received.
InetAddress, setAddress(java.net.InetAddress)
public int getPort()
Returns the port number on the remote host to which this datagram is being sent or from which the datagram was received.
setPort(int)public byte[] getData()
Returns the data buffer. The data received or the data to be sent starts from the offset in the buffer, and runs for length long.
setData(byte[], int, int)public int getOffset()
Returns the offset of the data to be sent or the offset of the data received.
public int getLength()
Returns the length of the data to be sent or the length of the data received.
setLength(int)public void setData(byte[] buf,
int offset,
int length) Set the data buffer for this packet. This sets the data, length and offset of the packet.
buf - the buffer to set for this packetoffset - the offset into the datalength - the length of the data and/or the length of the buffer used to receive dataNullPointerException - if the argument is nullgetData(), getOffset(), getLength()
public void setAddress(InetAddress iaddr)
Sets the IP address of the machine to which this datagram is being sent.
iaddr - the InetAddress
getAddress()public void setPort(int iport)
Sets the port number on the remote host to which this datagram is being sent.
iport - the port numbergetPort()public void setSocketAddress(SocketAddress address)
Sets the SocketAddress (usually IP address + port number) of the remote host to which this datagram is being sent.
address - the SocketAddress
IllegalArgumentException - if address is null or is a SocketAddress subclass not supported by this socketgetSocketAddress()public SocketAddress getSocketAddress()
Gets the SocketAddress (usually IP address + port number) of the remote host that this packet is being sent to or is coming from.
SocketAddress
setSocketAddress(java.net.SocketAddress)public void setData(byte[] buf)
Set the data buffer for this packet. With the offset of this DatagramPacket set to 0, and the length set to the length of buf.
buf - the buffer to set for this packet.NullPointerException - if the argument is null.getLength(), getData()
public void setLength(int length)
Set the length for this packet. The length of the packet is the number of bytes from the packet's data buffer that will be sent, or the number of bytes of the packet's data buffer that will be used for receiving data. The length must be lesser or equal to the offset plus the length of the packet's buffer.
length - the length to set for this packet.IllegalArgumentException - if the length is negative of if the length is greater than the packet's data buffer length.getLength(), setData(byte[], int, int)
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.