סוכן גבול

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

סיכום

מספור
otBorderAgentState{
  OT_BORDER_AGENT_STATE_STOPPED = 0,
  OT_BORDER_AGENT_STATE_STARTED = 1,
  OT_BORDER_AGENT_STATE_ACTIVE = 2
} 		טיפוסים בני מנייה (enum)
מגדיר את המצב של סוכן גבול.

סוג שגיאות
otBorderAgentId typedef
מייצג מזהה סוכן גבול.
otBorderAgentState typedef
מגדיר את המצב של סוכן גבול.

משתנים
OT_TOOL_PACKED_END

פונקציות
otBorderAgentGetId(otInstance *aInstance, otBorderAgentId *aId)
מקבל את מזהה סוכן הגבול שנוצר באופן אקראי.
otBorderAgentGetState(otInstance *aInstance)
מקבל את הערך otBorderAgentState לתפקיד Agent Border Agent.
otBorderAgentGetUdpPort(otInstance *aInstance)
uint16_t
מקבלת את יציאת ה-UDP של שירות Thread Border Agent.
otBorderAgentSetId(otInstance *aInstance, const otBorderAgentId *aId)
מגדיר את מזהה סוכן הגבול.

מבנים
otBorderAgentId

מייצג מזהה סוכן גבול.

מספור

OTBorderAgentState

 otBorderAgentState

מגדיר את המצב של סוכן גבול.

מאפיינים
OT_BORDER_AGENT_STATE_ACTIVE

סוכן גבול מחובר לנציג חיצוני.

OT_BORDER_AGENT_STATE_STARTED

סוכן גבול הופעל.

OT_BORDER_AGENT_STATE_STOPPED

האפשרות של סוכן גבול מושבתת.

סוג שגיאות

מזהה OTBorderAgentId

struct otBorderAgentId otBorderAgentId

מייצג מזהה סוכן גבול.

OTBorderAgentState

enum otBorderAgentState otBorderAgentState

מגדיר את המצב של סוכן גבול.

משתנים

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otBorderAgentId OT_TOOL_PACKED_END

פונקציות

OTBorderAgentGetId

otError otBorderAgentGetId(
  otInstance *aInstance,
  otBorderAgentId *aId
)

מקבל את מזהה סוכן הגבול שנוצר באופן אקראי.

התעודה המזהה נשמרת באחסון קבוע וממשיכת את ההפעלה מחדש. תרחיש השימוש האופייני במזהה הוא לפרסם בשירות mDNS של MeshCoP כערך id TXT ללקוח כדי שיזהה את מכשיר נתב הגבולות/סוכן הזה.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[out] aId
מצביע אל מאגר נתונים זמני כדי לקבל את המזהה.
ערכי החזרה
OT_ERROR_NONE
אחזור של מזהה סוכן הגבול בוצע בהצלחה.
...
אחזור מזהה הסוכן של הגבול נכשל.
מידע נוסף:
otBorderAgentSetId

OTBorderAgentGetState

otBorderAgentState otBorderAgentGetState(
  otInstance *aInstance
)

מקבל את הערך otBorderAgentState לתפקיד Agent Border Agent.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
החזרות
ה-otBorderAgentState הנוכחי ל-Border Agent.

פרוטוקול OTBorderAgentGetUdpPort

uint16_t otBorderAgentGetUdpPort(
  otInstance *aInstance
)

מקבלת את יציאת ה-UDP של שירות Thread Border Agent.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
החזרות
יציאת UDP של סוכן הגבול.

OTBorderAgentSetId

otError otBorderAgentSetId(
  otInstance *aInstance,
  const otBorderAgentId *aId
)

מגדיר את מזהה סוכן הגבול.

מזהה סוכן הגבול יישמר באחסון קבוע וישרוד את ההפעלות מחדש. צריך להגדיר את התעודה המזהה רק פעם אחת אחרי האיפוס להגדרות המקוריות. אם המזהה מעולם לא הוגדר על ידי קריאה לפונקציה הזו, המערכת תיצור מזהה רנדומלי ותוחזר כאשר הקריאה ל-otBorderAgentGetId מתבצעת.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[out] aId
מצביעים על המזהה של סוכן הגבול.
ערכי החזרה
OT_ERROR_NONE
אם הוגדר בהצלחה מזהה הגבול.
...
אם לא הוגדר המזהה של גבול הגבול.
מידע נוסף:
otBorderAgentGetId

פקודות מאקרו

OT_BORDER_AGENT_ID_LENGTH

 OT_BORDER_AGENT_ID_LENGTH (16)

האורך של מזהה סוכן/נתב גבולות בבייטים.

משאבים

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