وكيل الحدود

تتضمّن هذه الوحدة وظائف دور وكيل حدود سلسلة المحادثات.

ملخّص

التعدادات
otBorderAgentState{
  OT_BORDER_AGENT_STATE_STOPPED = 0,
  OT_BORDER_AGENT_STATE_STARTED = 1,
  OT_BORDER_AGENT_STATE_ACTIVE = 2
} 		تعداد
تحديد حالة وكيل الحدود

أنواع المحددات
otBorderAgentState typedef
تحديد حالة وكيل الحدود

المتغيّرات
OT_TOOL_PACKED_END

الدوال
otBorderAgentGetId(otInstance *aInstance, otBorderAgentId *aId)
للحصول على رقم تعريف وكيل الحدود الذي تم إنشاؤه عشوائيًا.
otBorderAgentGetState(otInstance *aInstance)
تحصل على otBorderAgentState لدور وكيل حدود سلسلة المحادثات.
otBorderAgentGetUdpPort(otInstance *aInstance)
uint16_t
تحصل على منفذ UDP لخدمة "وكيل سلسلة المحادثات"
otBorderAgentSetId(otInstance *aInstance, const otBorderAgentId *aId)
لضبط رقم تعريف وكيل الحدود

هياكل
otBorderAgentId

يمثل رقم تعريف وكيل الحدود.

التعدادات

otBorderAgentState

 otBorderAgentState

تحديد حالة وكيل الحدود

أماكن إقامة
OT_BORDER_AGENT_STATE_ACTIVE

وكيل الحدود مرتبط بالمفوّض الخارجي.

OT_BORDER_AGENT_STATE_STARTED

تم بدء وكيل الحدود.

OT_BORDER_AGENT_STATE_STOPPED

تم إيقاف دور وكيل الحدود.

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

otBorderAgentState

enum otBorderAgentState otBorderAgentState

تحديد حالة وكيل الحدود

المتغيّرات

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otBorderAgentId OT_TOOL_PACKED_END

الدوال

otBorderAgentGetId

otError otBorderAgentGetId(
  otInstance *aInstance,
  otBorderAgentId *aId
)

للحصول على رقم تعريف وكيل الحدود الذي تم إنشاؤه عشوائيًا.

يتم حفظ رقم التعريف في مساحة تخزين دائمة وتبقى قابلة لإعادة التشغيل. يتم نشر حالة الاستخدام النموذجية لرقم التعريف في خدمة MeshCoP mDNS كقيمة TXT للعميل id لتحديد جهاز توجيه الحدود/جهاز الوكيل.

التفاصيل
المَعلمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[out] aId
مؤشر إلى المخزن المؤقت لتلقّي المعرّف.
قيم الإرجاع
OT_ERROR_NONE
إذا تم استرداد معرّف وكيل الحدود بنجاح.
...
في حال تعذّر استرداد رقم تعريف وكيل الحدود.
يُرجى الاطّلاع أيضًا على:
otBorderAgentSetId

otBorderAgentGetState

otBorderAgentState otBorderAgentGetState(
  otInstance *aInstance
)

تحصل على otBorderAgentState لدور وكيل حدود سلسلة المحادثات.

التفاصيل
المَعلمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
المرتجعات
دالة otBorderAgentState الحالية لوكيل الحدود

otBorderAgentGetUdpPort

uint16_t otBorderAgentGetUdpPort(
  otInstance *aInstance
)

تحصل على منفذ UDP لخدمة "وكيل سلسلة المحادثات"

التفاصيل
المَعلمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
المرتجعات
منفذ UDP لوكيل الحدود

otBorderAgentSetId

otError otBorderAgentSetId(
  otInstance *aInstance,
  const otBorderAgentId *aId
)

لضبط رقم تعريف وكيل الحدود

سيتم حفظ رقم تعريف وكيل الحدود في مساحة تخزين دائمة وسيكون بإمكانك إعادة تشغيله. سيُطلب منك ضبط رقم التعريف مرة واحدة فقط بعد إعادة الضبط على الإعدادات الأصلية. إذا لم يتم ضبط المعرّف مطلقًا من خلال طلب هذه الدالة، سيتم إنشاء رقم تعريف عشوائي وعرضه عند طلب otBorderAgentGetId.

التفاصيل
المَعلمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[out] aId
مؤشر إلى رقم تعريف وكيل الحدود
قيم الإرجاع
OT_ERROR_NONE
إذا تم ضبط معرّف وكيل الحدود بنجاح.
...
في حال تعذّر ضبط معرّف وكيل الحدود
يُرجى الاطّلاع أيضًا على:
otBorderAgentGetId

وحدات ماكرو

OT_BORDER_AGENT_ID_LENGTH

 OT_BORDER_AGENT_ID_LENGTH (16)

طول رقم تعريف وكيل/جهاز التوجيه لجهاز التوجيه بالبايت.

الموارد

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