com.digi.xbee.api.packet.ip

Class RXIPv4Packet

java.lang.Object

com.digi.xbee.api.packet.XBeePacket

com.digi.xbee.api.packet.XBeeAPIPacket

com.digi.xbee.api.packet.ip.RXIPv4Packet

public class RXIPv4Packet
extends XBeeAPIPacket

This class represents an RX (Receive) IPv4 packet. Packet is built using the parameters of the constructor or providing a valid API payload.

Since:

1.2.0

See Also:

TXIPv4Packet, XBeeAPIPacket

Field Summary

Fields inherited from class com.digi.xbee.api.packet.XBeeAPIPacket

NO_FRAME_ID

Constructor Summary

Constructors

Constructor and Description
RXIPv4Packet(Inet4Address sourceAddress, int destPort, int sourcePort, IPProtocol protocol, byte[] data) Class constructor.

Method Summary

Modifier and Type	Method and Description
static RXIPv4Packet	createPacket(byte[] payload) Creates a new RXIPv4Packet object from the given payload.
LinkedHashMap<String,String>	getAPIPacketParameters() Returns a map with the XBee packet parameters and their values.
byte[]	getData() Retrieves the received data.
int	getDestPort() Retrieves the destination port.
IPProtocol	getProtocol() Retrieves the IP protocol.
Inet4Address	getSourceAddress() Retrieves the source IP address.
int	getSourcePort() Retrieves the source port.
boolean	isBroadcast() Returns whether or not the packet is a broadcast packet.
boolean	needsAPIFrameID() Returns whether the API packet needs API Frame ID or not.
void	setData(byte[] data) Sets the new received data.
void	setDestPort(int destPort) Sets the destination port.
void	setProtocol(IPProtocol protocol) Sets the IP protocol.
void	setSourceAddress(Inet4Address sourceAddress) Sets the source IP address.
void	setSourcePort(int sourcePort) Sets the source port.

Methods inherited from class com.digi.xbee.api.packet.XBeeAPIPacket

checkFrameID, getAPIData, getFrameID, getFrameType, getFrameTypeValue, getPacketData, setFrameID

Methods inherited from class com.digi.xbee.api.packet.XBeePacket

equals, generateByteArray, generateByteArrayEscaped, getChecksum, getPacketLength, getParameters, hashCode, parsePacket, parsePacket, toPrettyString, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RXIPv4Packet

public RXIPv4Packet(Inet4Address sourceAddress,
                    int destPort,
                    int sourcePort,
                    IPProtocol protocol,
                    byte[] data)

Class constructor. Instantiates a new RXIPv4Packet object with the given parameters.

Parameters:

sourceAddress - IP address of the source device.

destPort - Destination port number.

sourcePort - Source port number.

protocol - Protocol used for transmitted data.

data - Receive data bytes.

Throws:

IllegalArgumentException - if destPort < 0 or if destPort > 65535 or if sourcePort < 0 or if sourcePort > 65535 or if transmitOptions are invalid.

NullPointerException - if sourceAddress == null or if protocol == null.

See Also:

IPProtocol, Inet4Address

Method Detail

createPacket

public static RXIPv4Packet createPacket(byte[] payload)

Creates a new RXIPv4Packet object from the given payload.

Parameters:

payload - The API frame payload. It must start with the frame type corresponding to a RX IPv4 packet (0xB0). The byte array must be in OperatingMode.API mode.

Returns:

Parsed RX IPv4 packet.

Throws:

IllegalArgumentException - if payload[0] != APIFrameType.RX_IPV4.getValue() or if payload.length < .

NullPointerException - if payload == null.

getAPIPacketParameters

public LinkedHashMap<String,String> getAPIPacketParameters()

Description copied from class: XBeeAPIPacket

Returns a map with the XBee packet parameters and their values.

Returns:

A sorted map containing the XBee packet parameters with their values.

getData

public byte[] getData()

Retrieves the received data.

Returns:

The received data.

See Also:

setData(byte[])

getDestPort

public int getDestPort()

Retrieves the destination port.

Returns:

The destination port.

See Also:

setDestPort(int)

getProtocol

public IPProtocol getProtocol()

Retrieves the IP protocol.

Returns:

The IP protocol.

See Also:

setProtocol(IPProtocol), IPProtocol

getSourceAddress

public Inet4Address getSourceAddress()

Retrieves the source IP address.

Returns:

The source IP address.

See Also:

setSourceAddress(Inet4Address), Inet4Address

getSourcePort

public int getSourcePort()

Retrieves the source port.

Returns:

The source port.

See Also:

setSourcePort(int)

isBroadcast

public boolean isBroadcast()

Description copied from class: XBeeAPIPacket

Returns whether or not the packet is a broadcast packet.

Specified by:

isBroadcast in class XBeeAPIPacket

Returns:

true if the packet is a broadcast packet, false otherwise.

needsAPIFrameID

public boolean needsAPIFrameID()

Description copied from class: XBeeAPIPacket

Returns whether the API packet needs API Frame ID or not.

Specified by:

needsAPIFrameID in class XBeeAPIPacket

Returns:

true if the packet needs API Frame ID, false otherwise.

setData

public void setData(byte[] data)

Sets the new received data.

Parameters:

data - The received data.

See Also:

getData()

setDestPort

public void setDestPort(int destPort)

Sets the destination port.

Parameters:

destPort - The new destination port.

Throws:

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

See Also:

getDestPort()

setProtocol

public void setProtocol(IPProtocol protocol)

Sets the IP protocol.

Parameters:

protocol - The new IP protocol.

Throws:

NullPointerException - if protocol == null.

See Also:

getProtocol(), IPProtocol

setSourceAddress

public void setSourceAddress(Inet4Address sourceAddress)

Sets the source IP address.

Parameters:

sourceAddress - The new source IP address.

Throws:

NullPointerException - if sourceAddress == null.

See Also:

getSourceAddress(), Inet4Address

setSourcePort

public void setSourcePort(int sourcePort)

Sets the source port.

Parameters:

sourcePort - The new source port.

Throws:

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

See Also:

getSourcePort()