Google berkomitmen untuk mendorong terwujudnya keadilan ras bagi komunitas Kulit Hitam. Lihat caranya.

Pesan

Modul ini menyertakan fungsi yang memanipulasi buffer pesan OpenThread.

Ringkasan

Pencacahan

otMessagePriority {
OT_MESSAGE_PRIORITY_LOW = 0,
OT_MESSAGE_PRIORITY_NORMAL = 1,
OT_MESSAGE_PRIORITY_HIGH = 2
}
enum
Pencacahan ini menentukan tingkat prioritas pesan OpenThread.

Typedefs

otBufferInfo typedef
struct otBufferInfo
Struktur ini merepresentasikan informasi buffer pesan.
otMessage typedef
struct otMessage
Jenis ini adalah representasi buram dari buffer pesan OpenThread.
otMessagePriority typedef
Pencacahan ini menentukan tingkat prioritas pesan OpenThread.
otMessageSettings typedef
Struktur ini mewakili pengaturan pesan.

Fungsi

otMessageAppend ( otMessage *aMessage, const void *aBuf, uint16_t aLength)
Tambahkan byte ke pesan.
otMessageFree ( otMessage *aMessage)
void
Bebaskan buffer pesan yang dialokasikan.
otMessageGetBufferInfo ( otInstance *aInstance, otBufferInfo *aBufferInfo)
void
Dapatkan informasi Message Buffer.
otMessageGetLength (const otMessage *aMessage)
uint16_t
Dapatkan panjang pesan dalam byte.
otMessageGetOffset (const otMessage *aMessage)
uint16_t
Dapatkan pesan offset dalam byte.
otMessageGetRss (const otMessage *aMessage)
int8_t
Fungsi ini mengembalikan RSS rata-rata (kekuatan sinyal yang diterima) yang terkait dengan pesan.
otMessageIsLinkSecurityEnabled (const otMessage *aMessage)
bool
Fungsi ini menunjukkan apakah keamanan tautan diaktifkan untuk pesan atau tidak.
otMessageQueueDequeue ( otMessageQueue *aQueue, otMessage *aMessage)
void
Fungsi ini menghapus pesan dari antrian pesan yang diberikan.
otMessageQueueEnqueue ( otMessageQueue *aQueue, otMessage *aMessage)
void
Fungsi ini menambahkan pesan ke akhir antrian pesan yang diberikan.
otMessageQueueEnqueueAtHead ( otMessageQueue *aQueue, otMessage *aMessage)
void
Fungsi ini menambahkan pesan di kepala / depan antrian pesan yang diberikan.
otMessageQueueGetHead ( otMessageQueue *aQueue)
Fungsi ini mengembalikan penunjuk ke pesan di kepala antrian.
otMessageQueueGetNext ( otMessageQueue *aQueue, const otMessage *aMessage)
Fungsi ini mengembalikan pointer ke pesan berikutnya dalam antrian dengan melakukan iterasi ke depan (dari head to tail).
otMessageQueueInit ( otMessageQueue *aQueue)
void
Inisialisasi antrian pesan.
otMessageRead (const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength)
uint16_t
Membaca byte dari sebuah pesan.
otMessageSetDirectTransmission ( otMessage *aMessage, bool aEnabled)
void
Fungsi ini mengatur / memaksa pesan untuk diteruskan menggunakan transmisi langsung.
otMessageSetLength ( otMessage *aMessage, uint16_t aLength)
Tetapkan panjang pesan dalam byte.
otMessageSetOffset ( otMessage *aMessage, uint16_t aOffset)
void
Atur offset pesan dalam byte.
otMessageWrite ( otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength)
int
Menulis byte ke sebuah pesan.

Structs

otBufferInfo

Struktur ini merepresentasikan informasi buffer pesan.

otMessageQueue

Struktur ini mewakili antrian pesan OpenThread.

otMessageSettings

Struktur ini mewakili pengaturan pesan.

Pencacahan

otMessagePriority

 otMessagePriority

Pencacahan ini 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.

Typedefs

otBufferInfo

struct otBufferInfo otBufferInfo

Struktur ini merepresentasikan informasi buffer pesan.

otMessage

struct otMessage otMessage

Jenis ini adalah representasi buram dari buffer pesan OpenThread.

otMessagePriority

enum otMessagePriority otMessagePriority

Pencacahan ini menentukan tingkat prioritas pesan OpenThread.

otMessageSettings

struct otMessageSettings otMessageSettings

Struktur ini mewakili pengaturan pesan.

Fungsi

otMessageAppend

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

Tambahkan byte ke pesan.

Detail
Parameter
[in] aMessage
Sebuah penunjuk ke buffer pesan.
[in] aBuf
Penunjuk ke data yang akan ditambahkan.
[in] aLength
Jumlah byte untuk ditambahkan.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil ditambahkan ke pesan
OT_ERROR_NO_BUFS
Tidak ada buffer yang tersedia untuk mengembangkan pesan.
Lihat juga:
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageFree

void otMessageFree(
  otMessage *aMessage
)

Bebaskan buffer pesan yang dialokasikan.

Detail
Parameter
[in] aMessage
Sebuah penunjuk ke buffer pesan.
Lihat juga:
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetBufferInfo

void otMessageGetBufferInfo(
  otInstance *aInstance,
  otBufferInfo *aBufferInfo
)

Dapatkan informasi Message Buffer.

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

otMessageGetLength

uint16_t otMessageGetLength(
  const otMessage *aMessage
)

Dapatkan panjang pesan dalam byte.

Detail
Parameter
[in] aMessage
Sebuah penunjuk ke buffer pesan.
Kembali
Panjang pesan dalam byte.
Lihat juga:
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetLength

otMessageGetOffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

Dapatkan pesan offset dalam byte.

Detail
Parameter
[in] aMessage
Sebuah penunjuk ke buffer pesan.
Kembali
Nilai offset pesan.
Lihat juga:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetRss

int8_t otMessageGetRss(
  const otMessage *aMessage
)

Fungsi ini mengembalikan RSS rata-rata (kekuatan sinyal yang diterima) yang terkait dengan pesan.

Detail
Kembali
Nilai RSS rata-rata (dalam dBm) atau OT_RADIO_RSSI_INVALID jika rata-rata RSS tidak tersedia.

otMessageIsLinkSecurityEnabled

bool otMessageIsLinkSecurityEnabled(
  const otMessage *aMessage
)

Fungsi ini menunjukkan apakah keamanan tautan diaktifkan untuk pesan atau tidak.

Detail
Parameter
[in] aMessage
Sebuah penunjuk ke buffer pesan.
Kembalikan Nilai
TRUE
Jika keamanan tautan diaktifkan.
FALSE
Jika keamanan tautan tidak diaktifkan.

otMessageQueueDequeue

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Fungsi ini menghapus pesan dari antrian pesan yang diberikan.

Detail
Parameter
[in] aQueue
Penunjuk ke antrian pesan.
[in] aMessage
Pesan yang akan dihapus.

otMessageQueueEnqueue

void otMessageQueueEnqueue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)
.dll

Fungsi ini menambahkan pesan ke akhir antrian pesan yang diberikan.

Detail
Parameter
[in] aQueue
Penunjuk ke antrian pesan.
[in] aMessage
Pesan untuk ditambahkan.

otMessageQueueEnqueueAtHead

void otMessageQueueEnqueueAtHead(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Fungsi ini menambahkan pesan di kepala / depan antrian pesan yang diberikan.

Detail
Parameter
[in] aQueue
Penunjuk ke antrian pesan.
[in] aMessage
Pesan untuk ditambahkan.

otMessageQueueGetHead

otMessage * otMessageQueueGetHead(
  otMessageQueue *aQueue
)

Fungsi ini mengembalikan penunjuk ke pesan di kepala antrian.

Detail
Parameter
[in] aQueue
Penunjuk ke antrian pesan.
Kembali
Sebuah penunjuk ke pesan di kepala antrian atau NULL jika antrian kosong.

otMessageQueueGetNext

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

Fungsi ini mengembalikan pointer ke pesan berikutnya dalam antrian dengan melakukan iterasi ke depan (dari head to tail).

Detail
Parameter
[in] aQueue
Penunjuk ke antrian pesan.
[in] aMessage
Sebuah penunjuk ke buffer pesan saat ini.
Kembali
Sebuah pointer ke pesan berikutnya dalam antrian setelah aMessage atau NULL jika aMessage is the tail of queue. NULL is returned if aMessage is not in the queue aQueue`.

otMessageQueueInit

void otMessageQueueInit(
  otMessageQueue *aQueue
)

Inisialisasi antrian pesan.

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

Detail
Parameter
[in] aQueue
Penunjuk ke antrian pesan.

otMessageRead

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

Membaca byte dari sebuah pesan.

Detail
Parameter
[in] aMessage
Sebuah penunjuk ke buffer pesan.
[in] aOffset
Offset dalam byte.
[in] aBuf
Sebuah penunjuk ke buffer yang byte pesannya dibaca.
[in] aLength
Jumlah byte untuk dibaca.
Kembali
Jumlah byte yang dibaca.
Lihat juga:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite

otMessageSetDirectTransmission

void otMessageSetDirectTransmission(
  otMessage *aMessage,
  bool aEnabled
)

Fungsi ini mengatur / memaksa pesan untuk diteruskan menggunakan transmisi langsung.

Pengaturan default untuk pesan baru false .

Detail
Parameter
[in] aMessage
Sebuah penunjuk ke buffer pesan.
[in] aEnabled
Jika true , pesan tersebut terpaksa 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
Sebuah penunjuk ke buffer pesan.
[in] aLength
Panjang dalam byte.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil mengatur panjang pesan.
OT_ERROR_NO_BUFS
Tidak ada buffer yang tersedia untuk mengembangkan pesan.
Lihat juga:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageSetOffset

void otMessageSetOffset(
  otMessage *aMessage,
  uint16_t aOffset
)

Atur offset pesan dalam byte.

Detail
Parameter
[in] aMessage
Sebuah penunjuk ke buffer pesan.
[in] aOffset
Offset dalam byte.
Lihat juga:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite

otMessageWrite

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

Menulis byte ke sebuah pesan.

Detail
Parameter
[in] aMessage
Sebuah penunjuk ke buffer pesan.
[in] aOffset
Offset dalam byte.
[in] aBuf
Sebuah penunjuk ke buffer tempat byte pesan ditulis.
[in] aLength
Jumlah byte untuk ditulis.
Kembali
Jumlah byte yang ditulis.
Lihat juga:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead