المفوّض
تتضمن هذه الوحدة وظائف دور مفوض سلسلة المحادثات.
الملخّص
تعداد |
|
---|---|
otCommissionerJoinerEvent
|
تعداد يحدد هذا التعداد حدث الانضمام في المفوض. |
otCommissionerState{
|
تعداد يحدّد هذا التعداد ولاية المفوضية. |
otJoinerInfoType{
|
تعداد يحدّد هذا التعداد نوع معلومات المتصل. |
رفوف النوع |
|
---|---|
otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
|
typedefvoid(*
يتم استدعاء مؤشر الدالة هذا عندما يتلقى المفوض تقرير الطاقة. |
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
|
typedefvoid(*
يتم استدعاء مؤشر الدالة هذا كلما تغيرت حالة الرابط. |
otCommissionerJoinerEvent
|
typedef يحدد هذا التعداد حدث الانضمام في المفوض. |
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
|
typedefvoid(*
يتم استدعاء مؤشر الدالة هذا عندما يتلقى المفوض رسالة تعارض رقم PAN. |
otCommissionerState
|
typedefenum otCommissionerState
يحدّد هذا التعداد ولاية المفوضية. |
otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
|
typedefvoid(*
ويتم استدعاء مؤشر الدالة هذا كلما تغيّرت حالة المفوَّض. |
otCommissioningDataset
|
typedefstruct otCommissioningDataset
تمثل هذه البنية مجموعة بيانات التفويض. |
otJoinerInfo
|
typedefstruct otJoinerInfo
تمثل هذه البنية معلومات المُتصِل. |
otJoinerInfoType
|
typedefenum otJoinerInfoType
يحدّد هذا التعداد نوع معلومات المتصل. |
otJoinerPskd
|
typedefstruct otJoinerPskd
تمثل هذه البنية ملف PSKD. |
otSteeringData
|
typedefstruct otSteeringData
تمثل هذه البنية بيانات التوجيه. |
الدوال |
|
---|---|
otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
|
تضيف هذه الدالة إدخال رابط.
|
otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
|
تضيف هذه الدالة إدخال رابط مع قيمة محدد للبوّاب.
|
otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
|
ترسل هذه الدالة رسالة بدء الإعلان.
|
otCommissionerEnergyScan(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
|
ترسل هذه الدالة رسالة طلب البحث لفحص الطاقة.
|
otCommissionerGetId(otInstance *aInstance)
|
const char *
تعرض هذه الدالة رقم تعريف المفوّض.
|
otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
|
تعرض هذه الطريقة معلومات جهة الانضمام في موضع Google.
|
otCommissionerGetProvisioningUrl(otInstance *aInstance)
|
const char *
تحصل هذه الدالة على عنوان URL لإدارة الحسابات.
|
otCommissionerGetSessionId(otInstance *aInstance)
|
uint16_t
تعرض هذه الدالة رقم تعريف جلسة المفوّض.
|
otCommissionerGetState(otInstance *aInstance)
|
تعرض هذه الدالة حالة المفوّض.
|
otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
|
ترسل هذه الدالة رسالة طلب بحث لرقم تعريف PAN.
|
otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aEui64)
|
تزيل هذه الدالة إدخال رابط.
|
otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
|
تزيل هذه الدالة إدخال رابط.
|
otCommissionerSendMgmtGet(otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
|
ترسل هذه الدالة MGMT_COMMISSIONER_GET.
|
otCommissionerSendMgmtSet(otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
|
ترسل هذه الدالة MGMT_COMMISSIONER_SET.
|
otCommissionerSetId(otInstance *aInstance, const char *aId)
|
تضبط هذه الدالة رقم تعريف المفوّض.
|
otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl)
|
تضبط هذه الدالة عنوان URL لإدارة الحسابات.
|
otCommissionerStart(otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
|
تفعّل هذه الدالة دور مفوض سلسلة المحادثات.
|
otCommissionerStop(otInstance *aInstance)
|
وتعمل هذه الدالة على إيقاف دور مفوض سلسلة المحادثات.
|
الهياكل |
|
---|---|
otCommissioningDataset |
تمثل هذه البنية مجموعة بيانات التفويض. |
otjoinerInfo |
تمثل هذه البنية معلومات المُتصِل. |
otjoinerPskd |
تمثل هذه البنية ملف PSKD. |
otSteeringData |
تمثل هذه البنية بيانات التوجيه. |
تعداد
otCommissionerjoinerEvent
otCommissionerJoinerEvent
يحدد هذا التعداد حدث الانضمام في المفوض.
otCommissionerState
otCommissionerState
يحدّد هذا التعداد ولاية المفوضية.
أماكن إقامة | |
---|---|
OT_COMMISSIONER_STATE_ACTIVE
|
دور المفوض نشط. |
OT_COMMISSIONER_STATE_DISABLED
|
تم إيقاف دور المفوض. |
OT_COMMISSIONER_STATE_PETITION
|
يقدّم حاليًا شكوى ليصبح مفوضًا. |
otjoinerInfoType
otJoinerInfoType
يحدّد هذا التعداد نوع معلومات المتصل.
أماكن إقامة | |
---|---|
OT_JOINER_INFO_TYPE_ANY
|
اقبل أي انضمام (لم يتم تحديد الترميز II64 أو المرسِل). |
OT_JOINER_INFO_TYPE_DISCERNER
|
يتم تحديد القائم بالربط ( |
OT_JOINER_INFO_TYPE_EUI64
|
يتم تحديد الاتحاد الأوروبي الاتحاد الأوروبي 64 ( |
رفوف النوع
otCommissionerEnergyReportcallback
void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
يتم استدعاء مؤشر الدالة هذا عندما يتلقى المفوض تقرير الطاقة.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
otCommissionerjoinerCallback
void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
يتم استدعاء مؤشر الدالة هذا كلما تغيرت حالة الرابط.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
otCommissionerjoinerEvent
enum otCommissionerJoinerEvent otCommissionerJoinerEvent
يحدد هذا التعداد حدث الانضمام في المفوض.
otCommissionerPanIdCallCallback
void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
يتم استدعاء مؤشر الدالة هذا عندما يتلقى المفوض رسالة تعارض رقم PAN.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المعلَمات |
|
otCommissionerStateCallback
void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
ويتم استدعاء مؤشر الدالة هذا كلما تغيّرت حالة المفوَّض.
التفاصيل | |||||
---|---|---|---|---|---|
المعلَمات |
|
otCommissioningDataset
struct otCommissioningDataset otCommissioningDataset
تمثل هذه البنية مجموعة بيانات التفويض.
الدوال
otCommissionerAddAdder
otError otCommissionerAddJoiner( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout )
تضيف هذه الدالة إدخال رابط.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||||
قيم الإرجاع |
|
otCommissionerAddAdderWithDicercerner
otError otCommissionerAddJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout )
تضيف هذه الدالة إدخال رابط مع قيمة محدد للبوّاب.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||||
قيم الإرجاع |
|
otCommissionerAnnounceStart
otError otCommissionerAnnounceBegin( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress )
ترسل هذه الدالة رسالة بدء الإعلان.
التفاصيل | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||||||
قيم الإرجاع |
|
otCommissionerEnergyScan
otError otCommissionerEnergyScan( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext )
ترسل هذه الدالة رسالة طلب البحث لفحص الطاقة.
التفاصيل | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||||||||||||
قيم الإرجاع |
|
otCommissionerGetId
const char * otCommissionerGetId( otInstance *aInstance )
تعرض هذه الدالة رقم تعريف المفوّض.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
رقم تعريف المفوض
|
otCommissionerGetNextjoinerInfo
otError otCommissionerGetNextJoinerInfo( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner )
تعرض هذه الطريقة معلومات جهة الانضمام في موضع Google.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||
قيم الإرجاع |
|
otCommissionerGetProviderUrl
const char * otCommissionerGetProvisioningUrl( otInstance *aInstance )
تحصل هذه الدالة على عنوان URL لإدارة الحسابات.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
مؤشر إلى سلسلة عنوان URL.
|
otCommissionerGetSessionId
uint16_t otCommissionerGetSessionId( otInstance *aInstance )
تعرض هذه الدالة رقم تعريف جلسة المفوّض.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
رقم تعريف جلسة المفوَّض الحالي.
|
otCommissionerGetState
otCommissionerState otCommissionerGetState( otInstance *aInstance )
تعرض هذه الدالة حالة المفوّض.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||
قيم الإرجاع |
|
otCommissionerPanIdQuery
otError otCommissionerPanIdQuery( otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext )
ترسل هذه الدالة رسالة طلب بحث لرقم تعريف PAN.
التفاصيل | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||||||||
قيم الإرجاع |
|
otCommissionerRemoveLinker
otError otCommissionerRemoveJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
تزيل هذه الدالة إدخال رابط.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||||
قيم الإرجاع |
|
otCommissionerRemoveLinkerWithDiscerner
otError otCommissionerRemoveJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner )
تزيل هذه الدالة إدخال رابط.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||||
قيم الإرجاع |
|
otCommissionerSendMgmtGet
otError otCommissionerSendMgmtGet( otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength )
ترسل هذه الدالة MGMT_COMMISSIONER_GET.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||
قيم الإرجاع |
|
otCommissionerSendMgmtSet
otError otCommissionerSendMgmtSet( otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength )
ترسل هذه الدالة MGMT_COMMISSIONER_SET.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||||
قيم الإرجاع |
|
otCommissionerSetId
otError otCommissionerSetId( otInstance *aInstance, const char *aId )
تضبط هذه الدالة رقم تعريف المفوّض.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||
قيم الإرجاع |
|
otCommissionerSetProviderUrl
otError otCommissionerSetProvisioningUrl( otInstance *aInstance, const char *aProvisioningUrl )
تضبط هذه الدالة عنوان URL لإدارة الحسابات.
التفاصيل | |||||
---|---|---|---|---|---|
المعلَمات |
|
||||
قيم الإرجاع |
|
otCommissionerStart
otError otCommissionerStart( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext )
تفعّل هذه الدالة دور مفوض سلسلة المحادثات.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||||
قيم الإرجاع |
|
otCommissionerStop
otError otCommissionerStop( otInstance *aInstance )
وتعمل هذه الدالة على إيقاف دور مفوض سلسلة المحادثات.
التفاصيل | |||||
---|---|---|---|---|---|
المعلَمات |
|
||||
قيم الإرجاع |
|
وحدات ماكرو
OT_COMMISSIONING_PASSPHRASE_MAX_SIZE
OT_COMMISSIONING_PASSPHRASE_MAX_SIZE 255
الحد الأقصى لحجم عبارة المرور المستندة إلى التفويض.
OT_COMMISSIONING_PASSPHRASE_MIN_SIZE
OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6
الحد الأدنى لحجم عبارة المرور المستندة إلى التفويض.
OT_JOINER_MAX_PSKD_LENGTH
OT_JOINER_MAX_PSKD_LENGTH 32
الحد الأقصى لطول السلسلة لملف PSKd (لا يتضمن حرفًا خالٍ).
OT_PROVISIONING_URL_MAX_SIZE
OT_PROVISIONING_URL_MAX_SIZE 64
الحد الأقصى للحجم (عدد الأحرف) في سلسلة إدارة الحسابات (باستثناء الأحرف الفارغة ).
OT_STEERING_DATA_MAX_LENGTH
OT_STEERING_DATA_MAX_LENGTH 16
الحد الأقصى لطول بيانات التوجيه (بايت)
المراجع
تنشأ مواضيع واجهة برمجة تطبيقات OpenThread المرجعية من رمز المصدر المتاح على GitHub. للحصول على مزيد من المعلومات أو للمساهمة في الوثائق، يُرجى الرجوع إلى الموارد.