پیام
این ماژول شامل توابعی است که بافرهای پیام OpenThread را دستکاری می کند.
خلاصه
شمارش ها | |
---|---|
otMessagePriority { | شمارش این شمارش سطوح اولویت پیام OpenThread را تعریف می کند. |
Typedefs | |
---|---|
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 | این ساختار اطلاعاتی را در مورد یک صف پیام نشان می دهد. |
تنظیمات otMessage | این ساختار یک تنظیمات پیام را نشان می دهد. |
شمارش ها
otMessagePriority
otMessagePriority
Typedefs
otBufferInfo
struct otBufferInfo otBufferInfo
این ساختار اطلاعات بافر پیام را برای صف های مختلف مورد استفاده توسط پشته OpenThread نشان می دهد.
otMessagePriority
enum otMessagePriority otMessagePriority
این شمارش سطوح اولویت پیام OpenThread را تعریف می کند.
otMessageQueueInfo
struct otMessageQueueInfo otMessageQueueInfo
این ساختار اطلاعاتی را در مورد یک صف پیام نشان می دهد.
تنظیمات otMessage
struct otMessageSettings otMessageSettings
این ساختار یک تنظیمات پیام را نشان می دهد.
کارکرد
otMessageAppend
otError otMessageAppend( otMessage *aMessage, const void *aBuf, uint16_t aLength )
بایت ها را به پیام اضافه کنید.
جزئیات | |||||||
---|---|---|---|---|---|---|---|
مولفه های |
| ||||||
ارزش های بازگشتی |
|
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageFree
void otMessageFree( otMessage *aMessage )
بافر پیام اختصاص داده شده را آزاد کنید.
جزئیات | |||
---|---|---|---|
مولفه های |
|
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageGetBufferInfo
void otMessageGetBufferInfo( otInstance *aInstance, otBufferInfo *aBufferInfo )
اطلاعات بافر پیام را دریافت کنید.
جزئیات | |||||
---|---|---|---|---|---|
مولفه های |
|
otMessageGetLength
uint16_t otMessageGetLength( const otMessage *aMessage )
طول پیام را بر حسب بایت دریافت کنید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | طول پیام بر حسب بایت |
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetLength
otMessageGetOffset
uint16_t otMessageGetOffset( const otMessage *aMessage )
پیام را بر حسب بایت دریافت کنید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | مقدار افست پیام |
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageGetRss
int8_t otMessageGetRss( const otMessage *aMessage )
این تابع میانگین RSS (قدرت سیگنال دریافتی) مرتبط با پیام را برمی گرداند.
جزئیات | |
---|---|
برمی گرداند | مقدار متوسط RSS (بر حسب dBm) یا OT_RADIO_RSSI_INVALID اگر RSS متوسطی در دسترس نباشد. |
otMessageIsLinkSecurityEnabled
bool otMessageIsLinkSecurityEnabled( const otMessage *aMessage )
این تابع نشان می دهد که آیا امنیت پیوند برای پیام فعال است یا خیر.
جزئیات | |||||
---|---|---|---|---|---|
مولفه های |
| ||||
ارزش های بازگشتی |
|
otMessageQueueDequeue
void otMessageQueueDequeue( otMessageQueue *aQueue, otMessage *aMessage )
این تابع یک پیام را از صف پیام داده شده حذف می کند.
جزئیات | |||||
---|---|---|---|---|---|
مولفه های |
|
otMessageQueueEnqueue
void otMessageQueueEnqueue( otMessageQueue *aQueue, otMessage *aMessage )
این تابع یک پیام را به انتهای صف پیام داده شده اضافه می کند.
جزئیات | |||||
---|---|---|---|---|---|
مولفه های |
|
otMessageQueueEnqueueAtHead
void otMessageQueueEnqueueAtHead( otMessageQueue *aQueue, otMessage *aMessage )
این تابع یک پیام را در سر/ جلوی صف پیام داده شده اضافه می کند.
جزئیات | |||||
---|---|---|---|---|---|
مولفه های |
|
otMessageQueueGetHead
otMessage * otMessageQueueGetHead( otMessageQueue *aQueue )
این تابع یک اشاره گر را به پیام در سر صف برمی گرداند.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | یک اشاره گر به پیام در سر صف یا NULL در صورت خالی بودن صف. |
otMessageQueueGetNext
otMessage * otMessageQueueGetNext( otMessageQueue *aQueue, const otMessage *aMessage )
این تابع با تکرار جلو (از سر تا دم) یک اشاره گر را به پیام بعدی در صف برمی گرداند.
جزئیات | |||||
---|---|---|---|---|---|
مولفه های |
| ||||
برمی گرداند | اشاره گر به پیام بعدی در صف بعد از aMessage یا NULL اگر aMessage is the tail of queue. NULL is returned if aMessage is not in the queue aQueue نباشد، NULL برگردانده می شود. |
otMessageQueueInit
void otMessageQueueInit( otMessageQueue *aQueue )
صف پیام را راه اندازی کنید.
این تابع باید یک بار و فقط یک بار برای یک نمونه otMessageQueue
قبل از هر توابع دیگر otMessageQueue
شود. اگر سایر APIهای صف قبل از مقداردهی اولیه otMessageQueue
استفاده شوند یا اگر بیش از یک بار مقداردهی اولیه شود، این رفتار تعریف نشده است.
جزئیات | |||
---|---|---|---|
مولفه های |
|
otMessageRead
uint16_t otMessageRead( const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength )
خواندن بایت از یک پیام
جزئیات | |||||||||
---|---|---|---|---|---|---|---|---|---|
مولفه های |
| ||||||||
برمی گرداند | تعداد بایت های خوانده شده |
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite
otMessageSetDirectTransmission
void otMessageSetDirectTransmission( otMessage *aMessage, bool aEnabled )
این تابع پیام را با استفاده از انتقال مستقیم ارسال می کند/اجبار می کند.
تنظیم پیش فرض برای پیام جدید false
است.
جزئیات | |||||
---|---|---|---|---|---|
مولفه های |
|
otMessageSetLength
otError otMessageSetLength( otMessage *aMessage, uint16_t aLength )
طول پیام را بر حسب بایت تنظیم کنید.
جزئیات | |||||
---|---|---|---|---|---|
مولفه های |
| ||||
ارزش های بازگشتی |
|
otMessageFree
otMessageAppend
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetOffset
void otMessageSetOffset( otMessage *aMessage, uint16_t aOffset )
افست پیام را بر حسب بایت تنظیم کنید.
جزئیات | |||||
---|---|---|---|---|---|
مولفه های |
|
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite
otMessageWrite
int otMessageWrite( otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength )
نوشتن بایت در یک پیام
جزئیات | |||||||||
---|---|---|---|---|---|---|---|---|---|
مولفه های |
| ||||||||
برمی گرداند | تعداد بایت های نوشته شده |
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
منابع
موضوعات مرجع OpenThread API از کد منبع موجود در GitHub سرچشمه می گیرند. برای اطلاعات بیشتر، یا مشارکت در اسناد ما، به منابع مراجعه کنید.