Google is committed to advancing racial equity for Black communities. See how.

رسالة

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

ملخص

التعداد

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

النوع

otBufferInfo typedef
struct otBufferInfo
يمثل هذا الهيكل معلومات المخزن المؤقت للرسالة.
otMessage typedef
struct otMessage
هذا النوع هو تمثيل معتم لمخزن رسائل OpenThread المؤقت.
otMessagePriority typedef
يحدد هذا التعداد مستويات أولوية رسالة OpenThread.
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

يمثل هذا الهيكل معلومات المخزن المؤقت للرسالة.

otMessageQueue

تمثل هذه البنية قائمة انتظار رسائل OpenThread.

otMessageSettings

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

التعداد

otMessage الأولوية

 otMessagePriority

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

الخصائص
OT_MESSAGE_PRIORITY_HIGH

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

OT_MESSAGE_PRIORITY_LOW

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

OT_MESSAGE_PRIORITY_NORMAL

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

النوع

otBufferInfo

struct otBufferInfo otBufferInfo

يمثل هذا الهيكل معلومات المخزن المؤقت للرسالة.

otMessage

struct otMessage otMessage

هذا النوع هو تمثيل معتم لمخزن رسائل OpenThread المؤقت.

otMessage الأولوية

enum otMessagePriority otMessagePriority

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

otMessageSettings

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

otMessageFree

void otMessageFree(
  otMessage *aMessage
)

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

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

otMessageGetOffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

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

تفاصيل
المعلمات
[in] aMessage
مؤشر إلى مخزن الرسائل المؤقت.
عائدات
قيمة إزاحة الرسالة.
أنظر أيضا:
otMessageFree
otMessage
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetRss

int8_t otMessageGetRss(
  const otMessage *aMessage
)

تقوم هذه الوظيفة بإرجاع متوسط ​​RSS (قوة الإشارة المستقبلة) المرتبط بالرسالة.

تفاصيل
عائدات
متوسط ​​قيمة RSS (بالديسيبل) أو OT_RADIO_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
الرسالة المراد إضافتها.

otMessageQueueEnqueueAtHead

void otMessageQueueEnqueueAtHead(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

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

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

otMessageQueueGetHead

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 if is not in the queue aQueue`.

otMessageQueueInit

void otMessageQueueInit(
  otMessageQueue *aQueue
)

تهيئة قائمة انتظار الرسائل.

يجب استدعاء هذه الوظيفة مرة واحدة ومرة ​​واحدة فقط لمثيل otMessageQueue قبل أي وظائف 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
otMessageLend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite

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

otMessageSetOffset

void otMessageSetOffset(
  otMessage *aMessage,
  uint16_t aOffset
)

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

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

otMessageWrite

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

اكتب بايت للرسالة.

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