com.digi.xbee.api.models

Class IPMessage

java.lang.Object

com.digi.xbee.api.models.IPMessage

public class IPMessage
extends Object

This class represents an IP message containing the IP address the message belongs to, the source and destination ports, the IP protocol, and the content (data) of the message.

This class is used within the XBee Java Library to read data sent to IP devices.

Since:

1.2.0

Constructor Summary

Constructors

Constructor and Description
IPMessage(Inet4Address ipAddress, int sourcePort, int destPort, IPProtocol protocol, byte[] data) Class constructor.
IPMessage(Inet6Address ipv6Address, int sourcePort, int destPort, IPProtocol protocol, byte[] data) Class constructor.

Method Summary

Modifier and Type	Method and Description
byte[]	getData() Returns the byte array containing the data of the message.
String	getDataString() Returns the data of the message in string format.
int	getDestPort() Returns the destination port of the transmission.
String	getHostAddress() Returns the IPv4 or IPv6 address this message is associated to.
Inet4Address	getIPAddress() Returns the IPv4 address this message is associated to.
Inet6Address	getIPv6Address() Returns the IPv6 address this message is associated to.
IPProtocol	getProtocol() Returns the protocol used in the transmission.
int	getSourcePort() Returns the source port of the transmission.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IPMessage

public IPMessage(Inet4Address ipAddress,
                 int sourcePort,
                 int destPort,
                 IPProtocol protocol,
                 byte[] data)

Class constructor. Instantiates a new object of type IPMessage with the given parameters.

Parameters:

ipAddress - The IP address the message comes from.

sourcePort - TCP or UDP source port of the transmission.

destPort - TCP or UDP destination port of the transmission.

protocol - IP protocol used in the transmission.

data - Byte array containing the data of the message.

Throws:

IllegalArgumentException - if sourcePort < 0 or if sourcePort > 65535 or if destPort < 0 or if destPort > 65535.

NullPointerException - if ipAddress == null or if data == null or if protocol == null.

See Also:

IPProtocol, Inet4Address

IPMessage

public IPMessage(Inet6Address ipv6Address,
                 int sourcePort,
                 int destPort,
                 IPProtocol protocol,
                 byte[] data)

Class constructor. Instantiates a new object of type IPMessage with the given parameters.

Parameters:

ipv6Address - The IPv6 address the message comes from.

sourcePort - TCP or UDP source port of the transmission.

destPort - TCP or UDP destination port of the transmission.

protocol - IP protocol used in the transmission.

data - Byte array containing the data of the message.

Throws:

IllegalArgumentException - if sourcePort < 0 or if sourcePort > 65535 or if destPort < 0 or if destPort > 65535.

NullPointerException - if ipv6Address == null or if data == null or if protocol == null.

Since:

1.2.1

See Also:

IPProtocol, Inet6Address

Method Detail

getData

public byte[] getData()

Returns the byte array containing the data of the message.

Returns:

A byte array containing the data of the message.

getDataString

public String getDataString()

Returns the data of the message in string format.

Returns:

The data of the message in string format.

getDestPort

public int getDestPort()

Returns the destination port of the transmission.

Returns:

The destination port of the transmission.

getHostAddress

public String getHostAddress()

Returns the IPv4 or IPv6 address this message is associated to.

Returns:

The IPv4 or IPv6 address this message is associated to.

Since:

1.2.1

See Also:

Inet4Address, Inet6Address

getIPAddress

public Inet4Address getIPAddress()

Returns the IPv4 address this message is associated to.

Returns:

The IPv6 address this message is associated to.

See Also:

Inet4Address

getIPv6Address

public Inet6Address getIPv6Address()

Returns the IPv6 address this message is associated to.

Returns:

The IPv6 address this message is associated to.

Since:

1.2.1

See Also:

Inet6Address

getProtocol

public IPProtocol getProtocol()

Returns the protocol used in the transmission.

Returns:

The protocol used in the transmission

See Also:

IPProtocol

getSourcePort

public int getSourcePort()

Returns the source port of the transmission.

Returns:

The source port of the transmission.