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.

Thông điệp

Mô-đun này bao gồm các hàm thao tác với vùng đệm thông báo 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
Xác định các mức độ ưu tiên của thông báo OpenThread.

Typedef
otBufferInfo typedef
struct otBufferInfo
Biểu thị thông tin vùng đệm thông báo cho các hàng đợi khác nhau mà ngăn xếp OpenThread sử dụng.
otMessage typedef
struct otMessage
Bản trình bày mờ của vùng đệm thông báo OpenThread.
otMessagePriority typedef
Xác định các mức độ ưu tiên của thông báo OpenThread.
otMessageQueueInfo typedef
Biểu thị thông tin về một hàng đợi tin nhắn.
otMessageSettings typedef
Đại diện cho cài đặt thư.

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 vùng đệm tin nhắn được phân bổ.
otMessageGetBufferInfo(otInstance *aInstance, otBufferInfo *aBufferInfo)
void
Nhận thông tin 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 thông báo tính bằng byte.
otMessageGetRss(const otMessage *aMessage)
int8_t
Trả về RSS (cường độ tín hiệu) trung bình của thông báo.
otMessageIsLinkSecurityEnabled(const otMessage *aMessage)
bool
Cho biết liệu tính năng bảo mật đường liên kết đã được bật cho thư hay chưa.
otMessageQueueDequeue(otMessageQueue *aQueue, otMessage *aMessage)
void
Xóa thư khỏi hàng đợi thư đã cho.
otMessageQueueEnqueue(otMessageQueue *aQueue, otMessage *aMessage)
void
Thêm một tin nhắn vào cuối hàng đợi tin nhắn đã cho.
otMessageQueueEnqueueAtHead(otMessageQueue *aQueue, otMessage *aMessage)
void
Thêm một tin nhắn ở đầu/trước hàng đợi tin nhắn đã cho.
otMessageQueueGetHead(otMessageQueue *aQueue)
Trả lại con trỏ tới thông báo ở đầu hàng đợi.
otMessageQueueGetNext(otMessageQueue *aQueue, const otMessage *aMessage)
Trả lại con trỏ tới thư tiếp theo trong hàng đợi bằng cách lặp lại về phía trước (từ đầu đến đuôi).
otMessageQueueInit(otMessageQueue *aQueue)
void
Khởi động hàng đợi tin nhắn.
otMessageRead(const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength)
uint16_t
Đọc byte trong thư.
otMessageResetBufferInfo(otInstance *aInstance)
void
Đặt lại bộ đếm thông tin vùng đệm thông báo cùng một lúc, theo dõi số lượng vùng đệm tối đa được sử dụng.
otMessageSetDirectTransmission(otMessage *aMessage, bool aEnabled)
void
Đặt/buộc thư được chuyển tiếp bằng cách sử dụng 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 mức chênh lệch tin nhắn theo byte.
otMessageWrite(otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength)
int
Ghi các byte vào một thông báo.

Cấu trúc
otBufferInfo

Biểu thị thông tin vùng đệm thông báo cho các hàng đợi khác nhau mà ngăn xếp OpenThread sử dụng.

otMessageQueue

Đại diện cho hàng đợi thông báo OpenThread.

otMessageQueueInfo

Biểu thị thông tin về một hàng đợi tin nhắn.

Cài đặt tin nhắn

Đại diện cho cài đặt thư.

Bảng liệt kê

otMessagepriority

 otMessagePriority

Xác định các mức độ ưu tiên của thông báo OpenThread.

Thuộc tính
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

Biểu thị thông tin vùng đệm thông báo cho các hàng đợi khác nhau mà ngăn xếp OpenThread sử dụng.

Tin nhắn

struct otMessage otMessage

Bản trình bày mờ của vùng đệm thông báo OpenThread.

otMessagepriority

enum otMessagePriority otMessagePriority

Xác định các mức độ ưu tiên của thông báo OpenThread.

otMessageQueueInfo

struct otMessageQueueInfo otMessageQueueInfo

Biểu thị thông tin về một hàng đợi tin nhắn.

Cài đặt Tin nhắn

struct otMessageSettings otMessageSettings

Đại diện cho cài đặt thư.

Hàm

Thêm ứng dụng nhắn tin

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ỏ trỏ đến vùng đệm tin nhắn.
[in] aBuf
Con trỏ trỏ đến dữ liệu cần thêm.
[in] aLength
Số byte cần thêm.
Giá trị trả về
OT_ERROR_NONE
Đã thêm thành công vào thư
OT_ERROR_NO_BUFS
Không có vùng đệm nào để phát đi thông báo.
Xem thêm:
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

không có tin nhắn

void otMessageFree(
  otMessage *aMessage
)

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

Thông tin chi tiết
Thông số
[in] aMessage
Con trỏ trỏ đến vùng đệ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ùng đệm tin nhắn.

Thông tin chi tiết
Thông số
[in] aInstance
Con trỏ tới thực thể OpenThread.
[out] aBufferInfo
Con trỏ nơi ghi thông tin vùng đệm tin nhắn.

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ỏ trỏ đến vùng đệm tin nhắn.
Trả về
Độ dài của tin nhắn tính bằng byte.
Xem thêm:
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
{178ot

otMessageGetOffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

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

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

otMessageGetRss

int8_t otMessageGetRss(
  const otMessage *aMessage
)

Trả về RSS (cường độ tín hiệu) trung bình của thông báo.

Thông tin chi tiết
Trả về
Giá trị RSS trung bình (theo dBm) hoặc OT_RADIO_RSSI_INVALID nếu không có RSS trung bình.

otMessageIsLinkSecurityEnabled

bool otMessageIsLinkSecurityEnabled(
  const otMessage *aMessage
)

Cho biết liệu tính năng bảo mật đường liên kết đã được bật cho thư hay chưa.

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

otMessageQueueDeQueue

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Xóa thư khỏi hàng đợi thư đã cho.

Thông tin chi tiết
Thông số
[in] aQueue
Con trỏ tới hàng đợi thư.
[in] aMessage
Thông báo cần loại bỏ.

otMessageQueueEnQueue

void otMessageQueueEnqueue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Thêm một tin nhắn vào cuối hàng đợi tin nhắn đã cho.

Thông tin chi tiết
Thông số
[in] aQueue
Con trỏ tới hàng đợi thư.
[in] aMessage
Thông báo cần thêm.

otMessageQueueEnQueueAtHead

void otMessageQueueEnqueueAtHead(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Thêm một tin nhắn ở đầu/trước hàng đợi tin nhắn đã cho.

Thông tin chi tiết
Thông số
[in] aQueue
Con trỏ tới hàng đợi thư.
[in] aMessage
Thông báo cần thêm.

otMessageQueueGetHead

otMessage * otMessageQueueGetHead(
  otMessageQueue *aQueue
)

Trả lại 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ỏ tới hàng đợi tin nhắn.
Trả về
Con trỏ tới 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
)

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

Thông tin chi tiết
Thông số
[in] aQueue
Con trỏ tới hàng đợi tin nhắn.
[in] aMessage
Con trỏ trỏ đến vùng đệm tin nhắn hiện tại.
Trả về
Con trỏ tới 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 động hàng đợi tin nhắn.

PHẢI được gọi một lần và chỉ một lần cho mỗi thực thể otMessageQueue trước bất kỳ hàm otMessageQueue nào khác. Hành vi này không xác định được 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ỏ tới hàng đợi tin nhắn.

otMessageRead

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

Đọc byte trong thư.

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

otMessageResetBufferInfo

void otMessageResetBufferInfo(
  otInstance *aInstance
)

Đặt lại bộ đếm thông tin vùng đệm thông báo cùng một lúc, theo dõi số lượng vùng đệm tối đa được sử dụng.

Thao tác này sẽ đặt lại mMaxUsedBuffers trong otBufferInfo.

Thông tin chi tiết
Thông số
[in] aInstance
Con trỏ tới thực thể OpenThread.

otMessageSetDirectTransmission

void otMessageSetDirectTransmission(
  otMessage *aMessage,
  bool aEnabled
)

Đặt/buộc thư được chuyển tiếp bằng cách sử dụng 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ỏ trỏ đến vùng đệm tin nhắn.
[in] aEnabled
Nếu là true, thì thông báo buộc phải sử dụng chế độ truyền trực tiếp. Nếu là false, thông báo sẽ tuân theo quy trình bình 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ỏ trỏ đến vùng đệm tin nhắn.
[in] aLength
Độ dài tính bằng byte.
Giá trị trả về
OT_ERROR_NONE
Đã đặt thành công độ dài tin nhắn.
OT_ERROR_NO_BUFS
Không có vùng đệm nào để phát đi thông báo.
Xem thêm:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageSetOffset

void otMessageSetOffset(
  otMessage *aMessage,
  uint16_t aOffset
)

Đặt mức chênh lệch tin nhắn theo byte.

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

Viết thư

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

Ghi các byte vào một thông báo.

Thông tin chi tiết
Thông số
[in] aMessage
Con trỏ trỏ đến vùng đệm tin nhắn.
[in] aOffset
Độ lệch tính bằng byte.
[in] aBuf
Con trỏ trỏ đến vùng đệm chứa byte thông báo.
[in] aLength
Số byte cần ghi.
Trả về
Số byte đã ghi.
Xem thêm:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead

Tài nguyên

Các chủ đề Tham chiếu API OpenThread bắt nguồn 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.