Google se compromete a impulsar la igualdad racial para las comunidades afrodescendientes. Obtén información al respecto.

Router de red troncal

En este módulo, se incluyen funciones para el servicio del router 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 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 de la red troncal.

Typedefs

otBackboneRouterConfig typedef
Esta estructura representa la configuración del router de red 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 información de un objeto de escucha de 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 a este puntero de función cada vez que cambia el proxy de n.
otBackboneRouterNdProxyInfo typedef
Representa la información del proxy de ND de la red troncal.

Functions

otBackboneRouterConfigNextDuaRegistrationResponse(otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus)
void
Este método configura el estado de respuesta para el próximo registro de la DUA.
otBackboneRouterConfigNextMulticastListenerRegistrationResponse(otInstance *aInstance, uint8_t aStatus)
void
Este método configura el estado de respuesta para el próximo registro de escucha de multidifusión.
otBackboneRouterGetConfig(otInstance *aInstance, otBackboneRouterConfig *aConfig)
void
Esta función obtiene la configuración del router de red 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 de Backbone Router.
otBackboneRouterGetPrimary(otInstance *aInstance, otBackboneRouterConfig *aConfig)
Esta función obtiene la información del router principal de la red troncal en la red Thread.
otBackboneRouterGetRegistrationJitter(otInstance *aInstance)
uint8_t
Este método muestra el valor de jitter de registro del router de red troncal.
otBackboneRouterGetState(otInstance *aInstance)
Esta función obtiene el estado del router de red troncal.
otBackboneRouterMulticastListenerAdd(otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout)
Este método agrega un objeto de escucha multidifusión.
otBackboneRouterMulticastListenerClear(otInstance *aInstance)
void
Este método borra los objetos de escucha de multidifusión.
otBackboneRouterMulticastListenerGetNext(otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo)
Esta función obtiene la siguiente información de escucha de multidifusión (con un iterador).
otBackboneRouterRegister(otInstance *aInstance)
Esta función registra de manera explícita la configuración local del router de red troncal.
otBackboneRouterSetConfig(otInstance *aInstance, const otBackboneRouterConfig *aConfig)
Esta función establece la configuración local del router de red troncal.
otBackboneRouterSetDomainPrefixCallback(otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext)
void
Este método establece la devolución de llamada de prefijo del dominio del router de red troncal.
otBackboneRouterSetEnabled(otInstance *aInstance, bool aEnable)
void
Esta función habilita o inhabilita la funcionalidad de columna.
otBackboneRouterSetMulticastListenerCallback(otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext)
void
Este método establece la devolución de llamada del objeto de escucha multidifusión del router Backbone.
otBackboneRouterSetNdProxyCallback(otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext)
void
Este método establece la devolución de llamada del proxy de BackND del router de red.
otBackboneRouterSetRegistrationJitter(otInstance *aInstance, uint8_t aJitter)
void
Este método establece el valor de jitter de registro del router de red troncal.

Structs

otBackboneRouterConfig

Esta estructura representa la configuración del router de red troncal.

otBackboneRouterMulticastListenerInfo

Esta estructura representa información de un objeto de escucha de multidifusión del router de red troncal.

otBackboneRouterNdProxyInfo

Representa la información del proxy de ND de la red troncal.

Enumeraciones

otBackboneRouterDomainPrefixEvent

 otBackboneRouterDomainPrefixEvent

Representa los eventos de prefijo del dominio.

Properties
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 escucha de multidifusión.

Properties
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED

Se agregó el objeto de escucha multidifusión.

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED

Se quitó o venció el objeto de escucha multidifusión.

otBackboneRouterNdProxyEvent

 otBackboneRouterNdProxyEvent

Representa los eventos del proxy de ND.

Properties
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 de la red troncal.

Properties
OT_BACKBONE_ROUTER_STATE_DISABLED

La función de columna está inhabilitada.

OT_BACKBONE_ROUTER_STATE_PRIMARY

El router de columna principal.

OT_BACKBONE_ROUTER_STATE_SECONDARY

Router secundario de red troncal

Typedefs

otBackboneRouterConfig

struct otBackboneRouterConfig otBackboneRouterConfig

Esta estructura representa la configuración del router de red 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 de contexto de usuario.
[in] aEvent
El evento de prefijo del dominio.
[in] aDomainPrefix
El nuevo prefijo de dominio, si se agrega o se cambia, en caso contrario, es nullptr.

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

otBackboneRouterMulticastListenerInfo

struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo

Esta estructura representa información de un objeto de escucha de 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 a este puntero de función cada vez que cambia el proxy de n.

Detalles
Parámetros
[in] aContext
El puntero de contexto de usuario.
[in] aEvent
El evento de proxy ND
[in] aDua
La dirección de Unicast 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 de la red troncal.

Functions

otBackboneRouterConfigNextDuaRegistrationResponse

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

Este método configura el estado de 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.

PENDIENTE: (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 que se muestre. De lo contrario, solo responde al que coincida con aMlIid.
[in] aStatus
El estado que se debe responder.

otBackboneRouterConfigNextMulticastListenerRegistrationResponse

void otBackboneRouterConfigNextMulticastListenerRegistrationResponse(
  otInstance *aInstance,
  uint8_t aStatus
)

Este método configura el estado de respuesta para el próximo registro de escucha de multidifusión.

Nota: Disponible solo cuando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE esté habilitado. Solo se usa para pruebas y certificaciones.

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
)

Esta función obtiene la configuración del router de red troncal local.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aConfig
Un puntero para colocar la configuración local del router de red troncal
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 que se muestran
OT_ERROR_NONE
Se obtuvo correctamente la configuración de prefijo del dominio.
OT_ERROR_NOT_FOUND
No se configuró un prefijo de dominio.

otBackboneRouterGetNdProxyInfo

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

Este método obtiene la información del proxy de ND de Backbone Router.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDua
La dirección de Unicast del dominio
[out] aNdProxyInfo
Un puntero para la 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 pudo encontrar la dirección de Unicast del dominio en la tabla de proxy de ND.

otBackboneRouterGetPrimary

otError otBackboneRouterGetPrimary(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Esta función obtiene la información del router principal de la red troncal en la red Thread.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aConfig
Un puntero para ver dónde ubicar la información del router de la columna principal.
Valores que se muestran
OT_ERROR_NONE
Se obtuvo correctamente la información del router principal de la red troncal.
OT_ERROR_NOT_FOUND
No existe un router principal.

otBackboneRouterGetRegistrationJitter

uint8_t otBackboneRouterGetRegistrationJitter(
  otInstance *aInstance
)

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

Detalles
Qué muestra
Es el valor de jitter de registro del router de red troncal.
Consulta también:
otBackboneRouterSetRegistrationJitter

otBackboneRouterGetState

otBackboneRouterState otBackboneRouterGetState(
  otInstance *aInstance
)

Esta función obtiene el estado del router de red troncal.

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

otBackboneRouterMulticastListenerAdd

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

Este método agrega un objeto de escucha multidifusión.

Nota: Disponible solo cuando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE esté habilitado. Solo se usa para pruebas y certificaciones.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aAddress
La dirección de multidifusión del objeto de escucha
[in] aTimeout
Es el tiempo de espera (en segundos) del objeto de escucha multidifusión o 0 para usar el tiempo de espera predeterminado de la MLR.
Valores que se muestran
OT_ERROR_NONE
Si el objeto de escucha 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 objeto de escucha de multidifusión.
Consulta también:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerGetNext

otBackboneRouterMulticastListenerClear

void otBackboneRouterMulticastListenerClear(
  otInstance *aInstance
)

Este método borra los objetos de escucha de multidifusión.

Nota: Disponible solo cuando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE esté habilitado. Solo se usa para pruebas y certificaciones.

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 escucha de multidifusión (con 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, se debe configurar el iterador en OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT.
[out] aListenerInfo
Un puntero para un elemento otBackboneRouterMulticastListenerInfo en el que se coloca información sobre el siguiente objeto de escucha de multidifusión (en caso de éxito).
Valores que se muestran
OT_ERROR_NONE
Se encontró correctamente la siguiente información de escucha de multidifusión (aListenerInfo se actualizó correctamente).
OT_ERROR_NOT_FOUND
No se encontró ninguna información de escucha de multidifusión posterior.
Consulta también:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerAdd

otBackboneRouterRegister

otError otBackboneRouterRegister(
  otInstance *aInstance
)

Esta función registra de manera explícita la configuración local del router de red troncal.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores que se muestran
OT_ERROR_NO_BUFS
No hay suficiente espacio para agregar el servicio de router de espalda.
OT_ERROR_NONE
Se agregó correctamente a la 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
)

Esta función establece la configuración local del router de red troncal.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aConfig
Un puntero para la configuración del router de Backbone que se aplicará.
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
)

Este método establece la devolución de llamada de 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 de prefijo del dominio.
[in] aContext
Un puntero de contexto del usuario.

otBackboneRouterSetEnabled

void otBackboneRouterSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Esta función habilita o inhabilita la funcionalidad de columna.

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, es 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 objeto de escucha multidifusión del router Backbone.

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 BackND del router de red.

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 de red troncal.

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

Macros

OT_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 en el código fuente, disponible en GitHub. Para obtener más información o colaborar con nuestra documentación, consulta Recursos.