com.digi.xbee.api.packet.thread

Class CoAPTxRequestPacket

java.lang.Object

com.digi.xbee.api.packet.XBeePacket

com.digi.xbee.api.packet.XBeeAPIPacket

com.digi.xbee.api.packet.thread.CoAPTxRequestPacket

public class CoAPTxRequestPacket
extends XBeeAPIPacket

This class represents a CoAP Tx Request packet. Packet is built using the parameters of the constructor.

A CoAP Tx Request packet is used to send a CoAP message to a remote device of the network identified by an IPv6 address.

If the frame ID specified in the packet is different than zero, a Transmit Status frame (0x8B) is received with the status of the transmission. See TransmitStatusPacket.

The method indicates the HTTP function used for the transmission. It is specified by the HTTPMethodEnum enumerator.

The URI field is a string that must be for data transmission (PUT), for AT Command operations (PUT or GET) or for IO operation (POST).

The packet also includes an optional payload. For data transmission, it should contain the data to send; for AT Command operations, empty to query the setting (GET) or the new value (PUT).

Since:

1.2.1

See Also:

CoAPRxResponsePacket, XBeeAPIPacket

Field Summary

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

NO_FRAME_ID

Constructor Summary

Constructors

Constructor and Description
CoAPTxRequestPacket(int frameID, int transmitOptions, HTTPMethodEnum method, Inet6Address destAddress, String uri, byte[] payload) Class constructor.

Method Summary

Modifier and Type	Method and Description
static CoAPTxRequestPacket	createPacket(byte[] payload) Creates a new CoAPTxRequestPacket object from the given payload.
LinkedHashMap<String,String>	getAPIPacketParameters() Returns a map with the XBee packet parameters and their values.
Inet6Address	getDestAddress() Retrieves the destination IPv6 address.
HTTPMethodEnum	getMethod() Returns the HTTP method used for the transmission.
byte[]	getPayload() Retrieves the transmission data.
int	getTransmitOptions() Retrieves the transmit options bitfield.
String	getURI() Retrieves the URI.
boolean	needsAPIFrameID() Returns whether the API packet needs API Frame ID or not.
void	setDestAddress(Inet6Address destAddress) Sets the destination IPv6 address.
void	setMethod(HTTPMethodEnum method) Sets the HTTP method used for the transmission.
void	setPayload(byte[] payload) Sets the new transmission data.
void	setTransmitOptions(int transmitOptions) Sets the transmit options bifield.
void	setURI(String uri) Sets the URI.

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

CoAPTxRequestPacket

public CoAPTxRequestPacket(int frameID,
                           int transmitOptions,
                           HTTPMethodEnum method,
                           Inet6Address destAddress,
                           String uri,
                           byte[] payload)

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

Parameters:

frameID - Frame ID.

transmitOptions - Bitfield of supported transmission options.

method - HTTP method used for the transmission.

destAddress - IPv6 address of the destination device.

uri - Uniform Resource Identifier.

payload - Payload.

Throws:

IllegalArgumentException - if frameID < 0 or if frameID > 255 or if uri contains and transmitOptions != or transmitOptions != if uri does not contain and transmitOptions != .

NullPointerException - if method == null or if destAddress == null or if uri == null.

See Also:

HTTPMethodEnum, RemoteATCommandOptions, Inet6Address

Method Detail

createPacket

public static CoAPTxRequestPacket createPacket(byte[] payload)

Creates a new CoAPTxRequestPacket object from the given payload.

Parameters:

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

Returns:

Parsed CoAP Tx Request packet.

Throws:

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

getDestAddress

public Inet6Address getDestAddress()

Retrieves the destination IPv6 address.

Returns:

The destination IPv6 address.

See Also:

setDestAddress(Inet6Address), Inet6Address

getMethod

public HTTPMethodEnum getMethod()

Returns the HTTP method used for the transmission.

Returns:

HTTP method.

See Also:

setMethod(HTTPMethodEnum), HTTPMethodEnum

getPayload

public byte[] getPayload()

Retrieves the transmission data.

Returns:

The transmission data.

See Also:

setPayload(byte[])

getTransmitOptions

public int getTransmitOptions()

Retrieves the transmit options bitfield.

Returns:

Transmit options bitfield.

See Also:

setTransmitOptions(int), RemoteATCommandOptions

getURI

public String getURI()

Retrieves the URI.

Returns:

The URI.

See Also:

setURI(String)

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.

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

setMethod

public void setMethod(HTTPMethodEnum method)

Sets the HTTP method used for the transmission.

Parameters:

method - HTTP method.

See Also:

getMethod(), HTTPMethodEnum

setPayload

public void setPayload(byte[] payload)

Sets the new transmission data.

Parameters:

payload - The transmission data.

See Also:

getPayload()

setTransmitOptions

public void setTransmitOptions(int transmitOptions)

Sets the transmit options bifield.

Parameters:

transmitOptions - The transmit options bitfield.

Throws:

IllegalArgumentException - if uri contains and transmitOptions != or transmitOptions != if uri does not contain and transmitOptions != .

See Also:

getTransmitOptions(), RemoteATCommandOptions

setURI

public void setURI(String uri)

Sets the URI.

Parameters:

uri - URI.

Throws:

NullPointerException - if uri == null.

See Also:

getURI()