Message#

otMessagePriority#

otMessagePriority

Defines the OpenThread message priority levels.

otMessageOrigin#

otMessageOrigin

Defines the OpenThread message origins.

otMessage#

typedef struct otMessage otMessage

An opaque representation of an OpenThread message buffer.

otMessagePriority#

typedef enum otMessagePriority otMessagePriority

Defines the OpenThread message priority levels.

otMessageOrigin#

typedef enum otMessageOrigin otMessageOrigin

Defines the OpenThread message origins.

otMessageSettings#

typedef struct otMessageSettings otMessageSettings

Represents a message settings.

otThreadLinkInfo#

typedef struct otThreadLinkInfo otThreadLinkInfo

Represents link-specific information for messages received from the Thread radio.

otMessageQueueInfo#

typedef struct otMessageQueueInfo otMessageQueueInfo

Represents information about a message queue.

otBufferInfo#

typedef struct otBufferInfo otBufferInfo

Represents the message buffer information for different queues used by OpenThread stack.

otMessageFree#

void otMessageFree (otMessage * aMessage)

Free an allocated message buffer.

See Also

• otMessageAppend

• otMessageGetLength

• otMessageSetLength

• otMessageGetOffset

• otMessageSetOffset

• otMessageRead

• otMessageWrite

otMessageGetLength#

uint16_t otMessageGetLength (const otMessage * aMessage)

Get the message length in bytes.

Returns

• The message length in bytes.

See Also

• otMessageFree

• otMessageAppend

• otMessageSetLength

• otMessageGetOffset

• otMessageSetOffset

• otMessageRead

• otMessageWrite

• otMessageSetLength

otMessageSetLength#

otError otMessageSetLength (otMessage * aMessage, uint16_t aLength)

Set the message length in bytes.

See Also

• otMessageFree

• otMessageAppend

• otMessageGetLength

• otMessageGetOffset

• otMessageSetOffset

• otMessageRead

• otMessageWrite

otMessageGetOffset#

uint16_t otMessageGetOffset (const otMessage * aMessage)

Get the message offset in bytes.

Returns

• The message offset value.

See Also

• otMessageFree

• otMessageAppend

• otMessageGetLength

• otMessageSetLength

• otMessageSetOffset

• otMessageRead

• otMessageWrite

otMessageSetOffset#

void otMessageSetOffset (otMessage * aMessage, uint16_t aOffset)

Set the message offset in bytes.

See Also

• otMessageFree

• otMessageAppend

• otMessageGetLength

• otMessageSetLength

• otMessageGetOffset

• otMessageRead

• otMessageWrite

otMessageIsLinkSecurityEnabled#

bool otMessageIsLinkSecurityEnabled (const otMessage * aMessage)

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

otMessageIsLoopbackToHostAllowed#

bool otMessageIsLoopbackToHostAllowed (const otMessage * aMessage)

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

otMessageSetLoopbackToHostAllowed#

void otMessageSetLoopbackToHostAllowed (otMessage * aMessage, bool aAllowLoopbackToHost)

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

otMessageIsMulticastLoopEnabled#

bool otMessageIsMulticastLoopEnabled (otMessage * aMessage)

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

If 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 aMessage.

This API is mainly intended for use along with otIp6Send() which expects an already prepared IPv6 message.

otMessageSetMulticastLoopEnabled#

void otMessageSetMulticastLoopEnabled (otMessage * aMessage, bool aEnabled)

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

otMessageGetOrigin#

otMessageOrigin otMessageGetOrigin (const otMessage * aMessage)

Gets the message origin.

Returns

• The message origin.

otMessageSetOrigin#

void otMessageSetOrigin (otMessage * aMessage, otMessageOrigin aOrigin)

Sets the message origin.

otMessageSetDirectTransmission#

void otMessageSetDirectTransmission (otMessage * aMessage, bool aEnabled)

Sets/forces the message to be forwarded using direct transmission.

Default setting for a new message is false.

otMessageGetRss#

int8_t otMessageGetRss (const otMessage * aMessage)

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

Returns

• The average RSS value (in dBm) or OT_RADIO_RSSI_INVALID if no average RSS is available.

otMessageGetThreadLinkInfo#

otError otMessageGetThreadLinkInfo (const otMessage * aMessage, otThreadLinkInfo * aLinkInfo)

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

otMessageAppend#

otError otMessageAppend (otMessage * aMessage, const void * aBuf, uint16_t aLength)

Append bytes to a message.

See Also

• otMessageFree

• otMessageGetLength

• otMessageSetLength

• otMessageGetOffset

• otMessageSetOffset

• otMessageRead

• otMessageWrite

otMessageRead#

uint16_t otMessageRead (const otMessage * aMessage, uint16_t aOffset, void * aBuf, uint16_t aLength)

Read bytes from a message.

Returns

• The number of bytes read.

See Also

• otMessageFree

• otMessageAppend

• otMessageGetLength

• otMessageSetLength

• otMessageGetOffset

• otMessageSetOffset

• otMessageWrite

otMessageWrite#

int otMessageWrite (otMessage * aMessage, uint16_t aOffset, const void * aBuf, uint16_t aLength)

Write bytes to a message.

Returns

• The number of bytes written.

See Also

• otMessageFree

• otMessageAppend

• otMessageGetLength

• otMessageSetLength

• otMessageGetOffset

• otMessageSetOffset

• otMessageRead

otMessageQueueInit#

void otMessageQueueInit (otMessageQueue * aQueue)

Initialize the message queue.

MUST be called once and only once for a otMessageQueue instance before any other otMessageQueue functions. The behavior is undefined if other queue APIs are used with an otMessageQueue before it being initialized or if it is initialized more than once.

otMessageQueueEnqueue#

void otMessageQueueEnqueue (otMessageQueue * aQueue, otMessage * aMessage)

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

otMessageQueueEnqueueAtHead#

void otMessageQueueEnqueueAtHead (otMessageQueue * aQueue, otMessage * aMessage)

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

otMessageQueueDequeue#

void otMessageQueueDequeue (otMessageQueue * aQueue, otMessage * aMessage)

Removes a message from the given message queue.

otMessageQueueGetHead#

otMessage * otMessageQueueGetHead (otMessageQueue * aQueue)

Returns a pointer to the message at the head of the queue.

Returns

• A pointer to the message at the head of queue or NULL if queue is empty.

otMessageQueueGetNext#

otMessage * otMessageQueueGetNext (otMessageQueue * aQueue, const otMessage * aMessage)

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

Returns

• A pointer to the next message in the queue after aMessage or NULL if aMessage is the tail of queue. NULL is returned ifaMessageis not in the queueaQueue`.

otMessageGetBufferInfo#

void otMessageGetBufferInfo (otInstance * aInstance, otBufferInfo * aBufferInfo)

Get the Message Buffer information.

otMessageResetBufferInfo#

void otMessageResetBufferInfo (otInstance * aInstance)

Reset the Message Buffer information counter tracking the maximum number buffers in use at the same time.

This resets mMaxUsedBuffers in otBufferInfo.