Google 致力于为黑人社区推动种族平等。查看具体行动。

讯息

此模块包含一些操作 OpenThread 消息缓冲区的函数。

总结

枚举
otMessagePriority{
  OT_MESSAGE_PRIORITY_LOW = 0,
  OT_MESSAGE_PRIORITY_NORMAL = 1,
  OT_MESSAGE_PRIORITY_HIGH = 2
} 		枚举
此枚举定义 OpenThread 消息优先级。

类型定义符
otBufferInfo typedef
struct otBufferInfo
此结构表示 OpenThread 堆栈使用的不同队列的消息缓冲区信息。
otMessage typedef
struct otMessage
该类型是 OpenThread 消息缓冲区的不透明表示形式。
otMessagePriority typedef
此枚举定义 OpenThread 消息优先级。
otMessageQueueInfo typedef
此结构表示消息队列的相关信息。
otMessageSettings typedef
此结构代表一项消息设置。

函数
otMessageAppend(otMessage *aMessage, const void *aBuf, uint16_t aLength)
在消息中附加字节。
otMessageFree(otMessage *aMessage)
void
释放已分配的消息缓冲区。
otMessageGetBufferInfo(otInstance *aInstance, otBufferInfo *aBufferInfo)
void
获取消息缓冲区信息。
otMessageGetLength(const otMessage *aMessage)
uint16_t
获取消息长度（以字节为单位）。
otMessageGetOffset(const otMessage *aMessage)
uint16_t
获取消息偏移量（以字节为单位）。
otMessageGetRss(const otMessage *aMessage)
int8_t
此函数返回与消息关联的平均 RSS（接收信号强度）。
otMessageIsLinkSecurityEnabled(const otMessage *aMessage)
bool
此函数用于指明是否为邮件启用了链接安全。
otMessageQueueDequeue(otMessageQueue *aQueue, otMessage *aMessage)
void
此函数会从指定消息队列移除消息。
otMessageQueueEnqueue(otMessageQueue *aQueue, otMessage *aMessage)
void
此函数会将消息添加到给定消息队列的末尾。
otMessageQueueEnqueueAtHead(otMessageQueue *aQueue, otMessage *aMessage)
void
此函数会将消息添加到给定消息队列的头部/前面。
otMessageQueueGetHead(otMessageQueue *aQueue)
此函数返回一个指针，该指针指向队列顶部的消息。
otMessageQueueGetNext(otMessageQueue *aQueue, const otMessage *aMessage)
此函数通过向前迭代（从头到尾）返回一个指向队列中下一条消息的指针。
otMessageQueueInit(otMessageQueue *aQueue)
void
初始化消息队列。
otMessageRead(const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength)
uint16_t
从消息中读取字节。
otMessageResetBufferInfo(otInstance *aInstance)
void
重置消息缓冲区信息计数器以同时跟踪正在使用的缓冲区数上限。
otMessageSetDirectTransmission(otMessage *aMessage, bool aEnabled)
void
此函数设置/强制使用直接传输转发消息。
otMessageSetLength(otMessage *aMessage, uint16_t aLength)
设置消息长度（以字节为单位）。
otMessageSetOffset(otMessage *aMessage, uint16_t aOffset)
void
设置消息偏移量（以字节为单位）。
otMessageWrite(otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength)
int
向消息写入字节。

结构体
otBufferInfo

此结构表示 OpenThread 堆栈使用的不同队列的消息缓冲区信息。
otMessageQueue

此结构表示一个 OpenThread 消息队列。
otMessageQueueInfo

此结构表示消息队列的相关信息。
otMessageSettings

此结构代表一项消息设置。

枚举

otMessagePriority

 otMessagePriority

此枚举定义 OpenThread 消息优先级。

属性
OT_MESSAGE_PRIORITY_HIGH

高优先级。
OT_MESSAGE_PRIORITY_LOW

低优先级。
OT_MESSAGE_PRIORITY_NORMAL

普通优先级。

类型定义符

otBufferInfo

struct otBufferInfo otBufferInfo

此结构表示 OpenThread 堆栈使用的不同队列的消息缓冲区信息。

OT 消息

struct otMessage otMessage

该类型是 OpenThread 消息缓冲区的不透明表示形式。

otMessagePriority

enum otMessagePriority otMessagePriority

此枚举定义 OpenThread 消息优先级。

otMessageQueueInfo

struct otMessageQueueInfo otMessageQueueInfo

此结构表示消息队列的相关信息。

otMessageSettings

struct otMessageSettings otMessageSettings

此结构代表一项消息设置。

函数

otMessageAttach

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

在消息中附加字节。

详细说明
参数
[in] aMessage
指向消息缓冲区的指针。
[in] aBuf
指向要附加的数据的指针。
[in] aLength
要附加的字节数。
返回值
OT_ERROR_NONE
已成功附加到邮件
OT_ERROR_NO_BUFS
没有可用于扩展消息的可用缓冲区。
另请参阅：
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

OTT 服务

void otMessageFree(
  otMessage *aMessage
)

释放已分配的消息缓冲区。

详细说明
参数
[in] aMessage
指向消息缓冲区的指针。
另请参阅：
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetBufferInfo

void otMessageGetBufferInfo(
  otInstance *aInstance,
  otBufferInfo *aBufferInfo
)

获取消息缓冲区信息。

详细说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
[out] aBufferInfo
写入消息缓冲区信息的指针。

otGetGetLength

uint16_t otMessageGetLength(
  const otMessage *aMessage
)

获取消息长度（以字节为单位）。

详细说明
参数
[in] aMessage
指向消息缓冲区的指针。
返回
消息长度（以字节为单位）。
另请参阅：
otMessageFree
otMessageAttach
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetOffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

获取消息偏移量（以字节为单位）。

详细说明
参数
[in] aMessage
指向消息缓冲区的指针。
返回
消息偏移值。
另请参阅：
otMessageFree
otMessageAttach
otMessageGetLength
otMessageSetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetRss

int8_t otMessageGetRss(
  const otMessage *aMessage
)

此函数返回与消息关联的平均 RSS（接收信号强度）。

详细说明
返回
平均 RSS 值（以 dBm 为单位）或 OT_RADIO_RSSI_INVALID（如果没有可用的平均 RSS）。

已启用 oMessageMessage

bool otMessageIsLinkSecurityEnabled(
  const otMessage *aMessage
)

此函数用于指明是否为邮件启用了链接安全。

详细说明
参数
[in] aMessage
指向消息缓冲区的指针。
返回值
TRUE
已启用链接安全性。
FALSE
未启用链接安全性。

otMessageQueueDequeue

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

此函数会从指定消息队列移除消息。

详细说明
参数
[in] aQueue
指向消息队列的指针。
[in] aMessage
要移除的消息。

otMessageQueueEnqueue

void otMessageQueueEnqueue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

此函数会将消息添加到给定消息队列的末尾。

详细说明
参数
[in] aQueue
指向消息队列的指针。
[in] aMessage
要添加的消息。

otMessageQueueEnqueueAtHead

void otMessageQueueEnqueueAtHead(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

此函数会将消息添加到给定消息队列的头部/前面。

详细说明
参数
[in] aQueue
指向消息队列的指针。
[in] aMessage
要添加的消息。

otMessageQueueGetHead

otMessage * otMessageQueueGetHead(
  otMessageQueue *aQueue
)

此函数返回一个指针，该指针指向队列顶部的消息。

详细说明
参数
[in] aQueue
指向消息队列的指针。
返回
一个指针，指向队列顶部的消息；如果队列为空，则为 NULL。

otMessageQueueGetNext

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

此函数通过向前迭代（从头到尾）返回一个指向队列中下一条消息的指针。

详细说明
参数
[in] aQueue
指向消息队列的指针。
[in] aMessage
指向当前消息缓冲区的指针。
返回
指向 aMessage 后队列中的下一条消息的指针，如果 aMessage is the tail of queue. NULL is returned ifaMessageis not in the queueaQueue`，则返回 NULL。

otMessageQueueInit

void otMessageQueueInit(
  otMessageQueue *aQueue
)

初始化消息队列。

在任何其他 otMessageQueue 函数之前，必须针对 otMessageQueue 实例调用此函数一次，且仅调用一次。如果在使用其他 otMessageQueue 初始化队列 API 或初始化它多次或多次初始化此行为时，则未定义此行为。

详细说明
参数
[in] aQueue
指向消息队列的指针。

otMessageRead

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

从消息中读取字节。

详细说明
参数
[in] aMessage
指向消息缓冲区的指针。
[in] aOffset
以字节为单位的偏移量。
[in] aBuf
指向消息字节被读取的缓冲区的指针。
[in] aLength
要读取的字节数。
返回
读取的字节数。
另请参阅：
otMessageFree
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite

otMessageResetBufferInfo

void otMessageResetBufferInfo(
  otInstance *aInstance
)

重置消息缓冲区信息计数器以同时跟踪正在使用的缓冲区数上限。

这会重置 otBufferInfo 中的 mMaxUsedBuffers。

详细说明
参数
[in] aInstance
指向 OpenThread 实例的指针。

otMessageSetDirectTransmission

void otMessageSetDirectTransmission(
  otMessage *aMessage,
  bool aEnabled
)

此函数设置/强制使用直接传输转发消息。

新消息的默认设置是 false。

详细说明
参数
[in] aMessage
指向消息缓冲区的指针。
[in] aEnabled
如果为 true，则消息将被强制使用直接传输。如果为 false，则消息遵循常规过程。

otMessageSetLength

otError otMessageSetLength(
  otMessage *aMessage,
  uint16_t aLength
)

设置消息长度（以字节为单位）。

详细说明
参数
[in] aMessage
指向消息缓冲区的指针。
[in] aLength
长度（以字节为单位）。
返回值
OT_ERROR_NONE
已成功设置消息长度。
OT_ERROR_NO_BUFS
没有可用于扩展消息的可用缓冲区。
另请参阅：
otMessageFree
otMessageAttach
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageSetOffset

void otMessageSetOffset(
  otMessage *aMessage,
  uint16_t aOffset
)

设置消息偏移量（以字节为单位）。

详细说明
参数
[in] aMessage
指向消息缓冲区的指针。
[in] aOffset
以字节为单位的偏移量。
另请参阅：
otMessageFree
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite

otMessageWrite

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

向消息写入字节。

详细说明
参数
[in] aMessage
指向消息缓冲区的指针。
[in] aOffset
以字节为单位的偏移量。
[in] aBuf
指向写入消息字节的缓冲区的指针。
[in] aLength
要写入的字节数。
返回
写入的字节数。
另请参阅：
otMessageFree
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead

资源

OpenThread API 参考主题源自 GitHub 上提供的源代码。 如需了解详情或为我们的文档做出贡献，请参阅资源。