Pesan

Modul ini menyertakan fungsi yang memanipulasi buffering pesan OpenThread.

Ringkasan

Enumerasi
otMessagePriority{   OT_MESSAGE_PRIORITY_LOW = 0,   OT_MESSAGE_PRIORITY_NORMAL = 1,   OT_MESSAGE_PRIORITY_HIGH = 2 }	enum Menentukan tingkat prioritas pesan OpenThread.

Typedef
otBufferInfo	typedef struct otBufferInfo Menampilkan informasi buffer pesan untuk berbagai antrean yang digunakan oleh stack OpenThread.
otMessage	typedef struct otMessage Representasi buram dari buffering pesan OpenThread.
otMessagePriority	typedef enum otMessagePriority Menentukan tingkat prioritas pesan OpenThread.
otMessageQueueInfo	typedef struct otMessageQueueInfo Menampilkan informasi tentang antrean pesan.
otMessageSettings	typedef struct otMessageSettings Mewakili setelan pesan.

Fungsi
otMessageAppend(otMessage *aMessage, const void *aBuf, uint16_t aLength)	otError Menambahkan byte ke pesan.
otMessageFree(otMessage *aMessage)	void Kosongkan buffering pesan yang dialokasikan.
otMessageGetBufferInfo(otInstance *aInstance, otBufferInfo *aBufferInfo)	void Mendapatkan informasi Message Buffer.
otMessageGetLength(const otMessage *aMessage)	uint16_t Mendapatkan panjang pesan dalam byte.
otMessageGetOffset(const otMessage *aMessage)	uint16_t Mendapatkan offset pesan dalam byte.
otMessageGetRss(const otMessage *aMessage)	int8_t Menampilkan RSS (kekuatan sinyal yang diterima) rata-rata yang terkait dengan pesan.
otMessageIsLinkSecurityEnabled(const otMessage *aMessage)	bool Menunjukkan apakah keamanan link diaktifkan untuk pesan atau tidak.
otMessageQueueDequeue(otMessageQueue *aQueue, otMessage *aMessage)	void Menghapus pesan dari antrean pesan yang diberikan.
otMessageQueueEnqueue(otMessageQueue *aQueue, otMessage *aMessage)	void Menambahkan pesan ke akhir antrean pesan yang diberikan.
otMessageQueueEnqueueAtHead(otMessageQueue *aQueue, otMessage *aMessage)	void Menambahkan pesan di bagian depan/depan antrean pesan yang diberikan.
otMessageQueueGetHead(otMessageQueue *aQueue)	otMessage * Menampilkan pointer ke pesan di bagian awal antrean.
otMessageQueueGetNext(otMessageQueue *aQueue, const otMessage *aMessage)	otMessage * Menampilkan pointer ke pesan berikutnya dalam antrean dengan melakukan iterasi ke depan (dari head ke tail).
otMessageQueueInit(otMessageQueue *aQueue)	void Lakukan inisialisasi antrean pesan.
otMessageRead(const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength)	uint16_t Membaca byte dari pesan.
otMessageResetBufferInfo(otInstance *aInstance)	void Mereset penghitung informasi buffering Pesan yang melacak buffering jumlah maksimum yang digunakan secara bersamaan.
otMessageSetDirectTransmission(otMessage *aMessage, bool aEnabled)	void Menetapkan/memaksa pesan untuk diteruskan menggunakan transmisi langsung.
otMessageSetLength(otMessage *aMessage, uint16_t aLength)	otError Tetapkan panjang pesan dalam byte.
otMessageSetOffset(otMessage *aMessage, uint16_t aOffset)	void Menetapkan offset pesan dalam byte.
otMessageWrite(otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength)	int Menulis byte ke pesan.

Struct
otBufferInfo	Menampilkan informasi buffer pesan untuk berbagai antrean yang digunakan oleh stack OpenThread.
otMessageQueue	Merepresentasikan antrean pesan OpenThread.
otMessageQueue	Menampilkan informasi tentang antrean pesan.
otMessageSettings	Mewakili setelan pesan.

Enumerasi

OTMessagePriority

 otMessagePriority

Menentukan tingkat prioritas pesan OpenThread.

Properti
OT_MESSAGE_PRIORITY_HIGH	Tingkat prioritas tinggi.
OT_MESSAGE_PRIORITY_LOW	Tingkat prioritas rendah.
OT_MESSAGE_PRIORITY_NORMAL	Tingkat prioritas normal.

Typedef

BufferBufferInfo

struct otBufferInfo otBufferInfo

Menampilkan informasi buffer pesan untuk berbagai antrean yang digunakan oleh stack OpenThread.

OTMessage

struct otMessage otMessage

Representasi buram dari buffering pesan OpenThread.

OTMessagePriority

enum otMessagePriority otMessagePriority

Menentukan tingkat prioritas pesan OpenThread.

OTMessageQueueInfo

struct otMessageQueueInfo otMessageQueueInfo

Menampilkan informasi tentang antrean pesan.

OTMessageSettings

struct otMessageSettings otMessageSettings

Mewakili setelan pesan.

Fungsi

OTMessageAdd

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

Menambahkan byte ke pesan.

Detail
Parameter	[in] aMessage Pointer ke buffering pesan. [in] aBuf Pointer ke data yang akan ditambahkan. [in] aLength Jumlah byte yang akan ditambahkan.
Nilai yang Ditampilkan	OT_ERROR_NONE Berhasil ditambahkan ke pesan OT_ERROR_NO_BUFS Tidak ada buffering yang tersedia untuk menumbuhkan pesan.

Lihat juga:
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

OTMessageGratis

void otMessageFree(
  otMessage *aMessage
)

Kosongkan buffering pesan yang dialokasikan.

Detail
Parameter	[in] aMessage Pointer ke buffering pesan.

Lihat juga:
otMessageAdd
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

OTMessageGetBufferInfo

void otMessageGetBufferInfo(
  otInstance *aInstance,
  otBufferInfo *aBufferInfo
)

Mendapatkan informasi Message Buffer.

Detail
Parameter	[in] aInstance Pointer ke instance OpenThread. [out] aBufferInfo Pointer tempat informasi buffer pesan ditulis.

OTMessageGetLength

uint16_t otMessageGetLength(
  const otMessage *aMessage
)

Mendapatkan panjang pesan dalam byte.

Detail
Parameter	[in] aMessage Pointer ke buffering pesan.
Pengembalian	Panjang pesan dalam byte.

Lihat juga:
otMessageFree
otMessageAdd
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetLength

OTMessageGetOffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

Mendapatkan offset pesan dalam byte.

Detail
Parameter	[in] aMessage Pointer ke buffering pesan.
Pengembalian	Nilai offset pesan.

Lihat juga:
otMessageFree
otMessageAdd
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite

OTMessageGetRss

int8_t otMessageGetRss(
  const otMessage *aMessage
)

Menampilkan RSS (kekuatan sinyal yang diterima) rata-rata yang terkait dengan pesan.

Detail
Pengembalian	Nilai RSS rata-rata (dalam dBm) atau OT_MRC_RSSI_INVALID jika RSS rata-rata tidak tersedia.

OTMessageIsLinkSecurityEnabled

bool otMessageIsLinkSecurityEnabled(
  const otMessage *aMessage
)

Menunjukkan apakah keamanan link diaktifkan untuk pesan atau tidak.

Detail
Parameter	[in] aMessage Pointer ke buffering pesan.
Nilai yang Ditampilkan	TRUE Jika keamanan link diaktifkan. FALSE Jika keamanan link tidak diaktifkan.

OTMessageQueueDeQueue

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Menghapus pesan dari antrean pesan yang diberikan.

Detail
Parameter	[in] aQueue Pointer ke antrean pesan. [in] aMessage Pesan yang akan dihapus.

OTMessageQueueEnQueue

void otMessageQueueEnqueue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Menambahkan pesan ke akhir antrean pesan yang diberikan.

Detail
Parameter	[in] aQueue Pointer ke antrean pesan. [in] aMessage Pesan yang akan ditambahkan.

OTMessageQueueEnQueueAtHead

void otMessageQueueEnqueueAtHead(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Menambahkan pesan di bagian depan/depan antrean pesan yang diberikan.

Detail
Parameter	[in] aQueue Pointer ke antrean pesan. [in] aMessage Pesan yang akan ditambahkan.

OTMessageQueueGetHead

otMessage * otMessageQueueGetHead(
  otMessageQueue *aQueue
)

Menampilkan pointer ke pesan di bagian awal antrean.

Detail
Parameter	[in] aQueue Pointer ke antrean pesan.
Pengembalian	Pointer ke pesan di kepala antrean atau NULL jika antrean kosong.

OTMessageQueueGetNext

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

Menampilkan pointer ke pesan berikutnya dalam antrean dengan melakukan iterasi ke depan (dari head ke tail).

Detail
Parameter	[in] aQueue Pointer ke antrean pesan. [in] aMessage Pointer ke buffering pesan saat ini.
Pengembalian	Pointer ke pesan berikutnya dalam antrean setelah aMessage atau NULL jika aMessage is the tail of queue. NULL is returned ifaMessageis not in the queueaQueue`.

OTMessageQueueInit

void otMessageQueueInit(
  otMessageQueue *aQueue
)

Lakukan inisialisasi antrean pesan.

HARUS dipanggil sekali dan hanya sekali untuk instance otMessageQueue sebelum fungsi otMessageQueue lainnya. Perilaku ini tidak ditentukan jika API antrean lain digunakan dengan otMessageQueue sebelum diinisialisasi atau jika diinisialisasi lebih dari sekali.

Detail
Parameter	[in] aQueue Pointer ke antrean pesan.

OTMessageRead

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

Membaca byte dari pesan.

Detail
Parameter	[in] aMessage Pointer ke buffering pesan. [in] aOffset Offset dalam byte. [in] aBuf Pointer ke buffering tempat byte pesan dibaca. [in] aLength Jumlah byte yang akan dibaca.
Pengembalian	Jumlah byte yang dibaca.

Lihat juga:
otMessageFree
otMessageAdd
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite

OTMessageResetBufferInfo

void otMessageResetBufferInfo(
  otInstance *aInstance
)

Mereset penghitung informasi buffering Pesan yang melacak buffering jumlah maksimum yang digunakan secara bersamaan.

Tindakan ini akan mereset mMaxUsedBuffers di otBufferInfo.

Detail
Parameter	[in] aInstance Pointer ke instance OpenThread.

otMessageSetDirectTransmisi

void otMessageSetDirectTransmission(
  otMessage *aMessage,
  bool aEnabled
)

Menetapkan/memaksa pesan untuk diteruskan menggunakan transmisi langsung.

Setelan default untuk pesan baru adalah false.

Detail
Parameter	[in] aMessage Pointer ke buffering pesan. [in] aEnabled Jika true, pesan tersebut dipaksa untuk menggunakan transmisi langsung. Jika false, pesan mengikuti prosedur normal.

OTMessageSetLength

otError otMessageSetLength(
  otMessage *aMessage,
  uint16_t aLength
)

Tetapkan panjang pesan dalam byte.

Detail
Parameter	[in] aMessage Pointer ke buffering pesan. [in] aLength Panjang dalam byte.
Nilai yang Ditampilkan	OT_ERROR_NONE Berhasil menetapkan panjang pesan. OT_ERROR_NO_BUFS Tidak ada buffering yang tersedia untuk menumbuhkan pesan.

Lihat juga:
otMessageFree
otMessageAdd
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

OTMessageSetOffset

void otMessageSetOffset(
  otMessage *aMessage,
  uint16_t aOffset
)

Menetapkan offset pesan dalam byte.

Detail
Parameter	[in] aMessage Pointer ke buffering pesan. [in] aOffset Offset dalam byte.

Lihat juga:
otMessageFree
otMessageAdd
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite

OTMessage

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

Menulis byte ke pesan.

Detail
Parameter	[in] aMessage Pointer ke buffering pesan. [in] aOffset Offset dalam byte. [in] aBuf Pointer ke buffering tempat byte pesan ditulis. [in] aLength Jumlah byte yang akan ditulis.
Pengembalian	Jumlah byte yang ditulis.

Lihat juga:
otMessageFree
otMessageAdd
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead

Resource

Topik Referensi OpenThread API berasal dari kode sumber, yang tersedia di GitHub. Untuk informasi selengkapnya, atau untuk berkontribusi pada dokumentasi kami, lihat Referensi.