Google is committed to advancing racial equity for Black communities. See how.
דף זה תורגם על ידי Cloud Translation API.
Switch to English

למשל

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

סיכום

ספירות

anonymous enum {
OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0,
OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1,
OT_CHANGED_THREAD_ROLE = 1 << 2,
OT_CHANGED_THREAD_LL_ADDR = 1 << 3,
OT_CHANGED_THREAD_ML_ADDR = 1 << 4,
OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5,
OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6,
OT_CHANGED_THREAD_PARTITION_ID = 1 << 7,
OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8,
OT_CHANGED_THREAD_NETDATA = 1 << 9,
OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10,
OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11,
OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12,
OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13,
OT_CHANGED_THREAD_CHANNEL = 1 << 14,
OT_CHANGED_THREAD_PANID = 1 << 15,
OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16,
OT_CHANGED_THREAD_EXT_PANID = 1 << 17,
OT_CHANGED_MASTER_KEY = 1 << 18,
OT_CHANGED_PSKC = 1 << 19,
OT_CHANGED_SECURITY_POLICY = 1 << 20,
OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21,
OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22,
OT_CHANGED_COMMISSIONER_STATE = 1 << 23,
OT_CHANGED_THREAD_NETIF_STATE = 1 << 24,
OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25,
OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26,
OT_CHANGED_JOINER_STATE = 1 << 27,
OT_CHANGED_ACTIVE_DATASET = 1 << 28,
OT_CHANGED_PENDING_DATASET = 1 << 29
}
enum
ספירה זו מגדירה דגלים המועברים כחלק מ- otStateChangedCallback .

טיפוסיות

otChangedFlags typedef
uint32_t
סוג זה מייצג שדה ביט המציין מצב / תצורה ספציפיים שהשתנו.
otInstance typedef
struct otInstance
מבנה זה מייצג את מבנה המופע של OpenThread.
otStateChangedCallback )(otChangedFlags aFlags, void *aContext) typedef
void(*
מצביע פונקציה זה נקרא להודיע ​​על שינויים בתצורה או במצב מסוימים בתוך OpenThread.

פונקציות

otGetRadioVersionString ( otInstance *aInstance)
const char *
פונקציה זו מקבלת את מחרוזת גרסת הרדיו של OpenThread.
otGetVersionString (void)
const char *
פונקציה זו מקבלת את מחרוזת גרסת OpenThread.
otInstanceErasePersistentInfo ( otInstance *aInstance)
פונקציה זו מוחקת את כל המידע המתמשך של OpenThread (הגדרות רשת) המאוחסן בזיכרון שאינו נדיף.
otInstanceFactoryReset ( otInstance *aInstance)
void
שיטה זו מוחקת את כל ההגדרות המאוחסנות בזיכרון שאינו נדיף, ואז מפעילה את איפוס הפלטפורמה.
otInstanceFinalize ( otInstance *aInstance)
void
פונקציה זו מבטלת את ספריית OpenThread.
otInstanceInit (void *aInstanceBuffer, size_t *aInstanceBufferSize)
פונקציה זו מאתחלת את ספריית OpenThread.
otInstanceInitSingle (void)
פונקציה זו מאתחלת את המופע היחיד הסטטי של ספריית OpenThread.
otInstanceIsInitialized ( otInstance *aInstance)
bool
פונקציה זו מציינת אם המופע תקף / או אתחל.
otInstanceReset ( otInstance *aInstance)
void
שיטה זו מפעילה איפוס לפלטפורמה.
otRemoveStateChangeCallback ( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
void
פונקציה זו מסירה התקשרות חוזרת כדי לציין מתי תצורה או מצב מסוימים משתנים בתוך OpenThread.
otSetStateChangedCallback ( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
פונקציה זו רושמת התקשרות חוזרת כדי לציין מתי תצורה או מצב מסוימים משתנים בתוך OpenThread.

ספירות

אנונימי אנונימי

 anonymous enum

ספירה זו מגדירה דגלים המועברים כחלק מ- otStateChangedCallback .

נכסים
OT_CHANGED_ACTIVE_DATASET

ערכת נתונים פעילה פעילה השתנתה.

OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL

מנהל הערוצים ערוץ החוטים בהמתנה חדש שונה.

OT_CHANGED_COMMISSIONER_STATE

מדינת הנציב השתנתה.

OT_CHANGED_IP6_ADDRESS_ADDED

נוספה כתובת IPv6.

OT_CHANGED_IP6_ADDRESS_REMOVED

כתובת IPv6 הוסרה.

OT_CHANGED_IP6_MULTICAST_SUBSCRIBED

מנוי לכתובת ריבוי שידורי IPv6.

OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED

בוטל מנוי מכתובת ריבוי שידורים IPv6.

OT_CHANGED_JOINER_STATE

מדינת המצטרפים השתנתה.

OT_CHANGED_MASTER_KEY

מפתח הראשי השתנה.

OT_CHANGED_PENDING_DATASET

ערכת נתונים תפעולית בהמתנה שונתה.

OT_CHANGED_PSKC

PSKc השתנה.

OT_CHANGED_SECURITY_POLICY

מדיניות האבטחה שונתה.

OT_CHANGED_SUPPORTED_CHANNEL_MASK

מסכת הערוץ הנתמכת שונתה.

OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL

תצורת נתב השדרה המקומית שונתה.

OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE

מצב נתב עמוד השדרה השתנה.

OT_CHANGED_THREAD_CHANNEL

ערוץ רשת החוטים שונה.

OT_CHANGED_THREAD_CHILD_ADDED

ילד התווסף.

OT_CHANGED_THREAD_CHILD_REMOVED

ילד הוסר.

OT_CHANGED_THREAD_EXT_PANID

מזהה ה- PAN המורחב ברשת החוט שונה.

OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER

רצף מקשי החוט השתנה.

OT_CHANGED_THREAD_LL_ADDR

כתובת הקישור המקומית שונתה.

OT_CHANGED_THREAD_ML_ADDR

כתובת הרשת המקומית השתנתה.

OT_CHANGED_THREAD_NETDATA

נתוני רשת החוטים השתנו.

OT_CHANGED_THREAD_NETIF_STATE

מצב ממשק רשת החוט השתנה.

OT_CHANGED_THREAD_NETWORK_NAME

שם רשת החוטים שונה.

OT_CHANGED_THREAD_PANID

מזהה PAN של רשת החוטים השתנה.

OT_CHANGED_THREAD_PARTITION_ID

מזהה המחיצה השתנה.

OT_CHANGED_THREAD_RLOC_ADDED

נוספה RLOC.

OT_CHANGED_THREAD_RLOC_REMOVED

RLOC הוסר.

OT_CHANGED_THREAD_ROLE

התפקיד (מושבת, מנותק, ילד, נתב, מנהיג) השתנה.

טיפוסיות

otChangedFlags

uint32_t otChangedFlags

סוג זה מייצג שדה ביט המציין מצב / תצורה ספציפיים שהשתנו.

ראה הגדרות OT_CHANGED_* .

otInstance

struct otInstance otInstance

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

otStateChangedCallback

void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)

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

פרטים
פרמטרים
[in] aFlags
שדה ביט המציין מצב ספציפי שהשתנה. ראה הגדרות OT_CHANGED_* .
[in] aContext
מצביע להקשר ספציפי ליישום.

פונקציות

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

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

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
החזרות
מצביע לגרסת הרדיו OpenThread.

otGetVersionString

const char * otGetVersionString(
  void
)

פונקציה זו מקבלת את מחרוזת גרסת OpenThread.

פרטים
החזרות
מצביע לגרסת OpenThread.

otInstanceErasePersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

פונקציה זו מוחקת את כל המידע המתמשך של OpenThread (הגדרות רשת) המאוחסן בזיכרון שאינו נדיף.

המחיקה מוצלחת רק אם המכשיר במצב / תפקיד disabled .

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
החזר ערכים
OT_ERROR_NONE
כל המידע / מצב המתמידים נמחקו בהצלחה.
OT_ERROR_INVALID_STATE
המכשיר אינו במצב / תפקיד disabled .

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

שיטה זו מוחקת את כל ההגדרות המאוחסנות בזיכרון שאינו נדיף, ואז מפעילה את איפוס הפלטפורמה.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.

otInstance סיים

void otInstanceFinalize(
  otInstance *aInstance
)

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

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

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.

otInstanceInit

otInstance * otInstanceInit(
  void *aInstanceBuffer,
  size_t *aInstanceBufferSize
)

פונקציה זו מאתחלת את ספריית OpenThread.

פונקציה זו מאתחלת את OpenThread ומכינה אותה לקריאות ה- API של OpenThread שלאחר מכן. יש לקרוא לפונקציה זו לפני כל שיחה אחרת ל- OpenThread.

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

פרטים
פרמטרים
[in] aInstanceBuffer
המאגר לשימוש OpenThread להקצאת מבנה otInstance.
[in,out] aInstanceBufferSize
בכניסה, גודל ה- aInstanceBuffer. בפלט, אם לא מספיק מקום ל- otInstance, מספר הבתים הדרוש ל- otInstance.
החזרות
מצביע למופע OpenThread החדש.
ראה גם:
otInstance סיים

otInstanceInitSingle

otInstance * otInstanceInitSingle(
  void
)

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

פונקציה זו מאתחלת את OpenThread ומכינה אותה לקריאות ה- API של OpenThread שלאחר מכן. יש לקרוא לפונקציה זו לפני כל שיחה אחרת ל- OpenThread.

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

פרטים
החזרות
מצביע למופע ה- OpenThread הבודד.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

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

המופע נחשב תקף אם הוא נרכש otInstanceInitSingle() באמצעות otInstanceInitSingle() (במקרה של מקרה יחיד) או otInstanceInit() (במקרה של מופע רב). קריאה שלאחר מכן ל- otInstanceFinalize() גורמת למופע להיחשב כלא מאוחסן.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
החזרות
נכון אם המופע הנתון חוקי / מאותחל, אחרת לא נכון.

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

שיטה זו מפעילה איפוס לפלטפורמה.

תהליך האיפוס מבטיח שכל מצב / מידע OpenThread (המאוחסן בזיכרון נדיף) יימחק. שים לב שה- otPlatformReset אינו מוחק שום מצב / מידע קבוע שנשמר בזיכרון שאינו נדיף.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.

otRemoveStateChangeCallback

void otRemoveStateChangeCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

פונקציה זו מסירה התקשרות חוזרת כדי לציין מתי תצורה או מצב מסוימים משתנים בתוך OpenThread.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[in] aCallback
מצביע לפונקציה הנקראת עם שינויים מסוימים בתצורה או במצב.
[in] aContext
מצביע להקשר ספציפי ליישום.

otSetStateChangedCallback

otError otSetStateChangedCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

פונקציה זו רושמת התקשרות חוזרת כדי לציין מתי תצורה או מצב מסוימים משתנים בתוך OpenThread.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
[in] aCallback
מצביע לפונקציה הנקראת עם שינויים מסוימים בתצורה או במצב.
[in] aContext
מצביע להקשר ספציפי ליישום.
החזר ערכים
OT_ERROR_NONE
הוסיף את השיחה החזרה לרשימת השיחות החוזרות.
OT_ERROR_ALREADY
השיחה החוזרת כבר נרשמה.
OT_ERROR_NO_BUFS
לא ניתן להוסיף את החזרה להתקשרות עקב אילוצי משאבים.