信息

該模塊包括操縱OpenThread消息緩衝區的函數。

概要

枚舉
`otMessagePriority { OT_MESSAGE_PRIORITY_LOW = 0, OT_MESSAGE_PRIORITY_NORMAL = 1, OT_MESSAGE_PRIORITY_HIGH = 2 }`	枚舉該枚舉定義了OpenThread消息優先級。

類型定義
`otBufferInfo`	類型定義 `struct otBufferInfo` 此結構表示消息緩衝區信息。
`otMessage`	類型定義 `struct otMessage` 此結構指向一個OpenThread消息緩衝區。
`otMessagePriority`	類型定義 `enum otMessagePriority` 該枚舉定義了OpenThread消息優先級。
`otMessageSettings`	類型定義 `struct otMessageSettings` 此結構表示消息設置。

職能
`otMessageAppend ( otMessage aMessage, const void aBuf, uint16_t aLength)`	`otError` 將字節追加到消息。
`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)`	`otMessage *` 此函數返回指向隊列開頭消息的指針。
`otMessageQueueGetNext ( otMessageQueue aQueue, const otMessage aMessage)`	`otMessage *` 此函數通過向前（從頭到尾）迭代來返回指向隊列中下一條消息的指針。
`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)`	`otError` 設置消息長度（以字節為單位）。
`otMessageSetOffset ( otMessage *aMessage, uint16_t aOffset)`	`void` 設置消息偏移量（以字節為單位）。
`otMessageWrite ( otMessage aMessage, uint16_t aOffset, const void aBuf, uint16_t aLength)`	`int` 將字節寫入消息。

結構
otBufferInfo	此結構表示消息緩衝區信息。
otMessage	此結構指向一個OpenThread消息緩衝區。
otMessageQueue	此結構表示一個OpenThread消息隊列。
otMessageSettings	此結構表示消息設置。

枚舉

otMessagePriority

第0346章

該枚舉定義了OpenThread消息優先級。

物產
`OT_MESSAGE_PRIORITY_HIGH`	高優先級。
`OT_MESSAGE_PRIORITY_LOW`	低優先級。
`OT_MESSAGE_PRIORITY_NORMAL`	普通優先級。

類型定義

otBufferInfo

struct otBufferInfo otBufferInfo

此結構表示消息緩衝區信息。

otMessage

struct otMessage otMessage

此結構指向一個OpenThread消息緩衝區。

otMessagePriority

enum otMessagePriority otMessagePriority

該枚舉定義了OpenThread消息優先級。

otMessageSettings

struct otMessageSettings otMessageSettings

此結構表示消息設置。

職能

otMessageAppend

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

otMessageFree

void otMessageFree(
  otMessage *aMessage
)

釋放分配的消息緩衝區。

細節

參量

[in] aMessage

指向消息緩衝區的指針。

也可以看看：
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetBufferInfo

void otMessageGetBufferInfo(
  otInstance *aInstance,
  otBufferInfo *aBufferInfo
)

獲取消息緩衝區信息。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[out] aBufferInfo`	寫入消息緩衝區信息的指針。

otMessageGetLength

uint16_t otMessageGetLength(
  const otMessage *aMessage
)

獲取消息長度（以字節為單位）。

細節

參量

[in] aMessage

指向消息緩衝區的指針。

退貨

消息長度（以字節為單位）。

也可以看看：
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetLength

otMessageGetOffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

獲取消息偏移量（以字節為單位）。

細節

參量

[in] aMessage

指向消息緩衝區的指針。

退貨

消息偏移值。

也可以看看：
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetRss

int8_t otMessageGetRss(
  const otMessage *aMessage
)

此函數返回與消息關聯的平均RSS（接收信號強度）。

細節
退貨	如果沒有可用的平均RSS，則平均RSS值（以dBm為單位）或OT_RADIO_RSSI_INVALID。

otMessageIsLinkSecurityEnabled

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 if NULL aMessage is the tail of queue. NULL is returned if aMessage is not in the queue aQueue is not in the queue aMessage is the tail of queue. NULL is returned if 。

otMessageQueueInit

void otMessageQueueInit(
  otMessageQueue *aQueue
)

初始化消息隊列。

對於otMessageQueue實例，必須僅一次調用此函數一次，然後再調用其他otMessageQueue函數。如果其他隊列API在初始化之前與otMessageQueue一起使用，或者該初始化被多次初始化，則該行為是不確定的。

細節

參量

[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
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite

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
otMessageAppend
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageSetOffset

void otMessageSetOffset(
  otMessage *aMessage,
  uint16_t aOffset
)

設置消息偏移量（以字節為單位）。

細節

參量

`[in] aMessage`	指向消息緩衝區的指針。
`[in] aOffset`	以字節為單位的偏移量。

也可以看看：
otMessageFree
otMessageAppend
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
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead