Modules#

otMessageSettings

otMessageQueue

otMessageQueueInfo

otBufferInfo

Message#

This module includes functions that manipulate OpenThread message buffers.

Enumerations#

enum
OT_MESSAGE_PRIORITY_LOW = 0
OT_MESSAGE_PRIORITY_NORMAL = 1
OT_MESSAGE_PRIORITY_HIGH = 2
}

This enumeration defines the OpenThread message priority levels.

Typedefs#

typedef struct otMessage

This type is an opaque representation of an OpenThread message buffer.

typedef enum otMessagePriority

This enumeration defines the OpenThread message priority levels.

typedef struct otMessageSettings

This structure represents a message settings.

typedef struct otMessageQueueInfo

This structure represents information about a message queue.

typedef struct otBufferInfo

This structure represents the message buffer information for different queues used by OpenThread stack.

Functions#

void
otMessageFree(otMessage *aMessage)

Free an allocated message buffer.

uint16_t
otMessageGetLength(const otMessage *aMessage)

Get the message length in bytes.

otMessageSetLength(otMessage *aMessage, uint16_t aLength)

Set the message length in bytes.

uint16_t
otMessageGetOffset(const otMessage *aMessage)

Get the message offset in bytes.

void
otMessageSetOffset(otMessage *aMessage, uint16_t aOffset)

Set the message offset in bytes.

bool
otMessageIsLinkSecurityEnabled(const otMessage *aMessage)

This function indicates whether or not link security is enabled for the message.

void
otMessageSetDirectTransmission(otMessage *aMessage, bool aEnabled)

This function sets/forces the message to be forwarded using direct transmission.

int8_t
otMessageGetRss(const otMessage *aMessage)

This function returns the average RSS (received signal strength) associated with the message.

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

Append bytes to a message.

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

Read bytes from a message.

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

Write bytes to a message.

void
otMessageQueueInit(otMessageQueue *aQueue)

Initialize the message queue.

void
otMessageQueueEnqueue(otMessageQueue *aQueue, otMessage *aMessage)

This function adds a message to the end of the given message queue.

void
otMessageQueueEnqueueAtHead(otMessageQueue *aQueue, otMessage *aMessage)

This function adds a message at the head/front of the given message queue.

void
otMessageQueueDequeue(otMessageQueue *aQueue, otMessage *aMessage)

This function removes a message from the given message queue.

otMessageQueueGetHead(otMessageQueue *aQueue)

This function returns a pointer to the message at the head of the queue.

otMessageQueueGetNext(otMessageQueue *aQueue, const otMessage *aMessage)

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

void
otMessageGetBufferInfo(otInstance *aInstance, otBufferInfo *aBufferInfo)

Get the Message Buffer information.

void
otMessageResetBufferInfo(otInstance *aInstance)

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

Enumeration Documentation#

otMessagePriority#

otMessagePriority

This enumeration defines the OpenThread message priority levels.

Enumerator
OT_MESSAGE_PRIORITY_LOW

Low priority level.

OT_MESSAGE_PRIORITY_NORMAL

Normal priority level.

OT_MESSAGE_PRIORITY_HIGH

High priority level.


Definition at line 65 of file include/openthread/message.h

Typedef Documentation#

otMessage#

typedef struct otMessage otMessage

This type is an opaque representation of an OpenThread message buffer.


Definition at line 59 of file include/openthread/message.h

otMessagePriority#

typedef enum otMessagePriority otMessagePriority

This enumeration defines the OpenThread message priority levels.


Definition at line 70 of file include/openthread/message.h

otMessageSettings#

typedef struct otMessageSettings otMessageSettings

This structure represents a message settings.


Definition at line 80 of file include/openthread/message.h

otMessageQueueInfo#

typedef struct otMessageQueueInfo otMessageQueueInfo

This structure represents information about a message queue.


Definition at line 282 of file include/openthread/message.h

otBufferInfo#

typedef struct otBufferInfo otBufferInfo

This structure represents the message buffer information for different queues used by OpenThread stack.


Definition at line 308 of file include/openthread/message.h

Function Documentation#

otMessageFree#

void otMessageFree (otMessage *aMessage)

Free an allocated message buffer.

Parameters
[in]aMessage

A pointer to a message buffer.

See Also


Definition at line 96 of file include/openthread/message.h

otMessageGetLength#

uint16_t otMessageGetLength (const otMessage *aMessage)

Get the message length in bytes.

Parameters
[in]aMessage

A pointer to a message buffer.

Returns

  • The message length in bytes.

See Also


Definition at line 115 of file include/openthread/message.h

otMessageSetLength#

otError otMessageSetLength (otMessage *aMessage, uint16_t aLength)

Set the message length in bytes.

Parameters
[in]aMessage

A pointer to a message buffer.

[in]aLength

A length in bytes.

See Also


Definition at line 135 of file include/openthread/message.h

otMessageGetOffset#

uint16_t otMessageGetOffset (const otMessage *aMessage)

Get the message offset in bytes.

Parameters
[in]aMessage

A pointer to a message buffer.

Returns

  • The message offset value.

See Also


Definition at line 153 of file include/openthread/message.h

otMessageSetOffset#

void otMessageSetOffset (otMessage *aMessage, uint16_t aOffset)

Set the message offset in bytes.

Parameters
[in]aMessage

A pointer to a message buffer.

[in]aOffset

An offset in bytes.

See Also


Definition at line 170 of file include/openthread/message.h

otMessageIsLinkSecurityEnabled#

bool otMessageIsLinkSecurityEnabled (const otMessage *aMessage)

This function indicates whether or not link security is enabled for the message.

Parameters
[in]aMessage

A pointer to a message buffer.


Definition at line 181 of file include/openthread/message.h

otMessageSetDirectTransmission#

void otMessageSetDirectTransmission (otMessage *aMessage, bool aEnabled)

This function sets/forces the message to be forwarded using direct transmission.

Parameters
[in]aMessage

A pointer to a message buffer.

[in]aEnabled

If true, the message is forced to use direct transmission. If false, the message follows the normal procedure.

Default setting for a new message is false.


Definition at line 192 of file include/openthread/message.h

otMessageGetRss#

int8_t otMessageGetRss (const otMessage *aMessage)

This function returns the average RSS (received signal strength) associated with the message.

Parameters
N/AaMessage

Returns

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


Definition at line 200 of file include/openthread/message.h

otMessageAppend#

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

Append bytes to a message.

Parameters
[in]aMessage

A pointer to a message buffer.

[in]aBuf

A pointer to the data to append.

[in]aLength

Number of bytes to append.

See Also


Definition at line 221 of file include/openthread/message.h

otMessageRead#

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

Read bytes from a message.

Parameters
[in]aMessage

A pointer to a message buffer.

[in]aOffset

An offset in bytes.

[in]aBuf

A pointer to a buffer that message bytes are read to.

[in]aLength

Number of bytes to read.

Returns

  • The number of bytes read.

See Also


Definition at line 242 of file include/openthread/message.h

otMessageWrite#

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

Write bytes to a message.

Parameters
[in]aMessage

A pointer to a message buffer.

[in]aOffset

An offset in bytes.

[in]aBuf

A pointer to a buffer that message bytes are written from.

[in]aLength

Number of bytes to write.

Returns

  • The number of bytes written.

See Also


Definition at line 263 of file include/openthread/message.h

otMessageQueueInit#

void otMessageQueueInit (otMessageQueue *aQueue)

Initialize the message queue.

Parameters
[in]aQueue

A pointer to a message queue.

This function 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.


Definition at line 320 of file include/openthread/message.h

otMessageQueueEnqueue#

void otMessageQueueEnqueue (otMessageQueue *aQueue, otMessage *aMessage)

This function adds a message to the end of the given message queue.

Parameters
[in]aQueue

A pointer to the message queue.

[in]aMessage

The message to add.


Definition at line 329 of file include/openthread/message.h

otMessageQueueEnqueueAtHead#

void otMessageQueueEnqueueAtHead (otMessageQueue *aQueue, otMessage *aMessage)

This function adds a message at the head/front of the given message queue.

Parameters
[in]aQueue

A pointer to the message queue.

[in]aMessage

The message to add.


Definition at line 338 of file include/openthread/message.h

otMessageQueueDequeue#

void otMessageQueueDequeue (otMessageQueue *aQueue, otMessage *aMessage)

This function removes a message from the given message queue.

Parameters
[in]aQueue

A pointer to the message queue.

[in]aMessage

The message to remove.


Definition at line 347 of file include/openthread/message.h

otMessageQueueGetHead#

otMessage * otMessageQueueGetHead (otMessageQueue *aQueue)

This function returns a pointer to the message at the head of the queue.

Parameters
[in]aQueue

A pointer to a message queue.

Returns

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


Definition at line 357 of file include/openthread/message.h

otMessageQueueGetNext#

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

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

Parameters
[in]aQueue

A pointer to a message queue.

[in]aMessage

A pointer to current message buffer.

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`.


Definition at line 369 of file include/openthread/message.h

otMessageGetBufferInfo#

void otMessageGetBufferInfo (otInstance *aInstance, otBufferInfo *aBufferInfo)

Get the Message Buffer information.

Parameters
[in]aInstance

A pointer to the OpenThread instance.

[out]aBufferInfo

A pointer where the message buffer information is written.


Definition at line 378 of file include/openthread/message.h

otMessageResetBufferInfo#

void otMessageResetBufferInfo (otInstance *aInstance)

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

Parameters
[in]aInstance

A pointer to the OpenThread instance.

This resets mMaxUsedBuffers in otBufferInfo.


Definition at line 388 of file include/openthread/message.h