Google se compromete a impulsar la igualdad racial para las comunidades afrodescendientes. Obtén información al respecto.
Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Router 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 del dominio.
otBackboneRouterMulticastListenerEvent{
  OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED = 0,
  OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED = 1
}
Enum
Representa los eventos del receptor 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
Esta estructura representa la configuración del router troncal.
otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix) typedef
void(*
Se llama a este puntero de función cada vez que cambia el prefijo de dominio.
otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress) typedef
void(*
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 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 a este puntero de función cada vez que cambia el proxy Nd.
otBackboneRouterNdProxyInfo typedef
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
[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, de lo contrario, será nulo.

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
[in] aContext
El puntero del contexto del usuario.
[in] aEvent
El evento de multidifusión de objetos de escucha
[in] aAddress
La dirección de multidifusión IPv6 del objeto de escucha de multidifusión.

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
[in] aContext
El puntero del contexto del usuario.
[in] aEvent
El evento de proxy ND
[in] aDua
La dirección de dominio único del proxy 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 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
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aMlIid
Un puntero para el IID local de malla. Si es NULL, responde con aStatus para cualquier DUA.req entrante; 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 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
[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 troncal local.

Disponible cuando OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE está habilitado.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aConfig
Un puntero en el que se debe configurar el router troncal local.
Consulta también:
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
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aConfig
Un puntero para la configuración de prefijo de dominio.
Valores de retorno
OT_ERROR_NONE
Se obtuvo correctamente la configuración de prefijo del dominio.
OT_ERROR_NOT_FOUND
No se configuró ningún prefijo de dominio.

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
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDua
La dirección de dominio único.
[out] aNdProxyInfo
Un puntero para la información del proxy de ND
Valores de retorno
OT_ERROR_NONE
Se obtuvo la información del proxy de ND correctamente.
OT_ERROR_NOT_FOUND
No se pudo encontrar la dirección de dominio único en la tabla de proxy de ND.

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
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aConfig
Un puntero sobre dónde colocar la información del router troncal principal
Valores de retorno
OT_ERROR_NONE
Se obtuvo correctamente la información del router troncal principal.
OT_ERROR_NOT_FOUND
No existe un router troncal principal.

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.
Consulta también:
otBackboneRouterSetRegistrationJitter

otBackboneRouterGetState

otBackboneRouterState otBackboneRouterGetState(
  otInstance *aInstance
)

Obtiene el router de la red troncal otBackboneRouterState.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores de retorno
OT_BACKBONE_ROUTER_STATE_DISABLED
La funcionalidad de la red troncal está inhabilitada.
OT_BACKBONE_ROUTER_STATE_SECONDARY
Router de red troncal secundaria.
OT_BACKBONE_ROUTER_STATE_PRIMARY
Es el router troncal principal.
Consulta también:
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
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aAddress
La dirección de escucha de multidifusión.
[in] aTimeout
Es el tiempo de espera (en segundos) del receptor de multidifusión, o 0 para usar el tiempo de espera de MLR predeterminado.
Valores de retorno
OT_ERROR_NONE
Si el receptor de multidifusión se agregó correctamente.
OT_ERROR_INVALID_ARGS
Si la dirección del objeto de escucha multidifusión no es válida.
OT_ERROR_NO_BUFS
No hay espacio disponible para guardar el receptor de multidifusión.
Consulta también:
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
[in] aInstance
Un puntero para una instancia de OpenThread.
Consulta también:
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
[in] aInstance
Un puntero para una instancia de OpenThread.
[in,out] aIterator
Un puntero al iterador. Si se realiza correctamente, se actualizará el iterador para que apunte al siguiente objeto de escucha multidifusión. Para obtener la primera entrada, el iterador debe configurarse en OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT.
[out] aListenerInfo
Un puntero para un objeto otBackboneRouterMulticastListenerInfo en el que se coloca información del próximo objeto de escucha de multidifusión (si se ejecuta de forma correcta).
Valores de retorno
OT_ERROR_NONE
Se encontró correctamente la siguiente información del objeto de escucha multidifusión (aListenerInfo se actualizó correctamente).
OT_ERROR_NOT_FOUND
No se encontró información posterior del objeto de escucha multidifusión.
Consulta también:
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
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores de retorno
OT_ERROR_NO_BUFS
No hay espacio suficiente para agregar el servicio de router troncal.
OT_ERROR_NONE
Se colocó correctamente en cola un mensaje de solicitud de datos del servidor para la entrega.
Consulta también:
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
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aConfig
Un puntero para que se aplique la configuración del router troncal.
Valores de retorno
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
)

Este método establece la devolución de llamada del prefijo de dominio del router troncal.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aCallback
Un puntero para la devolución de llamada de prefijo de 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 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
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aEnable
TRUE para habilitar la funcionalidad de la red troncal; de lo contrario, FALSE.
Consulta también:
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
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aCallback
Un puntero para la devolución de llamada de escucha de multidifusión
[in] aContext
Un puntero de contexto del usuario.

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
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aCallback
Un puntero para la devolución de llamada de proxy ND.
[in] aContext
Un puntero de contexto del usuario.

otBackboneRouterSetRegistrationJitter

void otBackboneRouterSetRegistrationJitter(
  otInstance *aInstance,
  uint8_t aJitter
)

Este método establece el valor de jitter de registro del router troncal.

Detalles
Parámetros
[in] aJitter
el valor jitter de registro del router troncal para establecer.
Consulta también:
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.