इंस्टेंस

इस मॉड्यूल में ऐसे फ़ंक्शन शामिल हैं जो 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

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

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

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

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

टाइपडेफ़

otChangedफ़्लैग

uint32_t otChangedFlags

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

OT_CHANGED_* में दी गई परिभाषाएं देखें.

ओटी इंस्टेंस

struct otInstance otInstance

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

otStateChangedCallback

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

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

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

फ़ंक्शन

otGetRadioVersionस्ट्रिंग

const char * otGetRadioVersionString(
  otInstance *aInstance
)

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

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

otGetVersionString

const char * otGetVersionString(
  void
)

इस फ़ंक्शन को OpenThread वर्शन स्ट्रिंग मिलती है.

ब्यौरा
लौटाए गए सामान
OpenThread वर्शन का पॉइंटर.

otInstanceDeletePersistentInfo

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 इंस्टेंस का पॉइंटर.

OTInstanceLastize

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 कॉल के लिए तैयार करता है. OpenFrame पर किसी भी दूसरे कॉल से पहले इस फ़ंक्शन को कॉल किया जाना चाहिए.

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

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

OTInstanceInitSingle

otInstance * otInstanceInitSingle(
  void
)

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

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

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

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

otInstanceIs शुरू किया गया

bool otInstanceIsInitialized(
  otInstance *aInstance
)

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

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

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

ओट इंस्टेंस रीसेट

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

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

संसाधन

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