Google cam kết thúc đẩy công bằng chủng tộc cho Cộng đồng người da đen. Xem cách thực hiện.

Nội dung

Mô-đun này bao gồm các hàm điều khiển bộ đệm tin nhắn OpenThread.

Tóm tắt

Bảng liệt kê

otMessagePriority{
  OT_MESSAGE_PRIORITY_LOW = 0,
  OT_MESSAGE_PRIORITY_NORMAL = 1,
  OT_MESSAGE_PRIORITY_HIGH = 2
}
enum
Bảng liệt kê này xác định mức độ ưu tiên của thông báo OpenThread.

Typedef

otBufferInfo typedef
struct otBufferInfo
Cấu trúc này đại diện cho thông tin bộ đệm thư cho các hàng đợi khác nhau mà ngăn xếp OpenThread sử dụng.
otMessage typedef
struct otMessage
Loại này là đại diện mờ của một bộ đệm tin nhắn OpenThread.
otMessagePriority typedef
Bảng liệt kê này xác định mức độ ưu tiên của thông báo OpenThread.
otMessageQueueInfo typedef
Cấu trúc này thể hiện thông tin về một hàng đợi tin nhắn.
otMessageSettings typedef
Cấu trúc này đại diện cho một chế độ cài đặt thông báo.

Hàm

otMessageAppend(otMessage *aMessage, const void *aBuf, uint16_t aLength)
Thêm byte vào một thông báo.
otMessageFree(otMessage *aMessage)
void
Giải phóng bộ đệm tin nhắn được phân bổ.
otMessageGetBufferInfo(otInstance *aInstance, otBufferInfo *aBufferInfo)
void
Nhận thông tin về Vùng đệm tin nhắn.
otMessageGetLength(const otMessage *aMessage)
uint16_t
Nhận độ dài tin nhắn tính bằng byte.
otMessageGetOffset(const otMessage *aMessage)
uint16_t
Nhận giá trị chênh lệch của tin nhắn tính bằng byte.
otMessageGetRss(const otMessage *aMessage)
int8_t
Hàm này trả về RSS trung bình (cường độ tín hiệu nhận được) liên kết với thông báo.
otMessageIsLinkSecurityEnabled(const otMessage *aMessage)
bool
Chức năng này cho biết liệu bảo mật liên kết có được bật cho thư hay không.
otMessageQueueDequeue(otMessageQueue *aQueue, otMessage *aMessage)
void
Hàm này xóa một thư khỏi hàng đợi thư đã cho.
otMessageQueueEnqueue(otMessageQueue *aQueue, otMessage *aMessage)
void
Hàm này thêm một thông báo vào cuối hàng đợi thông báo đã cho.
otMessageQueueEnqueueAtHead(otMessageQueue *aQueue, otMessage *aMessage)
void
Hàm này thêm một thông báo ở đầu/phía trước hàng đợi thông báo đã cho.
otMessageQueueGetHead(otMessageQueue *aQueue)
Hàm này trả về một con trỏ tới thông báo ở đầu hàng đợi.
otMessageQueueGetNext(otMessageQueue *aQueue, const otMessage *aMessage)
Hàm này trả về một con trỏ cho thông báo tiếp theo trong hàng đợi bằng cách lặp lại về phía trước (từ đầu đến cuối).
otMessageQueueInit(otMessageQueue *aQueue)
void
Khởi tạo hàng đợi thông báo.
otMessageRead(const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength)
uint16_t
Đọc byte từ một thư.
otMessageSetDirectTransmission(otMessage *aMessage, bool aEnabled)
void
Hàm này sẽ đặt/buộc chuyển tiếp thư bằng phương thức truyền trực tiếp.
otMessageSetLength(otMessage *aMessage, uint16_t aLength)
Đặt độ dài tin nhắn tính bằng byte.
otMessageSetOffset(otMessage *aMessage, uint16_t aOffset)
void
Đặt độ lệch của thông báo theo byte.
otMessageWrite(otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength)
int
Viết byte vào một tin nhắn.

Cấu trúc

otBufferInfo

Cấu trúc này đại diện cho thông tin bộ đệm thư cho các hàng đợi khác nhau mà ngăn xếp OpenThread sử dụng.

otMessageQueue

Cấu trúc này đại diện cho một hàng đợi tin nhắn OpenThread.

otMessageQueueInfo

Cấu trúc này thể hiện thông tin về một hàng đợi tin nhắn.

otMessageSettings

Cấu trúc này đại diện cho một chế độ cài đặt thông báo.

Bảng liệt kê

Ưu tiên otMessage

 otMessagePriority

Bảng liệt kê này xác định mức độ ưu tiên của thông báo OpenThread.

Tài sản
OT_MESSAGE_PRIORITY_HIGH

Mức độ ưu tiên cao.

OT_MESSAGE_PRIORITY_LOW

Mức độ ưu tiên thấp.

OT_MESSAGE_PRIORITY_NORMAL

Mức độ ưu tiên bình thường.

Typedef

otBufferInfo

struct otBufferInfo otBufferInfo

Cấu trúc này đại diện cho thông tin bộ đệm thư cho các hàng đợi khác nhau mà ngăn xếp OpenThread sử dụng.

Tin nhắn ottin

struct otMessage otMessage

Loại này là đại diện mờ của một bộ đệm tin nhắn OpenThread.

Ưu tiên otMessage

enum otMessagePriority otMessagePriority

Bảng liệt kê này xác định mức độ ưu tiên của thông báo OpenThread.

otMessageQueueInfo

struct otMessageQueueInfo otMessageQueueInfo

Cấu trúc này thể hiện thông tin về một hàng đợi tin nhắn.

Cài đặt Tin nhắn

struct otMessageSettings otMessageSettings

Cấu trúc này đại diện cho một chế độ cài đặt thông báo.

Hàm

AppotApp

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

Thêm byte vào một thông báo.

Thông tin chi tiết
Thông số
[in] aMessage
Con trỏ đến bộ đệm tin nhắn.
[in] aBuf
Con trỏ đến dữ liệu cần thêm.
[in] aLength
Số byte cần thêm vào.
Giá trị trả về
OT_ERROR_NONE
Đã thêm vào tin nhắn thành công
OT_ERROR_NO_BUFS
Không có bộ đệm nào để phát triển thông báo.
Xem thêm:
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

Tin nhắn miễn phí

void otMessageFree(
  otMessage *aMessage
)

Giải phóng bộ đệm tin nhắn được phân bổ.

Thông tin chi tiết
Thông số
[in] aMessage
Con trỏ đến bộ đệm tin nhắn.
Xem thêm:
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetBufferInfo

void otMessageGetBufferInfo(
  otInstance *aInstance,
  otBufferInfo *aBufferInfo
)

Nhận thông tin về Vùng đệm tin nhắn.

Thông tin chi tiết
Thông số
[in] aInstance
Con trỏ tới phiên bản OpenThread.
[out] aBufferInfo
Con trỏ nơi nhập thông tin về bộ đệm thư.

otMessageGetLength

uint16_t otMessageGetLength(
  const otMessage *aMessage
)

Nhận độ dài tin nhắn tính bằng byte.

Thông tin chi tiết
Thông số
[in] aMessage
Con trỏ đến bộ đệm tin nhắn.
Trả lại
Độ dài của thư tính bằng byte.
Xem thêm:
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetLength

otMessageGetoffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

Nhận giá trị chênh lệch của tin nhắn tính bằng byte.

Thông tin chi tiết
Thông số
[in] aMessage
Con trỏ đến bộ đệm tin nhắn.
Trả lại
Giá trị bù trừ tin nhắn.
Xem thêm:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetRs

int8_t otMessageGetRss(
  const otMessage *aMessage
)

Hàm này trả về RSS trung bình (cường độ tín hiệu nhận được) liên kết với thông báo.

Thông tin chi tiết
Trả lại
Giá trị RSS trung bình (tính bằng dBm) hoặc OT_RADIO_RSSI_INVALID nếu không có RSS trung bình.

otMessageIsLinkSecurityEnabled

bool otMessageIsLinkSecurityEnabled(
  const otMessage *aMessage
)

Chức năng này cho biết liệu bảo mật liên kết có được bật cho thư hay không.

Thông tin chi tiết
Thông số
[in] aMessage
Con trỏ đến bộ đệm tin nhắn.
Giá trị trả về
TRUE
Nếu tính năng bảo mật đường liên kết được bật.
FALSE
Nếu tính năng bảo mật đường liên kết chưa được bật.

otMessageQueueDeQueue

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Hàm này xóa một thư khỏi hàng đợi thư đã cho.

Thông tin chi tiết
Thông số
[in] aQueue
Con trỏ đến hàng đợi tin nhắn.
[in] aMessage
Tin nhắn cần xóa.

otMessageQueueEnQueue

void otMessageQueueEnqueue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Hàm này thêm một thông báo vào cuối hàng đợi thông báo đã cho.

Thông tin chi tiết
Thông số
[in] aQueue
Con trỏ đến hàng đợi tin nhắn.
[in] aMessage
Tin nhắn cần thêm.

otMessageQueueEnQueueAtHEAD

void otMessageQueueEnqueueAtHead(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Hàm này thêm một thông báo ở đầu/phía trước hàng đợi thông báo đã cho.

Thông tin chi tiết
Thông số
[in] aQueue
Con trỏ đến hàng đợi tin nhắn.
[in] aMessage
Tin nhắn cần thêm.

otMessageQueueGetHEAD

otMessage * otMessageQueueGetHead(
  otMessageQueue *aQueue
)

Hàm này trả về một con trỏ tới thông báo ở đầu hàng đợi.

Thông tin chi tiết
Thông số
[in] aQueue
Con trỏ đến hàng đợi tin nhắn.
Trả lại
Con trỏ đến thông báo ở đầu hàng đợi hoặc NULL nếu hàng đợi trống.

otMessageQueueGetNext

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

Hàm này trả về một con trỏ cho thông báo tiếp theo trong hàng đợi bằng cách lặp lại về phía trước (từ đầu đến cuối).

Thông tin chi tiết
Thông số
[in] aQueue
Con trỏ đến hàng đợi tin nhắn.
[in] aMessage
Con trỏ đến bộ đệm tin nhắn hiện tại.
Trả lại
Con trỏ đến thông báo tiếp theo trong hàng đợi sau aMessage hoặc NULL nếu aMessage is the tail of queue. NULL is returned ifaMessageis not in the queueaQueue`.

otMessageQueueInit

void otMessageQueueInit(
  otMessageQueue *aQueue
)

Khởi tạo hàng đợi thông báo.

Hàm này PHẢI được gọi một lần và chỉ được gọi một lần cho bản sao otMessageQueue trước mọi hàm otMessageQueue khác. Hành vi này không được xác định nếu các API hàng đợi khác được sử dụng với otMessageQueue trước khi khởi tạo hoặc nếu API được khởi tạo nhiều lần.

Thông tin chi tiết
Thông số
[in] aQueue
Con trỏ đến hàng đợi tin nhắn.

Đọc trên otMessage

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

Đọc byte từ một thư.

Thông tin chi tiết
Thông số
[in] aMessage
Con trỏ đến bộ đệm tin nhắn.
[in] aOffset
Mức chênh lệch tính bằng byte.
[in] aBuf
Con trỏ tới một bộ đệm lưu các byte thông báo.
[in] aLength
Số lượng byte cần đọc.
Trả lại
Số lượng byte đã đọc.
Xem thêm:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite

otMessageSetDirectTransmission

void otMessageSetDirectTransmission(
  otMessage *aMessage,
  bool aEnabled
)

Hàm này sẽ đặt/buộc chuyển tiếp thư bằng phương thức truyền trực tiếp.

Chế độ cài đặt mặc định cho tin nhắn mới là false.

Thông tin chi tiết
Thông số
[in] aMessage
Con trỏ đến bộ đệm tin nhắn.
[in] aEnabled
Nếu true, tin nhắn bắt buộc phải sử dụng chế độ truyền trực tiếp. Nếu false, tin nhắn sẽ tuân theo quy trình thông thường.

otMessageSetLength

otError otMessageSetLength(
  otMessage *aMessage,
  uint16_t aLength
)

Đặt độ dài tin nhắn tính bằng byte.

Thông tin chi tiết
Thông số
[in] aMessage
Con trỏ đến bộ đệm tin nhắn.
[in] aLength
Độ dài tính bằng byte.
Giá trị trả về
OT_ERROR_NONE
Đặt độ dài tin nhắn thành công.
OT_ERROR_NO_BUFS
Không có bộ đệm nào để phát triển thông báo.
Xem thêm:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageGetOffset
otMessageSetoffset
otMessageRead
otMessageWrite

otMessageSetoffset

void otMessageSetOffset(
  otMessage *aMessage,
  uint16_t aOffset
)

Đặt độ lệch của thông báo theo byte.

Thông tin chi tiết
Thông số
[in] aMessage
Con trỏ đến bộ đệm tin nhắn.
[in] aOffset
Mức chênh lệch tính bằng byte.
Xem thêm:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite

Viết otMessage

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

Viết byte vào một tin nhắn.

Thông tin chi tiết
Thông số
[in] aMessage
Con trỏ đến bộ đệm tin nhắn.
[in] aOffset
Mức chênh lệch tính bằng byte.
[in] aBuf
Con trỏ tới một vùng đệm chứa byte thông báo được viết từ đó.
[in] aLength
Số byte cần ghi.
Trả lại
Số byte được ghi.
Xem thêm:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSet Offset
otMessageRead

Nguồn lực

Các chủ đề về Tham chiếu API OpenThread được tạo từ mã nguồn, có sẵn trên GitHub. Để biết thêm thông tin hoặc để đóng góp cho tài liệu của chúng tôi, hãy tham khảo phần Tài nguyên.