Roteador

Este módulo inclui funções para o OpenThread Backbone Router Service.

Resumo

Enumerações
otBackboneRouterDomainPrefixEvent{
  OT_BACKBONE_ROUTER_DOMAIN_PREFIX_ADDED = 0,
  OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED = 1,
  OT_BACKBONE_ROUTER_DOMAIN_PREFIX_CHANGED = 2
} 		tipo enumerado
Representa os eventos de prefixo do domínio.
otBackboneRouterMulticastListenerEvent{
  OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED = 0,
  OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED = 1
} 		tipo enumerado
Representa os eventos do listener de multicast.
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
} 		tipo enumerado
Representa os eventos do proxy ND.
otBackboneRouterState{
  OT_BACKBONE_ROUTER_STATE_DISABLED = 0,
  OT_BACKBONE_ROUTER_STATE_SECONDARY = 1,
  OT_BACKBONE_ROUTER_STATE_PRIMARY = 2
} 		tipo enumerado
Representa o status do roteador do backbone.

Typedefs
otBackboneRouterConfig typedef
Representa a configuração do roteador do backbone.
otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix) typedef
void(*
O ponteiro é chamado sempre que o prefixo do domínio é alterado.
otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress) typedef
void(*
Ponteiro é chamado sempre que os ouvintes multicast mudam.
otBackboneRouterMulticastListenerInfo typedef
Representa uma informação do listener de multicast do roteador de backbone.
otBackboneRouterMulticastListenerIterator typedef
uint16_t
Usado para iterar por meio de ouvintes de multicast.
otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua) typedef
void(*
Ponteiro é chamado sempre que o Nd Proxy é alterado.
otBackboneRouterNdProxyInfo typedef
Representa as informações de proxy ND do Backbone Router.

Funções
otBackboneRouterConfigNextDuaRegistrationResponse(otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus)
void
Configura o status da resposta para o próximo registro da DUA.
otBackboneRouterConfigNextMulticastListenerRegistrationResponse(otInstance *aInstance, uint8_t aStatus)
void
Configura o status da resposta para o próximo registro de listener de multicast.
otBackboneRouterGetConfig(otInstance *aInstance, otBackboneRouterConfig *aConfig)
void
Recebe a configuração local do Backbone Router.
otBackboneRouterGetDomainPrefix(otInstance *aInstance, otBorderRouterConfig *aConfig)
Recebe a configuração do prefixo do domínio local.
otBackboneRouterGetNdProxyInfo(otInstance *aInstance, const otIp6Address *aDua, otBackboneRouterNdProxyInfo *aNdProxyInfo)
Recebe as informações do proxy ND Roteador de backbone.
otBackboneRouterGetPrimary(otInstance *aInstance, otBackboneRouterConfig *aConfig)
Recebe as informações do roteador de backbone principal na rede Thread.
otBackboneRouterGetRegistrationJitter(otInstance *aInstance)
uint8_t
Retorna o valor de instabilidade de registro do roteador de backbone.
otBackboneRouterGetState(otInstance *aInstance)
Recebe o roteador do backbone otBackboneRouterState.
otBackboneRouterMulticastListenerAdd(otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout)
Adiciona um ouvinte de multicast com um valor de tempo limite, em segundos.
otBackboneRouterMulticastListenerClear(otInstance *aInstance)
void
Limpa os listeners de multicast.
otBackboneRouterMulticastListenerGetNext(otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo)
Recebe as próximas informações do listener de multicast (usando um iterador).
otBackboneRouterRegister(otInstance *aInstance)
Registra explicitamente a configuração do Backbone Router local.
otBackboneRouterSetConfig(otInstance *aInstance, const otBackboneRouterConfig *aConfig)
Define a configuração local do roteador de backbone otBackboneRouterConfig.
otBackboneRouterSetDomainPrefixCallback(otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext)
void
Define o callback do prefixo de domínio do roteador de backbone.
otBackboneRouterSetEnabled(otInstance *aInstance, bool aEnable)
void
Ativa ou desativa a funcionalidade do Backbone.
otBackboneRouterSetMulticastListenerCallback(otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext)
void
Define o callback do listener de multicast do roteador de backbone.
otBackboneRouterSetNdProxyCallback(otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext)
void
Define o callback do proxy ND Roteador de backbone.
otBackboneRouterSetRegistrationJitter(otInstance *aInstance, uint8_t aJitter)
void
Define o valor da instabilidade de registro do roteador de backbone.

Estruturas
otBackboneRouterConfig.

Representa a configuração do roteador do backbone.

otBackboneRouterMulticastListenerInfo.

Representa uma informação do listener de multicast do roteador de backbone.

otBackboneRouterNdProxyInfo.

Representa as informações de proxy ND do Backbone Router.

Enumerações

OtBackboneRouterDomainPrefixEvent

 otBackboneRouterDomainPrefixEvent

Representa os eventos de prefixo do domínio.

Propriedades
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_ADDED

O prefixo do domínio foi adicionado.

OT_BACKBONE_ROUTER_DOMAIN_PREFIX_CHANGED

O prefixo do domínio foi alterado.

OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED

O prefixo do domínio foi removido.

OtBackboneRouterMulticastListenerEvent

 otBackboneRouterMulticastListenerEvent

Representa os eventos do listener de multicast.

Propriedades
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED

O listener de multicast foi adicionado.

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED

O listener de multicast foi removido ou expirou.

OtBackboneRouterNdProxyEvent

 otBackboneRouterNdProxyEvent

Representa os eventos do proxy ND.

Propriedades
OT_BACKBONE_ROUTER_NDPROXY_ADDED

O proxy ND foi adicionado.

OT_BACKBONE_ROUTER_NDPROXY_CLEARED

Todos os proxies ND foram apagados.

OT_BACKBONE_ROUTER_NDPROXY_REMOVED

O proxy ND foi removido.

OT_BACKBONE_ROUTER_NDPROXY_RENEWED

O proxy ND foi renovado.

OtBackboneRouterState

 otBackboneRouterState

Representa o status do roteador do backbone.

Propriedades
OT_BACKBONE_ROUTER_STATE_DISABLED

A função de backbone está desativada.

OT_BACKBONE_ROUTER_STATE_PRIMARY

O roteador principal.

OT_BACKBONE_ROUTER_STATE_SECONDARY

Roteador de backbone secundário.

Typedefs

OtBackboneRouterConfig.

struct otBackboneRouterConfig otBackboneRouterConfig

Representa a configuração do roteador do backbone.

OtBackboneRouterDomainPrefixCallback

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

O ponteiro é chamado sempre que o prefixo do domínio é alterado.

Detalhes
Parâmetros
[in] aContext
O ponteiro de contexto do usuário.
[in] aEvent
O evento de prefixo do domínio.
[in] aDomainPrefix
O novo prefixo de domínio, se adicionado ou alterado, caso contrário será nulo.

OtBackboneRouterMulticastListenerCallback

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

Ponteiro é chamado sempre que os ouvintes multicast mudam.

Detalhes
Parâmetros
[in] aContext
O ponteiro de contexto do usuário.
[in] aEvent
O evento de listener multicast.
[in] aAddress
O endereço multicast IPv6 do listener multicast.

OtBackboneRouterMulticastListenerInfo

struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo

Representa uma informação do listener de multicast do roteador de backbone.

OtBackboneRouterMulticastListenerIterator

uint16_t otBackboneRouterMulticastListenerIterator

Usado para iterar por meio de ouvintes de multicast.

OtBackboneRouterNdProxyCallback

void(* otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua)

Ponteiro é chamado sempre que o Nd Proxy é alterado.

Detalhes
Parâmetros
[in] aContext
O ponteiro de contexto do usuário.
[in] aEvent
O evento ND Proxy.
[in] aDua
O endereço Unicast de domínio do proxy ND, ou nullptr se aEvent for OT_BACKBONE_ROUTER_NDPROXY_CLEARED.

Informações de rota de proxy

struct otBackboneRouterNdProxyInfo otBackboneRouterNdProxyInfo

Representa as informações de proxy ND do Backbone Router.

Funções

OtBackboneRouterConfigNextDuaRegistrationResponse

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

Configura o status da resposta para o próximo registro da DUA.

Observação: disponível apenas quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE estiver ativado. Usado apenas para teste e certificação.

TODO: (DUA) suporta código de erro coap e processo correspondente para fins de certificação.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aMlIid
Um ponteiro para o IID local da malha. Se NULL, responda com aStatus para qualquer DUA.req vindo. Caso contrário, responda apenas aquele com aMlIid correspondente.
[in] aStatus
O status para responder.

OtBackboneRouterConfigNextMulticastListenerRegistrationResponse

void otBackboneRouterConfigNextMulticastListenerRegistrationResponse(
  otInstance *aInstance,
  uint8_t aStatus
)

Configura o status da resposta para o próximo registro de listener de multicast.

Disponível quando OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE e OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE estão ativados.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aStatus
O status para responder.

OtBackboneRouterGetConfig

void otBackboneRouterGetConfig(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Recebe a configuração local do Backbone Router.

Disponível quando o OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE está ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aConfig
Um ponteiro para colocar a configuração local do Backbone Router.
Consulte também:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterSetConfig
otBackboneRouterRegister

OtBackboneRouterGetDomainPrefix

otError otBackboneRouterGetDomainPrefix(
  otInstance *aInstance,
  otBorderRouterConfig *aConfig
)

Recebe a configuração do prefixo do domínio local.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aConfig
Um ponteiro para a configuração de prefixo de domínio.
Valores de retorno
OT_ERROR_NONE
A configuração do prefixo do domínio foi recebida.
OT_ERROR_NOT_FOUND
Nenhum prefixo de domínio foi configurado.

OtBackboneRouterGetNdProxyInfo

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

Recebe as informações do proxy ND Roteador de backbone.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDua
O endereço Unicast do domínio.
[out] aNdProxyInfo
Um ponteiro para as informações do proxy ND.
Valores de retorno
OT_ERROR_NONE
As informações do proxy ND foram recuperadas.
OT_ERROR_NOT_FOUND
Falha ao localizar o endereço Unicast do domínio na tabela "Proxy ND".

otBackboneRouterGetPrimary

otError otBackboneRouterGetPrimary(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Recebe as informações do roteador de backbone principal na rede Thread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aConfig
Um ponteiro para onde colocar as informações do roteador principal.
Valores de retorno
OT_ERROR_NONE
As informações do roteador de backbone principal foram obtidas.
OT_ERROR_NOT_FOUND
Não existe roteador de backbone principal.

otBackboneRouterGetRegistrationJitter

uint8_t otBackboneRouterGetRegistrationJitter(
  otInstance *aInstance
)

Retorna o valor de instabilidade de registro do roteador de backbone.

Detalhes
Retorna
Instabilidade do registro do roteador do Backbone.
Consulte também:
otBackboneRouterSetRegistrationJitter

OtBackboneRouterGetState

otBackboneRouterState otBackboneRouterGetState(
  otInstance *aInstance
)

Recebe o roteador do backbone otBackboneRouterState.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
OT_BACKBONE_ROUTER_STATE_DISABLED
A funcionalidade de backbone está desativada.
OT_BACKBONE_ROUTER_STATE_SECONDARY
Roteador de backbone secundário.
OT_BACKBONE_ROUTER_STATE_PRIMARY
O roteador principal.
Consulte também:
otBackboneRouterSetEnabled
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister

OtBackboneRouterMulticastListenerAdd

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

Adiciona um ouvinte de multicast com um valor de tempo limite, em segundos.

Transmita 0 para usar o tempo limite padrão do MLR.

Disponível quando OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE e OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE estão ativados.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aAddress
O endereço do listener multicast.
[in] aTimeout
O tempo limite (em segundos) do listener multicast ou 0 para usar o tempo limite padrão do MLR.
Valores de retorno
OT_ERROR_NONE
Se o listener multicast foi adicionado.
OT_ERROR_INVALID_ARGS
Se o endereço do listener de multicast for inválido.
OT_ERROR_NO_BUFS
Não há espaço disponível para salvar o Multicast Listener.
Consulte também:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerGetNext

OtBackboneRouterMulticastListenerClear

void otBackboneRouterMulticastListenerClear(
  otInstance *aInstance
)

Limpa os listeners de multicast.

Disponível quando OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE e OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE estão ativados.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Consulte também:
otBackboneRouterMulticastListenerAdd
otBackboneRouterMulticastListenerGetNext

otBackboneRouterMulticastListenerGetNext

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

Recebe as próximas informações do listener de multicast (usando um iterador).

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in,out] aIterator
Um ponteiro para o iterador. Se for bem-sucedido, o iterador será atualizado para apontar para o próximo listener de multicast. Para obter a primeira entrada, o iterador deve ser definido como OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT.
[out] aListenerInfo
Um ponteiro para um otBackboneRouterMulticastListenerInfo em que as informações do próximo listener Multicast são colocadas (em caso de êxito)
Valores de retorno
OT_ERROR_NONE
As próximas informações do listener de multicast foram encontradas (aListenerInfo foi atualizado).
OT_ERROR_NOT_FOUND
Nenhuma informação subsequente do Listener de multicast foi encontrada.
Consulte também:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerAdd

OtBackboneRouterRegister

otError otBackboneRouterRegister(
  otInstance *aInstance
)

Registra explicitamente a configuração do Backbone Router local.

Uma mensagem de solicitação de dados do servidor SRV_DATA.ntf é acionada para o dispositivo conectado.

Disponível quando o OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE está ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
OT_ERROR_NO_BUFS
Espaço insuficiente para adicionar o serviço Backbone Router.
OT_ERROR_NONE
Mensagem de solicitação de dados do servidor na fila para entrega.
Consulte também:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig

OtBackboneRouterSetConfig

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

Define a configuração local do roteador de backbone otBackboneRouterConfig.

Uma mensagem de solicitação de dados do servidor SRV_DATA.ntf é iniciada automaticamente se o conjunto de dados BBR for alterado para o roteador de backbone principal.

Disponível quando o OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE está ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aConfig
Um ponteiro para a configuração do Backbone Router para entrar em vigor.
Valores de retorno
OT_ERROR_NONE
A configuração foi atualizada.
OT_ERROR_INVALID_ARGS
A configuração em aConfig é inválida.
Consulte também:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterRegister

OtBackboneRouterSetDomainPrefixCallback

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

Define o callback do prefixo de domínio do roteador de backbone.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aCallback
Um ponteiro para o callback do prefixo de domínio.
[in] aContext
Um ponteiro de contexto do usuário.

OtBackboneRouterSetEnabled

void otBackboneRouterSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Ativa ou desativa a funcionalidade do Backbone.

Se ativada, uma mensagem de solicitação de dados do servidor SRV_DATA.ntf será acionada para o dispositivo anexado se não houver um serviço de backbone roteador nos dados da rede Thread.

Se desativado, SRV_DATA.ntf será acionado se o roteador de backbone estiver no estado principal.

Disponível quando o OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE está ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aEnable
TRUE para ativar a funcionalidade Backbone. Caso contrário, FALSE.
Consulte também:
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister

OtBackboneRouterSetMulticastListenerCallback

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

Define o callback do listener de multicast do roteador de backbone.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aCallback
Um ponteiro para o retorno de chamada do listener de multicast.
[in] aContext
Um ponteiro de contexto do usuário.

OtBackboneRouterSetNdProxyCallback

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

Define o callback do proxy ND Roteador de backbone.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aCallback
Um ponteiro para o callback do proxy ND.
[in] aContext
Um ponteiro de contexto do usuário.

otBackboneRouterSetRegistrationJitter

void otBackboneRouterSetRegistrationJitter(
  otInstance *aInstance,
  uint8_t aJitter
)

Define o valor da instabilidade de registro do roteador de backbone.

Detalhes
Parâmetros
[in] aJitter
o valor de instabilidade de registro do Backbone Router a ser definido.
Consulte também:
otBackboneRouterGetRegistrationJitter

Macros

PRO_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT

 OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT 0

Inicializador para otBackboneRouterMulticastListenerIterator.

Recursos

Os tópicos de referência da API OpenThread são originados do código-fonte, disponível no GitHub. Para mais informações ou para contribuir com nossa documentação, consulte Recursos.