بيانات تشخيص الشبكة المتداخلة

تتضمّن هذه الوحدة تعريفات ووظائف لبيانات تشخيص الشبكات المتداخلة.

ملخّص

تتطلّب واجهات برمجة تطبيقات "بيانات تشخيص الشبكة المتداخلة" OPENTHREAD_CONFIG_MESH_DIAG_ENABLE وOPENTHREAD_FTD.

أنواع المحددات

otMeshDiagChildInfo typedef
يمثّل معلومات حول طفل تم اكتشافه في شبكة سلسلة المحادثات.
otMeshDiagChildIterator typedef
مكرّر مبهم يكرّر قائمة الأطفال في جهاز التوجيه
otMeshDiagDiscoverCallback)(otError aError, otMeshDiagRouterInfo *aRouterInfo, void *aContext) typedef
void(*
يمثّل نوع المؤشر معاودة الاتصال التي يستخدمها otMeshDiagDiscoverTopology() لتقديم معلومات حول جهاز توجيه تم اكتشافه.
otMeshDiagDiscoverConfig typedef
يمثّل مجموعة الضبط المستخدَمة عند اكتشاف المخططات الهيكلية التي تشير إلى العناصر المطلوب اكتشافها.
otMeshDiagIp6AddrIterator typedef
مُكرِّر مبهم يكرّر فوق قائمة عناوين IPv6 لجهاز التوجيه.
otMeshDiagRouterInfo typedef
يمثل معلومات حول جهاز التوجيه في الشبكة المتداخلة.

الدوال

otMeshDiagCancel(otInstance *aInstance)
void
إلغاء عملية اكتشاف هذه المخططات الهيكلية باستمرار في حال توفّرها، أو في حال عدم اتخاذ أي إجراء
otMeshDiagDiscoverTopology(otInstance *aInstance, const otMeshDiagDiscoverConfig *aConfig, otMeshDiagDiscoverCallback aCallback, void *aContext)
تبدأ هذه السياسة في اكتشاف مخطط الطبولوجيا في الشبكة.
otMeshDiagGetNextChildInfo(otMeshDiagChildIterator *aIterator, otMeshDiagChildInfo *aChildInfo)
يكرّر هذا الإعداد الأطفال المُخترَقين في جهاز التوجيه.
otMeshDiagGetNextIp6Address(otMeshDiagIp6AddrIterator *aIterator, otIp6Address *aIp6Address)
ويتم تكراره من خلال عنوان IPv6 المُكتشَف لجهاز التوجيه.

هياكل

otMeshDiagChildInfo

يمثّل معلومات حول طفل تم اكتشافه في شبكة سلسلة المحادثات.

otMeshDiagDiscoverConfig

يمثّل مجموعة الضبط المستخدَمة عند اكتشاف المخططات الهيكلية التي تشير إلى العناصر المطلوب اكتشافها.

otMeshDiagrouterInfo

يمثل معلومات حول جهاز التوجيه في الشبكة المتداخلة.

أنواع المحددات

otMeshDiagChildInfo

struct otMeshDiagChildInfo otMeshDiagChildInfo

يمثّل معلومات حول طفل تم اكتشافه في شبكة سلسلة المحادثات.

otMeshDiagChildIterator

struct otMeshDiagChildIterator otMeshDiagChildIterator

مكرّر مبهم يكرّر قائمة الأطفال في جهاز التوجيه

وتتوفّر مؤشرات إلى هذا النوع في otMeshDiagRouterInfo.

otMeshDiagDiscoverCallback

void(* otMeshDiagDiscoverCallback)(otError aError, otMeshDiagRouterInfo *aRouterInfo, void *aContext)

يمثّل نوع المؤشر معاودة الاتصال التي يستخدمها otMeshDiagDiscoverTopology() لتقديم معلومات حول جهاز توجيه تم اكتشافه.

عندما تكون قيمة aError هي OT_ERROR_PENDING، يشير ذلك إلى أنّ الاكتشاف لم ينتهِ بعد وسيتم إنشاء عدد أكبر من أجهزة التوجيه، وسيتم استدعاء معاودة الاتصال مرة أخرى.

التفاصيل
المَعلمات
[in] aError
يشير OT_ERROR_PENDING إلى وجود المزيد من أجهزة التوجيه التي يمكن اكتشافها. يشير OT_ERROR_NONE إلى أنّ هذا هو جهاز التوجيه الأخير، وأنه تم اكتشاف الشبكة المتداخلة. انتهت فترة الاستجابة OT_ERROR_RESPONSE_ {8/} من وقت انتظار الرد من جهاز توجيه واحد أو أكثر.
[in] aRouterInfo
معلومات جهاز التوجيه التي تم اكتشافها (يمكن أن تكون فارغة إذا كانت aError هي OT_ERROR_RESPONSE_ {8/}).
[in] aContext
السياق الخاص بالتطبيق

otMeshDiagDiscoverConfig

struct otMeshDiagDiscoverConfig otMeshDiagDiscoverConfig

يمثّل مجموعة الضبط المستخدَمة عند اكتشاف المخططات الهيكلية التي تشير إلى العناصر المطلوب اكتشافها.

otMeshDiagIp6AddrIterator

struct otMeshDiagIp6AddrIterator otMeshDiagIp6AddrIterator

مُكرِّر مبهم يكرّر فوق قائمة عناوين IPv6 لجهاز التوجيه.

وتتوفّر مؤشرات إلى هذا النوع في otMeshDiagRouterInfo.

otMeshDiagrouterInfo

struct otMeshDiagRouterInfo otMeshDiagRouterInfo

يمثل معلومات حول جهاز التوجيه في الشبكة المتداخلة.

الدوال

otMeshDiagCancel

void otMeshDiagCancel(
  otInstance *aInstance
)

إلغاء عملية اكتشاف هذه المخططات الهيكلية باستمرار في حال توفّرها، أو في حال عدم اتخاذ أي إجراء

عند إلغاء الاستكشاف المستمر، لن يتم الاتصال بـ otMeshDiagDiscoverTopology() بعد ذلك.

otMeshDiagDiscoverTopology

otError otMeshDiagDiscoverTopology(
  otInstance *aInstance,
  const otMeshDiagDiscoverConfig *aConfig,
  otMeshDiagDiscoverCallback aCallback,
  void *aContext
)

تبدأ هذه السياسة في اكتشاف مخطط الطبولوجيا في الشبكة.

التفاصيل
المَعلمات
[in] aInstance
مثيل OpenThread.
[in] aConfig
الإعدادات التي سيتم استخدامها للاكتشاف (على سبيل المثال، العناصر المطلوب اكتشافها).
[in] aCallback
رد الاتصال للإبلاغ عن أجهزة التوجيه التي تم اكتشافها
[in] aContext
سياق مطلوب اجتيازه في aCallback
قيم الإرجاع
OT_ERROR_NONE
بدأت عملية اكتشاف المخططات الهيكلية للشبكة بنجاح.
OT_ERROR_BUSY
لا يزال طلب الاكتشاف السابق قيد التنفيذ.
OT_ERROR_INVALID_STATE
لم يتم توصيل الجهاز.
OT_ERROR_NO_BUFS
تعذّر تخصيص المخزن المؤقت لإرسال رسائل أثناء التصفّح.

otMeshDiagGetNextChildInfo

otError otMeshDiagGetNextChildInfo(
  otMeshDiagChildIterator *aIterator,
  otMeshDiagChildInfo *aChildInfo
)

يكرّر هذا الإعداد الأطفال المُخترَقين في جهاز التوجيه.

التفاصيل
المَعلمات
[in,out] aIterator
مُكرِّر العنوان المطلوب استخدامه
[out] aChildInfo
مؤشر لعرض معلومات الطفل (إن توفّر)
قيم الإرجاع
OT_ERROR_NONE
تم استرداد الطفل التالي بنجاح. تم تحديث aChildInfo وaIterator.
OT_ERROR_NOT_FOUND
ما مِن طفل آخر. لقد وصلت إلى نهاية القائمة.

otMeshDiagGetNextIp6Address

otError otMeshDiagGetNextIp6Address(
  otMeshDiagIp6AddrIterator *aIterator,
  otIp6Address *aIp6Address
)

ويتم تكراره من خلال عنوان IPv6 المُكتشَف لجهاز التوجيه.

التفاصيل
المَعلمات
[in,out] aIterator
مُكرِّر العنوان المطلوب استخدامه
[out] aIp6Address
مؤشر لعرض عنوان IPv6 التالي (إن وُجد)
قيم الإرجاع
OT_ERROR_NONE
تم استرداد العنوان التالي بنجاح. تم تحديث aIp6Address وaIterator.
OT_ERROR_NOT_FOUND
لا عناوين إضافية. لقد وصلت إلى نهاية القائمة.

وحدات ماكرو

OT_MESH_DIAG_DESCRIPTION_UNKNOWN

 OT_MESH_DIAG_VERSION_UNKNOWN 0xffff

يشير هذا الثابت إلى أن إصدار سلسلة المحادثات غير معروف.

تُستخدم هذه القيمة في otMeshDiagRouterInfo للموقع الإلكتروني على mVersion عندما لا يقدّم الجهاز إصداره. ويشير هذا إلى أن الجهاز يعمل على الأرجح 1.3.0 (قيمة الإصدار 4) أو إصدار أقدم.

الموارد

تبدأ مواضيع مراجع واجهة برمجة تطبيقات OpenThread من رمز المصدر، وهو متاح على GitHub. للحصول على مزيد من المعلومات أو للمساهمة في المستندات، يمكنك الاطّلاع على المراجع.