מסר

המודול הזה כולל פונקציות שמבצעות מניפולציה של מאגרי הודעות של OpenThread.

סיכום

ספירות
otMessageOrigin{
  OT_MESSAGE_ORIGIN_THREAD_NETIF = 0,
  OT_MESSAGE_ORIGIN_HOST_TRUSTED = 1,
  OT_MESSAGE_ORIGIN_HOST_UNTRUSTED = 2
} 		טיפוסים בני מנייה (enum)
הגדרת המקורות של ההודעות ב-OpenThread.
otMessagePriority{
  OT_MESSAGE_PRIORITY_LOW = 0,
  OT_MESSAGE_PRIORITY_NORMAL = 1,
  OT_MESSAGE_PRIORITY_HIGH = 2
} 		טיפוסים בני מנייה (enum)
הגדרת רמות העדיפות של הודעות 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
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 הממוצע (ב-dBm) או 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.

ה-API הזה מיועד בעיקר לשימוש יחד עם 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
מצביע לתור של הודעות.
החזרות
המצביע על ההודעה בראש התור או 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. ההתנהגות לא מוגדרת אם ממשקי API אחרים של תור משמשים עם 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 API הוא קוד המקור, שזמין ב-GitHub. אפשר לקרוא מידע נוסף או לתרום למסמכי התיעוד שלנו בדף מקורות מידע.