الرسالة
تتضمّن هذه الوحدة الدوال التي تتلاعب بالمخازن المؤقتة للرسائل المفتوحة.
ملخّص
التعدادات |
|
---|---|
otMessagePriority{
|
تعداد تحديد مستويات أولوية رسائل OpenThread. |
أنواع المحددات |
|
---|---|
otBufferInfo
|
typedefstruct otBufferInfo
تمثل معلومات المخزن المؤقت للرسائل لقوائم الانتظار المختلفة التي تستخدمها حزمة OpenThread. |
otMessage
|
typedefstruct otMessage
تمثيل مبهم لذاكرة التخزين المؤقت للرسائل المفتوحة في سلسلة محادثات. |
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
قراءة وحدات البايت من رسالة.
|
otMessageResetBufferInfo(otInstance *aInstance)
|
void
يمكنك إعادة ضبط المخزن المؤقت لمعلومات المخزن المؤقت لتتبُّع الحد الأقصى المسموح به لعدد المخزن المؤقت في الوقت نفسه.
|
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 |
تمثل إعدادات الرسائل. |
التعدادات
OotMessagePriority
otMessagePriority
تحديد مستويات أولوية رسائل OpenThread.
أماكن إقامة | |
---|---|
OT_MESSAGE_PRIORITY_HIGH
|
مستوى الأولوية العالية |
OT_MESSAGE_PRIORITY_LOW
|
مستوى الأولوية منخفض |
OT_MESSAGE_PRIORITY_NORMAL
|
مستوى الأولوية العادي |
أنواع المحددات
otBufferInfo
struct otBufferInfo otBufferInfo
تمثل معلومات المخزن المؤقت للرسائل لقوائم الانتظار المختلفة التي تستخدمها حزمة OpenThread.
OotMessage
struct otMessage otMessage
تمثيل مبهم لذاكرة التخزين المؤقت للرسائل المفتوحة في سلسلة محادثات.
otMessageQueueInfo
struct otMessageQueueInfo otMessageQueueInfo
تمثل معلومات حول قائمة انتظار الرسائل.
الدوال
otMessageإضافة
otError otMessageAppend( otMessage *aMessage, const void *aBuf, uint16_t aLength )
إضافة بايت إلى رسالة
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||
قيم الإرجاع |
|
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
OotMessageFree
void otMessageFree( otMessage *aMessage )
إخلاء جزء من مساحة التخزين المخصّصة للرسالة.
التفاصيل | |||
---|---|---|---|
المَعلمات |
|
otMessageFetch
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageGetBufferInfo
void otMessageGetBufferInfo( otInstance *aInstance, otBufferInfo *aBufferInfo )
الحصول على معلومات المخزن المؤقت للرسائل
التفاصيل | |||||
---|---|---|---|---|---|
المَعلمات |
|
otMessageGetLength
uint16_t otMessageGetLength( const otMessage *aMessage )
تعرَّف على طول الرسالة بالبايت.
التفاصيل | |||
---|---|---|---|
المَعلمات |
|
||
المرتجعات |
طول الرسالة بالبايت.
|
otMessageFree
otMessageCompose
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageSet
8MessageSet
otMessageGetOffset
uint16_t otMessageGetOffset( const otMessage *aMessage )
يمكنك الحصول على إزاحة الرسالة بالبايت.
التفاصيل | |||
---|---|---|---|
المَعلمات |
|
||
المرتجعات |
قيمة إزاحة الرسالة
|
otMessageFree
otMessageCompose
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageGetRss
int8_t otMessageGetRss( const otMessage *aMessage )
لعرض متوسط RSS (قوة الإشارة المستلمة) المرتبط بالرسالة.
التفاصيل | |
---|---|
المرتجعات |
متوسط قيمة RSS (بالديسيبل بالمللي ثانية) أو OT_Rad_RSSI_INVALID في حال عدم توفّر متوسط RSS.
|
otMessageIsLinkSecurityEnabled
bool otMessageIsLinkSecurityEnabled( const otMessage *aMessage )
يشير إلى ما إذا كان قد تم تفعيل أمان الروابط للرسالة أم لا.
التفاصيل | |||||
---|---|---|---|---|---|
المَعلمات |
|
||||
قيم الإرجاع |
|
قائمة انتظار otMessageQueue
void otMessageQueueDequeue( otMessageQueue *aQueue, otMessage *aMessage )
إزالة رسالة من قائمة انتظار الرسائل المحدَّدة
التفاصيل | |||||
---|---|---|---|---|---|
المَعلمات |
|
otMessageQueueEneque
void otMessageQueueEnqueue( otMessageQueue *aQueue, otMessage *aMessage )
لإضافة رسالة إلى نهاية قائمة انتظار الرسائل المحددة.
التفاصيل | |||||
---|---|---|---|---|---|
المَعلمات |
|
otMessageQueueEnqueueAtHeader
void otMessageQueueEnqueueAtHead( otMessageQueue *aQueue, otMessage *aMessage )
لإضافة رسالة في رأس الصفحة أو أمامها.
التفاصيل | |||||
---|---|---|---|---|---|
المَعلمات |
|
otMessageQueueGetHeader
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 aMessageis not in the queue aQueue`. |
otMessageQueueInit
void otMessageQueueInit( otMessageQueue *aQueue )
إعداد قائمة انتظار الرسائل
يجب طلبها مرة واحدة فقط لمثيل otMessageQueue
قبل أي دوال otMessageQueue
أخرى. ولا يتم تحديد السلوك في حال استخدام واجهات برمجة تطبيقات أخرى لقوائم الانتظار مع otMessageQueue
قبل إعدادها أو في حال إعدادها أكثر من مرة.
التفاصيل | |||
---|---|---|---|
المَعلمات |
|
OotMessageRead
uint16_t otMessageRead( const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength )
قراءة وحدات البايت من رسالة.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||||
المرتجعات |
عدد وحدات البايت التي تمت قراءتها.
|
otMessageFree
otMessageCompose
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite
otMessageResetBufferInfo
void otMessageResetBufferInfo( otInstance *aInstance )
يمكنك إعادة ضبط المخزن المؤقت لمعلومات المخزن المؤقت لتتبُّع الحد الأقصى المسموح به لعدد المخزن المؤقت في الوقت نفسه.
يؤدي هذا إلى إعادة ضبط mMaxUsedBuffers
في otBufferInfo
.
التفاصيل | |||
---|---|---|---|
المَعلمات |
|
otMessageSetDirectTransmission
void otMessageSetDirectTransmission( otMessage *aMessage, bool aEnabled )
لضبط/فرض إعادة توجيه الرسالة باستخدام النقل المباشر.
الإعداد التلقائي لرسالة جديدة هو false
.
التفاصيل | |||||
---|---|---|---|---|---|
المَعلمات |
|
otMessageSetLength
otError otMessageSetLength( otMessage *aMessage, uint16_t aLength )
حدِّد مدة الرسالة بالبايت.
التفاصيل | |||||
---|---|---|---|---|---|
المَعلمات |
|
||||
قيم الإرجاع |
|
otMessageFree
otMessageCompose
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetOffset
void otMessageSetOffset( otMessage *aMessage, uint16_t aOffset )
اضبط إزاحة الرسالة بالبايت.
التفاصيل | |||||
---|---|---|---|---|---|
المَعلمات |
|
otMessageFree
otMessageCompose
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite
OotMessageكتابة
int otMessageWrite( otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength )
اكتب وحدات البايت إلى رسالة.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||||
المرتجعات |
عدد وحدات البايت المكتوبة.
|
otMessageFree
otMessageFetch
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
الموارد
تبدأ مواضيع مراجع واجهة برمجة تطبيقات OpenThread من رمز المصدر، وهو متاح على GitHub. للحصول على مزيد من المعلومات أو للمساهمة في المستندات، يمكنك الاطّلاع على المراجع.