इंस्टेंस

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

खास जानकारी

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

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

टाइपडीफ़

otChangedFlags

uint32_t otChangedFlags

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

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

otInstance

struct otInstance otInstance

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

otStateChangedCallback

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

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

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

फ़ंक्शन

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

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

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

otGetVersionString

const char * otGetVersionString(
  void
)

OpenThread वर्शन स्ट्रिंग की जानकारी मिलती है.

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

otInstanceErasePersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

नॉन-वोलाटाइल मेमोरी पर सेव की गई OpenThread स्थायी जानकारी (नेटवर्क सेटिंग) को हमेशा के लिए मिटा देता है.

हमेशा के लिए सिर्फ़ तब मिटाएं, जब डिवाइस disabled स्थिति/भूमिका में हो.

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

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

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

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

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

OpenThread लाइब्रेरी को बंद करता है.

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

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

otInstanceGetId

uint32_t otInstanceGetId(
  otInstance *aInstance
)

इंस्टेंस आइडेंटिफ़ायर की जानकारी मिलती है.

इंस्टेंस के बनने के बाद, इंस्टेंस आइडेंटिफ़ायर किसी रैंडम वैल्यू पर सेट होता है. हालांकि, इसे शुरू करने के बाद इसकी वैल्यू में कोई बदलाव नहीं होगा.

जानकारी
लौटाए गए सामान
इंस्टेंस आइडेंटिफ़ायर.

otInstanceGetUptime

uint64_t otInstanceGetUptime(
  otInstance *aInstance
)

मौजूदा इंस्टेंस का अपटाइम (मिलीसेकंड में) दिखाता है.

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
otइंस्टेंस स्ट्रक्चर को ऐलोकेशन करने के लिए इस्तेमाल किया जाने वाला OpenThread का बफ़र.
[in,out] aInstanceBufferSize
इनपुट पर, aइंस्टेंसBuffer का साइज़. आउटपुट में, अगर otइंस्टेंस के लिए ज़रूरी जगह नहीं है, तो otइंस्टेंस के लिए ज़रूरी बाइट संख्या.
लौटाए गए सामान
नए OpenThread इंस्टेंस के लिए पॉइंटर.
यह भी देखें:
otInstanceFinalize

otInstanceInitMultiple

otInstance * otInstanceInitMultiple(
  uint8_t aIdx
)

OpenThread इंस्टेंस को शुरू करता है.

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

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

जानकारी
पैरामीटर
[in] aIdx
शुरू करने के लिए, OpenThread इंस्टेंस का इंडेक्स.
लौटाए गए सामान
नए OpenThread इंस्टेंस के लिए पॉइंटर.

otInstanceInitSingle

otInstance * otInstanceInitSingle(
  void
)

OpenThread लाइब्रेरी के स्टैटिक सिंगल इंस्टेंस को शुरू करता है.

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

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

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

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

इससे पता चलता है कि इंस्टेंस मान्य/शुरू किया गया है या नहीं.

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

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

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

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

रीसेट करने की प्रोसेस यह पक्का करती है कि OpenThread स्टेटस/जानकारी (डेटा बार-बार बदलने वाली मेमोरी में सेव किया गया) को हमेशा के लिए मिटा दिया जाए. ध्यान दें कि otPlatformReset, नॉन-वोलाटाइल मेमोरी में सेव की गई किसी भी स्थायी स्थिति/जानकारी को नहीं मिटाता है.

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

otInstanceResetRadioStack

void otInstanceResetRadioStack(
  otInstance *aInstance
)

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

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

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

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

otInstanceResetToBootloader

otError otInstanceResetToBootloader(
  otInstance *aInstance
)

अगर सुविधा काम करती है, तो प्लैटफ़ॉर्म रीसेट को बूटलोडर मोड पर ट्रिगर करता है.

OPENTHREAD_CONFIG_PLATFORM_BOOTLOADER_MODE_ENABLE की ज़रूरत है.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस के लिए पॉइंटर.
रिटर्न वैल्यू
OT_ERROR_NONE
बूटलोडर पर रीसेट किया गया.
OT_ERROR_BUSY
कार्रवाई नहीं की जा सकी, क्योंकि कोई दूसरी कार्रवाई जारी है.
OT_ERROR_NOT_CAPABLE
बूटलोडर पर रीसेट नहीं किया जा सकता.

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_CHANGED_ACTIVE_DATASET

 OT_CHANGED_ACTIVE_DATASET (1U << 28)

ऐक्टिव ऑपरेशनल डेटासेट बदला गया.

OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL

 OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL (1U << 21)

Thread चैनल के नए चैनल मैनेजर में बदलाव किया गया है.

OT_CHANGED_COMMISSIONER_STATE

 OT_CHANGED_COMMISSIONER_STATE (1U << 23)

कमिश्नर का स्टेटस बदला गया.

OT_CHANGED_IP6_ADDRESS_ADDED

 OT_CHANGED_IP6_ADDRESS_ADDED (1U << 0)

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

OT_CHANGED_IP6_ADDRESS_REMOVED

 OT_CHANGED_IP6_ADDRESS_REMOVED (1U << 1)

IPv6 पता हटाया गया.

OT_CHANGED_IP6_MULTICAST_SUBSCRIBED

 OT_CHANGED_IP6_MULTICAST_SUBSCRIBED (1U << 12)

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

OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED

 OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED (1U << 13)

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

OT_CHANGED_JOINER_STATE

 OT_CHANGED_JOINER_STATE (1U << 27)

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

OT_CHANGED_NAT64_TRANSLATOR_STATE

 OT_CHANGED_NAT64_TRANSLATOR_STATE (1U << 30)

NAT64 अनुवादक की स्थिति बदल गई है.

OT_CHANGED_NETWORK_KEY

 OT_CHANGED_NETWORK_KEY (1U << 18)

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

 OT_CHANGED_PARENT_LINK_QUALITY (1U << 31)

पैरंट लिंक की क्वालिटी बदली गई.

OT_CHANGED_PENDING_DATASET

 OT_CHANGED_PENDING_DATASET (1U << 29)

लंबित ऑपरेशनल डेटासेट बदला गया.

OT_CHANGED_PSKC

 OT_CHANGED_PSKC (1U << 19)

PSKc बदला गया.

OT_CHANGED_SECURITY_POLICY

 OT_CHANGED_SECURITY_POLICY (1U << 20)

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

OT_CHANGED_SUPPORTED_CHANNEL_MASK

 OT_CHANGED_SUPPORTED_CHANNEL_MASK (1U << 22)

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

OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL

 OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL (1U << 26)

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

OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE

 OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE (1U << 25)

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

OT_CHANGED_THREAD_CHANNEL

 OT_CHANGED_THREAD_CHANNEL (1U << 14)

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

OT_CHANGED_THREAD_CHILD_ADDED

 OT_CHANGED_THREAD_CHILD_ADDED (1U << 10)

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

OT_CHANGED_THREAD_CHILD_REMOVED

 OT_CHANGED_THREAD_CHILD_REMOVED (1U << 11)

बच्चे को हटा दिया गया.

OT_CHANGED_THREAD_EXT_PANID

 OT_CHANGED_THREAD_EXT_PANID (1U << 17)

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

OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER

 OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER (1U << 8)

थ्रेड कुंजी का क्रम बदला गया.

OT_CHANGED_THREAD_LL_ADDR

 OT_CHANGED_THREAD_LL_ADDR (1U << 3)

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

OT_CHANGED_THREAD_ML_ADDR

 OT_CHANGED_THREAD_ML_ADDR (1U << 4)

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

OT_CHANGED_THREAD_NETDATA

 OT_CHANGED_THREAD_NETDATA (1U << 9)

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

OT_CHANGED_THREAD_NETIF_STATE

 OT_CHANGED_THREAD_NETIF_STATE (1U << 24)

थ्रेड नेटवर्क के इंटरफ़ेस का स्टेटस बदला गया.

OT_CHANGED_THREAD_NETWORK_NAME

 OT_CHANGED_THREAD_NETWORK_NAME (1U << 16)

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

OT_CHANGED_THREAD_PANID

 OT_CHANGED_THREAD_PANID (1U << 15)

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

OT_CHANGED_THREAD_PARTITION_ID

 OT_CHANGED_THREAD_PARTITION_ID (1U << 7)

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

OT_CHANGED_THREAD_RLOC_ADDED

 OT_CHANGED_THREAD_RLOC_ADDED (1U << 5)

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

OT_CHANGED_THREAD_RLOC_REMOVED

 OT_CHANGED_THREAD_RLOC_REMOVED (1U << 6)

आरएलओसी को हटा दिया गया है.

OT_CHANGED_THREAD_ROLE

 OT_CHANGED_THREAD_ROLE (1U << 2)

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

OT_UPTIME_STRING_SIZE

 OT_UPTIME_STRING_SIZE 24

स्ट्रिंग को अपटाइम दिखाने के लिए सुझाया गया साइज़.

संसाधन

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