संग्रह की मदद से व्यवस्थित रहें अपनी प्राथमिकताओं के आधार पर, कॉन्टेंट को सेव करें और कैटगरी में बांटें.

इंस्टेंस

इस मॉड्यूल में ऐसे फ़ंक्शन शामिल हैं जो OpenThread इंस्टेंस को कंट्रोल करते हैं.

खास जानकारी

इन्यूरेशन

anonymous enum{
  OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0,
  OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1,
  OT_CHANGED_THREAD_ROLE = 1 << 2,
  OT_CHANGED_THREAD_LL_ADDR = 1 << 3,
  OT_CHANGED_THREAD_ML_ADDR = 1 << 4,
  OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5,
  OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6,
  OT_CHANGED_THREAD_PARTITION_ID = 1 << 7,
  OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8,
  OT_CHANGED_THREAD_NETDATA = 1 << 9,
  OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10,
  OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11,
  OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12,
  OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13,
  OT_CHANGED_THREAD_CHANNEL = 1 << 14,
  OT_CHANGED_THREAD_PANID = 1 << 15,
  OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16,
  OT_CHANGED_THREAD_EXT_PANID = 1 << 17,
  OT_CHANGED_NETWORK_KEY = 1 << 18,
  OT_CHANGED_PSKC = 1 << 19,
  OT_CHANGED_SECURITY_POLICY = 1 << 20,
  OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21,
  OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22,
  OT_CHANGED_COMMISSIONER_STATE = 1 << 23,
  OT_CHANGED_THREAD_NETIF_STATE = 1 << 24,
  OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25,
  OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26,
  OT_CHANGED_JOINER_STATE = 1 << 27,
  OT_CHANGED_ACTIVE_DATASET = 1 << 28,
  OT_CHANGED_PENDING_DATASET = 1 << 29
}
enum
यह गिनती, उन फ़्लैग के बारे में बताती है जिन्हें otStateChangedCallback के हिस्से के तौर पर पास किया गया है.

टाइप आईडी

otChangedFlags टाइपडेफ़
uint32_t
यह टाइप, किसी बिट-फ़ील्ड को दिखाता है जो किसी खास स्थिति/कॉन्फ़िगरेशन को बदलता है.
otInstance टाइपडेफ़
struct otInstance
यह स्ट्रक्चर, OpenThread इंस्टेंस स्ट्रक्चर को दिखाता है.
otStateChangedCallback)(otChangedFlags aFlags, void *aContext) टाइपडेफ़
void(*
फ़ंक्शन फ़ंक्शन को OpenThread में कुछ कॉन्फ़िगरेशन या स्थिति के बदलावों के बारे में बताने के लिए कॉल किया जाता है.

फ़ंक्शन

otGetRadioVersionString(otInstance *aInstance)
const char *
यह फ़ंक्शन OpenThread रेडियो वर्शन स्ट्रिंग लेता है.
otGetVersionString(void)
const char *
यह फ़ंक्शन OpenThread वर्शन स्ट्रिंग लेता है.
otInstanceErasePersistentInfo(otInstance *aInstance)
यह फ़ंक्शन, अस्थिर वैल्यू वाली मेमोरी पर सेव की गई सभी OpenThread स्थायी जानकारी (नेटवर्क सेटिंग) को मिटा देता है.
otInstanceFactoryReset(otInstance *aInstance)
void
बार-बार अपडेट न होने वाली मेमोरी की सेव की गई सभी सेटिंग मिट जाती हैं. इसके बाद, प्लैटफ़ॉर्म रीसेट हो जाता है.
otInstanceFinalize(otInstance *aInstance)
void
यह फ़ंक्शन OpenThread लाइब्रेरी को बंद कर देता है.
otInstanceGetUptime(otInstance *aInstance)
uint64_t
यह फ़ंक्शन मौजूदा इंस्टेंस अपटाइम (msec में) दिखाता है.
otInstanceGetUptimeAsString(otInstance *aInstance, char *aBuffer, uint16_t aSize)
void
यह फ़ंक्शन मौजूदा इंस्टेंस अपटाइम को लोगों की ओर से पढ़ने लायक स्ट्रिंग के रूप में दिखाता है.
otInstanceInit(void *aInstanceBuffer, size_t *aInstanceBufferSize)
यह फ़ंक्शन OpenThread लाइब्रेरी को शुरू करता है.
otInstanceInitSingle(void)
यह फ़ंक्शन OpenThread लाइब्रेरी के स्टैटिक सिंगल इंस्टेंस की शुरुआत करता है.
otInstanceIsInitialized(otInstance *aInstance)
bool
यह फ़ंक्शन बताता है कि इंस्टेंस मान्य है या नहीं.
otInstanceReset(otInstance *aInstance)
void
इस तरीके से प्लैटफ़ॉर्म रीसेट हो जाता है.
otInstanceResetRadioStack(otInstance *aInstance)
void
यह तरीका, OpenThread रेडियो स्टैक के अंदरूनी स्टेटस को रीसेट करता है.
otRemoveStateChangeCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
void
यह फ़ंक्शन, कॉलबैक को हटाता है. इससे पता चलता है कि OpenThread में कोई खास कॉन्फ़िगरेशन या स्थिति कब बदलती है.
otSetStateChangedCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
यह फ़ंक्शन, कॉलबैक को रजिस्टर करता है, ताकि OpenThread में किसी खास कॉन्फ़िगरेशन या स्थिति में बदलाव होने पर दिखाया जा सके.

इन्यूरेशन

अनाम

 anonymous enum

यह गिनती, उन फ़्लैग के बारे में बताती है जिन्हें otStateChangedCallback के हिस्से के तौर पर पास किया गया है.

प्रॉपर्टी
OT_CHANGED_ACTIVE_DATASET

चालू ऑपरेशनल डेटासेट बदला गया.

OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL

चैनल मैनेजर के नए लंबित थ्रेड चैनल को बदला गया.

OT_CHANGED_COMMISSIONER_STATE

कमिश्नर की स्थिति बदली गई.

OT_CHANGED_IP6_ADDRESS_ADDED

IPv6 पता जोड़ा गया.

OT_CHANGED_IP6_ADDRESS_REMOVED

IPv6 पता हटा दिया गया है.

OT_CHANGED_IP6_MULTICAST_SUBSCRIBED

IPv6 मल्टीकास्ट पते की सदस्यता ली गई.

OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED

IPv6 मल्टीकास्ट पते से सदस्यता छोड़ी गई.

OT_CHANGED_JOINER_STATE

जॉइनर की स्थिति बदली गई.

OT_CHANGED_NETWORK_KEY

नेटवर्क कुंजी बदली गई.

OT_CHANGED_PENDING_DATASET

कार्रवाई करने के लिए बाकी डेटासेट को बदला गया.

OT_CHANGED_PSKC

पीएसकेसी बदल गया.

OT_CHANGED_SECURITY_POLICY

सुरक्षा नीति बदल गई है.

OT_CHANGED_SUPPORTED_CHANNEL_MASK

काम करने वाले चैनल मास्क को बदला गया.

OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL

स्थानीय बैकबोन राऊटर का कॉन्फ़िगरेशन बदला गया.

OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE

बैकबोन राऊटर की स्थिति बदली गई.

OT_CHANGED_THREAD_CHANNEL

थ्रेड नेटवर्क चैनल बदला गया.

OT_CHANGED_THREAD_CHILD_ADDED

बच्चे को जोड़ा गया.

OT_CHANGED_THREAD_CHILD_REMOVED

बच्चे की प्रोफ़ाइल हटाई गई.

OT_CHANGED_THREAD_EXT_PANID

थ्रेड नेटवर्क एक्सटेंडेड पैन आईडी बदला गया.

OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER

थ्रेड का क्रम बदला गया.

OT_CHANGED_THREAD_LL_ADDR

लिंक-स्थानीय पता बदला गया.

OT_CHANGED_THREAD_ML_ADDR

मेश-लोकल पता बदल गया है.

OT_CHANGED_THREAD_NETDATA

Thread नेटवर्क का डेटा बदला गया.

OT_CHANGED_THREAD_NETIF_STATE

थ्रेड नेटवर्क इंटरफ़ेस की स्थिति बदली गई.

OT_CHANGED_THREAD_NETWORK_NAME

थ्रेड के नेटवर्क का नाम बदला गया.

OT_CHANGED_THREAD_PANID

थ्रेड का नेटवर्क पैन आईडी बदला गया.

OT_CHANGED_THREAD_PARTITION_ID

विभाजन आईडी बदला गया.

OT_CHANGED_THREAD_RLOC_ADDED

आरएलओसी जोड़ा गया.

OT_CHANGED_THREAD_RLOC_REMOVED

RLOC को हटा दिया गया है.

OT_CHANGED_THREAD_ROLE

भूमिका (बंद है, अलग किया गया, बच्चे, राऊटर, और लीडर) की भूमिका बदल गई है.

टाइप आईडी

otChangedFlags

uint32_t otChangedFlags

यह टाइप, किसी बिट-फ़ील्ड को दिखाता है जो किसी खास स्थिति/कॉन्फ़िगरेशन को बदलता है.

OT_CHANGED_* परिभाषाएं देखें.

otInstance

struct otInstance otInstance

यह स्ट्रक्चर, OpenThread इंस्टेंस स्ट्रक्चर को दिखाता है.

otStateChangedCallback

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

फ़ंक्शन फ़ंक्शन को OpenThread में कुछ कॉन्फ़िगरेशन या स्थिति के बदलावों के बारे में बताने के लिए कॉल किया जाता है.

जानकारी
पैरामीटर
[in] aFlags
बदलाव करने वाली खास स्थिति को दिखाने वाला बिट-फ़ील्ड. OT_CHANGED_* परिभाषाएं देखें.
[in] aContext
ऐप्लिकेशन-खास संदर्भ के लिए पॉइंटर.

फ़ंक्शन

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

यह फ़ंक्शन OpenThread रेडियो वर्शन स्ट्रिंग लेता है.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस का पॉइंटर.
लौटाए गए सामान
OpenThread रेडियो वर्शन के लिए एक पॉइंटर.

otGetVersionString

const char * otGetVersionString(
  void
)

यह फ़ंक्शन OpenThread वर्शन स्ट्रिंग लेता है.

जानकारी
लौटाए गए सामान
OpenThread वर्शन के लिए एक पॉइंटर.

otInstanceErasePersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

यह फ़ंक्शन, अस्थिर वैल्यू वाली मेमोरी पर सेव की गई सभी OpenThread स्थायी जानकारी (नेटवर्क सेटिंग) को मिटा देता है.

डिवाइस को disabled स्थिति/भूमिका में होने पर ही मिटाया जाता है.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस का पॉइंटर.
सामान लौटाने की वैल्यू
OT_ERROR_NONE
सभी स्थायी जानकारी/स्थिति मिटा दी गई है.
OT_ERROR_INVALID_STATE
डिवाइस disabled स्थिति/भूमिका में नहीं है.

otInstanceFactoryरीसेट करें

void otInstanceFactoryReset(
  otInstance *aInstance
)

बार-बार अपडेट न होने वाली मेमोरी की सेव की गई सभी सेटिंग मिट जाती हैं. इसके बाद, प्लैटफ़ॉर्म रीसेट हो जाता है.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस का पॉइंटर.

otInstanceपूरी करें

void otInstanceFinalize(
  otInstance *aInstance
)

यह फ़ंक्शन OpenThread लाइब्रेरी को बंद कर देता है.

जब OpenThread का इस्तेमाल नहीं होता है, तब इस फ़ंक्शन को कॉल करें.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस का पॉइंटर.

otInstanceGetUptime

uint64_t otInstanceGetUptime(
  otInstance *aInstance
)

यह फ़ंक्शन मौजूदा इंस्टेंस अपटाइम (msec में) दिखाता है.

इस फ़ंक्शन के लिए OPENTHREAD_CONFIG_UPTIME_ENABLE की ज़रूरत होती है.

OpenThread इंस्टेंस शुरू होने के बाद से, सक्रिय समय का हिसाब, मिलीसेकंड में लगाया जाता है.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस का पॉइंटर.
लौटाए गए सामान
अपटाइम (मिलीसेकंड में संख्या).

otInstanceGetUptimeAsString

void otInstanceGetUptimeAsString(
  otInstance *aInstance,
  char *aBuffer,
  uint16_t aSize
)

यह फ़ंक्शन मौजूदा इंस्टेंस अपटाइम को लोगों की ओर से पढ़ने लायक स्ट्रिंग के रूप में दिखाता है.

इस फ़ंक्शन के लिए OPENTHREAD_CONFIG_UPTIME_ENABLE की ज़रूरत होती है.

स्ट्रिंग इस फ़ॉर्मैट और कोट के बाद आती है;::." घंटों, मिनट, सेकंड, और मिलीसेकंड के लिए (अगर अपटाइम एक दिन से कम है) या &कोट;

d.::." (अगर एक दिन से ज़्यादा है).

अगर नतीजे वाली स्ट्रिंग aBuffer में फ़िट नहीं होती है (aSize वर्णों में है), तो स्ट्रिंग छोटी कर दी जाएगी. हालांकि, आउटपुट स्ट्रिंग हमेशा शून्य नहीं रहती.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस का पॉइंटर.
[out] aBuffer
स्ट्रिंग को आउटपुट देने के लिए, वर्ण की श्रेणी का पॉइंटर.
[in] aSize
aBuffer का साइज़ (बाइट में). OT_UPTIME_STRING_SIZE इस्तेमाल करने का सुझाव दिया जाता है.

otInstanceInit

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

यह फ़ंक्शन OpenThread लाइब्रेरी को शुरू करता है.

यह फ़ंक्शन OpenThread को शुरू करता है और इसे बाद में OpenThread API कॉल के लिए तैयार करता है. OpenThread पर किसी भी दूसरे कॉल से पहले इस फ़ंक्शन को कॉल करना ज़रूरी है.

यह फ़ंक्शन उपलब्ध है और इसका इस्तेमाल सिर्फ़ तब किया जा सकता है, जब एक से ज़्यादा OpenThread इंस्टेंस चालू हों.

जानकारी
पैरामीटर
[in] aInstanceBuffer
OtInstance स्ट्रक्चर को आवंटित करने के लिए OpenThread का बफ़र.
[in,out] aInstanceBufferSize
इनपुट पर, aInstanceBuffer का साइज़. आउटपुट में, अगर otInstance के लिए ज़रूरत के मुताबिक जगह नहीं है, तो otInstance के लिए ज़रूरी बाइट की संख्या.
लौटाए गए सामान
नए OpenThread इंस्टेंस के लिए एक पॉइंटर.
यह भी देखें:
otInstancefinal पूरी करें

otInstanceInitसिंगल

otInstance * otInstanceInitSingle(
  void
)

यह फ़ंक्शन OpenThread लाइब्रेरी के स्टैटिक सिंगल इंस्टेंस की शुरुआत करता है.

यह फ़ंक्शन OpenThread को शुरू करता है और इसे बाद में OpenThread API कॉल के लिए तैयार करता है. OpenThread पर किसी भी दूसरे कॉल से पहले इस फ़ंक्शन को कॉल करना ज़रूरी है.

यह फ़ंक्शन उपलब्ध है और इसका इस्तेमाल सिर्फ़ तब किया जा सकता है, जब एक से ज़्यादा OpenThread इंस्टेंस बंद हों.

जानकारी
लौटाए गए सामान
सिंगल OpenThread इंस्टेंस के लिए एक पॉइंटर.

otInstanceIs नियंत्रित करना

bool otInstanceIsInitialized(
  otInstance *aInstance
)

यह फ़ंक्शन बताता है कि इंस्टेंस मान्य है या नहीं.

अगर इंस्टेंस को हासिल किया जाता है और उसे otInstanceInitSingle() (एक इंस्टेंस वाले मामले में) या otInstanceInit() (एक से ज़्यादा इंस्टेंस वाले मामलों में) का इस्तेमाल करके शुरू किया जाता है, तो इसे मान्य माना जाता है. otInstanceFinalize() पर बाद में कॉल करने से यह इंस्टेंस शुरू नहीं होता है.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस का पॉइंटर.
लौटाए गए सामान
अगर दिया गया इंस्टेंस मान्य/गलत है, तो 'सही' नहीं है.

otInstancereset

void otInstanceReset(
  otInstance *aInstance
)

इस तरीके से प्लैटफ़ॉर्म रीसेट हो जाता है.

रीसेट करने से यह पक्का होता है कि OpenThread से जुड़ी सभी स्थिति/जानकारी (इसमें उतार-चढ़ाव वाली मेमोरी मौजूद है) मिटा दी गई है. ध्यान दें कि otPlatformReset, अस्थिर मेमोरी में सेव की गई किसी भी स्थायी स्थिति/जानकारी को नहीं मिटाता है.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस का पॉइंटर.

otInstanceresetRadioStack

void otInstanceResetRadioStack(
  otInstance *aInstance
)

यह तरीका, OpenThread रेडियो स्टैक के अंदरूनी स्टेटस को रीसेट करता है.

कॉलबैक और कॉन्फ़िगरेशन सेव रखे जाते हैं.

यह एपीआई, सिर्फ़ रेडियो बिल्ड (OPENTHREAD_RADIO = 1) में उपलब्ध होता है.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस का पॉइंटर.

otRemoveStateChangeCallback

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

यह फ़ंक्शन, कॉलबैक को हटाता है. इससे पता चलता है कि OpenThread में कोई खास कॉन्फ़िगरेशन या स्थिति कब बदलती है.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस का पॉइंटर.
[in] aCallback
फ़ंक्शन के लिए एक पॉइंटर जिसे कुछ कॉन्फ़िगरेशन या स्थिति में बदलाव होने पर कॉल किया जाता है.
[in] aContext
ऐप्लिकेशन-खास संदर्भ के लिए पॉइंटर.

otSetStateChangedCallback

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

यह फ़ंक्शन, कॉलबैक को रजिस्टर करता है, ताकि OpenThread में किसी खास कॉन्फ़िगरेशन या स्थिति में बदलाव होने पर दिखाया जा सके.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस का पॉइंटर.
[in] aCallback
फ़ंक्शन के लिए एक पॉइंटर जिसे कुछ कॉन्फ़िगरेशन या स्थिति में बदलाव होने पर कॉल किया जाता है.
[in] aContext
ऐप्लिकेशन-खास संदर्भ के लिए पॉइंटर.
सामान लौटाने की वैल्यू
OT_ERROR_NONE
कॉलबैक को कॉलबैक की सूची में जोड़ा गया.
OT_ERROR_ALREADY
कॉलबैक पहले से रजिस्टर किया जा चुका है.
OT_ERROR_NO_BUFS
संसाधन की कमी की वजह से, कॉलबैक नहीं जोड़ा जा सका.

मैक्रो

OT_UPTIME_ROLE_SIZE

 OT_UPTIME_STRING_SIZE 24

स्ट्रिंग के लिए सक्रिय समय के लिए सुझाया गया साइज़.

संसाधन

ओपन थ्रेड एपीआई के विषय, सोर्स कोड से जनरेट होते हैं. ये GitHub पर उपलब्ध होते हैं. ज़्यादा जानकारी पाने या हमारे दस्तावेज़ में योगदान देने के लिए, संसाधन देखें.