דף זה תורגם על ידי Cloud Translation API.

כללי

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

סיכום

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

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

הערה: הפונקציות במודול הזה מחייבות OPENTHREAD_FTD=1 או OPENTHREAD_MTD=1.

מספור
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, OT_NETWORK_DIAGNOSTIC_TLV_VERSION = 24, OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME = 25, OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL = 26, OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION = 27, OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION = 28 }	טיפוסים בני מנייה (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) תפקיד המשתמש ב-Thread.
`otNetDataPublisherEvent{ OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0, OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1 }`	טיפוסים בני מנייה (enum) המספור הזה מייצג את האירועים המדווחים מהקריאות החוזרות של בעלי תוכן דיגיטלי.
`otRoutePreference{ OT_ROUTE_PREFERENCE_LOW = -1, OT_ROUTE_PREFERENCE_MED = 0, OT_ROUTE_PREFERENCE_HIGH = 1 }`	טיפוסים בני מנייה (enum) המדיניות מגדירה ערכים חוקיים עבור `mPreference` ב-`otExternalRouteConfig` וב-`otBorderRouterConfig`.

סוג שגיאות
`otBorderRouterConfig`	typedef `struct otBorderRouterConfig` המבנה הזה מייצג תצורה של נתב גבול.
`otDetachGracefullyCallback)(void *aContext)`	typedef `void(*` הקריאה החוזרת הזו מודיעה לאפליקציה שתהליך הניתוק הסתיים.
`otExternalRouteConfig`	typedef `struct otExternalRouteConfig` המבנה הזה מייצג הגדרה של מסלול חיצוני.
`otIpCounters`	typedef `struct otIpCounters` המבנה הזה מייצג את המונים ברמת ה-IP.
`otLeaderData`	typedef `struct otLeaderData` המבנה הזה מייצג את נתוני השרשורים המובילים.
`otLinkModeConfig`	typedef `struct otLinkModeConfig` המבנה הזה מייצג תצורה של מצב קישור MLE.
`otLowpanContextInfo`	typedef `struct otLowpanContextInfo` המבנה הזה מייצג מידע על מזהה הקשר של 6LoWPAN שמשויך לקידומת בנתוני הרשת.
`otMleCounters`	typedef `struct otMleCounters` המבנה הזה מייצג את המונים של Thread 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(*` סוג המצביע של הפונקציה הזו מגדיר את הקריאה החוזרת (callback) שמשמשת כדי להודיע על הוספה או הסרה של ערך קידומת (ברשת או ברשת חיצונית) מנתוני רשת Thread.
`otNetDataPublisherEvent`	typedef `enum otNetDataPublisherEvent` המספור הזה מייצג את האירועים המדווחים מהקריאות החוזרות של בעלי תוכן דיגיטלי.
`otNetworkDataIterator`	typedef `uint32_t` משמש לאיטרציה באמצעות מידע של נתוני רשת.
`otNetworkDiagChildEntry`	typedef `struct otNetworkDiagChildEntry` המבנה הזה מייצג רשומה בטבלה של ניתוחי ילדים.
`otNetworkDiagConnectivity`	typedef `struct otNetworkDiagConnectivity` המבנה הזה מייצג ערך של קישוריות אבחון רשת.
`otNetworkDiagIterator`	typedef `uint16_t` משמש לאיטרציה באמצעות TLV אבחון רשת.
`otNetworkDiagMacCounters`	typedef `struct otNetworkDiagMacCounters` המבנה הזה מייצג ערך של מונה Mac של אבחון הרשת.
`otNetworkDiagRoute`	typedef `struct otNetworkDiagRoute` המבנה הזה מייצג ערך TLV של מסלול האבחון של הרשת.
`otNetworkDiagRouteData`	typedef `struct otNetworkDiagRouteData` המבנה הזה מייצג נתונים של מסלול ניתוח הרשת.
`otNetworkDiagTlv`	typedef `struct otNetworkDiagTlv` המבנה הזה מייצג TLV של אבחון הרשת.
`otReceiveDiagnosticGetCallback)(otError aError, otMessage aMessage, const otMessageInfo aMessageInfo, void *aContext)`	typedef `void(*` מצביע הפונקציה הזה נקרא כאשר מתקבלת תגובה לקבלת אבחון רשת.
`otRoutePreference`	typedef `enum otRoutePreference` המדיניות מגדירה ערכים חוקיים עבור `mPreference` ב-`otExternalRouteConfig` וב-`otBorderRouterConfig`.
`otServerConfig`	typedef `struct otServerConfig` המבנה הזה מייצג הגדרה של שרת.
`otServiceConfig`	typedef `struct otServiceConfig` המבנה הזה מייצג הגדרת שירות.
`otThreadAnycastLocatorCallback)(void aContext, otError aError, const otIp6Address aMeshLocalAddress, uint16_t aRloc16)`	typedef `void(*` הסוג הזה של מצביע הפונקציה מגדיר את הקריאה החוזרת (callback) כדי להודיע על התוצאה של בקשת `otThreadLocateAnycastDestination()`.
`otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo aInfo, void aContext)`	typedef `void(*` מצביע הפונקציה הזה מופעל בכל פעם שמתקבלת הודעה של בקשת גילוי מסוג MLE.
`otThreadDiscoveryRequestInfo`	typedef `struct otThreadDiscoveryRequestInfo` המבנה הזה מייצג את הנתונים של בקשות השרשור ב-Discovery.
`otThreadParentResponseCallback)(otThreadParentResponseInfo aInfo, void aContext)`	typedef `void(*` המצביע של הפונקציה הזו נקרא בכל פעם שמתקבלת הודעת הורה מסוג MLE.
`otThreadParentResponseInfo`	typedef `struct otThreadParentResponseInfo` המבנה הזה מייצג את נתוני תגובת ההורה של MLE.

פונקציות
`otConvertDurationInSecondsToString(uint32_t aDuration, char *aBuffer, uint16_t aSize)`	`void` הפונקציה ממירה משך זמן של `uint32_t` (בשניות) למחרוזת שניתנת לקריאה על ידי אנשים.
`otNetDataContainsOmrPrefix(otInstance aInstance, const otIp6Prefix aPrefix)`	`bool` בדקו אם קידומת נתונה יכולה לשמש כקידומת OMR תקינה, וגם נתוני הרשת של ה-Leader מכילים את הקידומת הזו.
`otNetDataGet(otInstance aInstance, bool aStable, uint8_t aData, uint8_t *aDataLength)`	`otError` לספק עותק מלא או יציב של נתוני רשת השרשורים של המחיצה.
`otNetDataGetLength(otInstance *aInstance)`	`uint8_t` מוצאים את האורך הנוכחי (מספר הבייטים) של נתוני הרשת של החלוקה למחיצות.
`otNetDataGetMaxLength(otInstance *aInstance)`	`uint8_t` משך הזמן המרבי של נתוני Thread מאז האתחול של OT Stack, או מאז הקריאה האחרונה אל `otNetDataResetMaxLength()`.
`otNetDataGetNextLowpanContextInfo(otInstance aInstance, otNetworkDataIterator aIterator, otLowpanContextInfo *aContextInfo)`	`otError` קבלת המידע הבא על מזהה הקשר 6LoWPAN בנתוני הרשת של המחיצה.
`otNetDataGetNextOnMeshPrefix(otInstance aInstance, otNetworkDataIterator aIterator, otBorderRouterConfig *aConfig)`	`otError` קבלת הקידומת הבאה של Mesh בנתוני הרשת של המחיצה.
`otNetDataGetNextRoute(otInstance aInstance, otNetworkDataIterator aIterator, otExternalRouteConfig *aConfig)`	`otError` מקבלים את המסלול החיצוני הבא בנתוני הרשת של המחיצה.
`otNetDataGetNextService(otInstance aInstance, otNetworkDataIterator aIterator, otServiceConfig *aConfig)`	`otError` יש לקבל את השירות הבא בנתוני הרשת של המחיצה.
`otNetDataGetStableVersion(otInstance *aInstance)`	`uint8_t` להורדת הגרסה היציבה של נתוני הרשת.
`otNetDataGetVersion(otInstance *aInstance)`	`uint8_t` מורידים את גרסת נתוני הרשת.
`otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)`	`bool` הפונקציה הזו קובעת אם הערך "שירות DNS/SRP" נוסף לנתוני הרשת של Thread.
`otNetDataIsPrefixAdded(otInstance aInstance, const otIp6Prefix aPrefix)`	`bool` הפונקציה הזו קובעת אם נכון לעכשיו נוספה רשומת קידומת שפורסמה (ברשת או ברשת חיצונית) לנתוני הרשת של Thread.
`otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)`	`void` הפונקציה הזו מבקשת לפרסם את הכתובת "כתובת DNS/SRP של שירות anycast" בנתוני הרשת של Thread.
`otNetDataPublishDnsSrpServiceUnicast(otInstance aInstance, const otIp6Address aAddress, uint16_t aPort)`	`void` הפונקציה הזו מבקשת לפרסם את 'כתובת Unicast של DNS/SRP' בנתונים של רשת Thread.
`otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)`	`void` הפונקציה הזו מבקשת לפרסם את 'כתובת Unicast של DNS/SRP' בנתונים של רשת Thread.
`otNetDataPublishExternalRoute(otInstance aInstance, const otExternalRouteConfig aConfig)`	`otError` הפונקציה הזו מבקשת לפרסם קידומת נתיב חיצונית בנתונים של Thread Network.
`otNetDataPublishOnMeshPrefix(otInstance aInstance, const otBorderRouterConfig aConfig)`	`otError` הפונקציה הזו מבקשת לפרסם קידומת ברשת עבור נתוני הרשת של Thread.
`otNetDataReplacePublishedExternalRoute(otInstance aInstance, const otIp6Prefix aPrefix, const otExternalRouteConfig *aConfig)`	`otError` הפונקציה הזו מחליפה נתיב חיצוני שפורסם בעבר בנתוני הרשת של Thread.
`otNetDataResetMaxLength(otInstance *aInstance)`	`void` איפוס של משך הזמן המקסימלי של נתוני הרשת בשרשור שבמעקב.
`otNetDataSetDnsSrpServicePublisherCallback(otInstance aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void aContext)`	`void` הפונקציה הזו מחזירה קריאה חוזרת כדי להודיע כש'שירות DNS/SRP' מתפרסם בפועל, או כשהוא מתווסף לנתוני הרשת של Thread.
`otNetDataSetPrefixPublisherCallback(otInstance aInstance, otNetDataPrefixPublisherCallback aCallback, void aContext)`	`void` הפונקציה הזו מחזירה קריאה חוזרת כדי להודיע כשמתבצעת הוספה או הסרה של רשומת קידומת שפורסמה מנתוני רשת Thread.
`otNetDataSteeringDataCheckJoiner(otInstance aInstance, const otExtAddress aEui64)`	`otError` כדאי לבדוק אם נתוני ההיגוי כוללים רכיב חיבור.
`otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance aInstance, const struct otJoinerDiscerner aDiscerner)`	`otError` כדאי לבדוק אם נתוני ההיגוי כוללים חיבור עם ערך סקנדר נתון.
`otNetDataUnpublishDnsSrpService(otInstance *aInstance)`	`void` מבטל את הפרסום של כל ערך שירות DNS/SRP (Everycast או Unicast) שנוסף בעבר מנתוני רשת Thread.
`otNetDataUnpublishPrefix(otInstance aInstance, const otIp6Prefix aPrefix)`	`otError` ביטול הפרסום של מהדורה קודמת ברשת שכבר קיימת או קידומת של נתיב חיצוני.
`otThreadBecomeChild(otInstance *aInstance)`	`otError` מנסים לצרף את הסרטון מחדש כילד.
`otThreadBecomeDetached(otInstance *aInstance)`	`otError` התנתקות מרשת Thread.
`otThreadDetachGracefully(otInstance aInstance, otDetachGracefullyCallback aCallback, void aContext)`	`otError` הפונקציה שולחת הודעה לצמתים אחרים ברשת (אם יש כאלה), ומפסיקה את פעולת הפרוטוקול Thread.
`otThreadDeviceRoleToString(otDeviceRole aRole)`	`const char *` המרת תפקיד המכשיר למחרוזת שניתנת לקריאה על ידי אנשים.
`otThreadDiscover(otInstance aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void aCallbackContext)`	`otError` הפונקציה הזו מפעילה סריקה של פרוטוקול Thread Discovery.
`otThreadGetChildTimeout(otInstance *aInstance)`	`uint32_t` הצגת הזמן הקצוב לתפוגת הצאצא של השרשור (בשניות) המשמש בתפקיד 'ילד'.
`otThreadGetDeviceRole(otInstance *aInstance)`	`otDeviceRole` קבלת תפקיד המכשיר.
`otThreadGetDomainName(otInstance *aInstance)`	`const char *` קבלת שם הדומיין של השרשור.
`otThreadGetExtendedPanId(otInstance *aInstance)`	`const otExtendedPanId *` מקבל מזהה PAN מורחב של IEEE 802.15.4.
`otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)`	`const otIp6InterfaceIdentifier *` קבלת מזהה הממשק שצוין באופן ידני עבור כתובת Unicast של דומיין השרשור.
`otThreadGetIp6Counters(otInstance *aInstance)`	`const otIpCounters *` קבלת מונים של IPv6.
`otThreadGetKeySequenceCounter(otInstance *aInstance)`	`uint32_t` מקבל את thrKeyFrequencyCounter.
`otThreadGetKeySwitchGuardTime(otInstance *aInstance)`	`uint32_t` מתקבל thrKeySwitchGuardTime (בשעות).
`otThreadGetLeaderData(otInstance aInstance, otLeaderData aLeaderData)`	`otError` הפונקציה הזו מקבלת את הנתונים של מוביל השרשור.
`otThreadGetLeaderRloc(otInstance aInstance, otIp6Address aLeaderRloc)`	`otError` הפונקציה הזו מחזירה מצביע אל RLOC של המנהיג.
`otThreadGetLeaderRouterId(otInstance *aInstance)`	`uint8_t` לקבלת מזהה הנתב של המנהיג.
`otThreadGetLeaderWeight(otInstance *aInstance)`	`uint8_t` מורידים את המשקל של המנהיג.
`otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)`	`const otIp6Address *` מקבל את כתובת ה-Multicast של צמתים של Thread Link-Local.
`otThreadGetLinkLocalIp6Address(otInstance *aInstance)`	`const otIp6Address *` קבלת כתובת ה-IPv6 המקומית של קישור Thread.
`otThreadGetLinkMode(otInstance *aInstance)`	`otLinkModeConfig` הגדרה של מצב קישור MLE.
`otThreadGetMeshLocalEid(otInstance *aInstance)`	`const otIp6Address *` מקבלת את כתובת ה-EID של הרשת המקומית.
`otThreadGetMeshLocalPrefix(otInstance *aInstance)`	`const otMeshLocalPrefix *` הפונקציה הזו מחזירה קידומת לקידומת 'Mesh Local'.
`otThreadGetMleCounters(otInstance *aInstance)`	`const otMleCounters *` מקבל את המונים של Thread MLE.
`otThreadGetNetworkKey(otInstance aInstance, otNetworkKey aNetworkKey)`	`void` עכשיו אפשר לקבל את מפתח הרשת של Thread.
`otThreadGetNetworkKeyRef(otInstance *aInstance)`	`otNetworkKeyRef` רוצה לקבל את `otNetworkKeyRef` למפתח הרשת של Thread?
`otThreadGetNetworkName(otInstance *aInstance)`	`const char *` קבלת השם של Thread Network.
`otThreadGetNextDiagnosticTlv(const otMessage aMessage, otNetworkDiagIterator aIterator, otNetworkDiagTlv *aNetworkDiagTlv)`	`otError` הפונקציה הזו מקבלת את ה-TLV הבא של אבחון הרשת בהודעה.
`otThreadGetNextNeighborInfo(otInstance aInstance, otNeighborInfoIterator aIterator, otNeighborInfo *aInfo)`	`otError` הפונקציה הזו מקבלת את השכן הבא.
`otThreadGetParentAverageRssi(otInstance aInstance, int8_t aParentRssi)`	`otError` הפונקציה מאחזרת את ה-RSSI הממוצע עבור Thread ההורה.
`otThreadGetParentInfo(otInstance aInstance, otRouterInfo aParentInfo)`	`otError` הפונקציה מאחזרת פרטי אבחון של נתב Thread בתור הורה.
`otThreadGetParentLastRssi(otInstance aInstance, int8_t aLastRssi)`	`otError` הפונקציה מאחזרת את ה-RSSI של החבילה האחרונה מ-Thread ההורה.
`otThreadGetPartitionId(otInstance *aInstance)`	`uint32_t` מוצאים את מזהה המחיצה.
`otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)`	`const otIp6Address *` קבלת כתובת ה-Multicast של Thread Realm-Local All Thread Nodes.
`otThreadGetRloc(otInstance *aInstance)`	`const otIp6Address *` מקבלים את הכתובת של איתור השרשורים (RLOC).
`otThreadGetRloc16(otInstance *aInstance)`	`uint16_t` משיגים את RLOC16.
`otThreadGetServiceAloc(otInstance aInstance, uint8_t aServiceId, otIp6Address aServiceAloc)`	`otError` הפונקציה הזו מאחזרת את ה-ALOC של השירות עבור מזהה השירות הנתון.
`otThreadGetVendorModel(otInstance *aInstance)`	`const char *` מקבלים את המחרוזת של מודל הספק.
`otThreadGetVendorName(otInstance *aInstance)`	`const char *` לקבלת המחרוזת של שם הספק.
`otThreadGetVendorSwVersion(otInstance *aInstance)`	`const char *` יש לקבל את מחרוזת הגרסה של הספק.
`otThreadGetVersion(void)`	`uint16_t` הפונקציה הזו מקבלת את גרסת הפרוטוקול Thread.
`otThreadIsAnycastLocateInProgress(otInstance *aInstance)`	`bool` הפונקציה הזו מציינת אם מתבצעת כעת בקשת מיקום מסוג anycast.
`otThreadIsDiscoverInProgress(otInstance *aInstance)`	`bool` הפונקציה הזו קובעת אם מתבצעת כרגע סריקת שרשורים של MLE.
`otThreadIsSingleton(otInstance *aInstance)`	`bool` פונקציה זו מציינת אם צומת הוא הנתב היחיד ברשת.
`otThreadLocateAnycastDestination(otInstance aInstance, const otIp6Address aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)`	`otError` הפונקציה מבקשת את איתור היעד הקרוב ביותר של כתובת anycast נתונה.
`otThreadRegisterParentResponseCallback(otInstance aInstance, otThreadParentResponseCallback aCallback, void aContext)`	`void` הפונקציה הזו מתעדת קריאה חוזרת לקבלת נתוני תגובת הורה של MLE.
`otThreadResetIp6Counters(otInstance *aInstance)`	`void` מאפסת את המונים של IPv6.
`otThreadResetMleCounters(otInstance *aInstance)`	`void` איפוס המונים של Thread MLE.
`otThreadSearchForBetterParent(otInstance *aInstance)`	`otError` מתחיל את התהליך שבו ילדים יכולים לחפש הורה טוב יותר ועדיין לשמור על קשר להורה הנוכחי שלהם.
`otThreadSendAddressNotification(otInstance aInstance, otIp6Address aDestination, otIp6Address aTarget, otIp6InterfaceIdentifier aMlIid)`	`void` הפונקציה הזו שולחת הודעה יזומה של כתובת (optout_NTF.ntf).
`otThreadSendDiagnosticGet(otInstance aInstance, const otIp6Address aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)`	`otError` שליחת בקשה לקבלת אבחון רשת.
`otThreadSendDiagnosticReset(otInstance aInstance, const otIp6Address aDestination, const uint8_t aTlvTypes[], uint8_t aCount)`	`otError` שליחת בקשה לאיפוס של אבחון הרשת.
`otThreadSendProactiveBackboneNotification(otInstance aInstance, otIp6Address aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)`	`otError` הפונקציה הזו שולחת הודעה יזומה של עמוד שדרה (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)`	`otError` מגדיר את שם הדומיין של השרשור.
`otThreadSetEnabled(otInstance *aInstance, bool aEnabled)`	`otError` הפונקציה הזו מתחילה את הפעולה של פרוטוקול Thread.
`otThreadSetExtendedPanId(otInstance aInstance, const otExtendedPanId aExtendedPanId)`	`otError` מגדיר את מזהה ה-PAN המורחב של IEEE 802.15.4.
`otThreadSetFixedDuaInterfaceIdentifier(otInstance aInstance, const otIp6InterfaceIdentifier aIid)`	`otError` מגדיר או מנקה את מזהה הממשק שצוין ידנית עבור כתובת Unicast של דומיין השרשור.
`otThreadSetJoinerAdvertisement(otInstance aInstance, uint32_t aOui, const uint8_t aAdvData, uint8_t aAdvDataLength)`	`otError` השיטה הזו מגדירה את הפרסומת של Threading כשמשתמשים בזיהוי רשת Thread.
`otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)`	`void` מגדירה את thrKeyFrequencyCounter.
`otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)`	`void` המדיניות הזו מגדירה את thrKeySwitchGuardTime (בשעות).
`otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)`	`otError` קביעת התצורה של מצב קישור MLE.
`otThreadSetMeshLocalPrefix(otInstance aInstance, const otMeshLocalPrefix aMeshLocalPrefix)`	`otError` הפונקציה הזו מגדירה את הקידומת של Mesh Local.
`otThreadSetNetworkKey(otInstance aInstance, const otNetworkKey aKey)`	`otError` מגדירים את מפתח הרשת של Thread.
`otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)`	`otError` הגדרת מפתח הרשת לשרשור כ-`otNetworkKeyRef`.
`otThreadSetNetworkName(otInstance aInstance, const char aNetworkName)`	`otError` בחירת שם לרשת השרשורים.
`otThreadSetVendorModel(otInstance aInstance, const char aVendorModel)`	`otError` מגדירים את מחרוזת הדגם של הספק.
`otThreadSetVendorName(otInstance aInstance, const char aVendorName)`	`otError` מגדירים את המחרוזת של שם הספק.
`otThreadSetVendorSwVersion(otInstance aInstance, const char aVendorSwVersion)`	`otError` מגדירים את המחרוזת של גרסת התוכנה של הספק.

מבנים
otBorderRouterConfig	המבנה הזה מייצג תצורה של נתב גבול.
otExternalRouteConfig	המבנה הזה מייצג הגדרה של מסלול חיצוני.
otIpCounters	המבנה הזה מייצג את המונים ברמת ה-IP.
otLeaderData	המבנה הזה מייצג את נתוני השרשורים המובילים.
otLinkModeConfig	המבנה הזה מייצג תצורה של מצב קישור MLE.
otLowpanContextInfo	המבנה הזה מייצג מידע על מזהה הקשר של 6LoWPAN שמשויך לקידומת בנתוני הרשת.
otMleCounters	המבנה הזה מייצג את המונים של Thread MLE.
otNeighborInfo	המבנה הזה מכיל פרטי אבחון של צומת Thread סמוך.
otNetworkDiagChildEntry	המבנה הזה מייצג רשומה בטבלה של ניתוחי ילדים.
otNetworkDiagConnectivity	המבנה הזה מייצג ערך של קישוריות אבחון רשת.
otNetworkDiagMacCounters	המבנה הזה מייצג ערך של מונה Mac של אבחון הרשת.
otNetworkDiagRoute	המבנה הזה מייצג ערך TLV של מסלול האבחון של הרשת.
otNetworkDiagRouteData	המבנה הזה מייצג נתונים של מסלול ניתוח הרשת.
otNetworkDiagTlv	המבנה הזה מייצג TLV של אבחון הרשת.
otRouterInfo	המבנה הזה מכיל פרטי אבחון של נתב שרשור.
otServerConfig	המבנה הזה מייצג הגדרה של שרת.
otServiceConfig	המבנה הזה מייצג הגדרת שירות.
otThreadDiscoveryRequestInfo	המבנה הזה מייצג את הנתונים של בקשות השרשור ב-Discovery.
otThreadParentResponseInfo	המבנה הזה מייצג את נתוני תגובת ההורה של MLE.

מספור

טיפוס אנונימי

 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 מורחבת של TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST`	רשימת כתובות IPv6 של TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA`	TLV Data Leader.
`OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS`	TLV נגדי MAC.
`OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT`	הערך המקסימלי של זמן קצוב לתפוגה של הילד או הילדה הוא TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_MODE`	מצב TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA`	TLV לנתוני רשת.
`OT_NETWORK_DIAGNOSTIC_TLV_ROUTE`	כביש 64 TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS`	כתובת16 TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE`	מתח אספקה (TLV).
`OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION`	גרסת TLV בערימת שרשור.
`OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT`	זמן קצוב לתפוגה של TLV (תקופת הזמן המקסימלית לקלפי)
`OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST`	יש להקליד TLV ברשימה.
`OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL`	ספק: TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME`	שם הספק TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION`	הספק SW גרסה TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_VERSION`	גרסה TLV.

OTDeviceRole

 otDeviceRole

תפקיד המשתמש ב-Thread.

נכסים
`OT_DEVICE_ROLE_CHILD`	תפקיד השרשור של הצאצא.
`OT_DEVICE_ROLE_DETACHED`	לא משתתפים כרגע ברשת או בשרשור של Thread.
`OT_DEVICE_ROLE_DISABLED`	סטאק השרשורים מושבת.
`OT_DEVICE_ROLE_LEADER`	התפקיד של מוביל השרשור.
`OT_DEVICE_ROLE_ROUTER`	התפקיד של נתב השרשורים.

otNetDataPublisherEvent

 otNetDataPublisherEvent

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

נכסים
`OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED`	רשומה שפורסמה נוספה לנתונים בשרשור.
`OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED`	הרשומה שפורסמה תוסר מהנתונים של Thread Network.

otRouteהעדפות

 otRoutePreference

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

נכסים
`OT_ROUTE_PREFERENCE_HIGH`	העדפה למסלול גבוה.
`OT_ROUTE_PREFERENCE_LOW`	העדפה למסלול נמוך.
`OT_ROUTE_PREFERENCE_MED`	עדיפות למסלול בינוני.

סוג שגיאות

OTBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

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

otDetachGracefulCallback

void(* otDetachGracefullyCallback)(void *aContext)

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

פרטים

פרמטרים

[in] aContext

הצבעה על הקשר ספציפי לאפליקציה.

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

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

otIpCounters

struct otIpCounters otIpCounters

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

otLeaderData

struct otLeaderData otLeaderData

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

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

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

OTLowpanContextInfo

struct otLowpanContextInfo otLowpanContextInfo

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

otMleCounters

struct otMleCounters otMleCounters

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

otNeighborInfoIterator

int16_t otNeighborInfoIterator

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

otNetDataDnsSrpServicePublisherCallback

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

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

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

פרטים

פרמטרים

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

otNetDataPrefixPublisherCallback

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

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

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

פרטים

פרמטרים

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

otNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

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

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

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

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`	הצבעה על הקשר ספציפי לאפליקציה.

otRouteהעדפות

enum otRoutePreference otRoutePreference

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

otServerConfig

struct otServerConfig otServerConfig

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

otServiceConfig

struct otServiceConfig otServiceConfig

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

otThreadEverycastLocatorCallback

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

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

פרטים

פרמטרים

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

otThreadDiscoveryRequestCallback

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

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

פרטים

פרמטרים

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

פרוטוקול OTThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

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

otThreadParentResponseCallback

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

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

השם הזה בשימוש בחשבון otThreadRegisterParentResponseCallback().

פרטים

פרמטרים

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

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

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

פונקציות

otConvertDurationInSecondsToString

void otConvertDurationInSecondsToString(
  uint32_t aDuration,
  char *aBuffer,
  uint16_t aSize
)

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

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

המחרוזת בנויה בפורמט "::" עבור שעות, דקות, שניות (אם משך הזמן קצר מיום אחד) או "

ד.::" (אם הוא נמשך יותר מיום אחד).

אם המחרוזת שתתקבל לא תתאים לערך aBuffer (ב-aSize התווים שלה), המחרוזת תיחתך, אבל המחרוזת שהפלטה תמיד תסתיים ב-null.

הפונקציה הזו מיועדת לשימוש ב-mAge או ב-mConnectionTime במבנים ב-otNeighborInfo או ב-otChildInfo.

פרטים

פרמטרים

`[in] aDuration`	מרווח זמן בשניות.
`[out] aBuffer`	מצביעים למערך תווים כדי ליצור פלט של המחרוזת.
`[in] aSize`	הגודל של `aBuffer` (בבייטים). מומלץ להשתמש באפליקציה `OT_DURATION_STRING_SIZE`.

otNetDataContainsOmrPrefix

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

בדקו אם קידומת נתונה יכולה לשמש כקידומת OMR תקינה, וגם נתוני הרשת של ה-Leader מכילים את הקידומת הזו.

הערה: ה-API הזה זמין רק כשנעשה שימוש ב-OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aPrefix`	מצביע לקידומת IPv6.

החזרות

אם aPrefix הוא קידומת 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`. בעת היציאה, מספר הבייטים שהועתקו.

ערכי החזרה

`OT_ERROR_NONE`	הנתונים של Thread Network הועתקו בהצלחה אל `aData` ועדכנו את `aDataLength`.
`OT_ERROR_NO_BUFS`	אין מספיק מקום ב`aData` כדי להעתיק את נתוני רשת ה-Thread במלואם.

OTNetDataGetLength

uint8_t otNetDataGetLength(
  otInstance *aInstance
)

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

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

האורך של נתוני הרשת.

OTNetDataGetMaxLength

uint8_t otNetDataGetMaxLength(
  otInstance *aInstance
)

משך הזמן המרבי של נתוני Thread מאז האתחול של OT Stack, או מאז הקריאה האחרונה אל otNetDataResetMaxLength().

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

האורך המקסימלי של נתוני הרשת (סימן מים גבוה לאורך של נתוני הרשת).

otNetDataGetNextLowpanContextInfo

otError otNetDataGetNextLowpanContextInfo(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otLowpanContextInfo *aContextInfo
)

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

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in,out] aIterator`	מצביע אל שרת נתוני הרשת. כדי לקבל את רשומת השירות הראשונה, צריך להגדיר את הערך כ-OT_NETWORK_DATA_ITERATOR_INIT.
`[out] aContextInfo`	מצביע על המיקום שבו יאוחסן המידע של מזהה הקשר 6LoWPAN.

ערכי החזרה

`OT_ERROR_NONE`	נמצאו בהצלחה הפרטים הבאים של 6LoWPAN Context ID.
`OT_ERROR_NOT_FOUND`	אין נתוני הקשר של 6LoWPAN בהקשר של נתוני הרשת של המחיצה.

otNetDataGetNextOnMeshPrefix

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

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

פרטים

פרמטרים

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

ערכי החזרה

`OT_ERROR_NONE`	נמצאה הקידומת הבאה של On Mesh.
`OT_ERROR_NOT_FOUND`	לא קיימת קידומת של Mesh שמופיעה בהמשך בנתוני הרשת של 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`	לא קיימת רשומה חיצונית של נתיב חיצוני בנתונים של Thread Network.

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.

החזרות

גרסת נתוני הרשת

otNetDataIsDnsSrpServiceAdded

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

הפונקציה הזו קובעת אם הערך "שירות DNS/SRP" נוסף לנתוני הרשת של Thread.

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

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

ערכי החזרה

`TRUE`	הרשומה של שירות ה-DNS/SRP שמוסיפים מתווספת לנתוני הרשת של ה-Thread.
`FALSE`	הרשומה לא מתווספת לנתוני הרשת של Thread או שאין רשומה לפרסום.

otNetDataIsPrefixAdded

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

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

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

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aPrefix`	מצביע עם הקידומת (לא יכול להיות NULL).

ערכי החזרה

`TRUE`	הרשומה עם הקידומת של השם נוספה לקטע Thread Network Data.
`FALSE`	הרשומה לא מתווספת לנתוני הרשת של Thread או שאין רשומה לפרסום.

otNetDataPublishDnsSrpServiceEverycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

הפונקציה הזו מבקשת לפרסם את הכתובת "כתובת DNS/SRP של שירות anycast" בנתוני הרשת של Thread.

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

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

פרטים

פרמטרים

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

otNetDataPublishDnsSrpServiceUnicast

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

הפונקציה הזו מבקשת לפרסם את 'כתובת Unicast של DNS/SRP' בנתונים של רשת Thread.

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

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

פרטים

פרמטרים

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

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

הפונקציה הזו מבקשת לפרסם את 'כתובת Unicast של DNS/SRP' בנתונים של רשת Thread.

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

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

פרטים

פרמטרים

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

otNetDataPublishExternalRoute

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

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

כדי להשתמש בפונקציה הזו צריך להפעיל את התכונה 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`.

otNetDataReplaceExternalRoute

otError otNetDataReplacePublishedExternalRoute(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix,
  const otExternalRouteConfig *aConfig
)

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

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

אם לא פורסם מסלול חיצוני שתואם ל-aPrefix, הפונקציה הזו תפעל בדומה ל-otNetDataPublishExternalRoute(), כלומר היא תתחיל בתהליך פרסום של aConfig כמסלול חיצוני בנתונים של Thread Network.

אם קיים ערך מסלול שפורסם בעבר שתואם ל-aPrefix, הוא יוחלף בקידומת החדשה מ-aConfig.

אם העמודה aPrefix כבר נוספה בנתוני הרשת, השינוי בקידומת החדשה ב-aConfig משתקף מיד בנתוני הרשת. כך ניתן לוודא שרשומות של נתיב בנתוני הרשת לא יוסרו בפתאומיות ושהמעבר מ-aprefix לקידומת החדשה יהיה חלק.
אם aPrefix הישנה שפורסמה לא נוספה לנתוני הרשת, היא תוחלף בקידומת החדשה aConfig, אך לא תתווסף מיידית. במקום זאת, התהליך יתחיל בתהליך הפרסום שלו בנתוני הרשת (מעקב אחר נתוני הרשת כדי לקבוע מתי/אם להוסיף את הקידומת, בהתאם למספר הקידומות המקבילות בנתוני הרשת).

פרטים

פרמטרים

`[in] aPrefix`	הקידומת החיצונית של הנתיב החיצוני שכבר פורסמה במקום.
`[in] aConfig`	הגדרת הנתיב החיצוני לפרסום.
`[in] aRequester`	המבקש (מודול `kFromUser` או `kFromRoutingManager`).

ערכי החזרה

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

OTNetDataResetMaxLength

void otNetDataResetMaxLength(
  otInstance *aInstance
)

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

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

למידע נוסף:
otNetDataGetMaxLength

otNetDataSetDnsSrpServicePublisherCallback

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

הפונקציה הזו מחזירה קריאה חוזרת כדי להודיע כש'שירות DNS/SRP' מתפרסם בפועל, או כשהוא מתווסף לנתוני הרשת של Thread.

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

כדי להשתמש בפונקציה הזו צריך להפעיל את התכונה 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` מופעל).

otNetDataSteeringDataCheckJOINer

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
)

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

פרטים

פרמטרים

`[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 (Everycast או Unicast) שנוסף בעבר מנתוני רשת Thread.

חייבים להפעיל את 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`	הקידומת לביטול הפרסום (חייבת להיות NULL).

ערכי החזרה

`OT_ERROR_NONE`	בוטל הפרסום של הקידומת.
`OT_ERROR_NOT_FOUND`	הקידומת לא נמצאה ברשימה שפורסמה.

פרוטוקול otThreadchild

otError otThreadBecomeChild(
  otInstance *aInstance
)

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

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

ערכי החזרה

`OT_ERROR_NONE`	הניסיון להפוך לילד או לילדה הצליח.
`OT_ERROR_INVALID_STATE`	השרשור מושבת.

פרוטוקול OTThread DeDetach

otError otThreadBecomeDetached(
  otInstance *aInstance
)

התנתקות מרשת Thread.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

ערכי החזרה

`OT_ERROR_NONE`	התנתקת בהצלחה מהרשת של Thread.
`OT_ERROR_INVALID_STATE`	השרשור מושבת.

otThreadDetachGraceful

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

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

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

פרטים

פרמטרים

`[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`	הערך של ה-Flager של ההצטרפות ב-TLV של בקשת הגילוי.
`[in] aEnableEui64Filtering`	הערך TRUE כדי לסנן תגובות ב-EUI-64, אחרת FALSE.
`[in] aCallback`	המצביע אל פונקציה שנקראת קבלת תגובת MLE Discovery או הסריקה מסתיימת.
`[in] aCallbackContext`	הצבעה על הקשר ספציפי לאפליקציה.

ערכי החזרה

`OT_ERROR_NONE`	הסריקה של חיפוש השרשורים התחילה.
`OT_ERROR_INVALID_STATE`	ממשק ה-IPv6 אינו מופעל (ifif לא פועל).
`OT_ERROR_NO_BUFS`	לא ניתן להקצות הודעה לבקשת Discovery.
`OT_ERROR_BUSY`	סריקת הסריקה של Thread כבר מתבצעת.

פרוטוקול OTThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

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

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

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

למידע נוסף:
otThreadSetChildTimeout

פרוטוקול OTGetGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

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

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

ערכי החזרה

`OT_DEVICE_ROLE_DISABLED`	סטאק השרשורים מושבת.
`OT_DEVICE_ROLE_DETACHED`	המכשיר לא משתתף כרגע ברשת/מחיצה ברשת Thread.
`OT_DEVICE_ROLE_CHILD`	המכשיר פועל כצאצא של שרשור.
`OT_DEVICE_ROLE_ROUTER`	המכשיר פועל כרגע כנתב שרשור.
`OT_DEVICE_ROLE_LEADER`	נכון לעכשיו המכשיר פועל כמנהיג שרשורים.

פרוטוקול OTThreadGet

const char * otThreadGetDomainName(
  otInstance *aInstance
)

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

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

מצביעים על שם הדומיין של השרשור.

למידע נוסף:
otThreadSetSSL

OTThreadGetExpandPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

מקבל מזהה PAN מורחב של IEEE 802.15.4.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

מצביע למזהה IEEE 802.15.4 המורחב של תבניות PAN.

למידע נוסף:
otThreadSetExpandPanId

OTThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

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

זמין כש-OPENTHREAD_CONFIG_DUA_ENABLE מופעל.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

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

למידע נוסף:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

קבלת מונים של IPv6.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

מצביע על המונים של IPv6.

otThreadGetKeyFrequencyCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

מקבל את thrKeyFrequencyCounter.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

הערך של thrKeyFrequencyCounter.

למידע נוסף:
otThreadSetKeyFrequencyCounter

פרוטוקול 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
)

מקבל את כתובת ה-Multicast של צמתים של Thread Link-Local.

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

מספר הנ"ל מוגדר ל-3 (P = 1 ו-T = 1)
החיתוך מוגדר ל-2
plen, מוגדר ל-64
קידומת רשת שהוגדרה לקידומת Mesh מקומית
מזהה הקבוצה מוגדר ל-1

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

מצביע לכתובת של מספר שרשורים ב-Local Link Thread

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

קבלת כתובת ה-IPv6 המקומית של קישור Thread.

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

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

מצביע לכתובת Thread של קישור IPv6 מקומי.

פרוטוקול OTGetGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

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

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

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

מידע נוסף:
otThreadSetLinkMode

פרוטוקול OTThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

מקבלת את כתובת ה-EID של הרשת המקומית.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

מצביעים על כתובת ה-EID של הרשת המקומית.

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

הפונקציה הזו מחזירה קידומת לקידומת 'Mesh Local'.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

מצביע אל הקידומת המקומית של Mesh.

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

מקבל את המונים של Thread MLE.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

מצביע על המונים של Thread MLE.

מפתח OTGetGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

עכשיו אפשר לקבל את מפתח הרשת של Thread.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[out] aNetworkKey`	מצביע אל `otNetworkKey` כדי להחזיר את מפתח הרשת של Thread.

מידע נוסף:
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
)

קבלת השם של Thread Network.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

מצביעים על השם של שרשור הרשת.

למידע נוסף:
otThreadSetNetworkName

otThreadGetNextDiagnosticTlv

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

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

נדרשת גרסה OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

קריאה נוספת לפונקציה הזו מותרת רק כאשר ערך ההחזרה הנוכחי הוא 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.

otThreadGetParentParentRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

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

פרטים

פרמטרים

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

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

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

פרטים

פרמטרים

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

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

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

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[out] aLastRssi`	מצביע למיקום שבו יש להציב את ה-RSSI האחרון.

ערכי החזרה

`OT_ERROR_NONE`	נתוני ה-RSSI אוחזרו בהצלחה.
`OT_ERROR_FAILED`	לא ניתן לקבל נתוני RSSI.
`OT_ERROR_INVALID_ARGS`	`aLastRssi` הוא NULL.

OTThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

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

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

מזהה המחיצה.

otThreadGetmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

קבלת כתובת ה-Multicast של Thread Realm-Local All Thread Nodes.

הכתובת היא Unmcast local-fix Multifix-based Multicast address [RFC 3306], עם:

מספר הנ"ל מוגדר ל-3 (P = 1 ו-T = 1)
סקול מוגדר ל-3
plen, מוגדר ל-64
קידומת רשת שהוגדרה לקידומת Mesh מקומית
מזהה הקבוצה מוגדר ל-1

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

מצביע לכתובת של מספר שרשורים ב-thread Realm-Local All Thread.

פרוטוקול OTGetGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

מקבלים את הכתובת של איתור השרשורים (RLOC).

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

מצביע אל הכתובת של שרשור הניתוב (RLOC).

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

משיגים את RLOC16.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

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`	ממשק השרשור לא מחובר כרגע למחיצת שרשור.

מודל מודל otThreadGetProvider

const char * otThreadGetVendorModel(
  otInstance *aInstance
)

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

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

המחרוזת של מודל הספק.

otThreadGetהספקName

const char * otThreadGetVendorName(
  otInstance *aInstance
)

לקבלת המחרוזת של שם הספק.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

המחרוזת של שם הספק.

פרוטוקול OTThreadGetProvideSwVersion

const char * otThreadGetVendorSwVersion(
  otInstance *aInstance
)

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

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

המחרוזת הועברה על ידי הספק.

פרוטוקול otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

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

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

otThreadIsEverycastSpotInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

הפונקציה הזו מציינת אם מתבצעת כעת בקשת מיקום מסוג anycast.

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

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

TRUE אם בקשת איתור anycast נמצאת כעת בתהליך, FALSE אחרת.

פרוטוקול OTThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

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

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

פרוטוקול OotIsIstonton

bool otThreadIsSingleton(
  otInstance *aInstance
)

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

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

ערכי החזרה

`TRUE`	זהו הנתב היחיד ברשת.
`FALSE`	זהו ילד או נתב יחיד ברשת.

otThreadLocationsEverycastDestination

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

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

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

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

פרטים

פרמטרים

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

ערכי החזרה

`OT_ERROR_NONE`	הבקשה התחילה בהצלחה. התכונה `aCallback` תופעל כדי לדווח על התוצאה.
`OT_ERROR_INVALID_ARGS`	הערך `aAnycastAddress` אינו כתובת תקינה ב- anycast או ש-`aCallback` הוא NULL.
`OT_ERROR_NO_BUFS`	מחוץ לאחסון הזמני כדי להכין ולשלוח את הודעת הבקשה.

otThreadRegisterParentResponseCallback

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

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

לפונקציה הזו נדרש OPENTHREAD_CONFIG_MLE_PARENT_RESPONSE_CALLBACK_API_ENABLE.

פרטים

פרמטרים

`[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.

otThreadSearchForBetterParent

otError otThreadSearchForBetterParent(
  otInstance *aInstance
)

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

חובה להשתמש כשהמכשיר מחובר כילד.

פרטים

ערכי החזרה

`OT_ERROR_NONE`	התהליך התחיל בחיפוש הורה טוב יותר.
`OT_ERROR_INVALID_STATE`	תפקיד המכשיר הוא לא צאצא.

פרוטוקול OTThreadSendAddressNotification

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

הפונקציה הזו שולחת הודעה יזומה של כתובת (optout_NTF.ntf).

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

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aDestination`	היעד לשליחת ההודעה nowrap_NTF.ntf.
`[in] aTarget`	כתובת היעד של ההודעה optout_NTF.ntf.
`[in] aMlIid`	ML-IID של ההודעה optout_NTF.ntf.

otThreadSendDiagnosticGet

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

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

נדרשת גרסה OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aDestination`	מצביע אל כתובת היעד.
`[in] aTlvTypes`	מגוון סוגי TLV של אבחון רשת.
`[in] aCount`	מספר הסוגים ב-aTlTypes.
`[in] aCallback`	המצביע על פונקציה שנקראת כאשר מתקבלת תגובה של 'אבחון רשת' או NULL כדי להשבית את הקריאה החוזרת.
`[in] aCallbackContext`	הצבעה על הקשר ספציפי לאפליקציה.

ערכי החזרה

`OT_ERROR_NONE`	התור ב-DIAG_GET.req עבר בהצלחה.
`OT_ERROR_NO_BUFS`	אין מספיק מאגרי נתונים זמניים לשליחת SMS DIAG_GET.req.

otThreadSendDiagnosticReset

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

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

נדרשת גרסה OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

פרטים

פרמטרים

`[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.

otThreadSendProactiveBackboneNotification

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).

פרוטוקול OTThreadSetSSL

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

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

מוצלח רק כשהפרוטוקולים בשרשור מושבתים.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aDomainName`	מצביעים על שם הדומיין של השרשור.

ערכי החזרה

`OT_ERROR_NONE`	שם הדומיין של השרשור הוגדר בהצלחה.
`OT_ERROR_INVALID_STATE`	הפרוטוקולים של השרשורים מופעלים.

למידע נוסף:
otThreadGetSSL

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

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

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

בקריאת הפונקציה הזו כש-aEnabled מוגדר ל-FALSE, כל תהליך הניתוק הרציף מתחיל ב-otThreadDetachGraceful(). הקריאה החוזרת לקריאה שלה.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aEnabled`	TRUE אם ה-Thread מופעל, אחרת FALSE.

ערכי החזרה

`OT_ERROR_NONE`	פעולת פרוטוקול Thread התחילה בהצלחה.
`OT_ERROR_INVALID_STATE`	ממשק הרשת לא היה פעיל.

OTThreadSetExpandPanId

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`	הפרוטוקולים של השרשורים מופעלים.

למידע נוסף:
otThreadGetExpandPanId

otThreadSetFixedDuaInterfaceIdentifier

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

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

זמין כש-OPENTHREAD_CONFIG_DUA_ENABLE מופעל.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aIid`	מצביעים על מזהה הממשק שיש להגדיר או על NULL לניקוי.

ערכי החזרה

`OT_ERROR_NONE`	מזהה/הגדרת הממשק הסתיים בהצלחה.
`OT_ERROR_INVALID_ARGS`	מזהה הממשק שצוין שמור.

למידע נוסף:
otThreadGetFixedDuaInterfaceIdentifier

פרסומת ב-otThreadSetJOINer

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

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

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

פרטים

פרמטרים

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

ערכי החזרה

`OT_ERROR_NONE`	מודעת הצירוף הוגדרה בהצלחה.
`OT_ERROR_INVALID_ARGS`	AdvData לא חוקי.

otThreadSetKeyכאןCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

מגדירה את thrKeyFrequencyCounter.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aKeySequenceCounter`	הערך של thrKeyFrequencyCounter.

למידע נוסף:
otThreadGetKeyFrequencyCounter

פרוטוקול OTThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

המדיניות הזו מגדירה את thrKeySwitchGuardTime (בשעות).

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aKeySwitchGuardTime`	הערך של thrKeySwitchGuardTime (בשעות).

מידע נוסף:
otThreadGetKeySwitchGuardTime

otThreadSetLinkMode

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 Local.

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

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aMeshLocalPrefix`	מצביע אל הקידומת המקומית של Mesh.

ערכי החזרה

`OT_ERROR_NONE`	הגדרת קידומת מקומית של רשת הושלמה בהצלחה.
`OT_ERROR_INVALID_STATE`	הפרוטוקולים של השרשורים מופעלים.

מפתח OTSetSetNetworkKey

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

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

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aKey`	מצביע למאגר נתונים המכיל את מפתח Thread Network.

ערכי החזרה

`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 Network.

ערכי החזרה

`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

מודל OTThreadSetהספק

otError otThreadSetVendorModel(
  otInstance *aInstance,
  const char *aVendorModel
)

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

נדרשת גרסה OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

הערך aVendorModel צריך להיות בקידוד UTF8 באורך מקסימלי של 32 תווים (MAX_VENDOR_MODEL_TLV_LENGTH). האורך המקסימלי לא כולל את התו \0 ריק.

פרטים

פרמטרים

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

ערכי החזרה

`OT_ERROR_NONE`	מודל הספק הוגדר בהצלחה.
`OT_ERROR_INVALID_ARGS`	הערך של `aVendorModel` לא חוקי (ארוך מדי או לא UTF8).

OTThreadSetהספקName

otError otThreadSetVendorName(
  otInstance *aInstance,
  const char *aVendorName
)

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

נדרשת גרסה OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

הערך aVendorName צריך להיות בקידוד UTF8 באורך מקסימלי של 32 תווים (MAX_VENDOR_NAME_TLV_LENGTH). האורך המקסימלי לא כולל את התו \0 ריק.

פרטים

פרמטרים

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

ערכי החזרה

`OT_ERROR_NONE`	שם הספק הוגדר בהצלחה.
`OT_ERROR_INVALID_ARGS`	הערך של `aVendorName` לא חוקי (ארוך מדי או לא UTF8).

פרוטוקול OTThreadSetProvideSwVersion

otError otThreadSetVendorSwVersion(
  otInstance *aInstance,
  const char *aVendorSwVersion
)

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

נדרשת גרסה OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

הערך aVendorSwVersion צריך להיות בקידוד UTF8 באורך מקסימלי של 16 תווים(MAX_VENDOR_SW_VERSION_TLV_LENGTH). האורך המקסימלי לא כולל את התו \0 ריק.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aVendorSwVersion`	המחרוזת של גרסת התוכנה של הספק.

ערכי החזרה

`OT_ERROR_NONE`	הושלמה ההגדרה של גרסת התוכנה של הספק.
`OT_ERROR_INVALID_ARGS`	הערך של `aVendorSwVersion` לא חוקי (ארוך מדי או לא UTF8).

פקודות מאקרו

הארכה DURATION_STRING_SIZE

 OT_DURATION_STRING_SIZE 21

הגודל המומלץ לייצוג מחרוזת של משך uint32_t בשניות.

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_MAX_THREAD_STACK_VERSION_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH 64

האורך המקסימלי של גרסת Stack Stack VTL.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH 32

האורך המקסימלי של דגם הספק TLV.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH 32

האורך המקסימלי של שם הספק TLV.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH 16

האורך המקסימלי של הספק SW גרסה TLV.

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. למידע נוסף או כדי לתרום למסמכי התיעוד שלנו, יש לעיין בקטע משאבים.