Router troncal
Este módulo incluye funciones para el servicio de router de red troncal de OpenThread.
Resumen
Enumeraciones |
|
---|---|
otBackboneRouterDomainPrefixEvent{
|
Enum Representa los eventos de prefijo del dominio. |
otBackboneRouterMulticastListenerEvent{
|
Enum Representa los eventos del receptor de multidifusión. |
otBackboneRouterNdProxyEvent{
|
Enum Representa los eventos del proxy de ND. |
otBackboneRouterState{
|
Enum Representa el estado del router troncal. |
Typedefs |
|
---|---|
otBackboneRouterConfig
|
typedefstruct otBackboneRouterConfig
Esta estructura representa la configuración del router troncal. |
otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix)
|
typedefvoid(*
Se llama a este puntero de función cada vez que cambia el prefijo de dominio. |
otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress)
|
typedefvoid(*
Se llama a este puntero de función cada vez que cambian los objetos de escucha de multidifusión. |
otBackboneRouterMulticastListenerInfo
|
typedef Esta estructura representa la información de un receptor de multidifusión del router troncal. |
otBackboneRouterMulticastListenerIterator
|
typedefuint16_t
Se usa para iterar a través de objetos de escucha de multidifusión. |
otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua)
|
typedefvoid(*
Se llama a este puntero de función cada vez que cambia el proxy Nd. |
otBackboneRouterNdProxyInfo
|
typedefstruct otBackboneRouterNdProxyInfo
Representa la información del proxy de ND del router troncal. |
Funciones |
|
---|---|
otBackboneRouterConfigNextDuaRegistrationResponse(otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus)
|
void
Este método configura el estado de la respuesta para el próximo registro de la DUA.
|
otBackboneRouterConfigNextMulticastListenerRegistrationResponse(otInstance *aInstance, uint8_t aStatus)
|
void
Configura el estado de respuesta del próximo registro de receptor de multidifusión.
|
otBackboneRouterGetConfig(otInstance *aInstance, otBackboneRouterConfig *aConfig)
|
void
Obtiene la configuración del router troncal local.
|
otBackboneRouterGetDomainPrefix(otInstance *aInstance, otBorderRouterConfig *aConfig)
|
Este método obtiene la configuración del prefijo de dominio local.
|
otBackboneRouterGetNdProxyInfo(otInstance *aInstance, const otIp6Address *aDua, otBackboneRouterNdProxyInfo *aNdProxyInfo)
|
Este método obtiene la información del proxy de ND del router troncal.
|
otBackboneRouterGetPrimary(otInstance *aInstance, otBackboneRouterConfig *aConfig)
|
Esta función obtiene la información del router de la red troncal principal en la red Thread.
|
otBackboneRouterGetRegistrationJitter(otInstance *aInstance)
|
uint8_t
Este método muestra el valor jitter de registro del router troncal.
|
otBackboneRouterGetState(otInstance *aInstance)
|
Obtiene el router de la red troncal otBackboneRouterState.
|
otBackboneRouterMulticastListenerAdd(otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout)
|
Agrega un receptor de multidifusión en segundos con un valor de tiempo de espera.
|
otBackboneRouterMulticastListenerClear(otInstance *aInstance)
|
void
Borra los objetos de escucha de multidifusión.
|
otBackboneRouterMulticastListenerGetNext(otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo)
|
Esta función obtiene la siguiente información de receptor de multidifusión (mediante un iterador).
|
otBackboneRouterRegister(otInstance *aInstance)
|
Registra de forma explícita la configuración del router troncal local.
|
otBackboneRouterSetConfig(otInstance *aInstance, const otBackboneRouterConfig *aConfig)
|
Establece la configuración local del router troncal otBackboneRouterConfig.
|
otBackboneRouterSetDomainPrefixCallback(otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext)
|
void
Este método establece la devolución de llamada del prefijo de dominio del router troncal.
|
otBackboneRouterSetEnabled(otInstance *aInstance, bool aEnable)
|
void
Habilita o inhabilita la funcionalidad de la red troncal.
|
otBackboneRouterSetMulticastListenerCallback(otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext)
|
void
Este método establece la devolución de llamada del receptor de multidifusión del router de red troncal.
|
otBackboneRouterSetNdProxyCallback(otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext)
|
void
Este método establece la devolución de llamada del proxy de red ND de proxy.
|
otBackboneRouterSetRegistrationJitter(otInstance *aInstance, uint8_t aJitter)
|
void
Este método establece el valor de jitter de registro del router troncal.
|
Structs |
|
---|---|
otBackboneRouterConfig. |
Esta estructura representa la configuración del router troncal. |
otBackboneRouterMulticastListenerInfo |
Esta estructura representa la información de un receptor de multidifusión del router troncal. |
otBackboneRouterNdProxyInfo. |
Representa la información del proxy de ND del router troncal. |
Enumeraciones
otBackboneRouterDomainPrefixEvent
otBackboneRouterDomainPrefixEvent
Representa los eventos de prefijo del dominio.
Propiedades | |
---|---|
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_ADDED
|
Se agregó un prefijo de dominio. |
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_CHANGED
|
Se ha cambiado el prefijo de dominio. |
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED
|
Se quitó el prefijo del dominio. |
otBackboneRouterMulticastListenerEvent
otBackboneRouterMulticastListenerEvent
Representa los eventos del receptor de multidifusión.
Propiedades | |
---|---|
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED
|
Se agregó el receptor de multidifusión. |
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED
|
El receptor de multidifusión se quitó o venció. |
otBackboneRouterNdProxyEvent
otBackboneRouterNdProxyEvent
Representa los eventos del proxy de ND.
Propiedades | |
---|---|
OT_BACKBONE_ROUTER_NDPROXY_ADDED
|
Se agregó el proxy de ND. |
OT_BACKBONE_ROUTER_NDPROXY_CLEARED
|
Se borraron todos los proxies ND. |
OT_BACKBONE_ROUTER_NDPROXY_REMOVED
|
Se quitó el proxy de ND. |
OT_BACKBONE_ROUTER_NDPROXY_RENEWED
|
Se renovó el proxy de ND. |
otBackboneRouterState
otBackboneRouterState
Representa el estado del router troncal.
Propiedades | |
---|---|
OT_BACKBONE_ROUTER_STATE_DISABLED
|
La función troncal está inhabilitada. |
OT_BACKBONE_ROUTER_STATE_PRIMARY
|
Es el router troncal principal. |
OT_BACKBONE_ROUTER_STATE_SECONDARY
|
Router de red troncal secundaria. |
Typedefs
otBackboneRouterConfig
struct otBackboneRouterConfig otBackboneRouterConfig
Esta estructura representa la configuración del router troncal.
otBackboneRouterDomainPrefixCallback
void(* otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix)
Se llama a este puntero de función cada vez que cambia el prefijo de dominio.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
otBackboneRouterMulticastListenerCallback
void(* otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress)
Se llama a este puntero de función cada vez que cambian los objetos de escucha de multidifusión.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
otBackboneRouterMulticastListenerInfo
struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo
Esta estructura representa la información de un receptor de multidifusión del router troncal.
otBackboneRouterMulticastListenerIterator
uint16_t otBackboneRouterMulticastListenerIterator
Se usa para iterar a través de objetos de escucha de multidifusión.
otBackboneRouterNdProxyCallback
void(* otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua)
Se llama a este puntero de función cada vez que cambia el proxy Nd.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
otBackboneRouterNdProxyInfo
struct otBackboneRouterNdProxyInfo otBackboneRouterNdProxyInfo
Representa la información del proxy de ND del router troncal.
Funciones
otBackboneRouterConfigNextDuaRegistrationResponse
void otBackboneRouterConfigNextDuaRegistrationResponse( otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus )
Este método configura el estado de la respuesta para el próximo registro de la DUA.
Nota: Disponible solo cuando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
está habilitado. Solo se usa para pruebas y certificaciones.
ACTIVIDAD: (DUA) admite el código de error de coap y el proceso correspondiente para fines de certificación.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
otBackboneRouterConfigNextMulticastListenerRegistrationResponse
void otBackboneRouterConfigNextMulticastListenerRegistrationResponse( otInstance *aInstance, uint8_t aStatus )
Configura el estado de respuesta del próximo registro de receptor de multidifusión.
Disponible cuando OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE
y OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
están habilitados.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otBackboneRouterGetConfig
void otBackboneRouterGetConfig( otInstance *aInstance, otBackboneRouterConfig *aConfig )
Obtiene la configuración del router troncal local.
Disponible cuando OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
está habilitado.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterSetConfig
otBackboneRouterRegister
otBackboneRouterGetDomainPrefix
otError otBackboneRouterGetDomainPrefix( otInstance *aInstance, otBorderRouterConfig *aConfig )
Este método obtiene la configuración del prefijo de dominio local.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
otBackboneRouterGetNdProxyInfo
otError otBackboneRouterGetNdProxyInfo( otInstance *aInstance, const otIp6Address *aDua, otBackboneRouterNdProxyInfo *aNdProxyInfo )
Este método obtiene la información del proxy de ND del router troncal.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores de retorno |
|
otBackboneRouterGetPrimary
otError otBackboneRouterGetPrimary( otInstance *aInstance, otBackboneRouterConfig *aConfig )
Esta función obtiene la información del router de la red troncal principal en la red Thread.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
otBackboneRouterGetRegistrationJitter
uint8_t otBackboneRouterGetRegistrationJitter( otInstance *aInstance )
Este método muestra el valor jitter de registro del router troncal.
Detalles | |
---|---|
Qué muestra |
El valor de jitter de registro del router troncal.
|
otBackboneRouterSetRegistrationJitter
otBackboneRouterGetState
otBackboneRouterState otBackboneRouterGetState( otInstance *aInstance )
Obtiene el router de la red troncal otBackboneRouterState.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores de retorno |
|
otBackboneRouterSetEnabled
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister
otBackboneRouterMulticastListenerAdd
otError otBackboneRouterMulticastListenerAdd( otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout )
Agrega un receptor de multidifusión en segundos con un valor de tiempo de espera.
Pasa 0
para usar el tiempo de espera de MLR predeterminado.
Disponible cuando OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE
y OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
están habilitados.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores de retorno |
|
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerGetNext
otBackboneRouterMulticastListenerClear
void otBackboneRouterMulticastListenerClear( otInstance *aInstance )
Borra los objetos de escucha de multidifusión.
Disponible cuando OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE
y OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
están habilitados.
Detalles | |||
---|---|---|---|
Parámetros |
|
otBackboneRouterMulticastListenerAdd
otBackboneRouterMulticastListenerGetNext
otBackboneRouterMulticastListenerGetNext
otError otBackboneRouterMulticastListenerGetNext( otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo )
Esta función obtiene la siguiente información de receptor de multidifusión (mediante un iterador).
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores de retorno |
|
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerAdd
otBackboneRouterRegister
otError otBackboneRouterRegister( otInstance *aInstance )
Registra de forma explícita la configuración del router troncal local.
Se activa un mensaje SRV_DATA.ntf
de solicitud de datos del servidor para el dispositivo conectado.
Disponible cuando OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
está habilitado.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterSetConfig
otError otBackboneRouterSetConfig( otInstance *aInstance, const otBackboneRouterConfig *aConfig )
Establece la configuración local del router troncal otBackboneRouterConfig.
Un mensaje de solicitud de datos del servidor SRV_DATA.ntf
se inicia automáticamente si el conjunto de datos de BBR cambia para el router troncal principal.
Disponible cuando OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
está habilitado.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterRegister
otBackboneRouterSetDomainPrefixCallback
void otBackboneRouterSetDomainPrefixCallback( otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext )
Este método establece la devolución de llamada del prefijo de dominio del router troncal.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
otBackboneRouterSetEnabled
void otBackboneRouterSetEnabled( otInstance *aInstance, bool aEnable )
Habilita o inhabilita la funcionalidad de la red troncal.
Si está habilitado, se activa un mensaje de solicitud de datos del servidor SRV_DATA.ntf
para el dispositivo conectado si no hay un servicio de router de red troncal en los datos de red de Thread.
Si está inhabilitado, se activa SRV_DATA.ntf
si el router troncal está en el estado Principal.
Disponible cuando OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
está habilitado.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister
otBackboneRouterSetMulticastListenerCallback
void otBackboneRouterSetMulticastListenerCallback( otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext )
Este método establece la devolución de llamada del receptor de multidifusión del router de red troncal.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
otBackboneRouterSetNdProxyCallback
void otBackboneRouterSetNdProxyCallback( otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext )
Este método establece la devolución de llamada del proxy de red ND de proxy.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
otBackboneRouterSetRegistrationJitter
void otBackboneRouterSetRegistrationJitter( otInstance *aInstance, uint8_t aJitter )
Este método establece el valor de jitter de registro del router troncal.
Detalles | |||
---|---|---|---|
Parámetros |
|
otBackboneRouterGetRegistrationJitter
Macros
TS_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT 0
Inicializador de otBackboneRouterMulticastListenerIterator.
Recursos
Los temas de referencia de la API de OpenThread se originan a partir del código fuente, disponible en GitHub. Para obtener más información o contribuir con nuestra documentación, consulta Recursos.