סוכן גבול

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

סיכום

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

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

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

מספור

OTBorderAgentState

 otBorderAgentState

במספור הזה מוגדר המצב של סוכן גבול.

נכסים
OT_BORDER_AGENT_STATE_ACTIVE

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

OT_BORDER_AGENT_STATE_STARTED

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

OT_BORDER_AGENT_STATE_STOPPED

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

סוג שגיאות

OTBorderAgentState

enum otBorderAgentState otBorderAgentState

במספור הזה מוגדר המצב של סוכן גבול.

פונקציות

OTBorderAgentGetId

otError otBorderAgentGetId(
  otInstance *aInstance,
  uint8_t *aId,
  uint16_t *aLength
)

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

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

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[out] aId
מצביע אל מאגר נתונים זמני כדי לקבל את המזהה.
[in,out] aLength
המדיניות מציינת את האורך של aId כאשר משתמשים בה כקלט, ומקבלת את האורך של נתוני המזהה בפועל שהועתקו אל aId בזמן השימוש כפלט.
ערכי החזרה
OT_ERROR_INVALID_ARGS
אם הערך של aLength הוא קטן מ-OT_BORDER_AGENT_ID_LENGTH.
OT_ERROR_NONE
אחזור של מזהה סוכן הגבול בוצע בהצלחה.

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 של סוכן הגבול.

פקודות מאקרו

OT_BORDER_AGENT_ID_LENGTH

 OT_BORDER_AGENT_ID_LENGTH (16)

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

משאבים

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