Google is committed to advancing racial equity for Black communities. See how.
Se usó la API de Cloud Translation para traducir esta página.
Switch to English

Enrutador de red troncal

Este módulo incluye funciones para el servicio OpenThread Backbone Router.

Resumen

Enumeraciones

otBackboneRouterMulticastListenerEvent {
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED = 0,
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED = 1
}
enumeración
Representa los eventos de escucha de multidifusión.
otBackboneRouterState {
OT_BACKBONE_ROUTER_STATE_DISABLED = 0,
OT_BACKBONE_ROUTER_STATE_SECONDARY = 1,
OT_BACKBONE_ROUTER_STATE_PRIMARY = 2
}
enumeración
Representa el estado del enrutador principal.

Typedefs

otBackboneRouterConfig typedef
Esta estructura representa la configuración del enrutador troncal.
otBackboneRouterMulticastListenerCallback )(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress) typedef
void(*
Este puntero de función se llama siempre que cambian los escuchas de multidifusión.
otBackboneRouterMulticastListenerInfo typedef
Esta estructura representa una información de escucha de multidifusión de enrutador de red troncal.
otBackboneRouterMulticastListenerIterator typedef
uint16_t
Se utiliza para iterar a través de escuchas de multidifusión.

Funciones

otBackboneRouterConfigNextDuaRegistrationResponse ( otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus)
void
Este método configura el estado de respuesta para el próximo registro de 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 enrutador troncal local.
otBackboneRouterGetDomainPrefix ( otInstance *aInstance, otBorderRouterConfig *aConfig)
Este método obtiene la configuración de prefijo de dominio local.
otBackboneRouterGetPrimary ( otInstance *aInstance, otBackboneRouterConfig *aConfig)
Esta función obtiene la información del enrutador principal principal en la red de subprocesos.
otBackboneRouterGetRegistrationJitter ( otInstance *aInstance)
uint8_t
Este método devuelve el valor de fluctuación de fase de registro del enrutador principal.
otBackboneRouterGetState ( otInstance *aInstance)
Esta función obtiene el estado del enrutador troncal.
otBackboneRouterMulticastListenerAdd ( otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout)
Este método agrega un escucha de multidifusión.
otBackboneRouterMulticastListenerClear ( otInstance *aInstance)
void
Este método borra los escuchas de multidifusión.
otBackboneRouterMulticastListenerGetNext ( otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo)
Esta función obtiene la siguiente información de escucha de multidifusión (mediante un iterador).
otBackboneRouterRegister ( otInstance *aInstance)
Esta función registra explícitamente la configuración del enrutador troncal local.
otBackboneRouterSetConfig ( otInstance *aInstance, const otBackboneRouterConfig *aConfig)
Esta función establece la configuración del enrutador troncal local.
otBackboneRouterSetEnabled ( otInstance *aInstance, bool aEnable)
void
Esta función habilita o deshabilita la funcionalidad Backbone.
otBackboneRouterSetMulticastListenerCallback ( otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext)
void
Este método establece la devolución de llamada del escucha de multidifusión del enrutador principal.
otBackboneRouterSetRegistrationJitter ( otInstance *aInstance, uint8_t aJitter)
void
Este método establece el valor de fluctuación de fase de registro del enrutador principal.

Estructuras

otBackboneRouterConfig

Esta estructura representa la configuración del enrutador troncal.

otBackboneRouterMulticastListenerInfo

Esta estructura representa una información de escucha de multidifusión de enrutador de red troncal.

Enumeraciones

otBackboneRouterMulticastListenerEvent

 otBackboneRouterMulticastListenerEvent

Representa los eventos de escucha de multidifusión.

Propiedades
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED

Se agregó el escucha de multidifusión.

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED

El escucha de multidifusión se eliminó o expiró.

otBackboneRouterState

 otBackboneRouterState

Representa el estado del enrutador principal.

Propiedades
OT_BACKBONE_ROUTER_STATE_DISABLED

La función troncal está desactivada.

OT_BACKBONE_ROUTER_STATE_PRIMARY

El enrutador principal principal.

OT_BACKBONE_ROUTER_STATE_SECONDARY

Enrutador principal secundario.

Typedefs

otBackboneRouterConfig

struct otBackboneRouterConfig otBackboneRouterConfig

Esta estructura representa la configuración del enrutador troncal.

otBackboneRouterMulticastListenerCallback

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

Este puntero de función se llama siempre que cambian los escuchas de multidifusión.

Detalles
Parámetros
[in] aContext
El puntero de contexto de usuario.
[in] aEvent
El evento Multicast Listener.
[in] aAddress
La dirección de multidifusión Ip6 del escucha de multidifusión.

otBackboneRouterMulticastListenerInfo

struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo

Esta estructura representa una información de escucha de multidifusión de enrutador de red troncal.

otBackboneRouterMulticastListenerIterator

uint16_t otBackboneRouterMulticastListenerIterator

Se utiliza para iterar a través de escuchas de multidifusión.

Funciones

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 DUA.

Nota: disponible solo cuando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está habilitado. Solo se utiliza para pruebas y certificación.

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 a una instancia de OpenThread.
[in] aMlIid
Un puntero al IID local de malla. Si es NULL, responda con aStatus para cualquier DUA.req venidero; de lo contrario, solo responda el que aMlIid un aMlIid coincidente.
[in] aStatus
El estado para 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 utiliza para pruebas y certificación.

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

otBackboneRouterGetConfig

void otBackboneRouterGetConfig(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Esta función obtiene la configuración del enrutador backbone local.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[out] aConfig
Un puntero donde colocar la configuración del enrutador backbone local.
Ver 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 a una instancia de OpenThread.
[out] aConfig
Un puntero a la configuración del prefijo de dominio.
Valores devueltos
OT_ERROR_NONE
Obtuve con éxito la configuración del prefijo de dominio.
OT_ERROR_NOT_FOUND
No se configuró ningún prefijo de dominio.

otBackboneRouterGetPrimary

otError otBackboneRouterGetPrimary(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Esta función obtiene la información del enrutador principal principal en la red de subprocesos.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[out] aConfig
Un puntero sobre dónde colocar la información del enrutador principal.
Valores devueltos
OT_ERROR_NONE
Obtuve con éxito la información del enrutador principal principal.
OT_ERROR_NOT_FOUND
No existe ningún enrutador principal.

otBackboneRouterGetRegistrationJitter

uint8_t otBackboneRouterGetRegistrationJitter(
  otInstance *aInstance
)

Este método devuelve el valor de fluctuación de fase de registro del enrutador principal.

Detalles
Devoluciones
El valor de fluctuación de fase de registro del enrutador principal.
Ver también:
otBackboneRouterSetRegistrationJitter

otBackboneRouterGetState

otBackboneRouterState otBackboneRouterGetState(
  otInstance *aInstance
)

Esta función obtiene el estado Backbone Router.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Valores devueltos
OT_BACKBONE_ROUTER_STATE_DISABLED
La funcionalidad de la red troncal está desactivada.
OT_BACKBONE_ROUTER_STATE_SECONDARY
Enrutador principal secundario.
OT_BACKBONE_ROUTER_STATE_PRIMARY
El enrutador principal principal.
Ver también:
otBackboneRouterSetEnabled
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister

otBackboneRouterMulticastListenerAdd

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

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

Nota: disponible solo cuando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está habilitado. Solo se utiliza para pruebas y certificación.

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

otBackboneRouterMulticastListenerClear

void otBackboneRouterMulticastListenerClear(
  otInstance *aInstance
)

Este método borra los escuchas de multidifusión.

Nota: disponible solo cuando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está habilitado. Solo se utiliza para pruebas y certificación.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Ver 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 (mediante un iterador).

Nota: disponible solo cuando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está habilitado. Solo se utiliza para pruebas y certificación.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in,out] aIterator
Un puntero al iterador. En caso de éxito, el iterador se actualizará para apuntar al siguiente escucha de multidifusión. Para obtener la primera entrada, el iterador debe establecerse en OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT.
[out] aListenerInfo
Un puntero a un otBackboneRouterMulticastListenerInfo donde se otBackboneRouterMulticastListenerInfo información del próximo oyente de multidifusión (en caso de éxito).
Valores devueltos
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ó información de escucha de multidifusión posterior.
Ver también:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerAdd

otBackboneRouterRegister

otError otBackboneRouterRegister(
  otInstance *aInstance
)

Esta función registra explícitamente la configuración del enrutador troncal local.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Valores devueltos
OT_ERROR_NO_BUFS
Espacio insuficiente para agregar el servicio Backbone Router.
OT_ERROR_NONE
Se puso en cola correctamente un mensaje de solicitud de datos del servidor para su entrega.
Ver también:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig

otBackboneRouterSetConfig

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

Esta función establece la configuración del enrutador troncal local.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aConfig
Un puntero a la configuración del enrutador backbone para que surta efecto.
Valores devueltos
OT_ERROR_NONE
Configuración actualizada con éxito.
OT_ERROR_INVALID_ARGS
La configuración en aConfig no es válida.
Ver también:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterRegister

otBackboneRouterSetEnabled

void otBackboneRouterSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Esta función habilita o deshabilita la funcionalidad Backbone.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aEnable
TRUE para habilitar la funcionalidad Backbone, FALSE en caso contrario.
Ver 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 escucha de multidifusión del enrutador principal.

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

otBackboneRouterSetRegistrationJitter

void otBackboneRouterSetRegistrationJitter(
  otInstance *aInstance,
  uint8_t aJitter
)

Este método establece el valor de fluctuación de fase de registro del enrutador principal.

Detalles
Parámetros
[in] aJitter
el valor de jitter de registro de Backbone Router para establecer.
Ver también:
otBackboneRouterGetRegistrationJitter

Macros

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT

 OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT 0

Inicializador para otBackboneRouterMulticastListenerIterator.