com.digi.xbee.api.packet.thread

Class CoAPRxResponsePacket

java.lang.Object

com.digi.xbee.api.packet.XBeePacket

com.digi.xbee.api.packet.XBeeAPIPacket

com.digi.xbee.api.packet.thread.CoAPRxResponsePacket

public class CoAPRxResponsePacket
extends XBeeAPIPacket

This class represents a CoAP Rx Response packet. Packet is built using the parameters of the constructor.

When the module receives a CoAP packet, it is sent out the UART using this message type.

This packet is received when external devices send CoAP Tx Request packets to the module. See CoAPTxRequestPacket.

Since:

1.2.1

See Also:

CoAPTxRequestPacket, XBeeAPIPacket

Field Summary

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

NO_FRAME_ID

Constructor Summary

Constructors

Constructor and Description
CoAPRxResponsePacket(int frameID, Inet6Address destAddress, Inet6Address sourceAddress, int destPort, int sourcePort, IPProtocol protocol, RestFulStatusEnum restFulStatus, byte[] rfData) Class constructor.

Method Summary

Modifier and Type	Method and Description
static CoAPRxResponsePacket	createPacket(byte[] payload) Creates a new CoAPRxResponsePacket 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.
Inet6Address	getSourceAddress() Retrieves the source IPv6 address.
int	getSourcePort() Retrieves the source port.
RestFulStatusEnum	getStatus() Returns the RESTFul status used for the transmission.
boolean	needsAPIFrameID() Returns whether the API packet needs API Frame ID or not.
void	setData(byte[] rfData) 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	setSourceAddress(Inet6Address sourceAddress) Sets the source IPv6 address.
void	setSourcePort(int sourcePort) Sets the source port.
void	setStatus(RestFulStatusEnum restFulStatus) Sets the RESTFul status used for the transmission.

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

CoAPRxResponsePacket

public CoAPRxResponsePacket(int frameID,
                            Inet6Address destAddress,
                            Inet6Address sourceAddress,
                            int destPort,
                            int sourcePort,
                            IPProtocol protocol,
                            RestFulStatusEnum restFulStatus,
                            byte[] rfData)

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

Parameters:

frameID - Frame ID.

destAddress - IPv6 address of the destination device.

sourceAddress - IPv6 address of the source device.

destPort - Destination port number.

sourcePort - Source port number.

protocol - Protocol used for transmitted data.

restFulStatus - RESTful status.

rfData - RF 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 sourceAddress == null or if protocol == null or if restFulStatus == null.

See Also:

Inet6Address, IPProtocol, RestFulStatusEnum

Method Detail

createPacket

public static CoAPRxResponsePacket createPacket(byte[] payload)

Creates a new CoAPRxResponsePacket object from the given payload.

Parameters:

payload - The API frame payload. It must start with the frame type corresponding to a CoAP Rx Response packet (0x9C). The byte array must be in OperatingMode.API mode.

Returns:

Parsed CoAP Tx Request packet.

Throws:

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

getSourceAddress

public Inet6Address getSourceAddress()

Retrieves the source IPv6 address.

Returns:

The source IPv6 address.

See Also:

setSourceAddress(Inet6Address), Inet6Address

getSourcePort

public int getSourcePort()

Retrieves the source port.

Returns:

The source port.

See Also:

setSourcePort(int)

getStatus

public RestFulStatusEnum getStatus()

Returns the RESTFul status used for the transmission.

Returns:

RESTFul status.

See Also:

setStatus(RestFulStatusEnum), RestFulStatusEnum

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[] rfData)

Sets the new transmission data.

Parameters:

rfData - 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

setSourceAddress

public void setSourceAddress(Inet6Address sourceAddress)

Sets the source IPv6 address.

Parameters:

sourceAddress - The new source IPv6 address.

Throws:

NullPointerException - if sourceAddress == null.

See Also:

getSourceAddress(), Inet6Address

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

setStatus

public void setStatus(RestFulStatusEnum restFulStatus)

Sets the RESTFul status used for the transmission.

Parameters:

restFulStatus - RESTFul status.

See Also:

getStatus(), RestFulStatusEnum