Router de red troncal

Este módulo incluye funciones para el servicio de router de red troncal de OpenThread.

Resumen

Enumeraciones
otBackboneRouterDomainPrefixEvent{
  OT_BACKBONE_ROUTER_DOMAIN_PREFIX_ADDED = 0,
  OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED = 1,
  OT_BACKBONE_ROUTER_DOMAIN_PREFIX_CHANGED = 2
} 		Enum
Representa los eventos de prefijo de dominio.
otBackboneRouterMulticastListenerEvent{
  OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED = 0,
  OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED = 1
} 		Enum
Representa los eventos de objetos de escucha de multidifusión.
otBackboneRouterNdProxyEvent{
  OT_BACKBONE_ROUTER_NDPROXY_ADDED = 0,
  OT_BACKBONE_ROUTER_NDPROXY_REMOVED = 1,
  OT_BACKBONE_ROUTER_NDPROXY_RENEWED = 2,
  OT_BACKBONE_ROUTER_NDPROXY_CLEARED = 3
} 		Enum
Representa los eventos del proxy de ND.
otBackboneRouterState{
  OT_BACKBONE_ROUTER_STATE_DISABLED = 0,
  OT_BACKBONE_ROUTER_STATE_SECONDARY = 1,
  OT_BACKBONE_ROUTER_STATE_PRIMARY = 2
} 		Enum
Representa el estado del router troncal.

Typedefs
otBackboneRouterConfig typedef
Representa la configuración del router de red troncal.
otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix) typedef
void(*
Se llama al puntero cada vez que cambia el prefijo de dominio.
otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress) typedef
void(*
Se llama al puntero cuando cambian los objetos de escucha de multidifusión.
otBackboneRouterMulticastListenerInfo typedef
Representa una información del objeto de escucha multidifusión del router de red troncal.
otBackboneRouterMulticastListenerIterator typedef
uint16_t
Se usa para iterar a través de objetos de escucha de multidifusión.
otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua) typedef
void(*
Se llama al puntero cada vez que cambia el proxy Nd.
otBackboneRouterNdProxyInfo typedef
Representa la información del proxy de ND del router de red central.

Funciones
otBackboneRouterConfigNextDuaRegistrationResponse(otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus)
void
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 la respuesta del próximo registro de objetos de escucha de multidifusión.
otBackboneRouterGetConfig(otInstance *aInstance, otBackboneRouterConfig *aConfig)
void
Obtiene la configuración del router de red troncal local.
otBackboneRouterGetDomainPrefix(otInstance *aInstance, otBorderRouterConfig *aConfig)
Obtiene la configuración del prefijo del dominio local.
otBackboneRouterGetNdProxyInfo(otInstance *aInstance, const otIp6Address *aDua, otBackboneRouterNdProxyInfo *aNdProxyInfo)
Obtiene la información del proxy de ND del router de red central.
otBackboneRouterGetPrimary(otInstance *aInstance, otBackboneRouterConfig *aConfig)
Obtiene la información del router de red troncal principal en la red de subprocesos.
otBackboneRouterGetRegistrationJitter(otInstance *aInstance)
uint8_t
Muestra el valor de Jitter del registro del router de red troncal.
otBackboneRouterGetState(otInstance *aInstance)
Obtiene el router de red troncal otBackboneRouterState.
otBackboneRouterMulticastListenerAdd(otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout)
Agrega un objeto de escucha de multidifusión con un valor de tiempo de espera, en segundos.
otBackboneRouterMulticastListenerClear(otInstance *aInstance)
void
Borra los objetos de escucha de multidifusión.
otBackboneRouterMulticastListenerGetNext(otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo)
Obtiene la siguiente información de objeto de escucha de multidifusión (mediante un iterador).
otBackboneRouterRegister(otInstance *aInstance)
Registra de forma explícita la configuración del router de red troncal local.
otBackboneRouterSetConfig(otInstance *aInstance, const otBackboneRouterConfig *aConfig)
Establece la configuración del router de red troncal local otBackboneRouterConfig.
otBackboneRouterSetDomainPrefixCallback(otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext)
void
Establece la devolución de llamada del prefijo del dominio del router de red troncal.
otBackboneRouterSetEnabled(otInstance *aInstance, bool aEnable)
void
Habilita o inhabilita la funcionalidad de la red troncal.
otBackboneRouterSetMulticastListenerCallback(otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext)
void
Configura la devolución de llamada del objeto de escucha de multidifusión del router de Backbone.
otBackboneRouterSetNdProxyCallback(otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext)
void
Establece la devolución de llamada del proxy de ND de red troncal.
otBackboneRouterSetRegistrationJitter(otInstance *aInstance, uint8_t aJitter)
void
Establece el valor de Jitter del registro del router de red troncal.

Structs
otBackboneRouterConfig;

Representa la configuración del router de red troncal.

otBackboneRouterMulticastListenerInfo

Representa una información del objeto de escucha multidifusión del router de red troncal.

otBackboneRouterNdProxyInfo;

Representa la información del proxy de ND del router de red central.

Enumeraciones

otBackboneRouterDomainPrefixEvent

 otBackboneRouterDomainPrefixEvent

Representa los eventos de prefijo de dominio.

Propiedades
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_ADDED

Se agregó el prefijo del dominio.

OT_BACKBONE_ROUTER_DOMAIN_PREFIX_CHANGED

Se cambió el prefijo del dominio.

OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED

Se quitó el prefijo del dominio.

otBackboneRouterMulticastListenerEvent

 otBackboneRouterMulticastListenerEvent

Representa los eventos de objetos de escucha de multidifusión.

Propiedades
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED

Se agregó el objeto de escucha de multidifusión.

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED

El objeto de escucha 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 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

El router troncal principal.

OT_BACKBONE_ROUTER_STATE_SECONDARY

Router de red troncal secundaria.

Typedefs

otBackboneRouterConfig

struct otBackboneRouterConfig otBackboneRouterConfig

Representa la configuración del router de red troncal.

otBackboneRouterDomainPrefixCallback

void(* otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix)

Se llama al puntero cada vez que cambia el prefijo de dominio.

Detalles
Parámetros
[in] aContext
El puntero del contexto del usuario.
[in] aEvent
El evento de prefijo del dominio.
[in] aDomainPrefix
Si se agrega o se cambia el nuevo prefijo de dominio, se anula el valor de nullptr.

otBackboneRouterMulticastListenerCallback

void(* otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress)

Se llama al puntero cuando cambian los objetos de escucha de multidifusión.

Detalles
Parámetros
[in] aContext
El puntero del contexto del usuario.
[in] aEvent
Evento de escucha de multidifusión
[in] aAddress
La dirección multidifusión IPv6 del objeto de escucha de multidifusión.

otBackboneRouterMulticastListenerInfo,

struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo

Representa una información del objeto de escucha multidifusión del router de red 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 al puntero cada vez que cambia el proxy Nd.

Detalles
Parámetros
[in] aContext
El puntero del contexto del usuario.
[in] aEvent
El evento del proxy de ND.
[in] aDua
La dirección de dominio único del proxy de ND, o nullptr si aEvent es OT_BACKBONE_ROUTER_NDPROXY_CLEARED.

otBackboneRouterNdProxyInfo

struct otBackboneRouterNdProxyInfo otBackboneRouterNdProxyInfo

Representa la información del proxy de ND del router de red central.

Funciones

otBackboneRouterConfigNextDuaRegistrationResponse

void otBackboneRouterConfigNextDuaRegistrationResponse(
  otInstance *aInstance,
  const otIp6InterfaceIdentifier *aMlIid,
  uint8_t aStatus
)

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.

TODO: (DUA) admite el código de error coap y el proceso correspondiente para fines de certificación.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aMlIid
Un puntero para el IID local de la malla. Si es NULL, responde con aStatus para cualquier DUA.req próximo. De lo contrario, responde solo el que tenga aMlIid.
[in] aStatus
El estado que se debe responder.

otBackboneRouterConfigNextMulticastListenerRegistrationResponse

void otBackboneRouterConfigNextMulticastListenerRegistrationResponse(
  otInstance *aInstance,
  uint8_t aStatus
)

Configura el estado de la respuesta del próximo registro de objetos de escucha de multidifusión.

Disponible cuando se habilitan OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE y OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aStatus
El estado que se debe responder.

otBackboneRouterGetConfig

void otBackboneRouterGetConfig(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Obtiene la configuración del router de red troncal local.

Disponible cuando se habilita OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aConfig
Un puntero en el que se debe configurar el router local de red troncal.
Consulta también:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterSetConfig
otBackboneRouterRegister

otBackboneRouterGetDomainPrefix.

otError otBackboneRouterGetDomainPrefix(
  otInstance *aInstance,
  otBorderRouterConfig *aConfig
)

Obtiene la configuración del prefijo del dominio local.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aConfig
Un puntero para la configuración del prefijo de dominio.
Valores que se muestran
OT_ERROR_NONE
Se obtuvo correctamente la configuración de prefijo de dominio.
OT_ERROR_NOT_FOUND
No se configuró ningún prefijo de dominio.

otBackboneRouterGetNdProxyInfo

otError otBackboneRouterGetNdProxyInfo(
  otInstance *aInstance,
  const otIp6Address *aDua,
  otBackboneRouterNdProxyInfo *aNdProxyInfo
)

Obtiene la información del proxy de ND del router de red central.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDua
La dirección de dominio único.
[out] aNdProxyInfo
Un puntero para obtener información del proxy de ND
Valores que se muestran
OT_ERROR_NONE
Se obtuvo correctamente la información del proxy de ND.
OT_ERROR_NOT_FOUND
No se encontró la dirección de dominio único en la tabla del proxy de ND.

otBackRouteRouterGetPrimary

otError otBackboneRouterGetPrimary(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Obtiene la información del router de red troncal principal en la red de subprocesos.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aConfig
Un puntero al lugar donde se debe colocar la información del router de red troncal principal.
Valores que se muestran
OT_ERROR_NONE
Se obtuvo correctamente la información del router de red troncal principal.
OT_ERROR_NOT_FOUND
No existe un router troncal principal.

otBackboneRouterGetRegistrationJitter

uint8_t otBackboneRouterGetRegistrationJitter(
  otInstance *aInstance
)

Muestra el valor de Jitter del registro del router de red troncal.

Detalles
Qué muestra
El valor de Jitter del registro del router de red troncal.
Consulta también:
otBackboneRouterSetRegistrationJitter

otBackboneRouterGetState

otBackboneRouterState otBackboneRouterGetState(
  otInstance *aInstance
)

Obtiene el router de red troncal otBackboneRouterState.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores que se muestran
OT_BACKBONE_ROUTER_STATE_DISABLED
La función troncal está inhabilitada.
OT_BACKBONE_ROUTER_STATE_SECONDARY
Router de red troncal secundaria.
OT_BACKBONE_ROUTER_STATE_PRIMARY
El router troncal principal.
Consulta también:
otBackboneRouterSetEnabled
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister

otBackboneRouterMulticastListenerAdd

otError otBackboneRouterMulticastListenerAdd(
  otInstance *aInstance,
  const otIp6Address *aAddress,
  uint32_t aTimeout
)

Agrega un objeto de escucha de multidifusión con un valor de tiempo de espera, en segundos.

Pasa 0 para usar el tiempo de espera predeterminado de MLR.

Disponible cuando se habilitan OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE y OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aAddress
La dirección del objeto de escucha de multidifusión.
[in] aTimeout
Es el tiempo de espera (en segundos) del objeto de escucha de multidifusión, o 0 para usar el tiempo de espera predeterminado de MLR.
Valores que se muestran
OT_ERROR_NONE
Si el objeto de escucha de multidifusión se agregó correctamente.
OT_ERROR_INVALID_ARGS
Si la dirección del objeto de escucha de multidifusión no es válida.
OT_ERROR_NO_BUFS
No hay espacio disponible para guardar el objeto de escucha de multidifusión.
Consulta también:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerGetNext

otBackboneRouterMulticastListenerClear

void otBackboneRouterMulticastListenerClear(
  otInstance *aInstance
)

Borra los objetos de escucha de multidifusión.

Disponible cuando se habilitan OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE y OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Consulta también:
otBackboneRouterMulticastListenerAdd
otBackboneRouterMulticastListenerGetNext

otBackboneRouterMulticastListenerGetNext

otError otBackboneRouterMulticastListenerGetNext(
  otInstance *aInstance,
  otBackboneRouterMulticastListenerIterator *aIterator,
  otBackboneRouterMulticastListenerInfo *aListenerInfo
)

Obtiene la siguiente información de objeto de escucha de multidifusión (mediante un iterador).

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in,out] aIterator
Un puntero para el iterador Si se realiza de forma correcta, el iterador se actualizará para apuntar al siguiente objeto de escucha de multidifusión. Para obtener la primera entrada, el iterador se debe establecer en OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT.
[out] aListenerInfo
Es un puntero a un otBackboneRouterMulticastListenerInfo en el que se coloca información del próximo objeto de escucha de multidifusión (si se realiza correctamente).
Valores que se muestran
OT_ERROR_NONE
Se encontró correctamente la siguiente información del objeto de escucha de multidifusión (aListenerInfo se actualizó correctamente).
OT_ERROR_NOT_FOUND
No se encontró información posterior del objeto de escucha de multidifusión.
Consulta también:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerAdd

Registro de red troncal de registro

otError otBackboneRouterRegister(
  otInstance *aInstance
)

Registra de forma explícita la configuración del router de red troncal local.

Se activará el mensaje de solicitud de datos del servidor SRV_DATA.ntf para el dispositivo conectado.

Disponible cuando se habilita OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores que se muestran
OT_ERROR_NO_BUFS
No hay espacio suficiente para agregar el servicio de red troncal.
OT_ERROR_NONE
Un mensaje de solicitud de datos del servidor se colocó en cola correctamente para la entrega.
Consulta también:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig

otBackboneRouterSetConfig

otError otBackboneRouterSetConfig(
  otInstance *aInstance,
  const otBackboneRouterConfig *aConfig
)

Establece la configuración del router de red troncal local 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 de red troncal principal.

Disponible cuando se habilita OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aConfig
Un puntero para la configuración del router de red troncal.
Valores que se muestran
OT_ERROR_NONE
Se actualizó correctamente la configuración.
OT_ERROR_INVALID_ARGS
La configuración de aConfig no es válida.
Consulta también:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterRegister

otBackboneRouterSetDomainPrefixCallback

void otBackboneRouterSetDomainPrefixCallback(
  otInstance *aInstance,
  otBackboneRouterDomainPrefixCallback aCallback,
  void *aContext
)

Establece la devolución de llamada del prefijo del dominio del router de red troncal.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aCallback
Un puntero para la devolución de llamada del prefijo del dominio.
[in] aContext
Un puntero de contexto del usuario.

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 en los datos de red de Thread.

Si está inhabilitado, se activa SRV_DATA.ntf si el router de red troncal está en el estado principal.

Disponible cuando se habilita OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aEnable
TRUE para habilitar la funcionalidad de Backbone. De lo contrario, FALSE.
Consulta también:
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister

otBackboneRouterSetMulticastListenerCallback

void otBackboneRouterSetMulticastListenerCallback(
  otInstance *aInstance,
  otBackboneRouterMulticastListenerCallback aCallback,
  void *aContext
)

Configura la devolución de llamada del objeto de escucha de multidifusión del router de Backbone.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aCallback
Un puntero para la devolución de llamada de objeto de escucha de multidifusión.
[in] aContext
Un puntero de contexto del usuario.

otBackboneRouterSetNdProxyCallback

void otBackboneRouterSetNdProxyCallback(
  otInstance *aInstance,
  otBackboneRouterNdProxyCallback aCallback,
  void *aContext
)

Establece la devolución de llamada del proxy de ND de red troncal.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aCallback
Un puntero para la devolución de llamada del proxy de ND.
[in] aContext
Un puntero de contexto del usuario.

otBackboneRouterSetRegistrationJitter

void otBackboneRouterSetRegistrationJitter(
  otInstance *aInstance,
  uint8_t aJitter
)

Establece el valor de Jitter del registro del router de red troncal.

Detalles
Parámetros
[in] aJitter
el valor de Jitter del registro del router de Backbone.
Consulta también:
otBackboneRouterGetRegistrationJitter

Macros

PO_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 colaborar con nuestra documentación, consulta la sección Recursos.