otCoapMessageAppendOption() function

A pointer to the CoAP message.

The CoAP Option number.

The CoAP Option length.

A pointer to the CoAP value.

Casts an `otMessage` pointer to a `Coap::Message` reference.

Casts an `otMessage` pointer to a `Coap::Message` reference.

Free an allocated message buffer. @sa otMessageAppend @sa otMessageGetLength @sa otMessageSetLength @sa otMessageGetOffset @sa otMessageSetOffset @sa otMessageRead @sa otMessageWrite

Append bytes to a message. @sa otMessageFree @sa otMessageGetLength @sa otMessageSetLength @sa otMessageGetOffset @sa otMessageSetOffset @sa otMessageRead @sa otMessageWrite

Get the message length in bytes. @sa otMessageFree @sa otMessageAppend @sa otMessageSetLength @sa otMessageGetOffset @sa otMessageSetOffset @sa otMessageRead @sa otMessageWrite @sa otMessageSetLength

Get the message offset in bytes. @sa otMessageFree @sa otMessageAppend @sa otMessageGetLength @sa otMessageSetLength @sa otMessageSetOffset @sa otMessageRead @sa otMessageWrite

Read bytes from a message. @sa otMessageFree @sa otMessageAppend @sa otMessageGetLength @sa otMessageSetLength @sa otMessageGetOffset @sa otMessageSetOffset @sa otMessageWrite

Returns the Code value.

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.

Appends a Uri-Path option.

Adds Payload Marker indicating beginning of the payload to the CoAP header.

Sends a CoAP response from the server with custom transmission parameters.

Sends an IPv6 datagram via the Thread interface. The caller transfers ownership of @p aMessage when making this call. OpenThread will free @p aMessage when processing is complete, including when a value other than `OT_ERROR_NONE` is returned.

Initializes the CoAP header.

Initializes a response message.

Sets the Token length and randomizes its value.

Appends a Uri-Query option.

Returns the Type value.

Gets the next Network Diagnostic TLV in the message. Requires `OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE`.

Send a UDP/IPv6 message. If the return value is OT_ERROR_NONE, OpenThread takes ownership of @p aMessage, and the caller should no longer reference @p aMessage. If the return value is not OT_ERROR_NONE, the caller retains ownership of @p aMessage, including freeing @p aMessage if the message buffer is no longer needed.

Set the message length in bytes. @sa otMessageFree @sa otMessageAppend @sa otMessageGetLength @sa otMessageGetOffset @sa otMessageSetOffset @sa otMessageRead @sa otMessageWrite

Set the message offset in bytes. @sa otMessageFree @sa otMessageAppend @sa otMessageGetLength @sa otMessageSetLength @sa otMessageGetOffset @sa otMessageRead @sa otMessageWrite

Indicates whether or not link security is enabled for the message.

Indicates whether or not the message is allowed to be looped back to host.

Sets whether or not the message is allowed to be looped back to host.

Indicates whether the given message may be looped back in a case of a multicast destination address. If @p aMessage is used along with an `otMessageInfo`, the `mMulticastLoop` field from `otMessageInfo` structure takes precedence and will be used instead of the the value set on @p aMessage. This API is mainly intended for use along with `otIp6Send()` which expects an already prepared IPv6 message.

Adds a message to the end of the given message queue.

Adds a message at the head/front of the given message queue.

Removes a message from the given message queue.

Returns a pointer to the next message in the queue by iterating forward (from head to tail).

Controls whether the given message may be looped back in a case of a multicast destination address.

Gets the message origin.

Sets the message origin.

Sets/forces the message to be forwarded using direct transmission. Default setting for a new message is `false`.

Returns the average RSS (received signal strength) associated with the message.

Retrieves the link-specific information for a message received over Thread radio.

Write bytes to a message. @sa otMessageFree @sa otMessageAppend @sa otMessageGetLength @sa otMessageSetLength @sa otMessageGetOffset @sa otMessageSetOffset @sa otMessageRead

Sets the Token value and length in a header.

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.

Appends an unsigned integer CoAP option as specified in https://tools.ietf.org/html/rfc7252#section-3.2 @see otCoapMessageGetOptionUintValue

Appends an Observe option.

Appends a Block2 option

Appends a Block1 option

Appends a Proxy-Uri option.

Appends a Max-Age option.

Appends a single Uri-Query option.

Sets the Code value.

Returns the CoAP Code as human readable string. @ returns The CoAP Code as string.

Returns the Message ID value.

Returns the Token length.

Returns a pointer to the Token value.

Initialises an iterator for the options in the given message.

Sends a CoAP request block-wise with custom transmission parameters. 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.

Sends a CoAP response block-wise from the server with custom transmission parameters. Is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration is enabled.

Sends a UDP message without socket.

Sends UDP payload by platform.

Sends an ICMPv6 Echo Request via the Thread interface.

Sends a CoAP request block-wise. 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.

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.

Sends a CoAP response block-wise from the server. Is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration is enabled.

Sends a CoAP response from the server.

Translates an IPv4 datagram to an IPv6 datagram and sends via the Thread interface. The caller transfers ownership of @p aMessage when making this call. OpenThread will free @p aMessage when processing is complete, including when a value other than `OT_ERROR_NONE` is returned.

Starts an upstream query transaction. - In success case (and errors represented by DNS protocol messages), the platform is expected to call `otPlatDnsUpstreamQueryDone`. - The OpenThread core may cancel a (possibly timeout) query transaction by calling `otPlatDnsCancelUpstreamQuery`, the platform must not call `otPlatDnsUpstreamQueryDone` on a cancelled transaction.

The platform calls this function to finish DNS query. The transaction will be released, so the platform must not call on the same transaction twice. This function passes the ownership of `aResponse` to OpenThread stack. Platform can pass a nullptr to close a transaction without a response.

Handle a UDP packet received from host. @warning No matter the call success or fail, the message is freed.

Sends a CoAP request block-wise over secure DTLS connection. 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 no response is expected, these arguments should be NULL pointers. If Message Id was not set in the header (equal to 0), this function will assign unique Message Id to the message.

Sends a CoAP request over secure DTLS connection. 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. If Message Id was not set in the header (equal to 0), this function will assign unique Message Id to the message.

Sends a CoAP response block-wise from the CoAP Secure server. Is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration is enabled.

Sends a CoAP response from the CoAP Secure server.

Sends a secure BLE message. If the return value is OT_ERROR_NONE, OpenThread takes ownership of @p aMessage, and the caller should no longer reference @p aMessage. If the return value is not OT_ERROR_NONE, the caller retains ownership of @p aMessage, including freeing @p aMessage if the message buffer is no longer needed.