الرسالة

تتضمّن هذه الوحدة الدوال التي تتلاعب بالمخازن المؤقتة للرسائل المفتوحة.

ملخّص

التعدادات
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
تمثيل مبهم لذاكرة التخزين المؤقت للرسائل المفتوحة في سلسلة محادثات.
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
قراءة وحدات البايت من رسالة.
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

تمثيل مبهم لذاكرة التخزين المؤقت للرسائل المفتوحة في سلسلة محادثات.

OotMessagePriority

enum otMessagePriority otMessagePriority

تحديد مستويات أولوية رسائل OpenThread.

otMessageQueueInfo

struct otMessageQueueInfo otMessageQueueInfo

تمثل معلومات حول قائمة انتظار الرسائل.

OotMessageSettings

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

OotMessageFree

void otMessageFree(
  otMessage *aMessage
)

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

التفاصيل
المَعلمات
[in] aMessage
مؤشر إلى المخزن المؤقت للرسائل
راجع أيضًا:
otMessageFetch
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
otMessageCompose
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageSet
8MessageSet

otMessageGetOffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

يمكنك الحصول على إزاحة الرسالة بالبايت.

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

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

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

قائمة انتظار otMessageQueue

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

إزالة رسالة من قائمة انتظار الرسائل المحدَّدة

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

otMessageQueueEneque

void otMessageQueueEnqueue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

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

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

otMessageQueueEnqueueAtHeader

void otMessageQueueEnqueueAtHead(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

لإضافة رسالة في رأس الصفحة أو أمامها.

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

otMessageQueueGetHeader

otMessage * otMessageQueueGetHead(
  otMessageQueue *aQueue
)

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

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

otMessageQueueGetNext

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

لعرض مؤشر على الرسالة التالية في قائمة المحتوى التالي من خلال التكرار للأمام (من الرأس إلى الذيل).

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

otMessageQueueInit

void otMessageQueueInit(
  otMessageQueue *aQueue
)

إعداد قائمة انتظار الرسائل

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

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

OotMessageRead

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

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

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

otMessageResetBufferInfo

void otMessageResetBufferInfo(
  otInstance *aInstance
)

يمكنك إعادة ضبط المخزن المؤقت لمعلومات المخزن المؤقت لتتبُّع الحد الأقصى المسموح به لعدد المخزن المؤقت في الوقت نفسه.

يؤدي هذا إلى إعادة ضبط mMaxUsedBuffers في otBufferInfo.

التفاصيل
المَعلمات
[in] aInstance
مؤشر إلى مثيل OpenThread.

otMessageSetDirectTransmission

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
otMessageCompose
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageSetOffset

void otMessageSetOffset(
  otMessage *aMessage,
  uint16_t aOffset
)

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

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

OotMessageكتابة

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

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

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

الموارد

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