מסר

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

סיכום

מספור

otMessagePriority{
  OT_MESSAGE_PRIORITY_LOW = 0,
  OT_MESSAGE_PRIORITY_NORMAL = 1,
  OT_MESSAGE_PRIORITY_HIGH = 2
}
טיפוסים בני מנייה (enum)
ספירה זו מגדירה את רמות העדיפות של ההודעות ב-OpenThread.

סוג Dedef

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

מבנה זה מייצג הגדרות של הודעות.

מספור

otMessageעדיפות

 otMessagePriority

ספירה זו מגדירה את רמות העדיפות של ההודעות ב-OpenThread.

מאפיינים
OT_MESSAGE_PRIORITY_HIGH

רמת עדיפות גבוהה.

OT_MESSAGE_PRIORITY_LOW

רמת עדיפות נמוכה.

OT_MESSAGE_PRIORITY_NORMAL

רמת עדיפות רגילה.

סוג Dedef

פרטי OTBuffer

struct otBufferInfo otBufferInfo

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

otMessage

struct otMessage otMessage

סוג זה הוא ייצוג אטום של מאגר הודעות של OpenThread.

otMessageעדיפות

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

otMessageGetRss

int8_t otMessageGetRss(
  const otMessage *aMessage
)

פונקציה זו מחזירה את ה-RSS הממוצע (חוזק האות שהתקבל) המשויך להודעה.

פרטים
החזרות
ערך RSS ממוצע (ב-dBm) או OT_ רדיו_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 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

otMessageSetDirectTransmission

void otMessageSetDirectTransmission(
  otMessage *aMessage,
  bool aEnabled
)

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

הגדרת ברירת המחדל של הודעה חדשה היא false.

פרטים
פרמטרים
[in] aMessage
מצביע למאגר הודעות.
[in] aEnabled
אם true, ההודעה מאלצת שימוש בהעברה ישירה. אם ההודעה false מתבצעת, התהליך תקין.

אורך otMessageSet

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

otMessageSetSetset

void otMessageSetOffset(
  otMessage *aMessage,
  uint16_t aOffset
)

מגדירים את הבדלי ההודעות בבייטים.

פרטים
פרמטרים
[in] aMessage
מצביע למאגר הודעות.
[in] aOffset
היסט בבייטים.
להצגת גם:
otMessageFree
otMessageAppend
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
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead

מקורות מידע

הנושאים של Open API API מגיעים מקוד המקור, שזמין ב-GitHub. למידע נוסף או כדי להוסיף מידע למסמכים שלנו, יש לעיין במשאבים.