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

Pesan

Modul ini mencakup fungsi yang memanipulasi buffer pesan OpenThread.

Ringkasan

Enumerasi

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

Typedef

otBufferInfo typedef
struct otBufferInfo
Struktur ini mewakili informasi buffer pesan untuk berbagai antrean yang digunakan oleh stack OpenThread.
otMessage typedef
struct otMessage
Jenis ini adalah representasi buram dari buffer pesan OpenThread.
otMessagePriority typedef
Enumerasi ini menentukan tingkat prioritas pesan OpenThread.
otMessageQueueInfo typedef
Struktur ini mewakili informasi tentang antrean pesan.
otMessageSettings typedef
Struktur ini mewakili setelan pesan.

Fungsi

otMessageAppend(otMessage *aMessage, const void *aBuf, uint16_t aLength)
Menambahkan byte ke pesan.
otMessageFree(otMessage *aMessage)
void
Membebaskan buffer pesan yang dialokasikan.
otMessageGetBufferInfo(otInstance *aInstance, otBufferInfo *aBufferInfo)
void
Mendapatkan informasi Buffering Pesan.
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
Fungsi ini menampilkan RSS (kekuatan sinyal yang diterima) rata-rata yang dikaitkan dengan pesan.
otMessageIsLinkSecurityEnabled(const otMessage *aMessage)
bool
Fungsi ini menunjukkan apakah keamanan link diaktifkan untuk pesan atau tidak.
otMessageQueueDequeue(otMessageQueue *aQueue, otMessage *aMessage)
void
Fungsi ini menghapus pesan dari antrean pesan tertentu.
otMessageQueueEnqueue(otMessageQueue *aQueue, otMessage *aMessage)
void
Fungsi ini menambahkan pesan ke akhir antrean pesan tertentu.
otMessageQueueEnqueueAtHead(otMessageQueue *aQueue, otMessage *aMessage)
void
Fungsi ini menambahkan pesan di awal/depan antrean pesan tertentu.
otMessageQueueGetHead(otMessageQueue *aQueue)
Fungsi ini menampilkan pointer ke pesan di bagian awal antrean.
otMessageQueueGetNext(otMessageQueue *aQueue, const otMessage *aMessage)
Fungsi ini mengembalikan pointer ke pesan berikutnya dalam antrean dengan melakukan iterasi ke depan (dari head ke tail).
otMessageQueueInit(otMessageQueue *aQueue)
void
Menginisialisasi antrean pesan.
otMessageRead(const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength)
uint16_t
Membaca byte dari pesan.
otMessageSetDirectTransmission(otMessage *aMessage, bool aEnabled)
void
Fungsi ini menyetel/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
Menyetel offset pesan dalam byte.
otMessageWrite(otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength)
int
Menulis byte ke pesan.

Struct

otBufferInfo

Struktur ini mewakili informasi buffer pesan untuk berbagai antrean yang digunakan oleh stack OpenThread.

otMessageQueue

Struktur ini mewakili antrean pesan OpenThread.

otMessageQueueInfo

Struktur ini mewakili informasi tentang antrean pesan.

otMessageSettings

Struktur ini mewakili setelan pesan.

Enumerasi

otMessagePriority

 otMessagePriority

Enumerasi 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.

Typedef

BufferBufferInfo

struct otBufferInfo otBufferInfo

Struktur ini mewakili informasi buffer pesan untuk berbagai antrean yang digunakan oleh stack OpenThread.

otPesan

struct otMessage otMessage

Jenis ini adalah representasi buram dari buffer pesan OpenThread.

otMessagePriority

enum otMessagePriority otMessagePriority

Enumerasi ini menentukan tingkat prioritas pesan OpenThread.

otMessageQueueInfo

struct otMessageQueueInfo otMessageQueueInfo

Struktur ini mewakili informasi tentang antrean pesan.

otMessageSettings

struct otMessageSettings otMessageSettings

Struktur ini mewakili setelan pesan.

Fungsi

otMessageAppend

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

Menambahkan byte ke pesan.

Detail
Parameter
[in] aMessage
Pointer ke buffer pesan.
[in] aBuf
Pointer ke data yang akan ditambahkan.
[in] aLength
Jumlah byte untuk ditambahkan.
Nilai yang Ditampilkan
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
)

Membebaskan buffer pesan yang dialokasikan.

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

otMessageGetBufferInfo

void otMessageGetBufferInfo(
  otInstance *aInstance,
  otBufferInfo *aBufferInfo
)

Mendapatkan informasi Buffering Pesan.

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 buffer pesan.
Hasil
Panjang pesan dalam byte.
Lihat juga:
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetLength

otMessageGetOffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

Mendapatkan offset pesan dalam byte.

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

otMessageGetRss

int8_t otMessageGetRss(
  const otMessage *aMessage
)

Fungsi ini menampilkan RSS (kekuatan sinyal yang diterima) rata-rata yang dikaitkan dengan pesan.

Detail
Hasil
Nilai RSS rata-rata (dalam dBm) atau OT_Radio_RSSI_INVALID jika tidak ada RSS rata-rata yang tersedia.

otMessageIsLinkSecurityEnabled

bool otMessageIsLinkSecurityEnabled(
  const otMessage *aMessage
)

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

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

otMessageQueueDequeue

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Fungsi ini menghapus pesan dari antrean pesan tertentu.

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

otMessageQueueEnqueue

void otMessageQueueEnqueue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Fungsi ini menambahkan pesan ke akhir antrean pesan tertentu.

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

otMessageQueueEnqueueAtHead

void otMessageQueueEnqueueAtHead(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Fungsi ini menambahkan pesan di awal/depan antrean pesan tertentu.

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

otMessageQueueGetHead

otMessage * otMessageQueueGetHead(
  otMessageQueue *aQueue
)

Fungsi ini menampilkan pointer ke pesan di bagian awal antrean.

Detail
Parameter
[in] aQueue
Pointer ke antrean pesan.
Hasil
Pointer pesan ke header antrean atau NULL jika antrean kosong.

otMessageQueueGetNext

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

Fungsi ini mengembalikan 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 buffer pesan saat ini.
Hasil
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
)

Menginisialisasi antrean pesan.

Fungsi ini HARUS dipanggil satu kali dan hanya sekali untuk instance otMessageQueue sebelum fungsi otMessageQueue lainnya. Perilaku tidak ditentukan jika API antrean lainnya 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 buffer pesan.
[in] aOffset
Offset dalam byte.
[in] aBuf
Pointer ke buffer yang dibacakan byte pesan.
[in] aLength
Jumlah byte untuk dibaca.
Hasil
Jumlah byte yang dibaca.
Lihat juga:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite

otMessageSetDirectTransmission

void otMessageSetDirectTransmission(
  otMessage *aMessage,
  bool aEnabled
)

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

Setelan default untuk pesan baru adalah false.

Detail
Parameter
[in] aMessage
Pointer ke buffer pesan.
[in] aEnabled
Jika true, pesan 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 buffer pesan.
[in] aLength
Panjang dalam byte.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menetapkan 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
)

Menyetel offset pesan dalam byte.

Detail
Parameter
[in] aMessage
Pointer 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 pesan.

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

Resource

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