Java.net.DatagramPacket class in Java

This class provides facility for connection less transfer of messages from one system to another. Each message is routed only on the basis of information contained within the packet and it may be possible for different packets to route differently. There is also no guarantee as to whether the message will be delivered or not, and they may also arrive out of order. This class provides mechanisms for creation of datagram packets for connectionless delivery using datagram socket class. 
Constructors : The constructors vary according to their use, i.e. for receiving or for sending the packet. The important parameters used in these constructors are- 
 

1. buf : This is the actual message that is to be delivered or received. Datagram packets receive or send data in stuffed in a byte array. If this is used in constructor for sending the message, than this represents the message to be delivered, when used for receiving purpose, it represents the buffer where the received message will be stored.
2. offset : It represents the offset into the buffer array.
3. length : It is the actual size of packet to receive. This must be less than or equal to the size of buffer array or else there will be overflow as received message wont fit into the array.
4. InetAddress address : This is the destination to which the message is to be delivered.
5. port : This is the port to which the message will be delivered.
6. SocketAddress address : The information about the address and port can be represented with the help of socket address. Same function as the above two combined.

For sending purpose, following constructors are used : 
 

Syntax :public DatagramPacket(byte[] buf,
              int offset,
              int length,
              InetAddress address,
              int port)
Parameters :
buf : byte array
offset : offset into the array
length : length of message to deliver
address : address of destination
port : port number of destination

Syntax :public DatagramPacket(byte[] buf,
              int offset,
              int length,
              SocketAddress address)
Parameters :
buf : byte array
offset : offset into the array
length : length of message to deliver
address : socket address of destination

Syntax :public DatagramPacket(byte[] buf,
              int length,
              InetAddress address,
              int port)
Parameters :
buf : byte array
length : length of message to deliver
address : address of destination
port : port number of destination

Syntax :public DatagramPacket(byte[] buf,
              int length,
              SocketAddress address)
Parameters :
buf : byte array
length : length of message to deliver
address : socket address of destination

For receiving purpose, following constructors are used : 
 

Syntax :public DatagramPacket(byte[] buf,
              int offset,
              int length)
Parameters :
buf : byte array
offset : offset into the array
length : length of message to deliver

Syntax :public DatagramPacket(byte[] buf,
              int length)
Parameters :
buf : byte array
length : length of message to deliver

Methods : 
 

1. getAddress() : Returns the IP address to which this packet is sent to or from which it was received. 
    

Syntax :public InetAddress getAddress()

1. getPort() : Returns the port to which this packet is sent to or from which it was received. This method is specifically used on the server from getting the port of the client who sent the request. 
    

Syntax : public int getPort()

1. getData() : Returns the data contained in this packet as a byte array. The data starts from the offset specified and is of length specified. 
    

Syntax : public byte[] getData()

1. getOffset() : Returns the offset specified. 
    

Syntax : public int getOffset()

1. getLength() : Returns the length of the data to send or receive 
    

Syntax : public int getLength()

1. setData() : Used to set the data of this packet. 
    

Syntax : public void setData(byte[] buf,
           int offset,
           int length)
Parameters :
buf : data buffer
offset :offset into the data
length : length of the data

Syntax : public void setData(byte[] buf)
Parameters :
buf : data buffer

1. setAddress() : Used to set the address to which this packet is sent. 
    

Syntax : public void setAddress(InetAddress iaddr)
Parameters : 
iaddr : InetAddress of the recipient

1. setPort() : Set the port on which destination will receive this packet. 
    

Syntax :public void setPort(int iport)
Parameters : 
iport : the port number

1. setSocketAddress() : Used to set the socket address of the destination(IP address+ port number). 
    

Syntax : public void setSocketAddress(SocketAddress address)
Parameters :
address : socket address

1. getSocketAddress() : Returns the socket address of this packet. In case it was received, return the socket address of the host machine. 
    

Syntax : public SocketAddress getSocketAddress()

1. setLength() : Used to set the length for this packet. 
    

Syntax :public void setLength(int length)
Parameters :
length : length of the packet

Java Implementation : 
 

Output : 
 

Address : localhost/127.0.0.1
Port : 2525
Length : 4
Data : [15, 16, 17, 18, 19]
Socket Address : localhost/127.0.0.1:2525
Offset : 0

For a detailed implementation of a client-server program that uses datagram socket to send the actual packets over the network, please refer to – Working with UDP Datagram Sockets 
References : 
Official Java Documentation 
This article is contributed by Rishabh Mahrsee. If you like Lazyroar and would like to contribute, you can also write an article using write.geeksforgeeks.org or mail your article to review-team@geeksforgeeks.org. See your article appearing on the Lazyroar main page and help other Geeks.
Please write comments if you find anything incorrect, or you want to share more information about the topic discussed above.