O Google tem o compromisso de promover a igualdade racial para as comunidades negras. Saiba como.

Roteador de backbone

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
}
enumerar
Representa os eventos de prefixo de domínio.
otBackboneRouterMulticastListenerEvent {
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED = 0,
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED = 1
}
enumerar
Representa os eventos do Multicast Listener.
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
}
enumerar
Representa os eventos do ND Proxy.
otBackboneRouterState {
OT_BACKBONE_ROUTER_STATE_DISABLED = 0,
OT_BACKBONE_ROUTER_STATE_SECONDARY = 1,
OT_BACKBONE_ROUTER_STATE_PRIMARY = 2
}
enumerar
Representa o status do roteador de backbone.

Typedefs

otBackboneRouterConfig typedef
Esta estrutura representa a configuração do Backbone Router.
otBackboneRouterDomainPrefixCallback )(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix) typedef
void(*
Esse ponteiro de função é chamado sempre que o prefixo de domínio é alterado.
otBackboneRouterMulticastListenerCallback )(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress) typedef
void(*
Esse ponteiro de função é chamado sempre que os ouvintes de multicast são alterados.
otBackboneRouterMulticastListenerInfo typedef
Essa estrutura representa uma informação do Ouvinte Multicast do Backbone Router.
otBackboneRouterMulticastListenerIterator typedef
uint16_t
Usado para iterar por meio de ouvintes de multicast.
otBackboneRouterNdProxyCallback )(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua) typedef
void(*
Este ponteiro de função é chamado sempre que o Nd Proxy é alterado.
otBackboneRouterNdProxyInfo typedef
Representa as informações do Backbone Router ND Proxy.

Funções

otBackboneRouterConfigNextDuaRegistrationResponse ( otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus)
void
Este método configura o status de resposta para o próximo registro do DUA.
otBackboneRouterConfigNextMulticastListenerRegistrationResponse ( otInstance *aInstance, uint8_t aStatus)
void
Este método configura o status de resposta para o próximo registro do ouvinte de multicast.
otBackboneRouterGetConfig ( otInstance *aInstance, otBackboneRouterConfig *aConfig)
void
Esta função obtém a configuração do Backbone Router local.
otBackboneRouterGetDomainPrefix ( otInstance *aInstance, otBorderRouterConfig *aConfig)
Este método obtém a configuração de prefixo de domínio local.
otBackboneRouterGetNdProxyInfo ( otInstance *aInstance, const otIp6Address *aDua, otBackboneRouterNdProxyInfo *aNdProxyInfo)
Este método obtém as informações do Backbone Router ND Proxy.
otBackboneRouterGetPrimary ( otInstance *aInstance, otBackboneRouterConfig *aConfig)
Esta função obtém as informações do roteador de backbone primário na rede de threads.
otBackboneRouterGetRegistrationJitter ( otInstance *aInstance)
uint8_t
Este método retorna o valor de jitter de registro do Backbone Router.
otBackboneRouterGetState ( otInstance *aInstance)
Esta função obtém o estado do Backbone Router.
otBackboneRouterMulticastListenerAdd ( otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout)
Este método adiciona um Multicast Listener.
otBackboneRouterMulticastListenerClear ( otInstance *aInstance)
void
Este método limpa os ouvintes de multicast.
otBackboneRouterMulticastListenerGetNext ( otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo)
Esta função obtém as próximas informações do Multicast Listener (usando um iterador).
otBackboneRouterRegister ( otInstance *aInstance)
Esta função registra explicitamente a configuração do Backbone Router local.
otBackboneRouterSetConfig ( otInstance *aInstance, const otBackboneRouterConfig *aConfig)
Esta função define a configuração do Backbone Router local.
otBackboneRouterSetDomainPrefixCallback ( otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext)
void
Este método define o retorno de chamada do prefixo de domínio do roteador de backbone.
otBackboneRouterSetEnabled ( otInstance *aInstance, bool aEnable)
void
Esta função habilita ou desabilita a funcionalidade do Backbone.
otBackboneRouterSetMulticastListenerCallback ( otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext)
void
Este método define o retorno de chamada do Ouvinte de Multicast do Backbone Router.
otBackboneRouterSetNdProxyCallback ( otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext)
void
Este método define o retorno de chamada do Backbone Router ND Proxy.
otBackboneRouterSetRegistrationJitter ( otInstance *aInstance, uint8_t aJitter)
void
Este método define o valor de jitter de registro do Backbone Router.

Estruturas

otBackboneRouterConfig

Esta estrutura representa a configuração do Backbone Router.

otBackboneRouterMulticastListenerInfo

Essa estrutura representa uma informação do Ouvinte Multicast do Backbone Router.

otBackboneRouterNdProxyInfo

Representa as informações do Backbone Router ND Proxy.

Enumerações

otBackboneRouterDomainPrefixEvent

 otBackboneRouterDomainPrefixEvent

Representa os eventos de prefixo de domínio.

Propriedades
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_ADDED

Prefixo de 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 de domínio foi removido.

otBackboneRouterMulticastListenerEvent

 otBackboneRouterMulticastListenerEvent

Representa os eventos do Multicast Listener.

Propriedades
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED

Ouvinte Multicast foi adicionado.

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED

O Multicast Listener foi removido ou expirou.

otBackboneRouterNdProxyEvent

 otBackboneRouterNdProxyEvent

Representa os eventos do ND Proxy.

Propriedades
OT_BACKBONE_ROUTER_NDPROXY_ADDED

ND Proxy foi adicionado.

OT_BACKBONE_ROUTER_NDPROXY_CLEARED

Todos os ND Proxies foram limpos.

OT_BACKBONE_ROUTER_NDPROXY_REMOVED

ND Proxy foi removido.

OT_BACKBONE_ROUTER_NDPROXY_RENEWED

ND Proxy foi renovado.

otBackboneRouterState

 otBackboneRouterState

Representa o status do roteador de backbone.

Propriedades
OT_BACKBONE_ROUTER_STATE_DISABLED

A função de backbone está desabilitada.

OT_BACKBONE_ROUTER_STATE_PRIMARY

O roteador de backbone primário.

OT_BACKBONE_ROUTER_STATE_SECONDARY

Roteador Backbone Secundário.

Typedefs

otBackboneRouterConfig

struct otBackboneRouterConfig otBackboneRouterConfig

Esta estrutura representa a configuração do Backbone Router.

otBackboneRouterDomainPrefixCallback

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

Esse ponteiro de função é chamado sempre que o prefixo de domínio é alterado.

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

otBackboneRouterMulticastListenerCallback

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

Esse ponteiro de função é chamado sempre que os ouvintes de multicast são alterados.

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

otBackboneRouterMulticastListenerInfo

struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo

Essa estrutura representa uma informação do Ouvinte Multicast do Backbone Router.

otBackboneRouterMulticastListenerIterator

uint16_t otBackboneRouterMulticastListenerIterator

Usado para iterar por meio de ouvintes de multicast.

otBackboneRouterNdProxyCallback

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

Este ponteiro de função é 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 ND Proxy, ou nullptr se aEvent for OT_BACKBONE_ROUTER_NDPROXY_CLEARED .

otBackboneRouterNdProxyInfo

struct otBackboneRouterNdProxyInfo otBackboneRouterNdProxyInfo

Representa as informações do Backbone Router ND Proxy.

Funções

otBackboneRouterConfigNextDuaRegistrationResponse

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

Este método configura o status de resposta para o próximo registro do DUA.

Nota: disponível somente quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está habilitado. 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 OpenThread.
[in] aMlIid
Um ponteiro para o IID local da malha. Se for NULL, responda com aStatus para qualquer DUA.req, caso contrário, responda apenas aquele com aMlIid correspondente.
[in] aStatus
O status para responder.

otBackboneRouterConfigNextMulticastListenerRegistrationResponse

void otBackboneRouterConfigNextMulticastListenerRegistrationResponse(
  otInstance *aInstance,
  uint8_t aStatus
)

Este método configura o status de resposta para o próximo registro do ouvinte de multicast.

Nota: disponível somente quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está habilitado. Usado apenas para teste e certificação.

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

otBackboneRouterGetConfig

void otBackboneRouterGetConfig(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Esta função obtém a configuração do Backbone Router local.

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

otBackboneRouterGetDomainPrefix

otError otBackboneRouterGetDomainPrefix(
  otInstance *aInstance,
  otBorderRouterConfig *aConfig
)

Este método obtém a configuração de prefixo de domínio local.

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

otBackboneRouterGetNdProxyInfo

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

Este método obtém as informações do Backbone Router ND Proxy.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aDua
O Endereço Unicast do Domínio.
[out] aNdProxyInfo
Um ponteiro para as informações do ND Proxy.
Valores de retorno
OT_ERROR_NONE
Obteve com sucesso as informações do ND Proxy.
OT_ERROR_NOT_FOUND
Falha ao encontrar o Endereço Unicast do Domínio na tabela ND Proxy.

otBackboneRouterGetPrimary

otError otBackboneRouterGetPrimary(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Esta função obtém as informações do roteador de backbone primário na rede de threads.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[out] aConfig
Um ponteiro para onde colocar as informações do roteador de backbone primário.
Valores de retorno
OT_ERROR_NONE
Obteve com sucesso as informações do roteador de backbone primário.
OT_ERROR_NOT_FOUND
Não existe nenhum roteador de backbone primário.

otBackboneRouterGetRegistrationJitter

uint8_t otBackboneRouterGetRegistrationJitter(
  otInstance *aInstance
)

Este método retorna o valor de jitter de registro do Backbone Router.

Detalhes
Devoluções
O valor de jitter de registro do Backbone Router.
Veja também:
otBackboneRouterSetRegistrationJitter

otBackboneRouterGetState

otBackboneRouterState otBackboneRouterGetState(
  otInstance *aInstance
)

Esta função obtém o estado do Backbone Router.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Valores de retorno
OT_BACKBONE_ROUTER_STATE_DISABLED
A funcionalidade de backbone está desabilitada.
OT_BACKBONE_ROUTER_STATE_SECONDARY
Roteador Backbone Secundário.
OT_BACKBONE_ROUTER_STATE_PRIMARY
O roteador de backbone primário.
Veja também:
otBackboneRouterSetEnabled
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister

otBackboneRouterMulticastListenerAdd

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

Este método adiciona um Multicast Listener.

Nota: disponível somente quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está habilitado. Usado apenas para teste e certificação.

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

otBackboneRouterMulticastListenerClear

void otBackboneRouterMulticastListenerClear(
  otInstance *aInstance
)

Este método limpa os ouvintes de multicast.

Nota: disponível somente quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está habilitado. Usado apenas para teste e certificação.

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

otBackboneRouterMulticastListenerGetNext

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

Esta função obtém as próximas informações do Multicast Listener (usando um iterador).

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in,out] aIterator
Um ponteiro para o iterador. Em caso de sucesso, o iterador será atualizado para apontar para o próximo Multicast Listener. 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 onde as informações do próximo Multicast Listener são colocadas (em caso de sucesso).
Valores de retorno
OT_ERROR_NONE
Encontrado com sucesso a próxima informação do Multicast Listener ( aListenerInfo foi atualizado com sucesso).
OT_ERROR_NOT_FOUND
Nenhuma informação subsequente do Multicast Listener foi encontrada.
Veja também:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerAdd

otBackboneRouterRegister

otError otBackboneRouterRegister(
  otInstance *aInstance
)

Esta função registra explicitamente a configuração do Backbone Router local.

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

otBackboneRouterSetConfig

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

Esta função define a configuração do Backbone Router local.

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

otBackboneRouterSetDomainPrefixCallback

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

Este método define o retorno de chamada do prefixo de domínio do roteador de backbone.

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

otBackboneRouterSetEnabled

void otBackboneRouterSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Esta função habilita ou desabilita a funcionalidade do Backbone.

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

otBackboneRouterSetMulticastListenerCallback

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

Este método define o retorno de chamada do Ouvinte de Multicast do Backbone Router.

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

otBackboneRouterSetNdProxyCallback

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

Este método define o retorno de chamada do Backbone Router ND Proxy.

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

otBackboneRouterSetRegistrationJitter

void otBackboneRouterSetRegistrationJitter(
  otInstance *aInstance,
  uint8_t aJitter
)

Este método define o valor de jitter de registro do Backbone Router.

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

Macros

OT_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 se originam do código-fonte, disponível no GitHub . Para obter mais informações ou contribuir com nossa documentação, consulte Recursos .