com.digi.xbee.api.packet.thread

Class TXIPv6Packet

java.lang.Object

com.digi.xbee.api.packet.XBeePacket

com.digi.xbee.api.packet.XBeeAPIPacket

com.digi.xbee.api.packet.thread.TXIPv6Packet

public class TXIPv6Packet
extends XBeeAPIPacket

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

Since:

1.2.1

See Also:

RXIPv6Packet, XBeeAPIPacket

Field Summary

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

NO_FRAME_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static TXIPv6Packet	createPacket(byte[] payload) Creates a new TXIPv6Packet 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.
Inet6Address	getDestAddress() Retrieves the destination IPv6 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	needsAPIFrameID() Returns whether the API packet needs API Frame ID or not.
void	setData(byte[] data) Sets the new transmission data.
void	setDestAddress(Inet6Address destAddress) Sets the destination IPv6 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.

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

checkFrameID, getAPIData, getFrameID, getFrameType, getFrameTypeValue, getPacketData, isBroadcast, 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

TXIPv6Packet

public TXIPv6Packet(int frameID,
                    Inet6Address destAddress,
                    int destPort,
                    int sourcePort,
                    IPProtocol protocol,
                    byte[] data)

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

Parameters:

frameID - Frame ID.

destAddress - IPv6 address of the destination device.

destPort - Destination port number.

sourcePort - Source port number.

protocol - Protocol used for transmitted data.

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.

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

See Also:

IPProtocol, Inet6Address

Method Detail

createPacket

public static TXIPv6Packet createPacket(byte[] payload)

Creates a new TXIPv6Packet object from the given payload.

Parameters:

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

Returns:

Parsed TX IPv6 packet.

Throws:

IllegalArgumentException - if payload[0] != APIFrameType.TX_IPV6.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 Inet6Address getDestAddress()

Retrieves the destination IPv6 address.

Returns:

The destination IPv6 address.

See Also:

setDestAddress(Inet6Address), Inet6Address

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.

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

Sets the destination IPv6 address.

Parameters:

destAddress - The new destination IPv6 address.

Throws:

NullPointerException - if destAddress == null.

See Also:

getDestAddress(), Inet6Address

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