الرسالة
تتضمن هذه الوحدة دوالًا تعالج المخزن المؤقت لرسائل OpenThread.
الملخّص
تعداد |
|
---|---|
otMessagePriority{
|
تعداد يحدد هذا العداد مستويات أولوية رسالة 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
otMessagePriority
يحدد هذا العداد مستويات أولوية رسالة OpenThread.
المنشآت الفندقية | |
---|---|
OT_MESSAGE_PRIORITY_HIGH
|
مستوى الأولوية عالي. |
OT_MESSAGE_PRIORITY_LOW
|
مستوى الأولوية منخفض. |
OT_MESSAGE_PRIORITY_NORMAL
|
مستوى الأولوية العادي. |
رفوف النوع
معلومات إضافية
struct otBufferInfo otBufferInfo
تمثل هذه البنية معلومات المخزن المؤقت للرسائل لقوائم الانتظار المختلفة التي تستخدمها حزمة OpenThread.
رسالة
struct otMessage otMessage
هذا النوع من الملفات هو تمثيل غير شفاف المخزن المؤقت لرسائل OpenThread.
otMessagePriority
enum otMessagePriority otMessagePriority
يحدد هذا العداد مستويات أولوية رسالة OpenThread.
otMessageQueueInfo
struct otMessageQueueInfo otMessageQueueInfo
تمثل هذه البنية معلومات عن قائمة انتظار الرسائل.
الدوال
otMessageإلحاق
otError otMessageAppend( otMessage *aMessage, const void *aBuf, uint16_t aLength )
يمكنك إلحاق وحدات بايت برسالة.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||
قيم الإرجاع |
|
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
رسالة مجانية
void otMessageFree( otMessage *aMessage )
إخلاء مساحة تخزين رسائل مخصصة.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
otMessagefooter
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageGetBufferInfo
void otMessageGetBufferInfo( otInstance *aInstance, otBufferInfo *aBufferInfo )
الحصول على معلومات المخزن المؤقت للرسائل.
التفاصيل | |||||
---|---|---|---|---|---|
المعلَمات |
|
otMessageGetLength
uint16_t otMessageGetLength( const otMessage *aMessage )
معرفة طول الرسالة بالبايت.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
طول الرسالة بالبايت.
|
otMessageFree
otMessagefooter
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetLength
otMessageGetOffset
uint16_t otMessageGetOffset( const otMessage *aMessage )
يمكنك إزاحة الرسالة بالبايت.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
قيمة إزاحة الرسالة.
|
otMessageFree
otMessagefooter
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageGetRss
int8_t otMessageGetRss( const otMessage *aMessage )
تعرض هذه الدالة متوسط RSS (قوة الإشارة المستلمة) المرتبط بالرسالة.
التفاصيل | |
---|---|
المرتجعات |
متوسط قيمة RSS (بتنسيق dBm) أو OT_Rad_RSSI_INVALID في حال عدم توفّر متوسط RSS.
|
otMessageIsLinkSecurityEnabled
bool otMessageIsLinkSecurityEnabled( const otMessage *aMessage )
تشير هذه الدالة إلى ما إذا تم تفعيل أمان الرابط للرسالة أم لا.
التفاصيل | |||||
---|---|---|---|---|---|
المعلَمات |
|
||||
قيم الإرجاع |
|
otMessageQueueDequeue
void otMessageQueueDequeue( otMessageQueue *aQueue, otMessage *aMessage )
تؤدي هذه الدالة إلى إزالة رسالة من قائمة انتظار الرسائل المحددة.
التفاصيل | |||||
---|---|---|---|---|---|
المعلَمات |
|
otMessageQueueEnqueue
void otMessageQueueEnqueue( otMessageQueue *aQueue, otMessage *aMessage )
تضيف هذه الدالة رسالة إلى نهاية قائمة انتظار الرسائل.
التفاصيل | |||||
---|---|---|---|---|---|
المعلَمات |
|
otMessageQueueEnqueueAtHeader
void otMessageQueueEnqueueAtHead( otMessageQueue *aQueue, otMessage *aMessage )
تعمل هذه الدالة على إضافة رسالة في رأس/قائمة انتظار قائمة الرسائل المحددة.
التفاصيل | |||||
---|---|---|---|---|---|
المعلَمات |
|
otMessageQueueGetHead
otMessage * otMessageQueueGetHead( otMessageQueue *aQueue )
تعرض هذه الدالة مؤشرًا للرسالة في رأس قائمة الانتظار.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
مؤشر إلى الرسالة في رأس قائمة الانتظار أو فارغ إذا كانت قائمة الانتظار فارغة.
|
otMessageQueueGetNext
otMessage * otMessageQueueGetNext( otMessageQueue *aQueue, const otMessage *aMessage )
تعرِض هذه الدالة مؤشرًا إلى الرسالة التالية في قائمة الانتظار من خلال التكرار للأمام (من الرأس إلى الذيل).
التفاصيل | |||||
---|---|---|---|---|---|
المعلَمات |
|
||||
المرتجعات |
مؤشر إلى الرسالة التالية في قائمة الانتظار بعد
aMessage أو فارغ في حال aMessage is the tail of queue. NULL is returned if aMessageis not in the queue aQueue`. |
otMessageQueueInit
void otMessageQueueInit( otMessageQueue *aQueue )
ضبط قائمة انتظار الرسائل.
يجب استدعاء هذه الدالة مرة واحدة فقط في مثيل otMessageQueue
قبل أي دوال otMessageQueue
أخرى. لا يتم تعريف هذا السلوك في حال استخدام واجهات برمجة تطبيقات قوائم انتظار أخرى مع otMessageQueue
قبل إعداده أو في حال إعداده أكثر من مرة.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
otMessageRead
uint16_t otMessageRead( const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength )
قراءة وحدات البايت من رسالة
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||||
المرتجعات |
عدد وحدات البايت التي تمت قراءتها.
|
otMessageFree
otMessagefooter
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite
otMessageSetDirectTransportance
void otMessageSetDirectTransmission( otMessage *aMessage, bool aEnabled )
تعمل هذه الدالة على ضبط/إعادة توجيه الرسالة باستخدام النقل المباشر.
الإعداد التلقائي لرسالة جديدة هو false
.
التفاصيل | |||||
---|---|---|---|---|---|
المعلَمات |
|
otMessageSetLength
otError otMessageSetLength( otMessage *aMessage, uint16_t aLength )
اضبط طول الرسالة بالبايت.
التفاصيل | |||||
---|---|---|---|---|---|
المعلَمات |
|
||||
قيم الإرجاع |
|
otMessageFree
otMessagefooter
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetOffset
void otMessageSetOffset( otMessage *aMessage, uint16_t aOffset )
اضبط إزاحة الرسالة بالبايت.
التفاصيل | |||||
---|---|---|---|---|---|
المعلَمات |
|
otMessageFree
otMessagefooter
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite
oMessageWrite
int otMessageWrite( otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength )
كتابة وحدات البايت في رسالة.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||||
المرتجعات |
عدد وحدات البايت المكتوبة.
|
otMessageFree
otMessagefooter
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
المراجع
تنشأ مواضيع واجهة برمجة تطبيقات OpenThread المرجعية من رمز المصدر المتاح على GitHub. للحصول على مزيد من المعلومات أو للمساهمة في مستنداتنا، يُرجى الرجوع إلى الموارد.