نموذج

وتشمل هذه الوحدة الوظائف التي تتحكم في 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_MASTER_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 }	التعداد ويعرف هذا التعداد الأعلام التي تم تمريرها كجزء من `otStateChangedCallback` .

التعدادات

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_MASTER_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 
 }

التعداد

ويعرف هذا التعداد الأعلام التي تم تمريرها كجزء من otStateChangedCallback .

Typedefs
`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)`	`otError` هذه وظيفة يمحو جميع OpenThread المعلومات الثابتة (إعدادات الشبكة) المخزنة على ذاكرة غير متطايرة.
`otInstanceFactoryReset ( otInstance *aInstance)`	`void` هذه طريقة حذف جميع الإعدادات المخزنة على ذاكرة غير متطايرة، ومن ثم يؤدي إعادة النظام الأساسي.
`otInstanceFinalize ( otInstance *aInstance)`	`void` هذه الوظيفة تعطيل مكتبة OpenThread.
`otInstanceInit (void aInstanceBuffer, size_t aInstanceBufferSize)`	`otInstance *` هذه وظيفة تهيئة مكتبة OpenThread.
`otInstanceInitSingle (void)`	`otInstance *` هذه وظيفة تهيئة مثيل واحد ثابت من المكتبة OpenThread.
`otInstanceIsInitialized ( otInstance *aInstance)`	`bool` تشير هذه الوظيفة أم لا المثيل هو / صحيح تهيئة.
`otInstanceReset ( otInstance *aInstance)`	`void` يؤدي هذا الأسلوب إعادة النظام الأساسي.
`otRemoveStateChangeCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`void` هذه الوظيفة يزيل الاستدعاء للإشارة عندما تغييرات التكوين أو دولة معينة داخل OpenThread.
`otSetStateChangedCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`otError` هذه الوظيفة تسجل الاستدعاء للإشارة عندما تغييرات التكوين أو دولة معينة داخل OpenThread.

التعدادات

التعداد مجهول

 anonymous enum

ويعرف هذا التعداد الأعلام التي تم تمريرها كجزء من otStateChangedCallback .

الخصائص
`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_MASTER_KEY`	المفتاح الرئيسي تغيرت.
`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`	تمديد شبكة الموضوع PAN ID تغييرها.
`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`	شبكة الموضوع PAN تم تغيير رقم تعريف.
`OT_CHANGED_THREAD_PARTITION_ID`	ID التقسيم يتغير.
`OT_CHANGED_THREAD_RLOC_ADDED`	وأضاف RLOC.
`OT_CHANGED_THREAD_RLOC_REMOVED`	تمت إزالة RLOC.
`OT_CHANGED_THREAD_ROLE`	دور (المعوقين، منفصلة، الطفل، جهاز التوجيه، زعيم) تغييرها.

Typedefs

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.

otInstanceInit

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

هذه وظيفة تهيئة مكتبة OpenThread.

هذه وظيفة تهيئة OpenThread وتستعد ذلك للمكالمات API OpenThread اللاحقة. يجب استدعاء هذه الدالة قبل أي دعوات أخرى لOpenThread.

تتوفر هذه الوظيفة، ويمكن استخدامها فقط عندما يتم تمكين الدعم لحالات OpenThread متعددة.

تفاصيل

المعلمات

`[in] aInstanceBuffer`	المخزن المؤقت للOpenThread لاستخدامها لتخصيص هيكل otInstance.
`[in,out] aInstanceBufferSize`	على المدخلات، وحجم aInstanceBuffer. على الانتاج، إن لم يكن مساحة كافية لotInstance، عدد البايتات اللازمة لotInstance.

عائدات

مؤشر إلى مثيل OpenThread الجديد.

أنظر أيضا:
otInstanceFinalize

otInstanceInitSingle

 otInstance * otInstanceInitSingle(
  void
)

هذه وظيفة تهيئة مثيل واحد ثابت من المكتبة OpenThread.

هذه وظيفة تهيئة OpenThread وتستعد ذلك للمكالمات API OpenThread اللاحقة. يجب استدعاء هذه الدالة قبل أي دعوات أخرى لOpenThread.

تتوفر هذه الوظيفة، ويمكن استخدامها فقط عندما يتم تعطيل الدعم للحالات OpenThread متعددة.

تفاصيل
عائدات	مؤشر إلى مثيل OpenThread واحد.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

تشير هذه الوظيفة أم لا المثيل هو / صحيح تهيئة.

يعتبر المثال صحيحا إذا تم حيازته وتهيئة باستخدام otInstanceInitSingle() (في حالة واحدة مثلا) أو otInstanceInit() (في حالة المثال متعددة). دعوة لاحقة ل otInstanceFinalize() يؤدي سبيل المثال لا بد من اعتبار غير مهيأ.

تفاصيل

المعلمات

[in] aInstance

مؤشر إلى مثيل OpenThread.

عائدات

TRUE إذا كانت لحظة معينة صالح / تهيئة، FALSE خلاف ذلك.

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

يؤدي هذا الأسلوب إعادة النظام الأساسي.

ويضمن عملية إعادة تعيين أن جميع OpenThread الدولة / معلومات (المخزنة في الذاكرة المتطايرة) تم محوها. علما بأن otPlatformReset لا يمحو أي حالة المستمرة / المعلومات المحفوظة في الذاكرة غير المتقلبة.

تفاصيل

المعلمات

[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`	لا يمكن أن تضيف رد الاتصال بسبب القيود المفروضة على الموارد.