نجّار

تتضمن هذه الوحدة دوال لدور مشترك سلسلة المحادثات.

ملخّص

عمليات التعداد
otJoinerState تعداد
تحدد حالة الانضمام.

تحديدات النوع
otJoinerCallback)(otError aError, void *aContext) typedef
void(*
تم استدعاء المؤشر للإشعار باكتمال عملية الانضمام.
otJoinerDiscerner typedef
يمثل أداة تمييز الروابط.
otJoinerState typedef
تحدد حالة الانضمام.

الدوال
otJoinerGetDiscerner(otInstance *aInstance)
يتم الحصول على أداة تمييز الانضمام.
otJoinerGetId(otInstance *aInstance)
const otExtAddress *
الحصول على رقم تعريف أداة الانضمام.
otJoinerGetState(otInstance *aInstance)
الحصول على حالة الانضمام.
otJoinerSetDiscerner(otInstance *aInstance, otJoinerDiscerner *aDiscerner)
لضبط أداة تمييز الرابط.
otJoinerStart(otInstance *aInstance, const char *aPskd, const char *aProvisioningUrl, const char *aVendorName, const char *aVendorModel, const char *aVendorSwVersion, const char *aVendorData, otJoinerCallback aCallback, void *aContext)
تفعِّل هذه السياسة دور "أداة ربط سلسلة المحادثات".
otJoinerStateToString(otJoinerState aState)
const char *
لتحويل قيمة تعداد حالة دمج معينة إلى سلسلة يمكن لشخص عادي قراءتها.
otJoinerStop(otInstance *aInstance)
void
لإيقاف دور Join Thread.

الهياكل
otJoinerDiscerner

يمثل أداة تمييز الروابط.

عمليات التعداد

otJoinerState

 otJoinerState

تحدد حالة الانضمام.

تحديدات النوع

otJoinerCallback

void(* otJoinerCallback)(otError aError, void *aContext)

تم استدعاء المؤشر للإشعار باكتمال عملية الانضمام.

التفاصيل
المَعلمات
[in] aError
OT_ERROR_NONE إذا نجحت عملية الانضمام. OT_ERROR_ حين فشل عملية الانضمام بسبب بيانات اعتماد الأمان. OT_ERROR_NOT_FOUND في حالة عدم اكتشاف شبكة قابلة للانضمام. OT_ERROR_RESPONSE_TIMESTAMP في حالة انتهاء مهلة الاستجابة.
[in] aContext
مؤشر إلى السياق الخاص بالتطبيق.

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

يمثل أداة تمييز الروابط.

otJoinerState

enum otJoinerState otJoinerState

تحدد حالة الانضمام.

الدوال

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

يتم الحصول على أداة تمييز الانضمام.

لمزيد من المعلومات، راجِع otJoinerSetDiscerner.

التفاصيل
المَعلمات
[in] aInstance
يشير هذا المصطلح إلى مؤشر لمثيل OpenThread.
المرتجعات
مؤشر إلى مُميز الرابط أو NULL في حال عدم تعيين أي شيء.

otJoinerGetId

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

الحصول على رقم تعريف أداة الانضمام.

إذا لم يتم ضبط أداة إظهار Joiner، سيكون معرّف Joiner هو أول 64 بت من نتيجة حوسبة SHA-256 بالاستناد إلى معيار IEEE EUI-64 المعيّن من قِبل المصنع. وبخلاف ذلك، يتم حساب رقم تعريف أداة الربط من قيمة أداة الانضمام.

يُستخدم معرف أداة الربط أيضًا باعتباره عنوان IEEE 802.15.4 الموسع للجهاز أثناء عملية التكليف.

التفاصيل
المَعلمات
[in] aInstance
يشير هذا المصطلح إلى مؤشر لمثيل OpenThread.
المرتجعات
مؤشر يشير إلى "معرِّف أداة الانضمام".

otJoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

الحصول على حالة الانضمام.

التفاصيل
المَعلمات
[in] aInstance
يشير هذا المصطلح إلى مؤشر لمثيل OpenThread.
المرتجعات
حالة الضم.

otJoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

لضبط أداة تمييز الرابط.

يتم استخدام أداة إظهار علامة الربط لحساب رقم تعريف عامل الانضمام أثناء عملية تفويض سلسلة التعليمات. لمزيد من المعلومات، راجِع otJoinerGetId.

التفاصيل
المَعلمات
[in] aInstance
يشير هذا المصطلح إلى مؤشر لمثيل OpenThread.
[in] aDiscerner
مؤشر إلى أداة تمييز مادّة الربط. إذا محوت القيمة "NULL" (فارغ) أي أداة تمييز تم ضبطها سابقًا.
قيم الإرجاع
OT_ERROR_NONE
تم تعديل أداة إظهار الانضمام بنجاح.
OT_ERROR_INVALID_ARGS
aDiscerner غير صالح (الطول المحدد ليس ضمن النطاق الصحيح).
OT_ERROR_INVALID_STATE
هناك عملية "انضمام" جارية، ولذلك لا يمكن تغيير "أداة إظهار الانضمام".

otJoinerStart

otError otJoinerStart(
  otInstance *aInstance,
  const char *aPskd,
  const char *aProvisioningUrl,
  const char *aVendorName,
  const char *aVendorModel,
  const char *aVendorSwVersion,
  const char *aVendorData,
  otJoinerCallback aCallback,
  void *aContext
)

تفعِّل هذه السياسة دور "أداة ربط سلسلة المحادثات".

التفاصيل
المَعلمات
[in] aInstance
يشير هذا المصطلح إلى مؤشر لمثيل OpenThread.
[in] aPskd
مؤشر يشير إلى PSKd.
[in] aProvisioningUrl
مؤشر إلى عنوان URL لإدارة الحسابات (قد يكون فارغًا).
[in] aVendorName
يشير هذا المصطلح إلى مؤشر "اسم المورّد" (قد يكون NULL).
[in] aVendorModel
مؤشر إلى نموذج المورد (قد يكون NULL).
[in] aVendorSwVersion
يشير إلى إصدار مورّد SW (قد يكون NULL).
[in] aVendorData
مؤشر إلى "بيانات المورد" (قد تكون فارغة).
[in] aCallback
يشير هذا المصطلح إلى مؤشر لدالة يتم استدعاؤها عند اكتمال عملية الدمج.
[in] aContext
مؤشر إلى السياق الخاص بالتطبيق.
قيم الإرجاع
OT_ERROR_NONE
تم بدء دور Joiner بنجاح.
OT_ERROR_BUSY
ولا تزال المحاولة السابقة جارية.
OT_ERROR_INVALID_ARGS
aPskd أو aProvisioningUrl غير صالح.
OT_ERROR_INVALID_STATE
لم يتم تفعيل حزمة IPv6 أو تم تفعيل حزمة Thread بشكل كامل.

otJoinerStateToString

const char * otJoinerStateToString(
  otJoinerState aState
)

لتحويل قيمة تعداد حالة دمج معينة إلى سلسلة يمكن لشخص عادي قراءتها.

التفاصيل
المَعلمات
[in] aState
حالة الضم.
المرتجعات
تمثيل سلسلة aState يمكن لشخص عادي قراءته

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

لإيقاف دور Join Thread.

التفاصيل
المَعلمات
[in] aInstance
يشير هذا المصطلح إلى مؤشر لمثيل OpenThread.

وحدات ماكرو

OT_JOINER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

الحد الأقصى لطول محدد الرابط بالبت.

المراجِع

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