讯息
此模块包含操作 OpenThread 消息缓冲区的函数。
摘要
枚举 |
|
---|---|
otMessagePriority{
|
枚举 此枚举定义了 OpenThread 消息优先级。 |
类型定义符 |
|
---|---|
otBufferInfo
|
typedefstruct otBufferInfo
此结构表示 OpenThread 堆栈使用的不同队列的消息缓冲区信息。 |
otMessage
|
typedefstruct otMessage
此类型是 OpenThread 消息缓冲区的不透明表示形式。 |
otMessagePriority
|
typedefenum otMessagePriority
此枚举定义了 OpenThread 消息优先级。 |
otMessageQueueInfo
|
typedefstruct otMessageQueueInfo
此结构表示消息队列的相关信息。 |
otMessageSettings
|
typedefstruct otMessageSettings
此结构表示消息设置。 |
函数 |
|
---|---|
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
从消息中读取字节。
|
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 |
此结构表示消息设置。 |
枚举
oOT 消息优先级
otMessagePriority
此枚举定义了 OpenThread 消息优先级。
属性 | |
---|---|
OT_MESSAGE_PRIORITY_HIGH
|
高优先级。 |
OT_MESSAGE_PRIORITY_LOW
|
低优先级。 |
OT_MESSAGE_PRIORITY_NORMAL
|
普通优先级。 |
类型定义符
函数
otMessageAttach
otError otMessageAppend( otMessage *aMessage, const void *aBuf, uint16_t aLength )
在消息中附加字节。
详情 | |||||||
---|---|---|---|---|---|---|---|
参数 |
|
||||||
返回值 |
|
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
没有消息
void otMessageFree( otMessage *aMessage )
释放已分配的消息缓冲区。
详情 | |||
---|---|---|---|
参数 |
|
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageGetBufferInfo
void otMessageGetBufferInfo( otInstance *aInstance, otBufferInfo *aBufferInfo )
获取消息缓冲区信息。
详情 | |||||
---|---|---|---|---|---|
参数 |
|
otMessageGetLength
uint16_t otMessageGetLength( const otMessage *aMessage )
获取消息长度(以字节为单位)。
详情 | |||
---|---|---|---|
参数 |
|
||
返回值 |
消息长度(以字节为单位)。
|
otMessageFree
otMessageAttach
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetLength
otMessageGetOffset
uint16_t otMessageGetOffset( const otMessage *aMessage )
获取消息的偏移量(以字节为单位)。
详情 | |||
---|---|---|---|
参数 |
|
||
返回值 |
消息偏移值。
|
otMessageFree
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite
getMessageGetRss
int8_t otMessageGetRss( const otMessage *aMessage )
此函数返回与消息相关联的平均 RSS(接收信号强度)。
详情 | |
---|---|
返回值 |
平均 RSS 值(以 dBm 为单位)或 OT_RADIO_RSSI_INVALID(如果没有可用的平均 RSS)。
|
otMessageIsLinkSecurityEnabled
bool otMessageIsLinkSecurityEnabled( const otMessage *aMessage )
此函数用于指示消息是否启用了链接安全性。
详情 | |||||
---|---|---|---|---|---|
参数 |
|
||||
返回值 |
|
otMessageQueueDequeue
void otMessageQueueDequeue( otMessageQueue *aQueue, otMessage *aMessage )
此函数从指定消息队列中删除消息。
详情 | |||||
---|---|---|---|---|---|
参数 |
|
otMessageQueueEnqueue 消息
void otMessageQueueEnqueue( otMessageQueue *aQueue, otMessage *aMessage )
此函数将消息添加到给定消息队列的末尾。
详情 | |||||
---|---|---|---|---|---|
参数 |
|
otMessageQueueEnqueueAtHead
void otMessageQueueEnqueueAtHead( otMessageQueue *aQueue, otMessage *aMessage )
此函数在给定消息队列的头部/前面添加一条消息。
详情 | |||||
---|---|---|---|---|---|
参数 |
|
otMessageQueueGetHead
otMessage * otMessageQueueGetHead( otMessageQueue *aQueue )
此函数返回一个在队列顶部指向消息的指针。
详情 | |||
---|---|---|---|
参数 |
|
||
返回值 |
指向队列顶部的消息的指针;如果队列为空,则为 NULL。
|
otMessageQueueGetNext
otMessage * otMessageQueueGetNext( otMessageQueue *aQueue, const otMessage *aMessage )
该函数通过向前迭代(从头到尾)返回队列中下一条消息的指针。
详情 | |||||
---|---|---|---|---|---|
参数 |
|
||||
返回值 |
指向
aMessage 中的下一个消息的指针,如果 aMessage is the tail of queue. NULL is returned if aMessageis not in the queue aQueue`,则返回 NULL。 |
otMessageQueueInit 类中的方法
void otMessageQueueInit( otMessageQueue *aQueue )
初始化消息队列。
该函数只能调用一次,且只能针对otMessageQueue
实例之前otMessageQueue
函数。如果其他队列 API 在初始化之前与 otMessageQueue
一起使用或初始化多次,则未定义此行为。
详情 | |||
---|---|---|---|
参数 |
|
otMessageRead
uint16_t otMessageRead( const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength )
从消息中读取字节。
详情 | |||||||||
---|---|---|---|---|---|---|---|---|---|
参数 |
|
||||||||
返回值 |
读取的字节数。
|
otMessageFree
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite
otMessageSetDirectTransmission
void otMessageSetDirectTransmission( otMessage *aMessage, bool aEnabled )
此函数设置/强制使用直接传输转发消息。
新消息的默认设置是 false
。
详情 | |||||
---|---|---|---|---|---|
参数 |
|
otMessageSetLength
otError otMessageSetLength( otMessage *aMessage, uint16_t aLength )
设置消息长度(以字节为单位)。
详情 | |||||
---|---|---|---|---|---|
参数 |
|
||||
返回值 |
|
otMessageFree
otMessageAttach
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
oMessageMessageSetset
void otMessageSetOffset( otMessage *aMessage, uint16_t aOffset )
设置消息的偏移量(以字节为单位)。
详情 | |||||
---|---|---|---|---|---|
参数 |
|
otMessageFree
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite
OTMessageWrite
int otMessageWrite( otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength )
向消息写入字节。
详情 | |||||||||
---|---|---|---|---|---|---|---|---|---|
参数 |
|
||||||||
返回值 |
写入的字节数。
|
otMessageFree
otMessageAttach
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead