com.digi.xbee.api.packet.ip

Class TXIPv4Packet

java.lang.Object

com.digi.xbee.api.packet.XBeePacket

com.digi.xbee.api.packet.XBeeAPIPacket

com.digi.xbee.api.packet.ip.TXIPv4Packet

public class TXIPv4Packet
extends XBeeAPIPacket

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

Since:

1.2.0

See Also:

RXIPv4Packet, XBeeAPIPacket

Field Summary

Fields

Modifier and Type	Field and Description
static int	OPTIONS_CLOSE_SOCKET This option will close the socket after the transmission.
static int	OPTIONS_LEAVE_SOCKET_OPEN This option will leave socket open after the transmission.

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

NO_FRAME_ID

Constructor Summary

Constructors

Constructor and Description
TXIPv4Packet(int frameID, Inet4Address destAddress, int destPort, int sourcePort, IPProtocol protocol, int transmitOptions, byte[] data) Class constructor.

Method Summary

Modifier and Type	Method and Description
static TXIPv4Packet	createPacket(byte[] payload) Creates a new TXIPv4Packet object from the given payload.
LinkedHashMap<String,String>	getAPIPacketParameters() Returns a map with the XBee packet parameters and their values.
byte[]	getData() Retrieves the transmission data.
Inet4Address	getDestAddress() Retrieves the destination IP address.
int	getDestPort() Retrieves the destination port.
IPProtocol	getProtocol() Retrieves the IP protocol.
int	getSourcePort() Retrieves the source port.
int	getTransmitOptions() Retrieves the transmit options.
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 transmission data.
void	setDestAddress(Inet4Address destAddress) Sets the destination IP address.
void	setDestPort(int destPort) Sets the destination port.
void	setProtocol(IPProtocol protocol) Sets the IP protocol.
void	setSourcePort(int sourcePort) Sets the source port.
void	setTransmitOptions(int transmitOptions) Sets the transmit options.

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

Field Detail

OPTIONS_CLOSE_SOCKET

public static final int OPTIONS_CLOSE_SOCKET

This option will close the socket after the transmission.

See Also:

Constant Field Values

OPTIONS_LEAVE_SOCKET_OPEN

public static final int OPTIONS_LEAVE_SOCKET_OPEN

This option will leave socket open after the transmission.

See Also:

Constant Field Values

Constructor Detail

TXIPv4Packet

public TXIPv4Packet(int frameID,
                    Inet4Address destAddress,
                    int destPort,
                    int sourcePort,
                    IPProtocol protocol,
                    int transmitOptions,
                    byte[] data)

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

Parameters:

frameID - Frame ID.

destAddress - IP address of the destination device.

destPort - Destination port number.

sourcePort - Source port number.

protocol - Protocol used for transmitted data.

transmitOptions - Transmit options bitfield. Can be OPTIONS_LEAVE_SOCKET_OPEN or OPTIONS_CLOSE_SOCKET.

data - Transmit data bytes.

Throws:

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

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

See Also:

IPProtocol, Inet4Address

Method Detail

createPacket

public static TXIPv4Packet createPacket(byte[] payload)

Creates a new TXIPv4Packet object from the given payload.

Parameters:

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

Returns:

Parsed TX IPv4 packet.

Throws:

IllegalArgumentException - if payload[0] != APIFrameType.TX_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 transmission data.

Returns:

The transmission data.

See Also:

setData(byte[])

getDestAddress

public Inet4Address getDestAddress()

Retrieves the destination IP address.

Returns:

The destination IP address.

See Also:

setDestAddress(Inet4Address), Inet4Address

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

getSourcePort

public int getSourcePort()

Retrieves the source port.

Returns:

The source port.

See Also:

setSourcePort(int)

getTransmitOptions

public int getTransmitOptions()

Retrieves the transmit options.

Returns:

Transmit options.

See Also:

OPTIONS_CLOSE_SOCKET, OPTIONS_LEAVE_SOCKET_OPEN, setTransmitOptions(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 transmission data.

Parameters:

data - The transmission data.

See Also:

getData()

setDestAddress

public void setDestAddress(Inet4Address destAddress)

Sets the destination IP address.

Parameters:

destAddress - The new destination IP address.

Throws:

NullPointerException - if destAddress == null.

See Also:

getDestAddress(), Inet4Address

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

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()

setTransmitOptions

public void setTransmitOptions(int transmitOptions)

Sets the transmit options.

Parameters:

transmitOptions - Transmit options. Can be OPTIONS_CLOSE_SOCKET or OPTIONS_LEAVE_SOCKET_OPEN.

Throws:

IllegalArgumentException - if transmitOptions are invalid.

See Also:

OPTIONS_CLOSE_SOCKET, OPTIONS_LEAVE_SOCKET_OPEN, getTransmitOptions()