 |
0.01.00
|
|
0.01.00
|
This file defines the top-level OpenThread APIs related to message buffer and queues. More...
#include <openthread/types.h>Go to the source code of this file.
Classes | |
| struct | otMessageQueue |
| This structure represents an OpenThread message queue. More... | |
Functions | |
| void | otMessageFree (otMessage *aMessage) |
| Free an allocated message buffer. More... | |
| uint16_t | otMessageGetLength (otMessage *aMessage) |
| Get the message length in bytes. More... | |
| otError | otMessageSetLength (otMessage *aMessage, uint16_t aLength) |
| Set the message length in bytes. More... | |
| uint16_t | otMessageGetOffset (otMessage *aMessage) |
| Get the message offset in bytes. More... | |
| otError | otMessageSetOffset (otMessage *aMessage, uint16_t aOffset) |
| Set the message offset in bytes. More... | |
| bool | otMessageIsLinkSecurityEnabled (otMessage *aMessage) |
| This function indicates whether or not link security is enabled for the message. More... | |
| void | otMessageSetDirectTransmission (otMessage *aMessage, bool aEnabled) |
| This function sets/forces the message to be forwarded using direct transmission. More... | |
| int8_t | otMessageGetRss (otMessage *aMessage) |
| This function returns the average RSS (received signal strength) associated with the message. More... | |
| otError | otMessageAppend (otMessage *aMessage, const void *aBuf, uint16_t aLength) |
| Append bytes to a message. More... | |
| int | otMessageRead (otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength) |
| Read bytes from a message. More... | |
| int | otMessageWrite (otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength) |
| Write bytes to a message. More... | |
| void | otMessageQueueInit (otMessageQueue *aQueue) |
| Initialize the message queue. More... | |
| otError | otMessageQueueEnqueue (otMessageQueue *aQueue, otMessage *aMessage) |
| This function adds a message to the end of the given message queue. More... | |
| otError | otMessageQueueEnqueueAtHead (otMessageQueue *aQueue, otMessage *aMessage) |
| This function adds a message at the head/front of the given message queue. More... | |
| otError | otMessageQueueDequeue (otMessageQueue *aQueue, otMessage *aMessage) |
| This function removes a message from the given message queue. More... | |
| otMessage * | otMessageQueueGetHead (otMessageQueue *aQueue) |
| This function returns a pointer to the message at the head of the queue. More... | |
| 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). More... | |
| OTAPI void OTCALL | otMessageGetBufferInfo (otInstance *aInstance, otBufferInfo *aBufferInfo) |
| Get the Message Buffer information. More... | |
This file defines the top-level OpenThread APIs related to message buffer and queues.
1.8.12