TREL - מחסנית שרשורים

מודול זה מגדיר ממשקי API עבור שרשור פרוטוקול תקשורת (TREL) עבור שרשור בנושא תשתית.

סיכום

כדי להשתמש בפונקציות במודול הזה, צריך להפעיל את OPENTHREAD_CONFIG_RADIO_LINK_TREL_ENABLE.

סוג מגן

otTrelPeer typedef
struct otTrelPeer
המבנה הזה מייצג עמית TREL.
otTrelPeerIterator typedef
uint16_t
סוג זה מייצג איטרטור לחזרה על רשומות בטבלת אפליקציות דומות.

פונקציות

otTrelDisable(otInstance *aInstance)
void
הפונקציה הזו משביתה את פעולת ה-TREL.
otTrelEnable(otInstance *aInstance)
void
הפונקציה הזו מאפשרת פעולת TREL.
otTrelGetNextPeer(otInstance *aInstance, otTrelPeerIterator *aIterator)
const otTrelPeer *
פונקציה זו חוזרת על עצמה באמצעות הטבלה של אפליקציות להשוואה, מקבלת את הערך הבא מהטבלה.
otTrelInitPeerIterator(otInstance *aInstance, otTrelPeerIterator *aIterator)
void
הפונקציה הזו מפעילה איטרטור של טבלת אפליקציות להשוואה.
otTrelIsEnabled(otInstance *aInstance)
bool
פונקציה זו מציינת אם פעולת TREL מופעלת.
otTrelIsFilterEnabled(otInstance *aInstance)
bool
פונקציה זו מציינת אם מצב המסנן מופעל או לא.
otTrelSetFilterEnabled(otInstance *aInstance, bool aEnable)
void
הפונקציה הזו מגדירה את מצב המסנן (הפעלה/השבתה של סינון).

שטרטס

otTrelPeer

המבנה הזה מייצג עמית TREL.

סוג מגן

אוטרל פייר

struct otTrelPeer otTrelPeer

המבנה הזה מייצג עמית TREL.

otTrelPeerIterator

uint16_t otTrelPeerIterator

סוג זה מייצג איטרטור לחזרה על רשומות בטבלת אפליקציות דומות.

פונקציות

otTrelDisable

void otTrelDisable(
  otInstance *aInstance
)

הפונקציה הזו משביתה את פעולת ה-TREL.

הפונקציה הזו מפסיקה את הגלישה ב-DNS-SD בשם השירות "_trel._udp", מפסיקה את הפרסום של TREL DNS-SD ומנקה את טבלת האפליקציות הדומות של TREL.

פרטים
פרמטרים
[in] aInstance
המופע של OpenThread.

OTTrelEnable

void otTrelEnable(
  otInstance *aInstance
)

הפונקציה הזו מאפשרת פעולת TREL.

הפונקציה הזו מפעילה חיפוש DNS-SD מתמשך בשם השירות "_trel._udp" בדומיין הגלישה המקומי, כדי לגלות מכשירים אחרים שתומכים ב-TREL. המכשיר גם רושם שירות חדש לפרסום באמצעות DNS-SD, ושם השירות הוא "_trel._udp" מציין שהוא תומך ב-TREL. המכשיר מוכן לקבלת הודעות TREL מעמיתים.

פרטים
פרמטרים
[in] aInstance
המופע של OpenThread.

otTrelGetNextPeer

const otTrelPeer * otTrelGetNextPeer(
  otInstance *aInstance,
  otTrelPeerIterator *aIterator
)

פונקציה זו חוזרת על עצמה באמצעות הטבלה של אפליקציות להשוואה, מקבלת את הערך הבא מהטבלה.

פרטים
פרמטרים
[in] aInstance
המופע של OpenThread.
[in] aIterator
האיטרטור. חובה לאתחל.
החזרות
מצביע לערך הבא otTrelPeer או NULL אם אין עוד ערכים בטבלה.

otTrelInitPeerIterator

void otTrelInitPeerIterator(
  otInstance *aInstance,
  otTrelPeerIterator *aIterator
)

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

פרטים
פרמטרים
[in] aInstance
המופע של OpenThread.
[in] aIterator
האיטרטור לאתחול.

OTTrelIsEnabled

bool otTrelIsEnabled(
  otInstance *aInstance
)

פונקציה זו מציינת אם פעולת TREL מופעלת.

פרטים
פרמטרים
[in] aInstance
המופע של OpenThread.
ערכי החזרה
TRUE
אם פעולת ה-TREL מופעלת.
FALSE
אם פעולת ה-TREL מושבתת.

OTTrelIsFilterEnabled

bool otTrelIsFilterEnabled(
  otInstance *aInstance
)

פונקציה זו מציינת אם מצב המסנן מופעל או לא.

פרטים
פרמטרים
[in] aInstance
המופע של OpenThread.
ערכי החזרה
TRUE
אם מצב המסנן TREL מופעל.
FALSE
אם מצב מסנן ה-TREL מושבת.

otTrelSetFilterEnabled

void otTrelSetFilterEnabled(
  otInstance *aInstance,
  bool aEnable
)

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

כשמצב מסנן מופעל, תנועת rx ו-tx דרך ממשק TREL מבוטלת באופן שקט. אפשרות זו מיועדת בעיקר לשימוש במהלך בדיקה.

בשונה מ-otTrel{Enable/Disable}() שמתחילה או מפסיקה לגמרי את פעולת ה-TREL, כאשר מצב הסינון מופעל, ממשק ה-TREL ממשיך להיות מופעל.

פרטים
פרמטרים
[in] aInstance
המופע של OpenThread.
[in] aFiltered
TRUE כדי להפעיל מצב סינון, FALSE כדי להשבית מצב סינון.

מקורות מידע

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