ข้อความ
โมดูลนี้ประกอบด้วยฟังก์ชันที่จัดการบัฟเฟอร์ข้อความ OpenThread
สรุป
การแจกแจง |
|
---|---|
otMessagePriority{
|
enum การแจกแจงนี้กําหนดลําดับความสําคัญของข้อความ OpenThread |
ประเภทคําจํากัดความ |
|
---|---|
otBufferInfo
|
Typedefstruct otBufferInfo
โครงสร้างนี้แสดงข้อมูลการบัฟเฟอร์ของข้อความสําหรับคิวต่างๆ ที่สแต็ก OpenThread ใช้งาน |
otMessage
|
Typedefstruct otMessage
ข้อความประเภทนี้แสดงถึงการบัฟเฟอร์ของข้อความ OpenThread ที่คลุมเครือ |
otMessagePriority
|
Typedefenum otMessagePriority
การแจกแจงนี้กําหนดลําดับความสําคัญของข้อความ OpenThread |
otMessageQueueInfo
|
Typedefstruct otMessageQueueInfo
โครงสร้างนี้แสดงข้อมูลเกี่ยวกับคิวข้อความ |
otMessageSettings
|
Typedefstruct otMessageSettings
โครงสร้างนี้แสดงการตั้งค่าข้อความ |
ฟังก์ชัน |
|
---|---|
otMessageAppend(otMessage *aMessage, const void *aBuf, uint16_t aLength)
|
เพิ่มไบต์ต่อท้ายข้อความ
|
otMessageFree(otMessage *aMessage)
|
void
เพิ่มพื้นที่ว่างที่จัดสรรข้อความไว้
|
otMessageGetBufferInfo(otInstance *aInstance, otBufferInfo *aBufferInfo)
|
void
รับข้อมูลบัฟเฟอร์ข้อความ
|
otMessageGetLength(const otMessage *aMessage)
|
uint16_t
รับความยาวของข้อความเป็นไบต์
|
otMessageGetOffset(const otMessage *aMessage)
|
uint16_t
รับการชดเชยข้อความในหน่วยไบต์
|
otMessageGetRss(const otMessage *aMessage)
|
int8_t
โดยฟังก์ชันนี้จะแสดงผล RSS เฉลี่ย (ความแรงของสัญญาณที่ได้รับ) ที่เชื่อมโยงกับข้อความ
|
otMessageIsLinkSecurityEnabled(const otMessage *aMessage)
|
bool
ฟังก์ชันนี้จะระบุไว้ว่ามีการเปิดใช้ความปลอดภัยของลิงก์สําหรับข้อความหรือไม่
|
otMessageQueueDequeue(otMessageQueue *aQueue, otMessage *aMessage)
|
void
ฟังก์ชันนี้จะนําข้อความออกจากคิวข้อความที่ระบุ
|
otMessageQueueEnqueue(otMessageQueue *aQueue, otMessage *aMessage)
|
void
ฟังก์ชันนี้จะเพิ่มข้อความไว้ที่ท้ายคิวข้อความที่ระบุ
|
otMessageQueueEnqueueAtHead(otMessageQueue *aQueue, otMessage *aMessage)
|
void
ฟังก์ชันนี้จะเพิ่มข้อความที่ส่วนหัว/ด้านหน้าของคิวข้อความที่ระบุ
|
otMessageQueueGetHead(otMessageQueue *aQueue)
|
ฟังก์ชันนี้จะส่งคืนตัวชี้ไปยังข้อความที่ส่วนหัวของคิว
|
otMessageQueueGetNext(otMessageQueue *aQueue, const otMessage *aMessage)
|
ฟังก์ชันนี้จะส่งคืนตัวชี้ไปยังข้อความถัดไปในคิวโดยการทําซ้ําไปข้างหน้า (จากหัวต่อหาง)
|
otMessageQueueInit(otMessageQueue *aQueue)
|
void
เริ่มต้นคิวข้อความ
|
otMessageRead(const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength)
|
uint16_t
อ่านไบต์จากข้อความ
|
otMessageSetDirectTransmission(otMessage *aMessage, bool aEnabled)
|
void
โดยฟังก์ชันนี้จะกําหนด/บังคับให้มีการส่งต่อข้อความโดยใช้การส่งโดยตรง
|
otMessageSetLength(otMessage *aMessage, uint16_t aLength)
|
กําหนดความยาวของข้อความในหน่วยไบต์
|
otMessageSetOffset(otMessage *aMessage, uint16_t aOffset)
|
void
ตั้งค่าการชดเชยข้อความในหน่วยไบต์
|
otMessageWrite(otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength)
|
int
เขียนไบต์ลงในข้อความ
|
โครงสร้าง |
|
---|---|
otBufferInfo |
โครงสร้างนี้แสดงข้อมูลการบัฟเฟอร์ของข้อความสําหรับคิวต่างๆ ที่สแต็ก OpenThread ใช้งาน |
otMessageQueue |
โครงสร้างนี้แทนคิวข้อความ OpenThread |
otMessageQueueInfo |
โครงสร้างนี้แสดงข้อมูลเกี่ยวกับคิวข้อความ |
otMessageSettings |
โครงสร้างนี้แสดงการตั้งค่าข้อความ |
การแจกแจง
ลําดับความสําคัญของข้อความ
otMessagePriority
การแจกแจงนี้กําหนดลําดับความสําคัญของข้อความ OpenThread
พร็อพเพอร์ตี้ | |
---|---|
OT_MESSAGE_PRIORITY_HIGH
|
ลําดับความสําคัญสูง |
OT_MESSAGE_PRIORITY_LOW
|
ลําดับความสําคัญต่ํา |
OT_MESSAGE_PRIORITY_NORMAL
|
ระดับความสําคัญปกติ |
ประเภทคําจํากัดความ
ข้อมูล otBuffer
struct otBufferInfo otBufferInfo
โครงสร้างนี้แสดงข้อมูลการบัฟเฟอร์ของข้อความสําหรับคิวต่างๆ ที่สแต็ก OpenThread ใช้งาน
ข้อความ
struct otMessage otMessage
ข้อความประเภทนี้แสดงถึงการบัฟเฟอร์ของข้อความ OpenThread ที่คลุมเครือ
ลําดับความสําคัญของข้อความ
enum otMessagePriority otMessagePriority
การแจกแจงนี้กําหนดลําดับความสําคัญของข้อความ OpenThread
ข้อมูลคิวข้อความ
struct otMessageQueueInfo otMessageQueueInfo
โครงสร้างนี้แสดงข้อมูลเกี่ยวกับคิวข้อความ
ฟังก์ชัน
ข้อความสิ้นสุดแอป
otError otMessageAppend( otMessage *aMessage, const void *aBuf, uint16_t aLength )
เพิ่มไบต์ต่อท้ายข้อความ
รายละเอียด | |||||||
---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
||||||
แสดงผลค่า |
|
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
แบบไม่เสียค่าใช้จ่าย
void otMessageFree( otMessage *aMessage )
เพิ่มพื้นที่ว่างที่จัดสรรข้อความไว้
รายละเอียด | |||
---|---|---|---|
พารามิเตอร์ |
|
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
OTMessageGetBufferInfo
void otMessageGetBufferInfo( otInstance *aInstance, otBufferInfo *aBufferInfo )
รับข้อมูลบัฟเฟอร์ข้อความ
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
|
ความยาวข้อความ
uint16_t otMessageGetLength( const otMessage *aMessage )
รับความยาวของข้อความเป็นไบต์
รายละเอียด | |||
---|---|---|---|
พารามิเตอร์ |
|
||
การคืนสินค้า |
ความยาวของข้อความในหน่วยไบต์
|
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetLength
ปิดข้อความ
uint16_t otMessageGetOffset( const otMessage *aMessage )
รับการชดเชยข้อความในหน่วยไบต์
รายละเอียด | |||
---|---|---|---|
พารามิเตอร์ |
|
||
การคืนสินค้า |
ค่าออฟเซ็ตของข้อความ
|
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite
ข้อความข้อความรับ
int8_t otMessageGetRss( const otMessage *aMessage )
โดยฟังก์ชันนี้จะแสดงผล RSS เฉลี่ย (ความแรงของสัญญาณที่ได้รับ) ที่เชื่อมโยงกับข้อความ
รายละเอียด | |
---|---|
การคืนสินค้า |
ค่า RSS เฉลี่ย (ใน dBm) หรือ OT_RADIO_RSSI_INVALID หากไม่มี RSS เฉลี่ยพร้อมใช้งาน
|
OTMessageIsLinkSecurityEnabled
bool otMessageIsLinkSecurityEnabled( const otMessage *aMessage )
ฟังก์ชันนี้จะระบุไว้ว่ามีการเปิดใช้ความปลอดภัยของลิงก์สําหรับข้อความหรือไม่
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
|
||||
แสดงผลค่า |
|
คําอธิบายคิวข้อความ
void otMessageQueueDequeue( otMessageQueue *aQueue, otMessage *aMessage )
ฟังก์ชันนี้จะนําข้อความออกจากคิวข้อความที่ระบุ
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
|
จุดเริ่มคิวข้อความ
void otMessageQueueEnqueue( otMessageQueue *aQueue, otMessage *aMessage )
ฟังก์ชันนี้จะเพิ่มข้อความไว้ที่ท้ายคิวข้อความที่ระบุ
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
|
OTMessageQueueEnqueueAtHead
void otMessageQueueEnqueueAtHead( otMessageQueue *aQueue, otMessage *aMessage )
ฟังก์ชันนี้จะเพิ่มข้อความที่ส่วนหัว/ด้านหน้าของคิวข้อความที่ระบุ
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
|
คัดลอกคิวข้อความส่วนหัว
otMessage * otMessageQueueGetHead( otMessageQueue *aQueue )
ฟังก์ชันนี้จะส่งคืนตัวชี้ไปยังข้อความที่ส่วนหัวของคิว
รายละเอียด | |||
---|---|---|---|
พารามิเตอร์ |
|
||
การคืนสินค้า |
ตัวชี้ไปยังข้อความที่ด้านบนของคิว หรือค่าว่างหากคิวว่างเปล่า
|
ข้อความคิวถัดไป
otMessage * otMessageQueueGetNext( otMessageQueue *aQueue, const otMessage *aMessage )
ฟังก์ชันนี้จะส่งคืนตัวชี้ไปยังข้อความถัดไปในคิวโดยการทําซ้ําไปข้างหน้า (จากหัวต่อหาง)
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
|
||||
การคืนสินค้า |
ตัวชี้ไปยังข้อความถัดไปในคิวหลังจาก
aMessage หรือ NULL หาก aMessage is the tail of queue. NULL is returned if aMessageis not in the queue aQueue` |
OTMessageQueueInit
void otMessageQueueInit( otMessageQueue *aQueue )
เริ่มต้นคิวข้อความ
ต้องเรียกใช้ฟังก์ชันนี้เพียงครั้งเดียวและครั้งเดียวสําหรับอินสแตนซ์ otMessageQueue
ก่อนฟังก์ชัน otMessageQueue
อื่นๆ ลักษณะการทํางานจะไม่ได้รับการกําหนด หากมีการใช้ API คิวอื่นกับ otMessageQueue
ก่อนที่พารามิเตอร์จะเริ่มต้น หรือมีการเริ่มต้นมากกว่า 1 ครั้ง
รายละเอียด | |||
---|---|---|---|
พารามิเตอร์ |
|
อ่านข้อความ
uint16_t otMessageRead( const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength )
อ่านไบต์จากข้อความ
รายละเอียด | |||||||||
---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
||||||||
การคืนสินค้า |
จํานวนไบต์ที่อ่าน
|
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite
ข้อความชุดโดยตรง
void otMessageSetDirectTransmission( otMessage *aMessage, bool aEnabled )
โดยฟังก์ชันนี้จะกําหนด/บังคับให้มีการส่งต่อข้อความโดยใช้การส่งโดยตรง
การตั้งค่าเริ่มต้นสําหรับข้อความใหม่คือ false
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
|
ความยาวข้อความ
otError otMessageSetLength( otMessage *aMessage, uint16_t aLength )
กําหนดความยาวของข้อความในหน่วยไบต์
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
|
||||
แสดงผลค่า |
|
otMessageFree
otMessageAppend
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
ออฟเซ็ตข้อความ
void otMessageSetOffset( otMessage *aMessage, uint16_t aOffset )
ตั้งค่าการชดเชยข้อความในหน่วยไบต์
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
|
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite
ข้อความที่เขียน
int otMessageWrite( otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength )
เขียนไบต์ลงในข้อความ
รายละเอียด | |||||||||
---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
||||||||
การคืนสินค้า |
จํานวนไบต์ที่เขียน
|
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
ทรัพยากร
หัวข้ออ้างอิง API ของ OpenThread API มาจากซอร์สโค้ดซึ่งมีอยู่ใน GitHub ดูข้อมูลเพิ่มเติมหรือมีส่วนร่วมในเอกสารประกอบของเราได้ที่แหล่งข้อมูล