Pesan
Modul ini menyertakan fungsi yang memanipulasi buffer pesan OpenThread.
Ringkasan
Pencacahan | |
---|---|
otMessagePriority { | enum Pencacahan ini menentukan tingkat prioritas pesan OpenThread. |
Typedefs | |
---|---|
otBufferInfo | typedefstruct otBufferInfo Struktur ini merepresentasikan informasi buffer pesan. |
otMessage | typedefstruct otMessage Struktur ini menunjuk ke buffer pesan OpenThread. |
otMessagePriority | typedefenum otMessagePriority Pencacahan ini menentukan tingkat prioritas pesan OpenThread. |
otMessageSettings | typedefstruct otMessageSettings 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 pointer 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. |
otMessage | Struktur ini menunjuk ke buffer pesan OpenThread. |
otMessageQueue | Struktur ini mewakili antrian pesan OpenThread. |
otMessageSettings | Struktur ini mewakili pengaturan pesan. |
Pencacahan
otMessagePriority
otMessagePriority
Typedefs
otBufferInfo
struct otBufferInfo otBufferInfo
Struktur ini merepresentasikan informasi buffer pesan.
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 |
| ||||||
Kembalikan Nilai |
|
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageFree
void otMessageFree( otMessage *aMessage )
Bebaskan buffer pesan yang dialokasikan.
Detail | |||
---|---|---|---|
Parameter |
|
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageGetBufferInfo
void otMessageGetBufferInfo( otInstance *aInstance, otBufferInfo *aBufferInfo )
Dapatkan informasi Message Buffer.
Detail | |||||
---|---|---|---|---|---|
Parameter |
|
otMessageGetLength
uint16_t otMessageGetLength( const otMessage *aMessage )
Dapatkan panjang pesan dalam byte.
Detail | |||
---|---|---|---|
Parameter |
| ||
Kembali | Panjang pesan dalam byte. |
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetLength
otMessageGetOffset
uint16_t otMessageGetOffset( const otMessage *aMessage )
Dapatkan pesan offset dalam byte.
Detail | |||
---|---|---|---|
Parameter |
| ||
Kembali | Nilai offset pesan. |
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 |
| ||||
Kembalikan Nilai |
|
otMessageQueueDequeue
void otMessageQueueDequeue( otMessageQueue *aQueue, otMessage *aMessage )
Fungsi ini menghapus pesan dari antrian pesan yang diberikan.
Detail | |||||
---|---|---|---|---|---|
Parameter |
|
otMessageQueueEnqueue
void otMessageQueueEnqueue( otMessageQueue *aQueue, otMessage *aMessage )
Fungsi ini menambahkan pesan ke akhir antrian pesan yang diberikan.
Detail | |||||
---|---|---|---|---|---|
Parameter |
|
otMessageQueueEnqueueAtHead
void otMessageQueueEnqueueAtHead( otMessageQueue *aQueue, otMessage *aMessage )
Fungsi ini menambahkan pesan di kepala / depan antrian pesan yang diberikan.
Detail | |||||
---|---|---|---|---|---|
Parameter |
|
otMessageQueueGetHead
otMessage * otMessageQueueGetHead( otMessageQueue *aQueue )
Fungsi ini mengembalikan pointer ke pesan di kepala antrian.
Detail | |||
---|---|---|---|
Parameter |
| ||
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 |
| ||||
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 |
|
otMessageRead
uint16_t otMessageRead( const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength )
Membaca byte dari sebuah pesan.
Detail | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
| ||||||||
Kembali | Jumlah byte yang dibaca. |
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 |
|
otMessageSetLength
otError otMessageSetLength( otMessage *aMessage, uint16_t aLength )
Tetapkan panjang pesan dalam byte.
Detail | |||||
---|---|---|---|---|---|
Parameter |
| ||||
Kembalikan Nilai |
|
otMessageFree
otMessageAppend
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetOffset
void otMessageSetOffset( otMessage *aMessage, uint16_t aOffset )
Atur offset pesan dalam byte.
Detail | |||||
---|---|---|---|---|---|
Parameter |
|
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 |
| ||||||||
Kembali | Jumlah byte yang ditulis. |
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead