כללי

המודול הזה כולל פונקציות לכל התפקידים.

סיכום

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

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

מספור

anonymous enum{
  OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS = 0,
  OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS = 1,
  OT_NETWORK_DIAGNOSTIC_TLV_MODE = 2,
  OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT = 3,
  OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY = 4,
  OT_NETWORK_DIAGNOSTIC_TLV_ROUTE = 5,
  OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA = 6,
  OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA = 7,
  OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST = 8,
  OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS = 9,
  OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL = 14,
  OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE = 15,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE = 16,
  OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES = 17,
  OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST = 18,
  OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT = 19
}
טיפוסים בני מנייה (enum)
otDeviceRole{
  OT_DEVICE_ROLE_DISABLED = 0,
  OT_DEVICE_ROLE_DETACHED = 1,
  OT_DEVICE_ROLE_CHILD = 2,
  OT_DEVICE_ROLE_ROUTER = 3,
  OT_DEVICE_ROLE_LEADER = 4
}
טיפוסים בני מנייה (enum)
מייצג תפקיד של שרשור.
otNetDataPublisherEvent{
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
}
טיפוסים בני מנייה (enum)
הספירה הזו מייצגת את האירועים שדווחו על ידי קריאות חוזרות (callbacks) לבעלי תוכן דיגיטלי.
otRoutePreference{
  OT_ROUTE_PREFERENCE_LOW = -1,
  OT_ROUTE_PREFERENCE_MED = 0,
  OT_ROUTE_PREFERENCE_HIGH = 1
}
טיפוסים בני מנייה (enum)
הגדרת ערכים חוקיים עבור mPreference ב-otExternalRouteConfig וב-otBorderRouterConfig.

סוג Dedef

otBorderRouterConfig Typedef
המבנה הזה מייצג הגדרה של נתב גבולות.
otDetachGracefullyCallback)(void *aContext) Typedef
void(*
הקריאה החוזרת הזו מודיעה לאפליקציה שתהליך הניתוק הסתיים.
otExternalRouteConfig Typedef
מבנה זה מייצג הגדרה של מסלול חיצוני.
otIpCounters Typedef
struct otIpCounters
מבנה זה מייצג את המונים ברמת כתובת ה-IP.
otLeaderData Typedef
struct otLeaderData
מבנה זה מייצג את נתוני ה-Lead Thread.
otLinkModeConfig Typedef
המבנה הזה מייצג הגדרה של מצב קישור MLE.
otMleCounters Typedef
struct otMleCounters
מבנה זה מייצג את דלפקי השרשורים של MLE.
otNeighborInfoIterator Typedef
int16_t
משמש איטרציה דרך טבלת השכנים.
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext) Typedef
void(*
הסוג הזה של מצביע הפונקציה מגדיר את הקריאה החוזרת (callback) שתודיע כאשר ערך רשומה של DNS או SRP&&, יתווספו לנתוני הרשת של Thread או יוסר מהם.
otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) Typedef
void(*
הסוג הזה של מצביע הפונקציה מגדיר את הקריאה החוזרת המשמשת לשליחת התראה כשמתבצעת הוספה או הזנה של ערך קידומת (של רשת או נתיב חיצוני) מנתוני רשת השרשורים.
otNetDataPublisherEvent Typedef
הספירה הזו מייצגת את האירועים שדווחו על ידי קריאות חוזרות (callbacks) לבעלי תוכן דיגיטלי.
otNetworkDataIterator Typedef
uint32_t
משמש לאיטרציה באמצעות פרטי נתוני רשת.
otNetworkDiagChildEntry Typedef
המבנה הזה מייצג כניסה לטבלת אבחון רשת לילדים.
otNetworkDiagConnectivity Typedef
מבנה זה מייצג ערך של קישוריות לאבחון רשת.
otNetworkDiagIterator Typedef
uint16_t
משמש לביצוע איטרציה באמצעות אבחון רשת TLV.
otNetworkDiagMacCounters Typedef
מבנה זה מייצג ערך של מונה Mac של אבחון רשת.
otNetworkDiagRoute Typedef
המבנה הזה מייצג ערך של נתיב אבחון רשת.
otNetworkDiagRouteData Typedef
מבנה זה מייצג נתונים של נתיב אבחון הרשת.
otNetworkDiagTlv Typedef
המבנה הזה מייצג TLV לאבחון רשת.
otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) Typedef
void(*
מצביע הפונקציה הזה נקרא כאשר מתקבלת תגובה לקבלת אבחון רשת.
otRoutePreference Typedef
הגדרת ערכים חוקיים עבור mPreference ב-otExternalRouteConfig וב-otBorderRouterConfig.
otServerConfig Typedef
מבנה זה מייצג תצורת שרת.
otServiceConfig Typedef
מבנה זה מייצג תצורת שירות.
otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) Typedef
void(*
הסוג הזה של מצביע הפונקציה מגדיר את הקריאה החוזרת (callback) כדי להודיע על התוצאה של בקשת otThreadLocateAnycastDestination().
otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) Typedef
void(*
הסמן הזה של הפונקציה נקרא בכל פעם שמתקבלת בקשת MDiscovery Discovery.
otThreadDiscoveryRequestInfo Typedef
מבנה זה מייצג את הנתונים של בקשת השרשור.
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext) Typedef
void(*
מתבצעת קריאה להצבעה על הפונקציה הזו בכל פעם שמתקבלת הודעת MLE להורים.
otThreadParentResponseInfo Typedef
מבנה זה מייצג את הנתונים של 'תגובת MLE להורים'.

פונקציות

otNetDataContainsOmrPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
פונקציה זו בודקת אם קידומת נתונה יכולה לשמש כקידומת OMR חוקית וגם את נתוני הרשת של Leader' .
otNetDataGet(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
השיטה הזו מספקת עותק מלא או יציב של נתוני רשת השרשורים.
otNetDataGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
פונקציה זו מקבלת את הקידומת הבאה של 'רשת' בנתוני הרשת של המחיצה.
otNetDataGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
פונקציה זו מקבלת את המסלול החיצוני הבא בנתוני הרשת של המחיצה.
otNetDataGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
פונקציה זו מקבלת את השירות הבא בנתוני הרשת של המחיצה.
otNetDataGetStableVersion(otInstance *aInstance)
uint8_t
הורדת הגרסה היציבה של נתוני הרשת.
otNetDataGetVersion(otInstance *aInstance)
uint8_t
מורידים את גרסת נתוני הרשת.
otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)
bool
פונקציה זו מציינת אם הערך "DNS/SRP&&; כרגע נוסף לנתוני רשת השרשורים.
otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
פונקציה זו מציינת אם רשומה נוכחית של קידומת (ברשת או במסלול חיצוני) מתווספת לנתוני הרשת בשרשור.
otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)
void
פונקציה זו מבקשת "DNS/SRP Service Anycast Address" כדי לפרסם אותה בנתוני רשת השרשורים.
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
פונקציה זו מבקשת "DNS/SRP Service Unicast Address" כדי לפרסם אותה בנתוני רשת השרשורים.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
void
פונקציה זו מבקשת "DNS/SRP Service Unicast Address" כדי לפרסם אותה בנתוני רשת השרשורים.
otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
הפונקציה מבקשת בקשה לפרסם קידומת של מסלול חיצוני בנתוני הרשת של השרשורים.
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
פונקציה זו מבקשת להציב קידומת ברשת על מנת לפרסם אותה בנתוני הרשת Thread.
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
פונקציה זו מגדירה קריאה חוזרת (callback) כדי לקבל התראה כששירות "DNS/SRP Service , והוספה בפועל לנתונים ברשת השרשורים או הסרתם מהם.
otNetDataSetPrefixPublisherCallback(otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
פונקציה זו מגדירה קריאה חוזרת כדי להודיע כאשר מתווספת ערך קידומת שפורסם בפועל אל נתוני הרשת של Thread או מסירים אותו.
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
בודקים אם נתוני ההיגוי כוללים מחבר.
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
בודקים אם נתוני ההיגוי כוללים גורם חיבור עם ערך נתון של JSON.
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
void
פונקציה זו מבטלת את הפרסום של כל שירות "DNS/SRP (Anycast או Unicast) שכבר נוסף, מתוך נתוני רשת השרשורים.
otNetDataUnpublishPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
הפונקציה הזו מבטלת את הפרסום של קידומת שפורסמה בעבר (ברשת או במסלול חיצוני).
otThreadBecomeChild(otInstance *aInstance)
מנסים לצרף מחדש ילדים.
otThreadBecomeDetached(otInstance *aInstance)
התנתקות מרשת השרשורים.
otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
הפונקציה הזו מיידעת צמתים אחרים ברשת (אם יש) ואז מפסיקה את פעילות פרוטוקול השרשור.
otThreadDeviceRoleToString(otDeviceRole aRole)
const char *
המרה של תפקיד המכשיר למחרוזת שאנשים יכולים לקרוא.
otThreadDiscover(otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
פונקציה זו מתחילה סריקה של Thread Discovery.
otThreadGetChildTimeout(otInstance *aInstance)
uint32_t
כדאי להגדיר את הזמן הקצוב לתפוגה של השימוש ב-Thread לילדים במהלך השימוש בתפקיד 'ילד'.
otThreadGetDeviceRole(otInstance *aInstance)
מקבלים את תפקיד המכשיר.
otThreadGetDomainName(otInstance *aInstance)
const char *
קבלת שם הדומיין של השרשור.
otThreadGetExtendedPanId(otInstance *aInstance)
const otExtendedPanId *
מקבלים את מזהה ה-PAN המורחב של IEEE 802.15.4.
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
יש לציין את מזהה הממשק באופן ידני עבור כתובת Unicast של דומיין השרשור.
otThreadGetIp6Counters(otInstance *aInstance)
const otIpCounters *
קבלת מוני ה-IPv6.
otThreadGetKeySequenceCounter(otInstance *aInstance)
uint32_t
קבלת ה-thrKeyVariableCounter.
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
uint32_t
כדאי להוריד את thrKeySwitchguardTime.
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
פונקציה זו מקבלת את הנתונים של מובילי השרשור.
otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc)
פונקציה זו מחזירה מצביע ל-RLOC של המנהיג.
otThreadGetLeaderRouterId(otInstance *aInstance)
uint8_t
עליך לקבל את מזהה הנתב של הספק.
otThreadGetLeaderWeight(otInstance *aInstance)
uint8_t
משקל המנהיג.
otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
פונקציה זו מחזירה את כתובת ה-ריבוי שרשורים של Thread Link-Local All Threads.
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
const otIp6Address *
הפונקציה הזו מחזירה את כתובת ה-IPv6 של הקישור המקומי לשרשור.
otThreadGetLinkMode(otInstance *aInstance)
הגדרה של מצב קישור MLE.
otThreadGetMeshLocalEid(otInstance *aInstance)
const otIp6Address *
פונקציה זו מחזירה את הסמן לכתובת Esh Local EID.
otThreadGetMeshLocalPrefix(otInstance *aInstance)
פונקציה זו מחזירה מצביע אל קידומת הרשת המקומית.
otThreadGetMleCounters(otInstance *aInstance)
const otMleCounters *
חיפוש בדלפקי Thread MLE.
otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey)
void
לקבלת מפתח הרשת של Thread.
otThreadGetNetworkKeyRef(otInstance *aInstance)
לקבלת otNetworkKeyRef עבור מפתח רשת Thread.
otThreadGetNetworkName(otInstance *aInstance)
const char *
לקבלת שם הרשת של השרשור.
otThreadGetNextDiagnosticTlv(const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
פונקציה זו מקבלת את ה-TLV הבא לאבחון רשת בהודעה.
otThreadGetNextNeighborInfo(otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
הפונקציה הזו מקבלת את פרטי השכן הבא.
otThreadGetParentAverageRssi(otInstance *aInstance, int8_t *aParentRssi)
הפונקציה מאחזרת את פורמט ה-RSSI הממוצע עבור הורה השרשור.
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
הפונקציה מאחזרת נתוני אבחון של נתב שרשור כהורה.
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
הפונקציה מאחזרת את ה-RSSI של החבילה האחרונה מההורה של השרשור.
otThreadGetPartitionId(otInstance *aInstance)
uint32_t
מוצאים את מזהה החלוקה.
otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
פונקציה זו מחזירה את כתובת ה-ריבוי שרשורים של Thread Realm-Local All Threads.
otThreadGetRloc(otInstance *aInstance)
const otIp6Address *
פונקציה זו מחזירה את הסמן לכתובת של נתב הניתוב (RLOC).
otThreadGetRloc16(otInstance *aInstance)
uint16_t
משחקי RLOC16.
otThreadGetServiceAloc(otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
פונקציה זו מאחזרת את ה-ALOC של שירות עבור מזהה השירות הנתון.
otThreadGetVersion(void)
uint16_t
פונקציה זו מקבלת את גרסת הפרוטוקול Thread.
otThreadIsAnycastLocateInProgress(otInstance *aInstance)
bool
פונקציה זו מציינת אם בקשת ברגעים אלה נמצאת בתהליך חיפוש.
otThreadIsDiscoverInProgress(otInstance *aInstance)
bool
הפונקציה הזו קובעת אם מתבצעת כרגע גילוי שרשור MLE.
otThreadIsSingleton(otInstance *aInstance)
bool
פונקציה זו מציינת אם הצומת הוא הנתב היחיד ברשת.
otThreadLocateAnycastDestination(otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
פונקציה זו מבקשת את איתור היעד הקרוב ביותר לכתובת נתונה של Anycast.
otThreadRegisterParentResponseCallback(otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
פונקציה זו רושמת קריאה חוזרת (callback) כדי לקבל נתוני תגובת הורה (MLE).
otThreadResetIp6Counters(otInstance *aInstance)
void
מאפסים את מוני ה-IPv6.
otThreadResetMleCounters(otInstance *aInstance)
void
איפוס המונים של Thread MLE.
otThreadSendAddressNotification(otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
פונקציה זו שולחת הודעה פרואקטיבית של כתובת (eCPC_NTF.ntf).
otThreadSendDiagnosticGet(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
שליחת בקשה לקבלת אבחון רשת.
otThreadSendDiagnosticReset(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
שליחת בקשה לאיפוס של אבחון רשת.
otThreadSendProactiveBackboneNotification(otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
פונקציה זו שולחת הודעה פרואקטיבית של כריכה רכה (PRO_BB.ntf) בקישור 'הקודם'.
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
void
מגדירים את הזמן הקצוב לתפוגה של ילדים בשרשור שבו משתמשים בתפקיד 'ילד'.
otThreadSetDiscoveryRequestCallback(otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
פונקציה זו מגדירה קריאה חוזרת (callback) כדי לקבל נתוני בקשת גילוי של MLE.
otThreadSetDomainName(otInstance *aInstance, const char *aDomainName)
הגדרת שם הדומיין של השרשור.
otThreadSetEnabled(otInstance *aInstance, bool aEnabled)
פונקציה זו מתחילה את פעולת הפרוטוקול Thread.
otThreadSetExtendedPanId(otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
מגדירים את מזהה ה-PAN המורחב של IEEE 802.15.4.
otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
יש להגדיר/לנקות את מזהה הממשק שצוין באופן ידני עבור כתובת ה-Unicast של הדומיין בשרשור.
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
השיטה הזו מגדירה את הפרסום של מחבר השרשור כשמגלים את רשת השרשור.
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
void
מגדירים את ה-thrKeyקמפייןCounter.
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
מגדירים את thrKeySwitchguardTime.
otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)
מגדירים את מצב 'קישור' (MLE).
otThreadSetMeshLocalPrefix(otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
פונקציה זו מגדירה את הקידומת המקומית של Mesh.
otThreadSetNetworkKey(otInstance *aInstance, const otNetworkKey *aKey)
מגדירים את מפתח הרשת של השרשור.
otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)
יש להגדיר את מפתח הרשת של השרשור כ-otNetworkKeyRef.
otThreadSetNetworkName(otInstance *aInstance, const char *aNetworkName)
מגדירים את שם הרשת של השרשור.

מבנים

otBorderRouterConfig

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

otExternalRouteConfig

מבנה זה מייצג הגדרה של מסלול חיצוני.

otIpCounters

מבנה זה מייצג את המונים ברמת כתובת ה-IP.

otLeaderData

מבנה זה מייצג את נתוני ה-Lead Thread.

otLinkModeConfig

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

otMleCounters

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

otNeighborInfo

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

otNetworkDiagChildEntry

המבנה הזה מייצג כניסה לטבלת אבחון רשת לילדים.

otNetworkDiagConnectivity

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

otNetworkDiagMacCounters

מבנה זה מייצג ערך של מונה Mac של אבחון רשת.

otNetworkDiagRoute

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

otNetworkDiagRouteData

מבנה זה מייצג נתונים של נתיב אבחון הרשת.

otNetworkDiagTlv

המבנה הזה מייצג TLV לאבחון רשת.

otRouterInfo

מבנה זה מכיל פרטי אבחון של נתב שרשור.

otServerConfig

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

otServiceConfig

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

otThreadDiscoveryRequestInfo

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

otThreadParentResponseInfo

מבנה זה מייצג את הנתונים של 'תגובת MLE להורים'.

מספור

Enum אנונימי

 anonymous enum
מאפיינים
OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

רמת הטעינה של הסוללה.

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

מספר TLV בדפי ערוצים.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

TLV טבלת ילדים.

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

קישוריות TLV.

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

כתובת MAC מורחבת של MACV.

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

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

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

Leader Data TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

MAC Counts TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

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

OT_NETWORK_DIAGNOSTIC_TLV_MODE

מצב TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

נתוני רשת TLV.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

Route64 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

כתובת16 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

אספקת מתח TLV.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

הזמן הקצוב לתפוגה של TLV (תקופת הזמן המקסימלית לקלפי)

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

הקלדה של רשימת TLV.

OTDeviceRole

 otDeviceRole

מייצג תפקיד של שרשור.

מאפיינים
OT_DEVICE_ROLE_CHILD

תפקיד Thread Child.

OT_DEVICE_ROLE_DETACHED

לא משתתפת כרגע ברשת/חלוקה בשרשור.

OT_DEVICE_ROLE_DISABLED

מחסנית השרשורים מושבתת.

OT_DEVICE_ROLE_LEADER

תפקיד מוביל השרשור.

OT_DEVICE_ROLE_ROUTER

תפקיד נתב השרשור.

otNetDataPublisherEvent

 otNetDataPublisherEvent

הספירה הזו מייצגת את האירועים שדווחו על ידי קריאות חוזרות (callbacks) לבעלי תוכן דיגיטלי.

מאפיינים
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED

הרשומה שפורסמה מתווספת לנתוני הרשת של Thread.

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

הרשומה שפורסמה תוסר מנתוני רשת השרשורים.

otRoutepreferences

 otRoutePreference

הגדרת ערכים חוקיים עבור mPreference ב-otExternalRouteConfig וב-otBorderRouterConfig.

מאפיינים
OT_ROUTE_PREFERENCE_HIGH

העדפה למסלול גבוה.

OT_ROUTE_PREFERENCE_LOW

העדפה למסלול נמוך.

OT_ROUTE_PREFERENCE_MED

העדפה למסלול ממוצע.

סוג Dedef

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

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

otDetachGracefulCallback

void(* otDetachGracefullyCallback)(void *aContext)

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

פרטים
פרמטרים
[in] aContext
מצביע על הקשר ספציפי לאפליקציה.

מודל otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

מבנה זה מייצג הגדרה של מסלול חיצוני.

OTIpCounters

struct otIpCounters otIpCounters

מבנה זה מייצג את המונים ברמת כתובת ה-IP.

otLeaderData

struct otLeaderData otLeaderData

מבנה זה מייצג את נתוני ה-Lead Thread.

פורמט otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

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

OTMleCounters

struct otMleCounters otMleCounters

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

otNeighborInfoIterator

int16_t otNeighborInfoIterator

משמש איטרציה דרך טבלת השכנים.

otNetDataDnsSrpServicePublisherCallback

void(* otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)

הסוג הזה של מצביע הפונקציה מגדיר את הקריאה החוזרת (callback) שתודיע כאשר ערך רשומה של DNS או SRP&&, יתווספו לנתוני הרשת של Thread או יוסר מהם.

בהסרה, הקריאה החוזרת (callback) מופעלת גם אם הרשומה הזו הוסרה על ידי Publisher (למשל, אם יותר מדי רשומות דומות קיימות בנתוני הרשת) או באמצעות קריאה מפורשת לביטול הפרסום של הרשומה (כלומר, שיחה אל otNetDataUnpublishDnsSrpService()).

פרטים
פרמטרים
[in] aEvent
מציין את האירוע (האם הרשומה נוספה או הוסרה).
[in] aContext
מצביע על הקשר ספציפי לאפליקציה.

otNetDataPrefixPublisherCallback

void(* otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)

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

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

פרטים
פרמטרים
[in] aEvent
מציין את האירוע (האם הרשומה נוספה או הוסרה).
[in] aPrefix
מצביע על ערך הקידומת.
[in] aContext
מצביע על הקשר ספציפי לאפליקציה.

otNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

הספירה הזו מייצגת את האירועים שדווחו על ידי קריאות חוזרות (callbacks) לבעלי תוכן דיגיטלי.

otNetworkDataIterator

uint32_t otNetworkDataIterator

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

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

המבנה הזה מייצג כניסה לטבלת אבחון רשת לילדים.

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

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

otNetworkDiagIterator

uint16_t otNetworkDiagIterator

משמש לביצוע איטרציה באמצעות אבחון רשת TLV.

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

מבנה זה מייצג ערך של מונה Mac של אבחון רשת.

מידע על ההגדרות של שדות חבר זמין ב-RFC 2863.

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

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

otNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

מבנה זה מייצג נתונים של נתיב אבחון הרשת.

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

המבנה הזה מייצג TLV לאבחון רשת.

otGetDiagnosticGetCallback

void(* otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)

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

פרטים
פרמטרים
[in] aError
השגיאה לא התקבלה בגלל שגיאה.
[in] aMessage
מצביע על מאגר הנתונים של ההודעה, הכולל את המטען הייעודי (payload) של 'קבלת אבחון רשת' שהתקבל. זמין רק כאשר aError הוא OT_ERROR_NONE.
[in] aMessageInfo
מצביע על פרטי ההודעה של aMessage. זמין רק כאשר aError הוא OT_ERROR_NONE.
[in] aContext
מצביע על הקשר ספציפי לאפליקציה.

otRoutepreferences

enum otRoutePreference otRoutePreference

הגדרת ערכים חוקיים עבור mPreference ב-otExternalRouteConfig וב-otBorderRouterConfig.

otServerConfig

struct otServerConfig otServerConfig

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

שירות otServiceConfig

struct otServiceConfig otServiceConfig

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

otThreadAnycastLocatorCallback

void(* otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)

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

פרטים
פרמטרים
[in] aContext
מצביע להקשר שרירותי (בתנאי שהשיחה החוזרת רשומה).
[in] aError
השגיאה בעת טיפול בבקשה. OT_ERROR_NONE מציין הצלחה. OT_ERROR_Response_MINUTE מציינים יעד שלא נמצא. OT_ERROR_ABORT מציין שהבקשה בוטלה.
[in] aMeshLocalAddress
מצביע ל-EID המקומי המקומי של היעד הקרוב ביותר לכתובת Anycast כאשר aError הוא OT_ERROR_NONE, NULL אחרת.
[in] aRloc16
הקובץ RLOC16 של היעד אם נמצא, אחרת לא חוקי RLOC16 (0xfffe).

otThreadDiscoveryRequestCallcallback

void(* otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)

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

פרטים
פרמטרים
[in] aInfo
מצביע אל נתוני המידע של בקשת Discovery.
[in] aContext
מצביע על הקשר ספציפי לאפליקציה לקריאה חוזרת (callback).

otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

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

otThreadParentResponseCallback

void(* otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)

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

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

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

מבנה זה מייצג את הנתונים של 'תגובת MLE להורים'.

פונקציות

otNetDataContainsOmrPrefix

bool otNetDataContainsOmrPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

פונקציה זו בודקת אם קידומת נתונה יכולה לשמש כקידומת OMR חוקית וגם את נתוני הרשת של Leader' .

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aPrefix
מצביע על קידומת IPv6.
החזרות
אם aPrefix הוא קידומת OMR חוקית ונתוני Leader's כוללים את קידומת ה-OMR aPrefix.

otNetDataGet

otError otNetDataGet(
  otInstance *aInstance,
  bool aStable,
  uint8_t *aData,
  uint8_t *aDataLength
)

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aStable
TRUE בעת העתקת הגרסה היציבה, FALSE בעת העתקת הגרסה המלאה.
[out] aData
מצביע למאגר הנתונים.
[in,out] aDataLength
כשמזינים את הרשומה, גודל מאגר הנתונים שאליו מפנה aData. ביציאה, מספר הבייטים שהועתקו.

otNetDataGetNextOnMeshPrefix

otError otNetDataGetNextOnMeshPrefix(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otBorderRouterConfig *aConfig
)

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in,out] aIterator
מצביע להקשר של חוזר הנתונים של רשת. כדי לקבל את הערך הראשון ברשת, צריך להגדיר אותו כ-OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
מצביע אל המיקום שבו ימוקם המידע על קידומת הרשת.
ערכי החזרה
OT_ERROR_NONE
נמצאה הקידומת הבאה ב-Mesh.
OT_ERROR_NOT_FOUND
לא קיימת קידומת נוספת מסוג 'ברשת' בנתוני הרשת של Thread.

otNetDataGetNextRoute

otError otNetDataGetNextRoute(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otExternalRouteConfig *aConfig
)

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

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

otNetDataGetNextService

otError otNetDataGetNextService(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otServiceConfig *aConfig
)

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

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

otNetDataGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

הורדת הגרסה היציבה של נתוני הרשת.

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

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

מורידים את גרסת נתוני הרשת.

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

otNetDataIsDnsSrpServiceהתווסף

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

פונקציה זו מציינת אם הערך "DNS/SRP&&; כרגע נוסף לנתוני רשת השרשורים.

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

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

otNetDataIsPrefixAdded

bool otNetDataIsPrefixAdded(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

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

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aPrefix
מצביע אל הקידומת (חייב להיות לא NULL).
ערכי החזרה
TRUE
רשומת הקידומת שפורסמה נוספה לנתוני הרשת של Thread.
FALSE
הרשומה לא תתווסף לנתוני הרשת של Thread או שאין רשומה לפרסום.

otNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

פונקציה זו מבקשת "DNS/SRP Service Anycast Address" כדי לפרסם אותה בנתוני רשת השרשורים.

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

קריאה לפונקציה הזו תסיר ותחלף כל רשומה קודמת של &quot ;DNS/SRP; רשומה שפורסמה (משיחה קודמת לאחת מהפונקציות של otNetDataPublishDnsSrpService{Type}()).

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aSequenceNUmber
מספר הרצף של שירות DNS/SRP Anycast.

otNetDataPublishDnsSrpServiceUnicast

void otNetDataPublishDnsSrpServiceUnicast(
  otInstance *aInstance,
  const otIp6Address *aAddress,
  uint16_t aPort
)

פונקציה זו מבקשת "DNS/SRP Service Unicast Address" כדי לפרסם אותה בנתוני רשת השרשורים.

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

קריאה לפונקציה הזו תסיר ותחלף כל רשומה קודמת של &quot ;DNS/SRP; רשומה שפורסמה (משיחה קודמת לאחת מהפונקציות של otNetDataPublishDnsSrpService{Type}()).

פונקציה זו מפרסמת את "DNS/SRP Service Unicast address&& ; על ידי הכללת הכתובת ופרטי היציאה בנתוני ה-TLV של השירות.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aAddress
כתובת ה-DNS/SRP לפרסום (חייבת להיות NULL).
[in] aPort
מספר היציאה של שרת SRP לפרסום.

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

פונקציה זו מבקשת "DNS/SRP Service Unicast Address" כדי לפרסם אותה בנתוני רשת השרשורים.

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

קריאה לפונקציה הזו תסיר ותחלף כל רשומה קודמת של &quot ;DNS/SRP; רשומה שפורסמה (משיחה קודמת לאחת מהפונקציות של otNetDataPublishDnsSrpService{Type}()).

בשונה מ-otNetDataPublishDnsSrpServiceUnicast() שבה יש לספק את הכתובת שפורסמה וכוללת את המידע בנתוני ה-TLV של השירות, הפונקציה הזו משתמשת ב-EID מקומי של המכשיר וכוללת את המידע בנתוני ה-TLV של השרת.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aPort
מספר היציאה של שרת SRP לפרסום.

otNetDataPublishExternalRoute

otError otNetDataPublishExternalRoute(
  otInstance *aInstance,
  const otExternalRouteConfig *aConfig
)

הפונקציה מבקשת בקשה לפרסם קידומת של מסלול חיצוני בנתוני הרשת של השרשורים.

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

ניתן לפרסם רק ערכים יציבים (כלומרaConfig.mStable חייב להיות TRUE).

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

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

otNetDataPublishOnMeshPrefix

otError otNetDataPublishOnMeshPrefix(
  otInstance *aInstance,
  const otBorderRouterConfig *aConfig
)

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

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

ניתן לפרסם רק ערכים יציבים (כלומרaConfig.mStable חייב להיות TRUE).

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

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

otNetDataSetDnsSrpServicePublisherCallback

void otNetDataSetDnsSrpServicePublisherCallback(
  otInstance *aInstance,
  otNetDataDnsSrpServicePublisherCallback aCallback,
  void *aContext
)

פונקציה זו מגדירה קריאה חוזרת (callback) כדי לקבל התראה כששירות "DNS/SRP Service , והוספה בפועל לנתונים ברשת השרשורים או הסרתם מהם.

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

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aCallback
מצביע פונקציית הקריאה החוזרת (יכול להיות NULL אם לא נדרש).
[in] aContext
מצביע להקשר ספציפי של האפליקציה (בשימוש כאשר aCallback מופעל).

otNetDataSetPrefixPublisherCallback

void otNetDataSetPrefixPublisherCallback(
  otInstance *aInstance,
  otNetDataPrefixPublisherCallback aCallback,
  void *aContext
)

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

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

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aCallback
מצביע פונקציית הקריאה החוזרת (יכול להיות NULL אם לא נדרש).
[in] aContext
מצביע להקשר ספציפי של האפליקציה (בשימוש כאשר aCallback מופעל).

otNetDataSteeringDataCheckConnecter

otError otNetDataSteeringDataCheckJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64
)

בודקים אם נתוני ההיגוי כוללים מחבר.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aEui64
מצביע ל-IEEE EUI-64 של המחבר.
ערכי החזרה
OT_ERROR_NONE
המוצר aEui64 כלול בנתוני ההיגוי.
OT_ERROR_INVALID_STATE
אין נתוני הגה.
OT_ERROR_NOT_FOUND
aEui64 לא כלול בנתוני ההיגוי.

otNetDataSteeringDataCheckJOINerWithDiscerner

otError otNetDataSteeringDataCheckJoinerWithDiscerner(
  otInstance *aInstance,
  const struct otJoinerDiscerner *aDiscerner
)

בודקים אם נתוני ההיגוי כוללים גורם חיבור עם ערך נתון של JSON.

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

otNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

פונקציה זו מבטלת את הפרסום של כל שירות "DNS/SRP (Anycast או Unicast) שכבר נוסף, מתוך נתוני רשת השרשורים.

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

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

otNetDataUnpublishPrefix

otError otNetDataUnpublishPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

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

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aPrefix
הקידומת לביטול הפרסום (MUST לא יכולה להיות NULL).
ערכי החזרה
OT_ERROR_NONE
הפרסום של הקידומת בוטל.
OT_ERROR_NOT_FOUND
לא ניתן היה למצוא את הקידומת ברשימה שפורסמה.

להיכנס למסגרת

otError otThreadBecomeChild(
  otInstance *aInstance
)

מנסים לצרף מחדש ילדים.

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

אוטו-דיאטה

otError otThreadBecomeDetached(
  otInstance *aInstance
)

התנתקות מרשת השרשורים.

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

otThreadDetachGraceful

otError otThreadDetachGracefully(
  otInstance *aInstance,
  otDetachGracefullyCallback aCallback,
  void *aContext
)

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

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

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

OTThreadDeviceRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

המרה של תפקיד המכשיר למחרוזת שאנשים יכולים לקרוא.

פרטים
פרמטרים
[in] aRole
תפקיד ההמרה במכשיר.
החזרות
מחרוזת המייצגת את aRole.

OTThreadDiscover

otError otThreadDiscover(
  otInstance *aInstance,
  uint32_t aScanChannels,
  uint16_t aPanId,
  bool aJoiner,
  bool aEnableEui64Filtering,
  otHandleActiveScanResult aCallback,
  void *aCallbackContext
)

פונקציה זו מתחילה סריקה של Thread Discovery.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aScanChannels
קצת וקטור שמציין אילו ערוצים לסרוק (למשל OT_CHANNEL_11_MASK).
[in] aPanId
מסנן של מזהה PAN (יש להגדיר כ-PAN של שידור כדי להשבית את המסנן).
[in] aJoiner
הערך של feature join Flag ב-Discovery Request TLV.
[in] aEnableEui64Filtering
TRUE כדי לסנן תגובות ב-EUI-64, אחרת FALSE.
[in] aCallback
מצביע לפונקציה בעלת קריאה על תגובת MLE Discovery או לסריקה שהושלמה.
[in] aCallbackContext
מצביע על הקשר ספציפי לאפליקציה.
ערכי החזרה
OT_ERROR_NONE
הסריקה של Discovery Discovery התחילה.
OT_ERROR_INVALID_STATE
ממשק IPv6 לא מופעל (netif לא פועל).
OT_ERROR_NO_BUFS
המערכת לא הצליחה להקצות הודעה לבקשת Discovery.
OT_ERROR_BUSY
סריקה של גילוי שרשור כבר מתבצעת.

OTThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

כדאי להגדיר את הזמן הקצוב לתפוגה של השימוש ב-Thread לילדים במהלך השימוש בתפקיד 'ילד'.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
ערך הזמן הקצוב לתפוגת ילדים בשרשור בשניות.
לעיון גם:
otThreadSetChildTimeout

OTThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

מקבלים את תפקיד המכשיר.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
ערכי החזרה
OT_DEVICE_ROLE_DISABLED
מחסנית השרשורים מושבתת.
OT_DEVICE_ROLE_DETACHED
המכשיר לא משתתף כרגע ברשת/חלוקה של שרשורים.
OT_DEVICE_ROLE_CHILD
המכשיר פועל כרגע כילד Thread.
OT_DEVICE_ROLE_ROUTER
המכשיר פועל כרגע כנתב שרשור.
OT_DEVICE_ROLE_LEADER
המכשיר פועל כרגע כמנהיג השרשורים.

otThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

קבלת שם הדומיין של השרשור.

פונקציה זו זמינה רק החל משרשור 1.2.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
מצביע על שם הדומיין של השרשור.
מידע נוסף:
otThreadSetDomainName

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

מקבלים את מזהה ה-PAN המורחב של IEEE 802.15.4.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
מצביע ל-IEEE 802.15.4 של מזהה ה-PAN המורחב.
לעיון גם:
otThreadSetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

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

הפונקציה הזו זמינה רק כאשר שרשור 1.2 מופעל כאשר OPENTHREAD_CONFIG_DUA_ENABLE מופעל.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
מצביע על מזהה הממשק שהוגדר באופן ידני, או על NULL אם לא הוגדר ערך.
ראו גם:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

קבלת מוני ה-IPv6.

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

otThreadGetKeyCountCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

קבלת ה-thrKeyVariableCounter.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
הערך thrKeyקמפייןCounter.
ראו גם:
otThreadSetKeyKeyCounter

OTThreadGetKeySwitchguardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

כדאי להוריד את thrKeySwitchguardTime.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
הערך של thrKeySwitchguardTime (בשעות).
לעיון גם:
otThreadSetKeySwitchguardTime

OTThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

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

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

OTThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

פונקציה זו מחזירה מצביע ל-RLOC של המנהיג.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[out] aLeaderRloc
מצביע למנהיג/ה של RLOC.
ערכי החזרה
OT_ERROR_NONE
ה-RLOC של המנהיג נכתב אל aLeaderRloc.
OT_ERROR_INVALID_ARGS
הערך של aLeaderRloc היה NULL.
OT_ERROR_DETACHED
לא מחוברת כרגע למחיצת שרשור.

הפרמטר otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

עליך לקבל את מזהה הנתב של הספק.

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

OTThreadGetLeaderweight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

משקל המנהיג.

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

otThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

פונקציה זו מחזירה את כתובת ה-ריבוי שרשורים של Thread Link-Local All Threads.

הכתובת היא כתובת מקומית מקומית של Unicast המבוססת על ריבוי קידומת [RFC 3306], עם:

  • fligs מוגדר ל-3 (P = 1 ו-T = 1)
  • חיתוך מוגדר ל-2
  • הערך של תקופת השימוש מוגדר ל-64
  • קידומת הרשת הוגדרה כקידומת מקומית ברשת Mesh
  • מזהה הקבוצה מוגדר ל-1

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
מצביע על כתובת מרובת שרשורים של 'כל הקישורים בשרשור מקומי'.

הכתובת OTThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

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

הכתובת המקומית של קישור שרשור נגזרת באמצעות מזהה מורחב של IEEE802.15.4.

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

מצב otGetGetMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

הגדרה של מצב קישור MLE.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
תצורת מצב קישור MLE.
לעיון גם:
otThreadSetLinkMode

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

פונקציה זו מחזירה את הסמן לכתובת Esh Local EID.

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

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

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

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

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

חיפוש בדלפקי Thread MLE.

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

OTThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

לקבלת מפתח הרשת של Thread.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[out] aNetworkKey
מצביע אל otNetworkkey כדי להחזיר את מפתח הרשת של השרשור.
יש לעיין גם במאמרים:
otThreadSetNetworkKey

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

לקבלת otNetworkKeyRef עבור מפתח רשת Thread.

כדי להפעיל את הפונקציה הזו צריך להפעיל את התכונה 'זמן יצירה' OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
הפניה למפתח הרשת של Thread ששמור בזיכרון.
להצגת גם:
otThreadSetNetworkKeyRef

OTThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

לקבלת שם הרשת של השרשור.

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

otThreadGetNextDiagnosticTlv

otError otThreadGetNextDiagnosticTlv(
  const otMessage *aMessage,
  otNetworkDiagIterator *aIterator,
  otNetworkDiagTlv *aNetworkDiagTlv
)

פונקציה זו מקבלת את ה-TLV הבא לאבחון רשת בהודעה.

קריאה נוספת לפונקציה הזו מותרת רק כאשר ערך ההחזרה הנוכחי הוא OT_ERROR_NONE.

פרטים
פרמטרים
[in] aMessage
מצביע על הודעה.
[in,out] aIterator
מצביע להקשר של אינטרציית הרשת כדי לקבל את ה-TLV הראשון לאבחון רשת, יש להגדיר אותו ל-OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
[out] aNetworkDiagTlv
מצביע אל המיקום שבו ימוקמו פרטי ה-TLV של אבחון הרשת.
ערכי החזרה
OT_ERROR_NONE
ה-TLV האבחון הבא ברשת נמצא בהצלחה.
OT_ERROR_NOT_FOUND
לא קיימת הודעה נוספת לגבי TLV לאבחון רשת בהודעה הזו.
OT_ERROR_PARSE
ניתוח אבחון הרשת הבא נכשל.

otThreadGetNextNeighborInfo

otError otThreadGetNextNeighborInfo(
  otInstance *aInstance,
  otNeighborInfoIterator *aIterator,
  otNeighborInfo *aInfo
)

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

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

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

OTThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[out] aParentRssi
מצביע למקום שבו צריך למקם את ה-RSS של ההורה.

OTThreadGetGetInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[out] aParentInfo
מציין את המיקום של פרטי נתב ההורה.

OTThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

הפונקציה מאחזרת את ה-RSSI של החבילה האחרונה מההורה של השרשור.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[out] aLastRssi
מצביע למקום שבו יש להציב את ה-RSS האחרון.
ערכי החזרה
OT_ERROR_NONE
נתוני RSSI אוחזרו בהצלחה.
OT_ERROR_FAILED
לא ניתן לקבל נתוני RSSI.
OT_ERROR_INVALID_ARGS
aLastRssi הוא NULL.

OTThreadGetGetitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

מוצאים את מזהה החלוקה.

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

otThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

פונקציה זו מחזירה את כתובת ה-ריבוי שרשורים של Thread Realm-Local All Threads.

הכתובת היא Unicast מקומי: קידומת ריבוי כתובות של Unltcast המבוססת על קידומת [RFC 3306], עם:

  • fligs מוגדר ל-3 (P = 1 ו-T = 1)
  • הסקופ מוגדר ל-3
  • הערך של תקופת השימוש מוגדר ל-64
  • קידומת הרשת הוגדרה כקידומת מקומית ברשת Mesh
  • מזהה הקבוצה מוגדר ל-1

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
מצביע אל כתובת מרובת שרשורים של פרוטוקול Thread Realm-Local All Threads.

OTThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

פונקציה זו מחזירה את הסמן לכתובת של נתב הניתוב (RLOC).

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

OTThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

משחקי RLOC16.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
The RLOC16.

OTThreadGetServiceAloc

otError otThreadGetServiceAloc(
  otInstance *aInstance,
  uint8_t aServiceId,
  otIp6Address *aServiceAloc
)

פונקציה זו מאחזרת את ה-ALOC של שירות עבור מזהה השירות הנתון.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aServiceId
מזהה השירות שעבורו ברצונך לקבל ALOC.
[out] aServiceAloc
מצביע על האפשרות להשתמש ב-ALOC של שירות. אסור להיות נול.
ערכי החזרה
OT_ERROR_NONE
ALOC של השירות אוחזר בהצלחה.
OT_ERROR_DETACHED
ממשק השרשור לא מצורף למחיצת שרשור כרגע.

OTThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

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

פרטים
החזרות
גרסת הפרוטוקול של Thread.

otThreadIsAnycastFindInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

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

הפונקציה הזו זמינה רק כאשר OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE מופעל.

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

OTThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

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

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

חוט אריג יחיד

bool otThreadIsSingleton(
  otInstance *aInstance
)

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

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

OTThreadFindAnycastDestination

otError otThreadLocateAnycastDestination(
  otInstance *aInstance,
  const otIp6Address *aAnycastAddress,
  otThreadAnycastLocatorCallback aCallback,
  void *aContext
)

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

הפונקציה הזו זמינה רק כאשר OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE מופעל.

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aAnycastAddress
הכתובת שרוצים לאתר. אסור להיות נול.
[in] aCallback
פונקציית הקריאה החוזרת לדיווח על התוצאה.
[in] aContext
הקשר שרירותי שנעשה בו שימוש עם aCallback.
ערכי החזרה
OT_ERROR_NONE
הבקשה התחילה בהצלחה. הפעולה aCallback תופעל כדי לדווח על התוצאה.
OT_ERROR_INVALID_ARGS
ה-aAnycastAddress אינה כתובת Anycast חוקית או שהשדה aCallback הוא NULL.
OT_ERROR_NO_BUFS
מחוץ לאחסון הזמני כדי להכין ולשלוח את הודעת הבקשה.

otThreadenrollMemberResponseCallback

void otThreadRegisterParentResponseCallback(
  otInstance *aInstance,
  otThreadParentResponseCallback aCallback,
  void *aContext
)

פונקציה זו רושמת קריאה חוזרת (callback) כדי לקבל נתוני תגובת הורה (MLE).

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

otThreadresetIp6Counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

מאפסים את מוני ה-IPv6.

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

otThreadresetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

איפוס המונים של Thread MLE.

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

OTThreadSendAddressMessage

void otThreadSendAddressNotification(
  otInstance *aInstance,
  otIp6Address *aDestination,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid
)

פונקציה זו שולחת הודעה פרואקטיבית של כתובת (eCPC_NTF.ntf).

הפונקציה הזו זמינה רק כאשר OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE מופעל.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aDestination
היעד לשליחת הודעת ה-Target_NTF.ntf.
[in] aTarget
כתובת היעד של ההודעה DoCoMo_NTF.ntf
[in] aMlIid
ה-ML-IID של הודעת לחפש_NTF.ntf.

OTThreadSendDiagnosticGet

otError otThreadSendDiagnosticGet(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount,
  otReceiveDiagnosticGetCallback aCallback,
  void *aCallbackContext
)

שליחת בקשה לקבלת אבחון רשת.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aDestination
מצביע על כתובת היעד.
[in] aTlvTypes
מגוון של סוגי TLV לאבחון רשת.
[in] aCount
מספר הסוגים ב-aTlvTypes.
[in] aCallback
מצביע לפונקציה בעלת קריאה, כאשר מתקבלת תגובה לקבלת אבחון רשת או NULL כדי להשבית את הקריאה החוזרת.
[in] aCallbackContext
מצביע על הקשר ספציפי לאפליקציה.
ערכי החזרה
OT_ERROR_NONE
ה-DIAG_GET.req נוסף בהצלחה לתור.
OT_ERROR_NO_BUFS
אין מספיק מאגר נתונים זמני לשליחת הודעות כדי לשלוח DIAG_GET.req.

otThreadSendDiagnosticאיפוס

otError otThreadSendDiagnosticReset(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount
)

שליחת בקשה לאיפוס של אבחון רשת.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aDestination
מצביע על כתובת היעד.
[in] aTlvTypes
מגוון של סוגי TLV לאבחון רשת. בשלב זה, מותר להשתמש בסוג 9 בלבד.
[in] aCount
מספר הסוגים ב-aTlvTypes
ערכי החזרה
OT_ERROR_NONE
ה-DIAG_RST.ntf נוסף בהצלחה לתור.
OT_ERROR_NO_BUFS
אין מספיק מאגר נתונים זמני לשליחת הודעות כדי לשלוח DIAG_RST.ntf.

otThreadSendProactiveBackboneNotifications

otError otThreadSendProactiveBackboneNotification(
  otInstance *aInstance,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid,
  uint32_t aTimeSinceLastTransaction
)

פונקציה זו שולחת הודעה פרואקטיבית של כריכה רכה (PRO_BB.ntf) בקישור 'הקודם'.

הפונקציה הזו זמינה רק כאשר OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE מופעל.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aTarget
כתובת היעד של ההודעה PRO_BB.ntf.
[in] aMlIid
ה-ML-IID של הודעת PRO_BB.ntf.
[in] aTimeSinceLastTransaction
הזמן שחלף מאז העסקה האחרונה (בשניות).
ערכי החזרה
OT_ERROR_NONE
PRO_BB.ntf נשלח בהצלחה על קישור עמוד השדרה.
OT_ERROR_NO_BUFS
אם מאגר הנתונים הזמני של ההודעה לא מספיק.

OTThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

מגדירים את הזמן הקצוב לתפוגה של ילדים בשרשור שבו משתמשים בתפקיד 'ילד'.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aTimeout
ערך הזמן הקצוב בשניות.
כמו כן, מומלץ:
otThreadGetChildTimeout

otThreadSetDiscoveryRequestCallback

void otThreadSetDiscoveryRequestCallback(
  otInstance *aInstance,
  otThreadDiscoveryRequestCallback aCallback,
  void *aContext
)

פונקציה זו מגדירה קריאה חוזרת (callback) כדי לקבל נתוני בקשת גילוי של MLE.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aCallback
מצביע על פונקציה שנקראת בעת קבלת הודעת בקשת גילוי של MLE.
[in] aContext
מצביע על הקשר ספציפי לאפליקציה לקריאה חוזרת (callback).

OTThreadSetDomainName

otError otThreadSetDomainName(
  otInstance *aInstance,
  const char *aDomainName
)

הגדרת שם הדומיין של השרשור.

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aDomainName
מצביע על שם הדומיין של השרשור.
ערכי החזרה
OT_ERROR_NONE
שם הדומיין בשרשור הוגדר בהצלחה.
OT_ERROR_INVALID_STATE
הפרוטוקולים לשרשורים מופעלים.
מידע נוסף:
otThreadGetDomainName

OTThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

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

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

קריאה לפונקציה הזו אם הערך aEnabled מוגדרת FALSE כדי להפסיק תהליכים מתמשכים של הניתוק שהתחיל otThreadDetachGraceful(). המערכת תקרא לקריאה החוזרת של הפונקציה הזו.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aEnabled
TRUE אם השרשור מופעל, אחרת FALSE.
ערכי החזרה
OT_ERROR_NONE
הפעולה של פרוטוקול Thread התחילה בהצלחה.
OT_ERROR_INVALID_STATE
ממשק הרשת לא היה פועל.

OTThreadSetExtendedPanId

otError otThreadSetExtendedPanId(
  otInstance *aInstance,
  const otExtendedPanId *aExtendedPanId
)

מגדירים את מזהה ה-PAN המורחב של IEEE 802.15.4.

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aExtendedPanId
מצביע ל-IEEE 802.15.4 של מזהה ה-PAN המורחב.
ערכי החזרה
OT_ERROR_NONE
הוגדר בהצלחה את מזהה ה-PAN המורחב.
OT_ERROR_INVALID_STATE
הפרוטוקולים לשרשורים מופעלים.
לעיון גם:
otThreadGetExtendedPanId

otThreadSetFixedDuaInterfaceIdentifier

otError otThreadSetFixedDuaInterfaceIdentifier(
  otInstance *aInstance,
  const otIp6InterfaceIdentifier *aIid
)

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

הפונקציה הזו זמינה רק כאשר שרשור 1.2 מופעל כאשר OPENTHREAD_CONFIG_DUA_ENABLE מופעל.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aIid
מצביע אל מזהה הממשק שיש להגדיר או NULL לניקוי.
ערכי החזרה
OT_ERROR_NONE
הוגדר/נוקה בהצלחה את מזהה הממשק.
OT_ERROR_INVALID_ARGS
מזהה הממשק שצוין שמור.
ראו גם:
otThreadGetFixedDuaInterfaceIdentifier

פרסום otThreadSet

otError otThreadSetJoinerAdvertisement(
  otInstance *aInstance,
  uint32_t aOui,
  const uint8_t *aAdvData,
  uint8_t aAdvDataLength
)

השיטה הזו מגדירה את הפרסום של מחבר השרשור כשמגלים את רשת השרשור.

פרסום מחבר שרשור מאפשר לאפשר למפרסם לפרסם מידע ספציפי לאפליקציה שלו (למשל, מזהה ספק, מזהה מוצר, מפלג וכו') באמצעות הצעה חדשה שהוצעה על ידי חבר/ה בתוכנית, ולאפשר גישה לנציבים או למועמדי הנציבות ללא אינטראקציה אנושית.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aOui
ערך IEEE OUI של הספק שייכללו בפרסומת של המחבר. המערכת תשתמש רק ב-3 הבייטים המשמעותיים ביותר, והמערכת תתעלם מהבייטים החשובים ביותר.
[in] aAdvData
מצביע על AdvData שייכללו בפרסומת של המחבר.
[in] aAdvDataLength
האורך של AdvData בבייטים.
ערכי החזרה
OT_ERROR_NONE
הגדרת פרסום המודעות של ההצטרפות הסתיימה בהצלחה.
OT_ERROR_INVALID_ARGS
AdvData לא חוקי.

otThreadSetKeyVariableCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

מגדירים את ה-thrKeyקמפייןCounter.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aKeySequenceCounter
הערך thrKeyקמפייןCounter.
להצגת גם:
otThreadGetKeyCountCounter

OTThreadSetKeySwitchguardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

מגדירים את thrKeySwitchguardTime.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aKeySwitchGuardTime
הערך של thrKeySwitchguardTime (בשעות).
עיינו גם ב:
otThreadGetKeySwitchguardTime

מצב OTthread

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

מגדירים את מצב 'קישור' (MLE).

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aConfig
מצביע על ההגדרה של מצב קישור.
ערכי החזרה
OT_ERROR_NONE
הגדרת מצב הקישור של MLE הסתיימה.
לעיון גם:
otThreadGetLinkMode

otThreadSetMeshLocalPrefix

otError otThreadSetMeshLocalPrefix(
  otInstance *aInstance,
  const otMeshLocalPrefix *aMeshLocalPrefix
)

פונקציה זו מגדירה את הקידומת המקומית של Mesh.

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

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

otThreadSetNetworkKey

otError otThreadSetNetworkKey(
  otInstance *aInstance,
  const otNetworkKey *aKey
)

מגדירים את מפתח הרשת של השרשור.

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aKey
מצביע למאגר נתונים המכיל את מפתח רשת השרשור.
ערכי החזרה
OT_ERROR_NONE
הגדרת 'הרשת שרשור' הסתיימה.
OT_ERROR_INVALID_STATE
הפרוטוקולים לשרשורים מופעלים.
כמו כן, מומלץ:
otThreadGetNetworkKey

otThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

יש להגדיר את מפתח הרשת של השרשור כ-otNetworkKeyRef.

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

כדי להפעיל את הפונקציה הזו צריך להפעיל את התכונה 'זמן יצירה' OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aKeyRef
הפניה למפתח הרשת של Thread.
ערכי החזרה
OT_ERROR_NONE
הגדרת 'הרשת שרשור' הסתיימה.
OT_ERROR_INVALID_STATE
הפרוטוקולים לשרשורים מופעלים.
כמו כן, מומלץ:
otThreadGetNetworkKeyRef

OTThreadSetNetworkName

otError otThreadSetNetworkName(
  otInstance *aInstance,
  const char *aNetworkName
)

מגדירים את שם הרשת של השרשור.

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aNetworkName
מצביע על שם רשת השרשורים.
ערכי החזרה
OT_ERROR_NONE
השם של שרשור הרשת הוגדר בהצלחה.
OT_ERROR_INVALID_STATE
הפרוטוקולים לשרשורים מופעלים.
לעיון גם:
otThreadGetNetworkName

פקודות מאקרו

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

אורך AdvData מקסימלי של פרסום מחבר.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

מאתחל עבור otNeighborInfoIterator.

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

אורך הערך המקסימלי של Thread Base TLV.

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

ערך להפעלת otNetworkDataIterator.

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

גודל הרשומה של טבלת הצאצאים של אבחון הרשת.

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

מאתחל עבור otNetworkDiagIterator.

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

המספר המקסימלי של סוגי TLV לאבחון רשת שיש לבקש או לאפס.

OT_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

מזהה נתב מקסימלי.

OT_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

הגודל המקסימלי של נתוני השרת בבייטים. מגבלה תאורטית, כמעט נמוכה בהרבה.

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

הגודל המקסימלי של נתוני השירות בבייטים.

משאבים

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