الرسالة

تتضمن هذه الوحدة دوالًا تعالج المخزن المؤقت لرسائل OpenThread.

الملخّص

تعداد

otMessagePriority{
  OT_MESSAGE_PRIORITY_LOW = 0,
  OT_MESSAGE_PRIORITY_NORMAL = 1,
  OT_MESSAGE_PRIORITY_HIGH = 2
}
تعداد
يحدد هذا العداد مستويات أولوية رسالة OpenThread.

رفوف النوع

otBufferInfo typedef
struct otBufferInfo
تمثل هذه البنية معلومات المخزن المؤقت للرسائل لقوائم الانتظار المختلفة التي تستخدمها حزمة OpenThread.
otMessage typedef
struct otMessage
هذا النوع من الملفات هو تمثيل غير شفاف المخزن المؤقت لرسائل OpenThread.
otMessagePriority typedef
يحدد هذا العداد مستويات أولوية رسالة OpenThread.
otMessageQueueInfo typedef
تمثل هذه البنية معلومات عن قائمة انتظار الرسائل.
otMessageSettings typedef
تمثل هذه البنية إعدادات الرسائل.

الدوال

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

struct otMessageSettings otMessageSettings

تمثل هذه البنية إعدادات الرسائل.

الدوال

otMessageإلحاق

otError otMessageAppend(
  otMessage *aMessage,
  const void *aBuf,
  uint16_t aLength
)

يمكنك إلحاق وحدات بايت برسالة.

التفاصيل
المعلَمات
[in] aMessage
مؤشر إلى المخزن المؤقت للرسائل.
[in] aBuf
مؤشر للبيانات المطلوب إلحاقها.
[in] aLength
عدد وحدات البايت المراد إلحاقها.
قيم الإرجاع
OT_ERROR_NONE
تم الإلحاق بالرسالة بنجاح
OT_ERROR_NO_BUFS
ما مِن مخازن مؤقتة متاحة لتوسيع الرسالة.
يمكنك أيضًا الاطّلاع على ما يلي:
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

رسالة مجانية

void otMessageFree(
  otMessage *aMessage
)

إخلاء مساحة تخزين رسائل مخصصة.

التفاصيل
المعلَمات
[in] aMessage
مؤشر إلى المخزن المؤقت للرسائل.
يُرجى الاطِّلاع أيضًا على:
otMessagefooter
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetBufferInfo

void otMessageGetBufferInfo(
  otInstance *aInstance,
  otBufferInfo *aBufferInfo
)

الحصول على معلومات المخزن المؤقت للرسائل.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[out] aBufferInfo
مؤشر تتم فيه كتابة معلومات المخزن المؤقت للرسائل.

otMessageGetLength

uint16_t otMessageGetLength(
  const otMessage *aMessage
)

معرفة طول الرسالة بالبايت.

التفاصيل
المعلَمات
[in] aMessage
مؤشر إلى المخزن المؤقت للرسائل.
المرتجعات
طول الرسالة بالبايت.
يُرجى الاطِّلاع أيضًا على:
otMessageFree
otMessagefooter
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetLength

otMessageGetOffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

يمكنك إزاحة الرسالة بالبايت.

التفاصيل
المعلَمات
[in] 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
)

تشير هذه الدالة إلى ما إذا تم تفعيل أمان الرابط للرسالة أم لا.

التفاصيل
المعلَمات
[in] aMessage
مؤشر إلى المخزن المؤقت للرسائل.
قيم الإرجاع
TRUE
في حال تفعيل أمان الرابط
FALSE
في حال عدم تفعيل أمان الرابط.

otMessageQueueDequeue

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

تؤدي هذه الدالة إلى إزالة رسالة من قائمة انتظار الرسائل المحددة.

التفاصيل
المعلَمات
[in] aQueue
مؤشر إلى قائمة انتظار الرسائل.
[in] aMessage
الرسالة المطلوب إزالتها.

otMessageQueueEnqueue

void otMessageQueueEnqueue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

تضيف هذه الدالة رسالة إلى نهاية قائمة انتظار الرسائل.

التفاصيل
المعلَمات
[in] aQueue
مؤشر إلى قائمة انتظار الرسائل.
[in] aMessage
الرسالة المطلوب إضافتها.

otMessageQueueEnqueueAtHeader

void otMessageQueueEnqueueAtHead(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

تعمل هذه الدالة على إضافة رسالة في رأس/قائمة انتظار قائمة الرسائل المحددة.

التفاصيل
المعلَمات
[in] aQueue
مؤشر إلى قائمة انتظار الرسائل.
[in] aMessage
الرسالة المطلوب إضافتها.

otMessageQueueGetHead

otMessage * otMessageQueueGetHead(
  otMessageQueue *aQueue
)

تعرض هذه الدالة مؤشرًا للرسالة في رأس قائمة الانتظار.

التفاصيل
المعلَمات
[in] aQueue
مؤشر إلى قائمة انتظار الرسائل.
المرتجعات
مؤشر إلى الرسالة في رأس قائمة الانتظار أو فارغ إذا كانت قائمة الانتظار فارغة.

otMessageQueueGetNext

otMessage * otMessageQueueGetNext(
  otMessageQueue *aQueue,
  const otMessage *aMessage
)

تعرِض هذه الدالة مؤشرًا إلى الرسالة التالية في قائمة الانتظار من خلال التكرار للأمام (من الرأس إلى الذيل).

التفاصيل
المعلَمات
[in] aQueue
مؤشر إلى قائمة انتظار الرسائل.
[in] aMessage
مؤشر إلى المخزن المؤقت للرسائل الحالية
المرتجعات
مؤشر إلى الرسالة التالية في قائمة الانتظار بعد aMessage أو فارغ في حال aMessage is the tail of queue. NULL is returned ifaMessageis not in the queueaQueue`.

otMessageQueueInit

void otMessageQueueInit(
  otMessageQueue *aQueue
)

ضبط قائمة انتظار الرسائل.

يجب استدعاء هذه الدالة مرة واحدة فقط في مثيل otMessageQueue قبل أي دوال otMessageQueue أخرى. لا يتم تعريف هذا السلوك في حال استخدام واجهات برمجة تطبيقات قوائم انتظار أخرى مع otMessageQueue قبل إعداده أو في حال إعداده أكثر من مرة.

التفاصيل
المعلَمات
[in] aQueue
مؤشر إلى قائمة انتظار الرسائل.

otMessageRead

uint16_t otMessageRead(
  const otMessage *aMessage,
  uint16_t aOffset,
  void *aBuf,
  uint16_t aLength
)

قراءة وحدات البايت من رسالة

التفاصيل
المعلَمات
[in] aMessage
مؤشر إلى المخزن المؤقت للرسائل.
[in] aOffset
الإزاحة بالبايت.
[in] aBuf
مؤشر إلى المخزن المؤقت الذي تتم قراءة وحدات بايت الرسالة إليه.
[in] aLength
عدد وحدات البايت المراد قراءتها.
المرتجعات
عدد وحدات البايت التي تمت قراءتها.
يُرجى الاطِّلاع أيضًا على:
otMessageFree
otMessagefooter
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite

otMessageSetDirectTransportance

void otMessageSetDirectTransmission(
  otMessage *aMessage,
  bool aEnabled
)

تعمل هذه الدالة على ضبط/إعادة توجيه الرسالة باستخدام النقل المباشر.

الإعداد التلقائي لرسالة جديدة هو false.

التفاصيل
المعلَمات
[in] aMessage
مؤشر إلى المخزن المؤقت للرسائل.
[in] aEnabled
في حال استخدام true، يتم فرض استخدام الرسالة المباشرة. إذا كانت false، تتبع الرسالة الإجراء العادي.

otMessageSetLength

otError otMessageSetLength(
  otMessage *aMessage,
  uint16_t aLength
)

اضبط طول الرسالة بالبايت.

التفاصيل
المعلَمات
[in] aMessage
مؤشر إلى المخزن المؤقت للرسائل.
[in] aLength
طول النص بالبايت.
قيم الإرجاع
OT_ERROR_NONE
تم تحديد طول الرسالة بنجاح.
OT_ERROR_NO_BUFS
ما مِن مخازن مؤقتة متاحة لتوسيع الرسالة.
يُرجى الاطِّلاع أيضًا على:
otMessageFree
otMessagefooter
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageSetOffset

void otMessageSetOffset(
  otMessage *aMessage,
  uint16_t aOffset
)

اضبط إزاحة الرسالة بالبايت.

التفاصيل
المعلَمات
[in] aMessage
مؤشر إلى المخزن المؤقت للرسائل.
[in] aOffset
الإزاحة بالبايت.
يُرجى الاطِّلاع أيضًا على:
otMessageFree
otMessagefooter
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite

oMessageWrite

int otMessageWrite(
  otMessage *aMessage,
  uint16_t aOffset,
  const void *aBuf,
  uint16_t aLength
)

كتابة وحدات البايت في رسالة.

التفاصيل
المعلَمات
[in] aMessage
مؤشر إلى المخزن المؤقت للرسائل.
[in] aOffset
الإزاحة بالبايت.
[in] aBuf
مؤشر إلى المخزن المؤقت الذي تتم كتابة الرسائل منه.
[in] aLength
عدد وحدات البايت المراد كتابتها.
المرتجعات
عدد وحدات البايت المكتوبة.
يُرجى الاطِّلاع أيضًا على:
otMessageFree
otMessagefooter
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead

المراجع

تنشأ مواضيع واجهة برمجة تطبيقات OpenThread المرجعية من رمز المصدر المتاح على GitHub. للحصول على مزيد من المعلومات أو للمساهمة في مستنداتنا، يُرجى الرجوع إلى الموارد.