מערך נתונים תפעולי

מודול זה כולל פונקציות עבור Dataset Updater.

סיכום

הפונקציות במודול הזה זמינות כשתכונת Dataset Updater מופעלת (כלומר, הערך OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE מוגדר כ-1). בנוסף, התכונה הזו זמינה רק בגרסת FTD.

מספור

otMeshcopTlvType{
  OT_MESHCOP_TLV_CHANNEL = 0,
  OT_MESHCOP_TLV_PANID = 1,
  OT_MESHCOP_TLV_EXTPANID = 2,
  OT_MESHCOP_TLV_NETWORKNAME = 3,
  OT_MESHCOP_TLV_PSKC = 4,
  OT_MESHCOP_TLV_NETWORKKEY = 5,
  OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE = 6,
  OT_MESHCOP_TLV_MESHLOCALPREFIX = 7,
  OT_MESHCOP_TLV_STEERING_DATA = 8,
  OT_MESHCOP_TLV_BORDER_AGENT_RLOC = 9,
  OT_MESHCOP_TLV_COMMISSIONER_ID = 10,
  OT_MESHCOP_TLV_COMM_SESSION_ID = 11,
  OT_MESHCOP_TLV_SECURITYPOLICY = 12,
  OT_MESHCOP_TLV_GET = 13,
  OT_MESHCOP_TLV_ACTIVETIMESTAMP = 14,
  OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT = 15,
  OT_MESHCOP_TLV_STATE = 16,
  OT_MESHCOP_TLV_JOINER_DTLS = 17,
  OT_MESHCOP_TLV_JOINER_UDP_PORT = 18,
  OT_MESHCOP_TLV_JOINER_IID = 19,
  OT_MESHCOP_TLV_JOINER_RLOC = 20,
  OT_MESHCOP_TLV_JOINER_ROUTER_KEK = 21,
  OT_MESHCOP_TLV_PROVISIONING_URL = 32,
  OT_MESHCOP_TLV_VENDOR_NAME_TLV = 33,
  OT_MESHCOP_TLV_VENDOR_MODEL_TLV = 34,
  OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV = 35,
  OT_MESHCOP_TLV_VENDOR_DATA_TLV = 36,
  OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV = 37,
  OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV = 48,
  OT_MESHCOP_TLV_IPV6_ADDRESS_TLV = 49,
  OT_MESHCOP_TLV_PENDINGTIMESTAMP = 51,
  OT_MESHCOP_TLV_DELAYTIMER = 52,
  OT_MESHCOP_TLV_CHANNELMASK = 53,
  OT_MESHCOP_TLV_COUNT = 54,
  OT_MESHCOP_TLV_PERIOD = 55,
  OT_MESHCOP_TLV_SCAN_DURATION = 56,
  OT_MESHCOP_TLV_ENERGY_LIST = 57,
  OT_MESHCOP_TLV_DISCOVERYREQUEST = 128,
  OT_MESHCOP_TLV_DISCOVERYRESPONSE = 129,
  OT_MESHCOP_TLV_JOINERADVERTISEMENT = 241
}
טיפוסים בני מנייה (enum)
ספירה זו מייצגת את סוגי meshcop TLV.

סוג Dedef

otChannelMask Typedef
uint32_t
סוג זה מייצג את מסכת הערוץ.
otDatasetMgmtSetCallback)(otError aResult, void *aContext) Typedef
void(*
מצביע הפונקציה הזה נקרא כאשר מתקבלת תגובה לבקשה ל-MGMT_SET או שתם הזמן הקצוב לתפוגה.
otDatasetUpdaterCallback)(otError aError, void *aContext) Typedef
void(*
מצביע זה הוא פונקציית קריאה חוזרת בסיום בקשת עדכון של מערך נתונים, דיווח על הצלחה או סטטוס כשל של בקשת עדכון של מערך נתונים.
otExtendedPanId Typedef
מבנה זה מייצג מזהה PAN מורחב.
otMeshLocalPrefix Typedef
מבנה זה מייצג קידומת מקומית של רשת.
otMeshcopTlvType Typedef
ספירה זו מייצגת את סוגי meshcop TLV.
otNetworkKey Typedef
struct otNetworkKey
מבנה זה מייצג מפתח לרשת Thread.
otNetworkKeyRef Typedef
סוג הנתונים הזה מייצג את KeyRef אל NetworkKey.
otNetworkName Typedef
struct otNetworkName
מבנה זה מייצג שם של רשת.
otOperationalDataset Typedef
מבנה זה מייצג קבוצת נתונים תפעולית פעילה או בהמתנה.
otOperationalDatasetComponents Typedef
מבנה זה מייצג נוכחות של רכיבים שונים במערך נתונים פעיל או בהמתנה.
otOperationalDatasetTlvs Typedef
מבנה זה מייצג קבוצת נתונים תפעולית פעילה או בהמתנה.
otPskc Typedef
struct otPskc
מבנה זה מייצג PSKc.
otPskcRef Typedef
סוג הנתונים הזה מייצג את KeyRef ל-PSKc.
otSecurityPolicy Typedef
המבנה הזה מייצג את מדיניות האבטחה.
otTimestamp Typedef
struct otTimestamp
המבנה הזה מייצג רכיב של חותמת זמן של Thread Dataset.

משתנים

OT_TOOL_PACKED_END

פונקציות

otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset)
השיטה הזו יוצרת מערך נתונים תפעולי חדש לשימוש בעת יצירת רשת חדשה.
otDatasetGeneratePskc(const char *aPassPhrase, const otNetworkName *aNetworkName, const otExtendedPanId *aExtPanId, otPskc *aPskc)
הפונקציה הזו יוצרת PSKc מתוך ביטוי נתון, שם רשת ומזהה PAN מורחב.
otDatasetGetActive(otInstance *aInstance, otOperationalDataset *aDataset)
פונקציה זו מקבלת את מערך הנתונים התפעולי הפעיל.
otDatasetGetActiveTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
פונקציה זו מקבלת את מערך הנתונים התפעולי הפעיל.
otDatasetGetDelayTimerMinimal(otInstance *aInstance)
uint32_t
קבלת טיימר לעיכוב מינימלי.
otDatasetGetPending(otInstance *aInstance, otOperationalDataset *aDataset)
פונקציה זו מקבלת את מערך הנתונים התפעולי הבהמתנה.
otDatasetGetPendingTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
פונקציה זו מקבלת את מערך הנתונים התפעולי הבהמתנה.
otDatasetIsCommissioned(otInstance *aInstance)
bool
פונקציה זו מציינת אם קיימת רשת חוקית במערך הנתונים התפעולי הפעיל.
otDatasetParseTlvs(const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset)
פונקציה זו מנתחת מערך נתונים תפעולי מ-otOperationalDatasetTlvs.
otDatasetSendMgmtActiveGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
פונקציה זו שולחת את MGMT_ACTIVE_GET.
otDatasetSendMgmtActiveSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
פונקציה זו שולחת את MGMT_ACTIVE_SET.
otDatasetSendMgmtPendingGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
פונקציה זו שולחת את MGMT_PENDING_GET.
otDatasetSendMgmtPendingSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
פונקציה זו שולחת MGMT_PENDING_SET.
otDatasetSetActive(otInstance *aInstance, const otOperationalDataset *aDataset)
פונקציה זו מגדירה את מערך הנתונים התפעולי הפעיל.
otDatasetSetActiveTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
פונקציה זו מגדירה את מערך הנתונים התפעולי הפעיל.
otDatasetSetDelayTimerMinimal(otInstance *aInstance, uint32_t aDelayTimerMinimal)
הגדרת טיימר לעיכוב מינימלי.
otDatasetSetPending(otInstance *aInstance, const otOperationalDataset *aDataset)
פונקציה זו מגדירה את מערך הנתונים התפעולי הבהמתנה.
otDatasetSetPendingTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
פונקציה זו מגדירה את מערך הנתונים התפעולי הבהמתנה.
otDatasetUpdaterCancelUpdate(otInstance *aInstance)
void
פונקציה זו מבטלת את הבקשה לעדכון תפעולי של מערך הנתונים (אם יש).
otDatasetUpdaterIsUpdateOngoing(otInstance *aInstance)
bool
פונקציה זו מציינת אם יש בקשת עדכון פעילה של מערך נתונים.
otDatasetUpdaterRequestUpdate(otInstance *aInstance, const otOperationalDataset *aDataset, otDatasetUpdaterCallback aCallback, void *aContext)
פונקציה זו מבקשת עדכון למערך הנתונים התפעולי.
otNetworkNameFromString(otNetworkName *aNetworkName, const char *aNameString)
פונקציה זו מגדירה מופע של otNetworkName ממחרוזת C ריקה מסוג null.

מבנים

otExtendedPanId

מבנה זה מייצג מזהה PAN מורחב.

otNetworkKey

מבנה זה מייצג מפתח לרשת Thread.

otNetworkName

מבנה זה מייצג שם של רשת.

otOperationalDataset

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

otOperationalDatasetComponents

מבנה זה מייצג נוכחות של רכיבים שונים במערך נתונים פעיל או בהמתנה.

otOperationalDatasetTlvs

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

otPskc

מבנה זה מייצג PSKc.

otSecurityPolicy

המבנה הזה מייצג את מדיניות האבטחה.

otTimestamp

המבנה הזה מייצג רכיב של חותמת זמן של Thread Dataset.

מספור

otMeshcopTlvType

 otMeshcopTlvType

ספירה זו מייצגת את סוגי meshcop TLV.

מאפיינים
OT_MESHCOP_TLV_ACTIVETIMESTAMP

חותמת זמן פעילה של Mehcop

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

MEhcop Border Agent Locator TLV

OT_MESHCOP_TLV_CHANNEL

ערוץ Mehcop TLV

OT_MESHCOP_TLV_CHANNELMASK

ערוץ Masshop של Mask TLV

OT_MESHCOP_TLV_COMMISSIONER_ID

MEhcop Commissioner ID TLV

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

meshcop Commissioner UDP יציאה TLV

OT_MESHCOP_TLV_COMM_SESSION_ID

מזהה TLV הסשן של Commissioner

OT_MESHCOP_TLV_COUNT

מספר meshcop TLV

OT_MESHCOP_TLV_DELAYTIMER

עיכוב טיימר ממסר

OT_MESHCOP_TLV_DISCOVERYREQUEST

בקשת גילוי של Mehcop TLV

OT_MESHCOP_TLV_DISCOVERYRESPONSE

TLV תגובה של meshcop

OT_MESHCOP_TLV_ENERGY_LIST

רשימת ספקי האנרגיה של Mehcop

OT_MESHCOP_TLV_EXTPANID

meshcop Extended Pan ID TLV

OT_MESHCOP_TLV_GET

לקבלת TLV

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

כתובת TLV ב-meshcop IPv6

OT_MESHCOP_TLV_JOINERADVERTISEMENT

מודעת Meshop joiner TLV

OT_MESHCOP_TLV_JOINER_DTLS

כלי יש גישה ל-DTLS למארז

OT_MESHCOP_TLV_JOINER_IID

MEhcop joiner IID TLV

OT_MESHCOP_TLV_JOINER_RLOC

meshcop joiner Router Locator TLV

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

meshcop joiner Router KEK TLV

OT_MESHCOP_TLV_JOINER_UDP_PORT

meshcop joiner UDP יציאה TLV

OT_MESHCOP_TLV_MESHLOCALPREFIX

קידומת עסק מסוג Mehcop Mesh

OT_MESHCOP_TLV_NETWORKKEY

מפתח רשת TLV

OT_MESHCOP_TLV_NETWORKNAME

שם הרשת של Mehcop

OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE

TLV

OT_MESHCOP_TLV_PANID

מזהה הזזת אפליקציה של Mehcop TLV

OT_MESHCOP_TLV_PENDINGTIMESTAMP

meshcop בהמתנה חותמת זמן TLV

OT_MESHCOP_TLV_PERIOD

תקופת מסלפי TLV

OT_MESHCOP_TLV_PROVISIONING_URL

כתובת URL של TLV לניהול תצורה של Mehcop

OT_MESHCOP_TLV_PSKC

meshcop PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

משך סריקה של Mehcop TLV

OT_MESHCOP_TLV_SECURITYPOLICY

מדיניות האבטחה של Mehcop TLV

OT_MESHCOP_TLV_STATE

Mehch State TLV

OT_MESHCOP_TLV_STEERING_DATA

Mehcop Steering Data TLV

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

MEhcop UDP encapsulation TLV

OT_MESHCOP_TLV_VENDOR_DATA_TLV

ספק נתוני Mehcop TLV

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

מודל של ספק Mehcop של TLV

OT_MESHCOP_TLV_VENDOR_NAME_TLV

ספק meshcop של ספק TLV

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

ספק meshcop ספק המקבץ TLV

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

ספק meshcop SW גרסת TLV

סוג Dedef

otChannelMask

uint32_t otChannelMask

סוג זה מייצג את מסכת הערוץ.

otDatasetMgmtSetCallback

void(* otDatasetMgmtSetCallback)(otError aResult, void *aContext)

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

פרטים
פרמטרים
[in] aResult
התוצאה של הפעולה.
[in] aContext
מצביע על הקשר ספציפי לאפליקציה.
ערכי החזרה
OT_ERROR_NONE
הבקשה אושרה על ידי המנהיג.
OT_ERROR_REJECTED
הבקשה נדחתה על ידי המנהיג.
OT_ERROR_PARSE
אירעה שגיאה במהלך ניתוח התגובה.
OT_ERROR_ABORT
הבקשה אופסה על ידי אפליקציות דומות.
OT_ERROR_RESPONSE_TIMEOUT
לא התקבלה תגובה או אישור במהלך תקופת הזמן הקצוב לתפוגה.

otDatasetUpdaterCallback

void(* otDatasetUpdaterCallback)(otError aError, void *aContext)

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

פרטים
פרמטרים
[in] aError
סטטוס השגיאה. OT_ERROR_NONE מציין עדכון מוצלח של מערך הנתונים. OT_ERROR_INVALID_STATE מציין כשל במצב לא חוקי (MLE מושבת). OT_ERROR_ALREADY מציין כשל עקב מכשיר אחר ברשת המבקש עדכון מתנגש של מערך נתונים.
[in] aContext
מצביע אל ההקשר השרירותי (מסופק על ידי משתמש ב-otDatasetUpdaterRequestUpdate()).

otExtendedPanId

struct otExtendedPanId otExtendedPanId

מבנה זה מייצג מזהה PAN מורחב.

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

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

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

ספירה זו מייצגת את סוגי meshcop TLV.

OTNetworkKey

struct otNetworkKey otNetworkKey

מבנה זה מייצג מפתח לרשת Thread.

otNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

סוג הנתונים הזה מייצג את KeyRef אל NetworkKey.

הפניה למפתח

otNetworkName

struct otNetworkName otNetworkName

מבנה זה מייצג שם של רשת.

ה-otNetworkName הוא מחרוזת C ריקה (כלומר מערך m8 תו חובה חייב להסתיים בתו ריק תו \0).

otOperationalDataset

struct otOperationalDataset otOperationalDataset

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

הרכיבים במערך הנתונים הם אופציונליים. מבנה mComponets מציין את הרכיבים שנמצאים במערך הנתונים.

otOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

מבנה זה מייצג נוכחות של רכיבים שונים במערך נתונים פעיל או בהמתנה.

otOperationalDatasetTlv

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

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

מערך הנתונים התפעולי מקודד כ-TLV כפי שצוין בשרשור.

OTPC

struct otPskc otPskc

מבנה זה מייצג PSKc.

OTPskcRef

otCryptoKeyRef otPskcRef

סוג הנתונים הזה מייצג את KeyRef ל-PSKc.

הפניה למפתח

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

struct otSecurityPolicy otSecurityPolicy

המבנה הזה מייצג את מדיניות האבטחה.

חותמת זמן

struct otTimestamp otTimestamp

המבנה הזה מייצג רכיב של חותמת זמן של Thread Dataset.

משתנים

OT_tools_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

פונקציות

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

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

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

otDatasetGeneratePskc

otError otDatasetGeneratePskc(
  const char *aPassPhrase,
  const otNetworkName *aNetworkName,
  const otExtendedPanId *aExtPanId,
  otPskc *aPskc
)

הפונקציה הזו יוצרת PSKc מתוך ביטוי נתון, שם רשת ומזהה PAN מורחב.

PSKc משמש ליצירת הסשן של הנציבות.

פרטים
פרמטרים
[in] aPassPhrase
ביטוי הסיסמה שמזמין.
[in] aNetworkName
שם הרשת עבור חישוב PSKc.
[in] aExtPanId
מזהה ה-PAN המורחב עבור חישוב PSKc.
[out] aPskc
מצביע על משתנה לפלט ה-PSKc שנוצר.
ערכי החזרה
OT_ERROR_NONE
'ה-PSKc' נוצר בהצלחה.
OT_ERROR_INVALID_ARGS
אם ארגומנט הקלט אינו חוקי.

otDatasetGetActive

otError otDatasetGetActive(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[out] aDataset
מציין את המיקום של מערך הנתונים התפעולי הפעיל.
ערכי החזרה
OT_ERROR_NONE
מערך הנתונים התפעולי הפעיל אוחזר בהצלחה.
OT_ERROR_NOT_FOUND
לא נמצא ערך תואם בחנות ההגדרות.

otDatasetGetActiveTlvs

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[out] aDataset
מציין את המיקום של מערך הנתונים התפעולי הפעיל.
ערכי החזרה
OT_ERROR_NONE
מערך הנתונים התפעולי הפעיל אוחזר בהצלחה.
OT_ERROR_NOT_FOUND
לא נמצא ערך תואם בחנות ההגדרות.

otDatasetGetDelayטיימרMinimal

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

קבלת טיימר לעיכוב מינימלי.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
ערכי החזרה
the
הערך של טיימר לעיכוב מינימלי (באלפיות השנייה).

otDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[out] aDataset
מצביע למיקום של קבוצת נתונים תפעולית בהמתנה.
ערכי החזרה
OT_ERROR_NONE
מערך הנתונים התפעולי הבהמתנה בוצע בהצלחה.
OT_ERROR_NOT_FOUND
לא נמצא ערך תואם בחנות ההגדרות.

otDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[out] aDataset
מצביע למיקום של קבוצת נתונים תפעולית בהמתנה.
ערכי החזרה
OT_ERROR_NONE
מערך הנתונים התפעולי הבהמתנה בוצע בהצלחה.
OT_ERROR_NOT_FOUND
לא נמצא ערך תואם בחנות ההגדרות.

otDatasetIsCommissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
TRUE אם קיימת רשת חוקית במערך הנתונים התפעולי הפעיל, FALSE אם לא.

otDatasetParseTlvs

otError otDatasetParseTlvs(
  const otOperationalDatasetTlvs *aDatasetTlvs,
  otOperationalDataset *aDataset
)

פונקציה זו מנתחת מערך נתונים תפעולי מ-otOperationalDatasetTlvs.

פרטים
פרמטרים
[in] aDatasetTlvs
מצביע אל TLV של מערך נתונים.
[out] aDataset
מציין את המיקום של מערך הנתונים.
ערכי החזרה
OT_ERROR_NONE
המדיניות aDataset הוגדרה בהצלחה מהאפליקציה aDatasetTlvs.
OT_ERROR_INVALID_ARGS
aDatasetTlvs אינו חוקי.

otDatasetSendMgmtActiveGet

otError otDatasetSendMgmtActiveGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

פונקציה זו שולחת את MGMT_ACTIVE_GET.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aDatasetComponents
מצביע על מבנה של רכיבי מערך נתונים המציין את הרכיבים שיש לבקש.
[in] aTlvTypes
מצביע למערך המכיל סוגי TLV גולמיים נוספים שיש לבקש.
[in] aLength
האורך של aTlvTypes.
[in] aAddress
מצביע אל יעד IPv6, אם הוא NULL, ישתמש ב-Lead ALOC כברירת מחדל.
ערכי החזרה
OT_ERROR_NONE
פקודת meshcop נשלחה בהצלחה.
OT_ERROR_NO_BUFS
אין מספיק שטח אחסון במאגר הנתונים לשליחה.

otDatasetSendMgmtActiveSet

otError otDatasetSendMgmtActiveSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

פונקציה זו שולחת את MGMT_ACTIVE_SET.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aDataset
מצביע על מערך נתונים תפעולי.
[in] aTlvs
מצביע אל TLV.
[in] aLength
האורך של ערכי ברירת המחדל.
[in] aCallback
מצביע על פונקציה שנקראת קליטה של תגובה או זמן קצוב לתפוגה.
[in] aContext
מצביע על הקשר ספציפי לאפליקציה של aCallback.
ערכי החזרה
OT_ERROR_NONE
פקודת meshcop נשלחה בהצלחה.
OT_ERROR_NO_BUFS
אין מספיק שטח אחסון במאגר הנתונים לשליחה.
OT_ERROR_BUSY
בקשה קודמת מתבצעת.

otDatasetSendMgmtPendingGet

otError otDatasetSendMgmtPendingGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

פונקציה זו שולחת את MGMT_PENDING_GET.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aDatasetComponents
מצביע על מבנה של רכיבי מערך נתונים המציין את הרכיבים שיש לבקש.
[in] aTlvTypes
מצביע למערך המכיל סוגי TLV גולמיים נוספים שיש לבקש.
[in] aLength
האורך של aTlvTypes.
[in] aAddress
מצביע אל יעד IPv6, אם הוא NULL, ישתמש ב-Lead ALOC כברירת מחדל.
ערכי החזרה
OT_ERROR_NONE
פקודת meshcop נשלחה בהצלחה.
OT_ERROR_NO_BUFS
אין מספיק שטח אחסון במאגר הנתונים לשליחה.

otDatasetSendMgmtPendingSet

otError otDatasetSendMgmtPendingSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

פונקציה זו שולחת MGMT_PENDING_SET.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aDataset
מצביע על מערך נתונים תפעולי.
[in] aTlvs
מצביע אל TLV.
[in] aLength
האורך של ערכי ברירת המחדל.
[in] aCallback
מצביע על פונקציה שנקראת קליטה של תגובה או זמן קצוב לתפוגה.
[in] aContext
מצביע על הקשר ספציפי לאפליקציה של aCallback.
ערכי החזרה
OT_ERROR_NONE
פקודת meshcop נשלחה בהצלחה.
OT_ERROR_NO_BUFS
אין מספיק שטח אחסון במאגר הנתונים לשליחה.
OT_ERROR_BUSY
בקשה קודמת מתבצעת.

otDatasetSetActive

otError otDatasetSetActive(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

פונקציה זו מגדירה את מערך הנתונים התפעולי הפעיל.

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

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

אם הערוץ לא נכלל במערך הנתונים, המכשיר ישלח הודעות MLE הכרזה על ערוצים שונים כדי לאתר שכנים בערוצים אחרים.

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aDataset
מצביע על מערך הנתונים התפעולי הפעיל.
ערכי החזרה
OT_ERROR_NONE
מערך הנתונים התפעולי הפעיל הוגדר בהצלחה.
OT_ERROR_NO_BUFS
אין מספיק מקום במאגר נתונים זמני כדי להגדיר את מערך הנתונים התפעולי הפעיל.
OT_ERROR_NOT_IMPLEMENTED
הפלטפורמה לא מיישמת פונקציונליות של הגדרות.

otDatasetSetActiveTlvs

otError otDatasetSetActiveTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

פונקציה זו מגדירה את מערך הנתונים התפעולי הפעיל.

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

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

אם הערוץ לא נכלל במערך הנתונים, המכשיר ישלח הודעות MLE הכרזה על ערוצים שונים כדי לאתר שכנים בערוצים אחרים.

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aDataset
מצביע על מערך הנתונים התפעולי הפעיל.
ערכי החזרה
OT_ERROR_NONE
מערך הנתונים התפעולי הפעיל הוגדר בהצלחה.
OT_ERROR_NO_BUFS
אין מספיק מקום במאגר נתונים זמני כדי להגדיר את מערך הנתונים התפעולי הפעיל.
OT_ERROR_NOT_IMPLEMENTED
הפלטפורמה לא מיישמת פונקציונליות של הגדרות.

otDatasetSetDelayTimeoutMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

הגדרת טיימר לעיכוב מינימלי.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aDelayTimerMinimal
הערך של טיימר לעיכוב מינימלי (באלפיות השנייה).
ערכי החזרה
OT_ERROR_NONE
הטיימר הוגדר בהצלחה להשהיית הזמן הנכונה.
OT_ERROR_INVALID_ARGS
אם הערך aDelayTimerMinimal אינו חוקי.

otDatasetSetPending

otError otDatasetSetPending(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aDataset
מצביע על מערך הנתונים התפעולי בהמתנה.
ערכי החזרה
OT_ERROR_NONE
הגדרת בהצלחה את מערך הנתונים התפעולי הממתין.
OT_ERROR_NO_BUFS
אין מספיק מקום במאגר נתונים זמני כדי להגדיר את מערך הנתונים התפעולי הבהמתנה.
OT_ERROR_NOT_IMPLEMENTED
הפלטפורמה לא מיישמת פונקציונליות של הגדרות.

otDatasetSetPendingTlvs

otError otDatasetSetPendingTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aDataset
מצביע על מערך הנתונים התפעולי בהמתנה.
ערכי החזרה
OT_ERROR_NONE
הגדרת בהצלחה את מערך הנתונים התפעולי הממתין.
OT_ERROR_NO_BUFS
אין מספיק מקום במאגר נתונים זמני כדי להגדיר את מערך הנתונים התפעולי הבהמתנה.
OT_ERROR_NOT_IMPLEMENTED
הפלטפורמה לא מיישמת פונקציונליות של הגדרות.

otDatasetUpdaterCancelUpdate

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

פונקציה זו מבטלת את הבקשה לעדכון תפעולי של מערך הנתונים (אם יש).

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

otDatasetUpdaterIsUpdateOnחיבור

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

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

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

otDatasetUpdaterRequestUpdate

otError otDatasetUpdaterRequestUpdate(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  otDatasetUpdaterCallback aCallback,
  void *aContext
)

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

השדה aDataset צריך להכיל את השדות שיש לעדכן ואת הערך החדש שלהם. הוא לא יכול לכלול שדות פעילים או חותמת זמן בהמתנה. השדה 'השהיה' הוא אופציונלי אם לא צוין ערך ברירת מחדל (1, 000 אלפיות שנייה).

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aDataset
מצביע על מערך הנתונים שכולל את השדות לשינוי.
[in] aCallback
קריאה חוזרת (callback) כדי לציין מתי בקשת העדכון של מערך הנתונים מסתיימת.
[in] aContext
הקשר שרירותי הועבר לקריאה חוזרת (callback).
ערכי החזרה
OT_ERROR_NONE
עדכון מערך הנתונים התחיל בהצלחה (aCallback יופעל בסיום התהליך).
OT_ERROR_INVALID_STATE
המכשיר מושבת (MLE מושבת).
OT_ERROR_INVALID_ARGS
המאפיין aDataset אינו חוקי (מכיל חותמת זמן פעילה או בהמתנה).
OT_ERROR_BUSY
לא ניתן להתחיל את העדכון. עדכון קודם מתבצע.
OT_ERROR_NO_BUFS
לא ניתן להקצות מאגר נתונים זמני כדי לשמור את מערך הנתונים.

otNetworkNameFromString

otError otNetworkNameFromString(
  otNetworkName *aNetworkName,
  const char *aNameString
)

פונקציה זו מגדירה מופע של otNetworkName ממחרוזת C ריקה מסוג null.

הפונקציה הזו גם מוודאת שה-aNameString הנתון כפוף לקידוד UTF-8 ושהאורך שלו לא עולה על OT_NETWORK_NAME_MAX_SIZE.

פרטים
פרמטרים
[out] aNetworkName
מצביע אל otNetworkName כדי להגדיר.
[in] aNameString
מחרוזת C בשם.
ערכי החזרה
OT_ERROR_NONE
המדיניות aNetworkName הוגדרה בהצלחה מהאפליקציה aNameString.
OT_ERROR_INVALID_ARGS
הערך aNameStrng אינו חוקי (ארוך מדי או שאינו תואם לקידוד UTF-8).

פקודות מאקרו

OT_CHANNEL_10_MASK

 OT_CHANNEL_10_MASK (1 << 10)

ערוץ 10.

OT_CHANNEL_11_MASK

 OT_CHANNEL_11_MASK (1 << 11)

ערוץ 11.

OT_CHANNEL_12_MASK

 OT_CHANNEL_12_MASK (1 << 12)

ערוץ 12.

OT_CHANNEL_13_MASK

 OT_CHANNEL_13_MASK (1 << 13)

ערוץ 13.

OT_CHANNEL_14_MASK

 OT_CHANNEL_14_MASK (1 << 14)

ערוץ 14.

OT_CHANNEL_15_MASK

 OT_CHANNEL_15_MASK (1 << 15)

ערוץ 15.

OT_CHANNEL_16_MASK

 OT_CHANNEL_16_MASK (1 << 16)

ערוץ 16.

OT_CHANNEL_17_MASK

 OT_CHANNEL_17_MASK (1 << 17)

ערוץ 17.

OT_CHANNEL_18_MASK

 OT_CHANNEL_18_MASK (1 << 18)

ערוץ 18.

OT_CHANNEL_19_MASK

 OT_CHANNEL_19_MASK (1 << 19)

ערוץ 19.

OT_CHANNEL_1_MASK

 OT_CHANNEL_1_MASK (1 << 1)

ערוץ 1.

OT_CHANNEL_20_MASK

 OT_CHANNEL_20_MASK (1 << 20)

ערוץ 20.

OT_CHANNEL_21_MASK

 OT_CHANNEL_21_MASK (1 << 21)

ערוץ 21.

OT_CHANNEL_22_MASK

 OT_CHANNEL_22_MASK (1 << 22)

ערוץ 22.

OT_CHANNEL_23_MASK

 OT_CHANNEL_23_MASK (1 << 23)

ערוץ 23.

OT_CHANNEL_24_MASK

 OT_CHANNEL_24_MASK (1 << 24)

ערוץ 24.

OT_CHANNEL_25_MASK

 OT_CHANNEL_25_MASK (1 << 25)

ערוץ 25.

OT_CHANNEL_26_MASK

 OT_CHANNEL_26_MASK (1 << 26)

ערוץ 26.

OT_CHANNEL_2_MASK

 OT_CHANNEL_2_MASK (1 << 2)

ערוץ 2.

OT_CHANNEL_3_MASK

 OT_CHANNEL_3_MASK (1 << 3)

ערוץ 3.

OT_CHANNEL_4_MASK

 OT_CHANNEL_4_MASK (1 << 4)

ערוץ 4.

OT_CHANNEL_5_MASK

 OT_CHANNEL_5_MASK (1 << 5)

ערוץ 5.

OT_CHANNEL_6_MASK

 OT_CHANNEL_6_MASK (1 << 6)

ערוץ 6.

OT_CHANNEL_7_MASK

 OT_CHANNEL_7_MASK (1 << 7)

ערוץ 7.

OT_CHANNEL_8_MASK

 OT_CHANNEL_8_MASK (1 << 8)

ערוץ 8.

OT_CHANNEL_9_MASK

 OT_CHANNEL_9_MASK (1 << 9)

ערוץ 9.

OT_EXT_PAN_ID_SIZE

 OT_EXT_PAN_ID_SIZE 8

גודל מזהה PAN של שרשור (בייטים)

OT_MESH_NETWORK_MESSAGES_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

גודל הקידומת המקומית ברשת (בייטים)

OT_NETWORK_KEY_SIZE

 OT_NETWORK_KEY_SIZE 16

גודל מפתח החוט לרשת (בייטים)

OT_NETWORK_NAME_MAX_SIZE

 OT_NETWORK_NAME_MAX_SIZE 16

הגודל המקסימלי של השדה 'שם רשת שרשור' (בייטים)

OT_OPERATIONAL_DATASET_MAX_LENGTH

 OT_OPERATIONAL_DATASET_MAX_LENGTH 254

האורך המקסימלי של מערך הנתונים התפעולי בבייטים.

OT_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

הגודל המקסימלי של PSKc (בייטים)

משאבים

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