CoAP#

otCoapType#

otCoapType

CoAP Type values (2 bit unsigned integer).

otCoapCode#

otCoapCode

CoAP Code values.

otCoapOptionType#

otCoapOptionType

CoAP Option Numbers.

otCoapOptionContentFormat#

otCoapOptionContentFormat

CoAP Content Format codes.

The full list is documented at https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats

otCoapBlockSzx#

otCoapBlockSzx

CoAP Block Size Exponents.

otCoapType#

typedef enum otCoapType otCoapType

CoAP Type values (2 bit unsigned integer).

otCoapCode#

typedef enum otCoapCode otCoapCode

CoAP Code values.

otCoapOptionType#

typedef enum otCoapOptionType otCoapOptionType

CoAP Option Numbers.

otCoapOption#

typedef struct otCoapOption otCoapOption

This structure represents a CoAP option.

otCoapOptionIterator#

typedef struct otCoapOptionIterator otCoapOptionIterator

This structure acts as an iterator for CoAP options.

otCoapOptionContentFormat#

typedef enum otCoapOptionContentFormat otCoapOptionContentFormat

CoAP Content Format codes.

The full list is documented at https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats

otCoapBlockSzx#

typedef enum otCoapBlockSzx otCoapBlockSzx

CoAP Block Size Exponents.

otCoapResponseHandler#

typedef void(* otCoapResponseHandler) (void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult) )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult)

This function pointer is called when a CoAP response is received or on the request timeout.

otCoapRequestHandler#

typedef void(* otCoapRequestHandler) (void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)

This function pointer is called when a CoAP request with a given Uri-Path is received.

otCoapBlockwiseReceiveHook#

typedef otError(* otCoapBlockwiseReceiveHook) (void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength) )(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength)

This function pointer is called when a CoAP message with an block-wise transfer option is received.

This function is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration is enabled.

otCoapBlockwiseTransmitHook#

typedef otError(* otCoapBlockwiseTransmitHook) (void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore) )(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore)

This function pointer is called before the next block in a block-wise transfer is sent.

This function is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration is enabled.

Warnings

• By changing the value of aBlockLength, the block size of the whole exchange is renegotiated. It is recommended to do this after the first block has been received as later changes could cause problems with other CoAP implementations.

otCoapResource#

typedef struct otCoapResource otCoapResource

This structure represents a CoAP resource.

otCoapBlockwiseResource#

typedef struct otCoapBlockwiseResource otCoapBlockwiseResource

This structure represents a CoAP resource with block-wise transfer.

otCoapTxParameters#

typedef struct otCoapTxParameters otCoapTxParameters

This structure represents the CoAP transmission parameters.

Note

• mAckTimeout * ((2 ** (mMaxRetransmit + 1)) - 1) * (mAckRandomFactorNumerator / mAckRandomFactorDenominator) must not exceed what can be represented by a uint32_t (0xffffffff). This limitation allows OpenThread to avoid 64-bit arithmetic.

otCoapMessageInit#

void otCoapMessageInit (otMessage * aMessage, otCoapType aType, otCoapCode aCode)

This function initializes the CoAP header.

otCoapMessageInitResponse#

otError otCoapMessageInitResponse (otMessage * aResponse, const otMessage * aRequest, otCoapType aType, otCoapCode aCode)

This function initializes a response message.

Note

• Both message ID and token are set according to aRequest.

otCoapMessageSetToken#

otError otCoapMessageSetToken (otMessage * aMessage, const uint8_t * aToken, uint8_t aTokenLength)

This function sets the Token value and length in a header.

otCoapMessageGenerateToken#

void otCoapMessageGenerateToken (otMessage * aMessage, uint8_t aTokenLength)

This function sets the Token length and randomizes its value.

otCoapMessageAppendContentFormatOption#

otError otCoapMessageAppendContentFormatOption (otMessage * aMessage, otCoapOptionContentFormat aContentFormat)

This function appends the Content Format CoAP option as specified in https://tools.ietf.org/html/rfc7252#page-92.

This must be called before setting otCoapMessageSetPayloadMarker if a payload is to be included in the message.

The function is a convenience wrapper around otCoapMessageAppendUintOption, and if the desired format type code isn't listed in otCoapOptionContentFormat, this base function should be used instead.

otCoapMessageAppendOption#

otError otCoapMessageAppendOption (otMessage * aMessage, uint16_t aNumber, uint16_t aLength, const void * aValue)

This function appends a CoAP option in a header.

otCoapMessageAppendUintOption#

otError otCoapMessageAppendUintOption (otMessage * aMessage, uint16_t aNumber, uint32_t aValue)

This function appends an unsigned integer CoAP option as specified in https://tools.ietf.org/html/rfc7252#section-3.2.

See Also

• otCoapMessageGetOptionUintValue

otCoapMessageAppendObserveOption#

otError otCoapMessageAppendObserveOption (otMessage * aMessage, uint32_t aObserve)

This function appends an Observe option.

otCoapMessageAppendUriPathOptions#

otError otCoapMessageAppendUriPathOptions (otMessage * aMessage, const char * aUriPath)

This function appends a Uri-Path option.

otCoapBlockSizeFromExponent#

uint16_t otCoapBlockSizeFromExponent (otCoapBlockSzx aSize)

This function converts a CoAP Block option SZX field to the actual block size.

Returns

• The actual size exponent value.

otCoapMessageAppendBlock2Option#

otError otCoapMessageAppendBlock2Option (otMessage * aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)

This function appends a Block2 option.

otCoapMessageAppendBlock1Option#

otError otCoapMessageAppendBlock1Option (otMessage * aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)

This function appends a Block1 option.

otCoapMessageAppendProxyUriOption#

otError otCoapMessageAppendProxyUriOption (otMessage * aMessage, const char * aUriPath)

This function appends a Proxy-Uri option.

otCoapMessageAppendMaxAgeOption#

otError otCoapMessageAppendMaxAgeOption (otMessage * aMessage, uint32_t aMaxAge)

This function appends a Max-Age option.

otCoapMessageAppendUriQueryOption#

otError otCoapMessageAppendUriQueryOption (otMessage * aMessage, const char * aUriQuery)

This function appends a single Uri-Query option.

otCoapMessageSetPayloadMarker#

otError otCoapMessageSetPayloadMarker (otMessage * aMessage)

This function adds Payload Marker indicating beginning of the payload to the CoAP header.

otCoapMessageGetType#

otCoapType otCoapMessageGetType (const otMessage * aMessage)

This function returns the Type value.

Returns

• The Type value.

otCoapMessageGetCode#

otCoapCode otCoapMessageGetCode (const otMessage * aMessage)

This function returns the Code value.

Returns

• The Code value.

otCoapMessageSetCode#

void otCoapMessageSetCode (otMessage * aMessage, otCoapCode aCode)

This function sets the Code value.

otCoapMessageCodeToString#

const char * otCoapMessageCodeToString (const otMessage * aMessage)

This method returns the CoAP Code as human readable string.

@ returns The CoAP Code as string.

otCoapMessageGetMessageId#

uint16_t otCoapMessageGetMessageId (const otMessage * aMessage)

This function returns the Message ID value.

Returns

• The Message ID value.

otCoapMessageGetTokenLength#

uint8_t otCoapMessageGetTokenLength (const otMessage * aMessage)

This function returns the Token length.

Returns

• The Token length.

otCoapMessageGetToken#

const uint8_t * otCoapMessageGetToken (const otMessage * aMessage)

This function returns a pointer to the Token value.

Returns

• A pointer to the Token value.

otCoapOptionIteratorInit#

otError otCoapOptionIteratorInit (otCoapOptionIterator * aIterator, const otMessage * aMessage)

This function initialises an iterator for the options in the given message.

otCoapOptionIteratorGetFirstOptionMatching#

const otCoapOption * otCoapOptionIteratorGetFirstOptionMatching (otCoapOptionIterator * aIterator, uint16_t aOption)

This function returns a pointer to the first option matching the specified option number.

Returns

• A pointer to the first matching option. If no matching option is present NULL pointer is returned.

otCoapOptionIteratorGetFirstOption#

const otCoapOption * otCoapOptionIteratorGetFirstOption (otCoapOptionIterator * aIterator)

This function returns a pointer to the first option.

Returns

• A pointer to the first option. If no option is present NULL pointer is returned.

otCoapOptionIteratorGetNextOptionMatching#

const otCoapOption * otCoapOptionIteratorGetNextOptionMatching (otCoapOptionIterator * aIterator, uint16_t aOption)

This function returns a pointer to the next option matching the specified option number.

Returns

• A pointer to the next matching option. If no further matching option is present NULL pointer is returned.

otCoapOptionIteratorGetNextOption#

const otCoapOption * otCoapOptionIteratorGetNextOption (otCoapOptionIterator * aIterator)

This function returns a pointer to the next option.

Returns

• A pointer to the next option. If no more options are present NULL pointer is returned.

otCoapOptionIteratorGetOptionUintValue#

otError otCoapOptionIteratorGetOptionUintValue (otCoapOptionIterator * aIterator, uint64_t * aValue)

This function fills current option value into aValue assuming the current value is an unsigned integer encoded according to https://tools.ietf.org/html/rfc7252#section-3.2.

See Also

• otCoapMessageAppendUintOption

otCoapOptionIteratorGetOptionValue#

otError otCoapOptionIteratorGetOptionValue (otCoapOptionIterator * aIterator, void * aValue)

This function fills current option value into aValue.

otCoapNewMessage#

otMessage * otCoapNewMessage (otInstance * aInstance, const otMessageSettings * aSettings)

This function creates a new CoAP message.

Note

• If aSettings is 'NULL', the link layer security is enabled and the message priority is set to OT_MESSAGE_PRIORITY_NORMAL by default.

Returns

• A pointer to the message buffer or NULL if no message buffers are available or parameters are invalid.

otCoapSendRequestWithParameters#

otError otCoapSendRequestWithParameters (otInstance * aInstance, otMessage * aMessage, const otMessageInfo * aMessageInfo, otCoapResponseHandler aHandler, void * aContext, const otCoapTxParameters * aTxParameters)

This function sends a CoAP request with custom transmission parameters.

If a response for a request is expected, respective function and context information should be provided. If no response is expected, these arguments should be NULL pointers.

otCoapSendRequestBlockWiseWithParameters#

otError otCoapSendRequestBlockWiseWithParameters (otInstance * aInstance, otMessage * aMessage, const otMessageInfo * aMessageInfo, otCoapResponseHandler aHandler, void * aContext, const otCoapTxParameters * aTxParameters, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)

This function sends a CoAP request block-wise with custom transmission parameters.

This function is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration is enabled.

If a response for a request is expected, respective function and context information should be provided. If the response is expected to be block-wise, a respective hook function should be provided. If no response is expected, these arguments should be NULL pointers.

otCoapSendRequestBlockWise#

static otError otCoapSendRequestBlockWise (otInstance * aInstance, otMessage * aMessage, const otMessageInfo * aMessageInfo, otCoapResponseHandler aHandler, void * aContext, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)

This function sends a CoAP request block-wise.

This function is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration is enabled.

If a response for a request is expected, respective function and context information should be provided. If the response is expected to be block-wise, a respective hook function should be provided. If no response is expected, these arguments should be NULL pointers.

otCoapSendRequest#

static otError otCoapSendRequest (otInstance * aInstance, otMessage * aMessage, const otMessageInfo * aMessageInfo, otCoapResponseHandler aHandler, void * aContext)

This function sends a CoAP request.

If a response for a request is expected, respective function and context information should be provided. If no response is expected, these arguments should be NULL pointers.

otCoapStart#

otError otCoapStart (otInstance * aInstance, uint16_t aPort)

This function starts the CoAP server.

otCoapStop#

otError otCoapStop (otInstance * aInstance)

This function stops the CoAP server.

otCoapAddResource#

void otCoapAddResource (otInstance * aInstance, otCoapResource * aResource)

This function adds a resource to the CoAP server.

otCoapRemoveResource#

void otCoapRemoveResource (otInstance * aInstance, otCoapResource * aResource)

This function removes a resource from the CoAP server.

otCoapAddBlockWiseResource#

void otCoapAddBlockWiseResource (otInstance * aInstance, otCoapBlockwiseResource * aResource)

This function adds a block-wise resource to the CoAP server.

otCoapRemoveBlockWiseResource#

void otCoapRemoveBlockWiseResource (otInstance * aInstance, otCoapBlockwiseResource * aResource)

This function removes a block-wise resource from the CoAP server.

otCoapSetDefaultHandler#

void otCoapSetDefaultHandler (otInstance * aInstance, otCoapRequestHandler aHandler, void * aContext)

This function sets the default handler for unhandled CoAP requests.

otCoapSendResponseWithParameters#

otError otCoapSendResponseWithParameters (otInstance * aInstance, otMessage * aMessage, const otMessageInfo * aMessageInfo, const otCoapTxParameters * aTxParameters)

This function sends a CoAP response from the server with custom transmission parameters.

otCoapSendResponseBlockWiseWithParameters#

otError otCoapSendResponseBlockWiseWithParameters (otInstance * aInstance, otMessage * aMessage, const otMessageInfo * aMessageInfo, const otCoapTxParameters * aTxParameters, void * aContext, otCoapBlockwiseTransmitHook aTransmitHook)

This function sends a CoAP response block-wise from the server with custom transmission parameters.

This function is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration is enabled.

otCoapSendResponseBlockWise#

static otError otCoapSendResponseBlockWise (otInstance * aInstance, otMessage * aMessage, const otMessageInfo * aMessageInfo, void * aContext, otCoapBlockwiseTransmitHook aTransmitHook)

This function sends a CoAP response block-wise from the server.

This function is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration is enabled.

otCoapSendResponse#

static otError otCoapSendResponse (otInstance * aInstance, otMessage * aMessage, const otMessageInfo * aMessageInfo)

This function sends a CoAP response from the server.

OT_DEFAULT_COAP_PORT#

#define OT_DEFAULT_COAP_PORT

5683

Default CoAP port, as specified in RFC 7252.

OT_COAP_DEFAULT_TOKEN_LENGTH#

#define OT_COAP_DEFAULT_TOKEN_LENGTH

2

Default token length.

OT_COAP_MAX_TOKEN_LENGTH#

#define OT_COAP_MAX_TOKEN_LENGTH

8

Max token length as specified (RFC 7252).

OT_COAP_MAX_RETRANSMIT#

#define OT_COAP_MAX_RETRANSMIT

20

Max retransmit supported by OpenThread.

OT_COAP_MIN_ACK_TIMEOUT#

#define OT_COAP_MIN_ACK_TIMEOUT

1000

Minimal ACK timeout in milliseconds supported by OpenThread.

OT_COAP_CODE#

#define OT_COAP_CODE

(c, d)

Helper macro to define CoAP Code values.