مراسلة

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

ملخّص

عمليات التعداد
otMessageOrigin{
  OT_MESSAGE_ORIGIN_THREAD_NETIF = 0,
  OT_MESSAGE_ORIGIN_HOST_TRUSTED = 1,
  OT_MESSAGE_ORIGIN_HOST_UNTRUSTED = 2
} 		تعداد
تحدِّد أصول رسالة 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
otMessageOrigin typedef
تحدِّد أصول رسالة 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
الحصول على إزاحة الرسالة بالبايت.
otMessageGetOrigin(const otMessage *aMessage)
تحصل على أصل الرسالة.
otMessageGetRss(const otMessage *aMessage)
int8_t
لعرض متوسط RSS (قوة الإشارة المستلمة) المرتبط بالرسالة.
otMessageIsLinkSecurityEnabled(const otMessage *aMessage)
bool
يشير إلى ما إذا كان تم تفعيل أمان الرابط للرسالة أم لا.
otMessageIsLoopbackToHostAllowed(const otMessage *aMessage)
bool
يشير إلى ما إذا كان مسموحًا بتكرار الرسالة مرة أخرى إلى المضيف أم لا.
otMessageIsMulticastLoopEnabled(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)
ضبط طول الرسالة بالبايت.
otMessageSetLoopbackToHostAllowed(otMessage *aMessage, bool aAllowLoopbackToHost)
void
يحدد هذا الإعداد ما إذا كان يُسمح بتكرار الرسالة إلى المضيف أم لا.
otMessageSetMulticastLoopEnabled(otMessage *aMessage, bool aEnabled)
void
تتحكّم هذه السياسة في ما إذا كان يمكن تكرار الرسالة المحدّدة في حال استخدام عنوان وجهة للبث المتعدد.
otMessageSetOffset(otMessage *aMessage, uint16_t aOffset)
void
تعيين إزاحة الرسالة بالبايت.
otMessageSetOrigin(otMessage *aMessage, otMessageOrigin aOrigin)
void
لضبط مصدر الرسالة.
otMessageWrite(otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength)
int
كتابة وحدات البايت إلى رسالة.

الهياكل
otBufferInfo

تُمثِّل معلومات المخزن المؤقت للرسائل لقوائم الانتظار المختلفة التي يستخدمها تكديس OpenThread.

otMessageQueue

يُمثِّل قائمة انتظار رسائل OpenThread.

otMessageQueueInfo

يعرض هذا الخيار معلومات عن قائمة انتظار الرسائل.

otMessageSettings

يمثل إعدادات الرسالة.

عمليات التعداد

otMessageOrigin

 otMessageOrigin

تحدِّد أصول رسالة OpenThread.

أماكن إقامة
OT_MESSAGE_ORIGIN_HOST_TRUSTED

رسالة من مصدر موثوق فيه على المضيف

OT_MESSAGE_ORIGIN_HOST_UNTRUSTED

رسالة من مصدر غير موثوق به على المضيف

OT_MESSAGE_ORIGIN_THREAD_NETIF

رسالة من Thread Netif

otMessagePriority

 otMessagePriority

تحدِّد هذه السياسة مستويات أولوية رسالة OpenThread.

أماكن إقامة
OT_MESSAGE_PRIORITY_HIGH

مستوى أولوية عالية.

OT_MESSAGE_PRIORITY_LOW

مستوى أولوية منخفضة.

OT_MESSAGE_PRIORITY_NORMAL

مستوى الأولوية العادي.

تحديدات النوع

otBufferInfo

struct otBufferInfo otBufferInfo

تُمثِّل معلومات المخزن المؤقت للرسائل لقوائم الانتظار المختلفة التي يستخدمها تكديس OpenThread.

otMessage

struct otMessage otMessage

تمثيل مبهم للمخزن المؤقت لرسائل OpenThread

otMessageOrigin

enum otMessageOrigin otMessageOrigin

تحدِّد أصول رسالة OpenThread.

otMessagePriority

enum otMessagePriority otMessagePriority

تحدِّد هذه السياسة مستويات أولوية رسالة OpenThread.

otMessageQueueInfo

struct otMessageQueueInfo otMessageQueueInfo

يعرض هذا الخيار معلومات عن قائمة انتظار الرسائل.

otMessageSettings

struct otMessageSettings otMessageSettings

يمثل إعدادات الرسالة.

الدوال

otMessageAppend

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

otMessageFree

void otMessageFree(
  otMessage *aMessage
)

تفريغ مخزن مؤقت مخصص للرسائل

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

otMessageGetOffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

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

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

otMessageGetOrigin

otMessageOrigin otMessageGetOrigin(
  const otMessage *aMessage
)

تحصل على أصل الرسالة.

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

otMessageGetRss

int8_t otMessageGetRss(
  const otMessage *aMessage
)

لعرض متوسط RSS (قوة الإشارة المستلمة) المرتبط بالرسالة.

التفاصيل
المرتجعات
متوسط قيمة RSS (بالديسيبل بالمللي وات) أو OT_Radio_RSSI_INVALID في حال عدم توفر متوسط RSS.

otMessageIsLinkSecurityEnabled

bool otMessageIsLinkSecurityEnabled(
  const otMessage *aMessage
)

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

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

otMessageIsLoopbackToHostAllowed

bool otMessageIsLoopbackToHostAllowed(
  const otMessage *aMessage
)

يشير إلى ما إذا كان مسموحًا بتكرار الرسالة مرة أخرى إلى المضيف أم لا.

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

otMessageIsMulticastLoopEnabled

bool otMessageIsMulticastLoopEnabled(
  otMessage *aMessage
)

يشير إلى ما إذا كان يمكن تكرار الرسالة المقدمة في حالة عنوان وجهة البث المتعدد.

في حال استخدام aMessage مع otMessageInfo، تكون الأولوية للحقل mMulticastLoop من بنية otMessageInfo وسيتم استخدامه بدلاً من القيمة المحدَّدة في aMessage.

إنّ واجهة برمجة التطبيقات هذه مُعدّة بشكل أساسي للاستخدام مع otIp6Send() التي تتوقّع تلقّي رسالة IPv6 سبق أن تم إعدادها.

التفاصيل
المَعلمات
[in] aMessage
مؤشر للرسالة.

otMessageQueueDequeue

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

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

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

otMessageQueueEnqueue

void otMessageQueueEnqueue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

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

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

otMessageQueueEnqueueAtHead

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 أو 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
مؤشر يشير إلى قائمة انتظار الرسائل

otMessageRead

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

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

التفاصيل
المَعلمات
[in] aMessage
مؤشر يشير إلى المخزن المؤقت للرسائل.
[in] aOffset
إزاحة بالبايت.
[in] aBuf
يشير هذا المصطلح إلى مؤشر لمخزن مؤقت تتم قراءة وحدات بايت الرسالة عليه.
[in] aLength
عدد وحدات بايت للقراءة.
المرتجعات
عدد وحدات البايت التي تمت قراءتها.
يُرجى الاطّلاع أيضًا على:
otMessageFree
otMessageAppend
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
otMessageAppend
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageSetLoopbackToHostAllowed

void otMessageSetLoopbackToHostAllowed(
  otMessage *aMessage,
  bool aAllowLoopbackToHost
)

يحدد هذا الإعداد ما إذا كان يُسمح بتكرار الرسالة إلى المضيف أم لا.

التفاصيل
المَعلمات
[in] aMessage
مؤشر يشير إلى المخزن المؤقت للرسائل.
[in] aAllowLoopbackToHost
ما إذا كان سيتم السماح بتكرار الرسالة مرة أخرى إلى المضيف.

otMessageSetMulticastLoopEnabled

void otMessageSetMulticastLoopEnabled(
  otMessage *aMessage,
  bool aEnabled
)

تتحكّم هذه السياسة في ما إذا كان يمكن تكرار الرسالة المحدّدة في حال استخدام عنوان وجهة للبث المتعدد.

التفاصيل
المَعلمات
[in] aMessage
مؤشر للرسالة.
[in] aEnabled
قيمة الإعداد.

otMessageSetOffset

void otMessageSetOffset(
  otMessage *aMessage,
  uint16_t aOffset
)

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

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

otMessageSetOrigin

void otMessageSetOrigin(
  otMessage *aMessage,
  otMessageOrigin aOrigin
)

لضبط مصدر الرسالة.

التفاصيل
المَعلمات
[in] aMessage
مؤشر يشير إلى المخزن المؤقت للرسائل.
[in] aOrigin
أصل الرسالة.

otMessageWrite

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

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

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

المراجِع

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