ترجمت واجهة Cloud Translation API‏ هذه الصفحة.

نموذج

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

تعداد

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

النوع
`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.
`otInstanceGetUptime ( otInstance *aInstance)`	`uint64_t` ترجع هذه الوظيفة وقت تشغيل المثيل الحالي (بالمللي ثانية).
`otInstanceGetUptimeAsString ( otInstance aInstance, char aBuffer, uint16_t aSize)`	`void` تقوم هذه الوظيفة بإرجاع وقت تشغيل المثيل الحالي كسلسلة يمكن للبشر قراءتها.
`otInstanceInit (void aInstanceBuffer, size_t aInstanceBufferSize)`	`otInstance *` تعمل هذه الوظيفة على تهيئة مكتبة OpenThread.
`otInstanceInitSingle (void)`	`otInstance *` تعمل هذه الوظيفة على تهيئة المثيل الفردي الثابت لمكتبة 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)`	`otError` تسجل هذه الوظيفة رد اتصال للإشارة إلى تغيير حالة أو تكوين معين داخل 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`	تم تغيير معرف PAN الموسع لشبكة الخيط.
`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`	تم تغيير معرف القسم.
`OT_CHANGED_THREAD_RLOC_ADDED`	تمت إضافة RLOC.
`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
)

ترجع هذه الوظيفة وقت تشغيل المثيل الحالي (بالمللي ثانية).

تتطلب هذه الوظيفة OPENTHREAD_CONFIG_UPTIME_ENABLE إلى تمكين.

يتم تحديد وقت التشغيل على أنه عدد من المللي ثانية منذ تهيئة مثيل OpenThread.

تفاصيل

العوامل

[in] aInstance

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

عائدات

الجهوزية (عدد المللي ثانية).

otInstanceGetUptimeAsString

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

تقوم هذه الوظيفة بإرجاع وقت تشغيل المثيل الحالي كسلسلة يمكن للبشر قراءتها.

تتطلب هذه الوظيفة OPENTHREAD_CONFIG_UPTIME_ENABLE إلى تمكين.

السلسلة تتبع التنسيق " : : . "للساعات والدقائق والثواني والميلي ثانية (إذا كان وقت التشغيل أقصر من يوم واحد) أو"

د. : : . "(إذا كانت أطول من يوم واحد).

إذا لم يتم احتواء السلسلة الناتجة في 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`	المخزن المؤقت لـ OpenThread لاستخدامه في تخصيص بنية otInstance.
`[in,out] aInstanceBufferSize`	عند الإدخال ، يكون حجم aInstanceBuffer. عند الإخراج ، إذا لم تكن هناك مساحة كافية لـ otInstance ، فإن عدد البايت المطلوب لـ otInstance.

عائدات

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

أنظر أيضا:
otInstance

otInstanceInitSingle

otInstance * otInstanceInitSingle(
  void
)

تعمل هذه الوظيفة على تهيئة المثيل الفردي الثابت لمكتبة OpenThread.

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

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

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

تشير هذه الوظيفة إلى ما إذا كان المثيل صالحًا / مهيأ أم لا.

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

تفاصيل

العوامل

[in] aInstance

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

عائدات

TRUE إذا كان المثيل المحدد صالحًا / مهيأ ، و FALSE بخلاف ذلك.

otInstance إعادة تعيين

void otInstanceReset(
  otInstance *aInstance
)

تؤدي هذه الطريقة إلى إعادة تعيين النظام الأساسي.

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

تفاصيل

العوامل

[in] aInstance

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

otInstanceResetRadioStack

void otInstanceResetRadioStack(
  otInstance *aInstance
)

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

يتم الاحتفاظ بعمليات الاسترجاعات والتكوينات.

هذا API متاح فقط تحت الراديو يبني ( 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_STRING_SIZE

 OT_UPTIME_STRING_SIZE 24

الحجم الموصى به لتمثيل سلسلة الجهوزية.