روتر ستون فقرات
این ماژول شامل توابعی برای سرویس روتر ستون فقرات OpenThread است.
خلاصه
شمارش ها | |
|---|---|
 otBackboneRouterDomainPrefixEvent { |  enum  رویدادهای پیشوند دامنه را نشان می دهد.  | 
 otBackboneRouterMulticastListenerEvent { |  enum  رویدادهای Multicast Listener را نشان می دهد.  | 
 otBackboneRouterNdProxyEvent { |  enum  رویدادهای ND Proxy را نشان می دهد.  | 
 otBackboneRouterState { |  enum  وضعیت مسیریاب ستون فقرات را نشان می دهد.   | 
Typedefs | |
|---|---|
 otBackboneRouterConfig |  typedefstruct otBackboneRouterConfig نشان دهنده پیکربندی مسیریاب ستون فقرات است.  | 
 otBackboneRouterDomainPrefixCallback )(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix) |  typedefvoid(* هر زمان که پیشوند دامنه تغییر کند، اشاره گر فراخوانی می شود.  | 
 otBackboneRouterMulticastListenerCallback )(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress) |  typedefvoid(* هر زمان که شنوندگان Multicast تغییر کنند، اشاره گر فراخوانی می شود.  | 
 otBackboneRouterMulticastListenerInfo |  typedef  اطلاعات شنونده Multicast Router Backbone را نشان می دهد.  | 
 otBackboneRouterMulticastListenerIterator |  typedefuint16_t برای تکرار از طریق شنوندگان چندپخشی استفاده می شود.  | 
 otBackboneRouterNdProxyCallback )(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua) |  typedefvoid(* هر زمان که Nd Proxy تغییر کند، اشاره گر فراخوانی می شود.  | 
 otBackboneRouterNdProxyInfo |  typedefstruct otBackboneRouterNdProxyInfo اطلاعات پروکسی Backbone Router ND را نشان می دهد.   | 
کارکرد | |
|---|---|
 otBackboneRouterConfigNextDuaRegistrationResponse ( otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus) | void وضعیت پاسخ را برای ثبت نام بعدی DUA پیکربندی می کند.  | 
 otBackboneRouterConfigNextMulticastListenerRegistrationResponse ( otInstance *aInstance, uint8_t aStatus) | void وضعیت پاسخ را برای ثبت شنونده چندپخشی بعدی پیکربندی می کند.  | 
 otBackboneRouterGetConfig ( otInstance *aInstance, otBackboneRouterConfig *aConfig) | void پیکربندی محلی Backbone Router را دریافت می کند.  | 
 otBackboneRouterGetDomainPrefix ( otInstance *aInstance, otBorderRouterConfig *aConfig) |  پیکربندی پیشوند دامنه محلی را دریافت می کند.  | 
 otBackboneRouterGetNdProxyInfo ( otInstance *aInstance, const otIp6Address *aDua, otBackboneRouterNdProxyInfo *aNdProxyInfo) |  اطلاعات Backbone Router ND Proxy را دریافت می کند.  | 
 otBackboneRouterGetPrimary ( otInstance *aInstance, otBackboneRouterConfig *aConfig) |  اطلاعات روتر Backbone اصلی را در شبکه Thread دریافت می کند.  | 
 otBackboneRouterGetRegistrationJitter ( otInstance *aInstance) | uint8_t مقدار جیتر ثبت مسیریاب ستون فقرات را برمیگرداند.  | 
 otBackboneRouterGetState ( otInstance *aInstance) |  مسیریاب ستون فقرات otBackboneRouterState را دریافت می کند.  | 
 otBackboneRouterMulticastListenerAdd ( otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout) |  یک شنونده چندپخشی با مقدار وقفه در چند ثانیه اضافه می کند.  | 
 otBackboneRouterMulticastListenerClear ( otInstance *aInstance) | void شنوندگان چندپخشی را پاک می کند.  | 
 otBackboneRouterMulticastListenerGetNext ( otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo) |  اطلاعات Multicast Listener بعدی را دریافت می کند (با استفاده از تکرارکننده).  | 
 otBackboneRouterRegister ( otInstance *aInstance) |  پیکربندی روتر Backbone محلی را به صراحت ثبت می کند.  | 
 otBackboneRouterSetConfig ( otInstance *aInstance, const otBackboneRouterConfig *aConfig) |  پیکربندی محلی Backbone Router را تنظیم می کند.  | 
 otBackboneRouterSetDomainPrefixCallback ( otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext) | void پیشوند Backbone Router Domain را تنظیم می کند.  | 
 otBackboneRouterSetEnabled ( otInstance *aInstance, bool aEnable) | void عملکرد Backbone را فعال یا غیرفعال می کند.  | 
 otBackboneRouterSetMulticastListenerCallback ( otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext) | void Backbone Router Multicast Listener را تنظیم می کند.  | 
 otBackboneRouterSetNdProxyCallback ( otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext) | void Backbone Router ND Proxy را تنظیم می کند.  | 
 otBackboneRouterSetRegistrationJitter ( otInstance *aInstance, uint8_t aJitter) | void مقدار jitter ثبت مسیریاب ستون فقرات را تنظیم می کند.   | 
سازه ها | |
|---|---|
| otBackboneRouterConfig | نشان دهنده پیکربندی مسیریاب ستون فقرات است.  | 
| otBackboneRouterMulticastListenerInfo | اطلاعات شنونده Multicast Router Backbone را نشان می دهد.  | 
| otBackboneRouterNdProxyInfo | اطلاعات پروکسی Backbone Router ND را نشان می دهد.  | 
شمارش ها
otBackboneRouterDomainPrefixEvent
otBackboneRouterDomainPrefixEvent
otBackboneRouterMulticastListenerEvent
otBackboneRouterMulticastListenerEvent
otBackboneRouterNdProxyEvent
otBackboneRouterNdProxyEvent
otBackboneRouterState
otBackboneRouterState
Typedefs
otBackboneRouterConfig
struct otBackboneRouterConfig otBackboneRouterConfig
نشان دهنده پیکربندی مسیریاب ستون فقرات است.
otBackboneRouterDomainPrefixCallback
void(* otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix)
هر زمان که پیشوند دامنه تغییر کند، اشاره گر فراخوانی می شود.
| جزئیات | |||||||
|---|---|---|---|---|---|---|---|
| مولفه های | 
  | 
otBackboneRouterMulticastListenerCallback
void(* otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress)
هر زمان که شنوندگان Multicast تغییر کنند، اشاره گر فراخوانی می شود.
| جزئیات | |||||||
|---|---|---|---|---|---|---|---|
| مولفه های | 
  | 
otBackboneRouterMulticastListenerInfo
struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo
اطلاعات شنونده Multicast Router Backbone را نشان می دهد.
otBackboneRouterMulticastListenerIterator
uint16_t otBackboneRouterMulticastListenerIterator
برای تکرار از طریق شنوندگان چندپخشی استفاده می شود.
otBackboneRouterNdProxyCallback
void(* otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua)
هر زمان که Nd Proxy تغییر کند، اشاره گر فراخوانی می شود.
| جزئیات | |||||||
|---|---|---|---|---|---|---|---|
| مولفه های | 
  | 
otBackboneRouterNdProxyInfo
struct otBackboneRouterNdProxyInfo otBackboneRouterNdProxyInfo
اطلاعات پروکسی Backbone Router ND را نشان می دهد.
کارکرد
otBackboneRouterConfigNextDuaRegistrationResponse
void otBackboneRouterConfigNextDuaRegistrationResponse( otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus )
وضعیت پاسخ را برای ثبت نام بعدی DUA پیکربندی می کند.
 توجه: فقط زمانی در دسترس است که OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE فعال باشد. فقط برای تست و صدور گواهینامه استفاده می شود.
TODO: (DUA) از کد خطای coap و فرآیند مربوطه برای هدف صدور گواهینامه پشتیبانی می کند.
| جزئیات | |||||||
|---|---|---|---|---|---|---|---|
| مولفه های | 
  | 
otBackboneRouterConfigNextMulticastListenerRegistrationResponse
void otBackboneRouterConfigNextMulticastListenerRegistrationResponse( otInstance *aInstance, uint8_t aStatus )
وضعیت پاسخ را برای ثبت شنونده چندپخشی بعدی پیکربندی می کند.
 زمانی در دسترس است که OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE ، OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE ، و OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE فعال باشند.
| جزئیات | |||||
|---|---|---|---|---|---|
| مولفه های | 
  | 
otBackboneRouterGetConfig
void otBackboneRouterGetConfig( otInstance *aInstance, otBackboneRouterConfig *aConfig )
پیکربندی محلی Backbone Router را دریافت می کند.
 زمانی در دسترس است که OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE فعال باشد.
| جزئیات | |||||
|---|---|---|---|---|---|
| مولفه های | 
  | 
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterSetConfig
otBackboneRouterRegister
otBackboneRouterGetDomainPrefix
otError otBackboneRouterGetDomainPrefix( otInstance *aInstance, otBorderRouterConfig *aConfig )
پیکربندی پیشوند دامنه محلی را دریافت می کند.
| جزئیات | |||||
|---|---|---|---|---|---|
| مولفه های | 
  | ||||
| ارزش های بازگشتی | 
  | 
otBackboneRouterGetNdProxyInfo
otError otBackboneRouterGetNdProxyInfo( otInstance *aInstance, const otIp6Address *aDua, otBackboneRouterNdProxyInfo *aNdProxyInfo )
اطلاعات Backbone Router ND Proxy را دریافت می کند.
| جزئیات | |||||||
|---|---|---|---|---|---|---|---|
| مولفه های | 
  | ||||||
| ارزش های بازگشتی | 
  | 
otBackboneRouterGetPrimary
otError otBackboneRouterGetPrimary( otInstance *aInstance, otBackboneRouterConfig *aConfig )
اطلاعات روتر Backbone اصلی را در شبکه Thread دریافت می کند.
| جزئیات | |||||
|---|---|---|---|---|---|
| مولفه های | 
  | ||||
| ارزش های بازگشتی | 
  | 
otBackboneRouterGetRegistrationJitter
uint8_t otBackboneRouterGetRegistrationJitter( otInstance *aInstance )
مقدار جیتر ثبت مسیریاب ستون فقرات را برمیگرداند.
| جزئیات | |
|---|---|
| برمی گرداند |  مقدار جیتر ثبت مسیریاب ستون فقرات.  | 
otBackboneRouterSetRegistrationJitter
otBackboneRouterGetState
otBackboneRouterState otBackboneRouterGetState( otInstance *aInstance )
مسیریاب ستون فقرات otBackboneRouterState را دریافت می کند.
| جزئیات | |||||||
|---|---|---|---|---|---|---|---|
| مولفه های | 
  | ||||||
| ارزش های بازگشتی | 
  | 
otBackboneRouterSetEnabled
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister
otBackboneRouterMulticastListenerAdd
otError otBackboneRouterMulticastListenerAdd( otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout )
یک شنونده چندپخشی با مقدار وقفه در چند ثانیه اضافه می کند.
 برای استفاده از مهلت زمانی پیشفرض MLR، 0 پاس کنید.
 زمانی در دسترس است که OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE ، OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE ، و OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE فعال باشند.
| جزئیات | |||||||
|---|---|---|---|---|---|---|---|
| مولفه های | 
  | ||||||
| ارزش های بازگشتی | 
  | 
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerGetNext
otBackboneRouterMulticastListenerClear
void otBackboneRouterMulticastListenerClear( otInstance *aInstance )
شنوندگان چندپخشی را پاک می کند.
 زمانی در دسترس است که OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE ، OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE ، و OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE فعال باشند.
| جزئیات | |||
|---|---|---|---|
| مولفه های | 
  | 
otBackboneRouterMulticastListenerAdd
otBackboneRouterMulticastListenerGetNext
otBackboneRouterMulticastListenerGetNext
otError otBackboneRouterMulticastListenerGetNext( otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo )
اطلاعات Multicast Listener بعدی را دریافت می کند (با استفاده از تکرارکننده).
| جزئیات | |||||||
|---|---|---|---|---|---|---|---|
| مولفه های | 
  | ||||||
| ارزش های بازگشتی | 
  | 
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerAdd
otBackboneRouterRegister
otError otBackboneRouterRegister( otInstance *aInstance )
پیکربندی روتر Backbone محلی را به صراحت ثبت می کند.
 یک پیام درخواست داده سرور SRV_DATA.ntf برای دستگاه پیوست شده راه اندازی می شود.
 زمانی در دسترس است که OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE فعال باشد.
| جزئیات | |||||
|---|---|---|---|---|---|
| مولفه های | 
  | ||||
| ارزش های بازگشتی | 
  | 
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterSetConfig
otError otBackboneRouterSetConfig( otInstance *aInstance, const otBackboneRouterConfig *aConfig )
پیکربندی محلی Backbone Router را تنظیم می کند.
 اگر مجموعه داده های BBR برای روتر اصلی ستون فقرات تغییر کند، یک پیام درخواست داده سرور SRV_DATA.ntf به طور خودکار آغاز می شود.
 زمانی در دسترس است که OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE فعال باشد.
| جزئیات | |||||
|---|---|---|---|---|---|
| مولفه های | 
  | ||||
| ارزش های بازگشتی | 
  | 
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterRegister
otBackboneRouterSetDomainPrefixCallback
void otBackboneRouterSetDomainPrefixCallback( otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext )
پیشوند Backbone Router Domain را تنظیم می کند.
| جزئیات | |||||||
|---|---|---|---|---|---|---|---|
| مولفه های | 
  | 
otBackboneRouterSetEnabled
void otBackboneRouterSetEnabled( otInstance *aInstance, bool aEnable )
عملکرد Backbone را فعال یا غیرفعال می کند.
 اگر فعال باشد، اگر سرویس مسیریاب ستون فقرات در داده شبکه موضوعی وجود نداشته باشد، یک پیام درخواست داده سرور SRV_DATA.ntf برای دستگاه متصل راهاندازی میشود.
 در صورت غیرفعال شدن، SRV_DATA.ntf راه اندازی می شود اگر روتر Backbone در حالت Primary باشد.
 زمانی در دسترس است که OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE فعال باشد.
| جزئیات | |||||
|---|---|---|---|---|---|
| مولفه های | 
  | 
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister
otBackboneRouterSetMulticastListenerCallback
void otBackboneRouterSetMulticastListenerCallback( otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext )
Backbone Router Multicast Listener را تنظیم می کند.
| جزئیات | |||||||
|---|---|---|---|---|---|---|---|
| مولفه های | 
  | 
otBackboneRouterSetNdProxyCallback
void otBackboneRouterSetNdProxyCallback( otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext )
Backbone Router ND Proxy را تنظیم می کند.
| جزئیات | |||||||
|---|---|---|---|---|---|---|---|
| مولفه های | 
  | 
otBackboneRouterSetRegistrationJitter
void otBackboneRouterSetRegistrationJitter( otInstance *aInstance, uint8_t aJitter )
مقدار jitter ثبت مسیریاب ستون فقرات را تنظیم می کند.
| جزئیات | |||
|---|---|---|---|
| مولفه های | 
  | 
otBackboneRouterGetRegistrationJitter
ماکروها
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT 0
Initializer برای otBackboneRouterMulticastListenerIterator.
منابع
موضوعات مرجع OpenThread API از کد منبع موجود در GitHub سرچشمه می گیرند. برای اطلاعات بیشتر، یا مشارکت در اسناد ما، به منابع مراجعه کنید.