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
}
enum
Representa os eventos de prefixo de domínio.
otBackboneRouterMulticastListenerEvent {
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED = 0,
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED = 1
}
enum
Representa os eventos do Listener 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
}
enum
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
}
enum
Representa o status do roteador de backbone.

Typedefs

otBackboneRouterConfig typedef
Esta estrutura representa a configuração do roteador de backbone.
otBackboneRouterDomainPrefixCallback )(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix) typedef
void(*
Este ponteiro de função é chamado sempre que o Prefixo do Domínio é alterado.
otBackboneRouterMulticastListenerCallback )(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress) typedef
void(*
Este ponteiro de função é chamado sempre que os ouvintes de multicast mudam.
otBackboneRouterMulticastListenerInfo typedef
Esta estrutura representa uma informação do Backbone Router Multicast Listener.
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.

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 DUA.
otBackboneRouterConfigNextMulticastListenerRegistrationResponse ( otInstance *aInstance, uint8_t aStatus)
void
Este método configura o status de resposta para o próximo Registro de Listener Multicast.
otBackboneRouterGetConfig ( otInstance *aInstance, otBackboneRouterConfig *aConfig)
void
Esta função obtém a configuração do roteador de backbone local.
otBackboneRouterGetDomainPrefix ( otInstance *aInstance, otBorderRouterConfig *aConfig)
Este método obtém a configuração do Prefixo do domínio local.
otBackboneRouterGetNdProxyInfo ( otInstance *aInstance, const otIp6Address *aDua,otBackboneRouterNdProxyInfo *aNdProxyInfo)
Este método obtém as informações do proxy ND do roteador de backbone.
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 do registro do roteador de backbone.
otBackboneRouterGetState ( otInstance *aInstance)
Esta função obtém o estado do roteador de backbone.
otBackboneRouterMulticastListenerAdd ( otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout)
Este método adiciona um ouvinte multicast.
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 roteador de backbone local.
otBackboneRouterSetConfig ( otInstance *aInstance, const otBackboneRouterConfig *aConfig)
Esta função define a configuração do roteador de backbone local.
otBackboneRouterSetDomainPrefixCallback ( otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext)
void
Este método define o retorno de chamada do prefixo do domínio do roteador de backbone.
otBackboneRouterSetEnabled ( otInstance *aInstance, bool aEnable)
void
Esta função ativa ou desativa a funcionalidade Backbone.
otBackboneRouterSetMulticastListenerCallback ( otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext)
void
Este método define o retorno de chamada do Backbone Router Multicast Listener.
otBackboneRouterSetNdProxyCallback ( otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext)
void
Este método define o retorno de chamada do proxy ND do roteador de backbone.
otBackboneRouterSetRegistrationJitter ( otInstance *aInstance, uint8_t aJitter)
void
Este método define o valor de jitter de registro do roteador de backbone.

Structs

otBackboneRouterConfig

Esta estrutura representa a configuração do roteador de backbone.

otBackboneRouterMulticastListenerInfo

Esta estrutura representa uma informação do Backbone Router Multicast Listener.

otBackboneRouterNdProxyInfo

Representa as informações do proxy ND do roteador de backbone.

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

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

Propriedades
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED

Listener multicast foi adicionado.

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED

O listener multicast 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 apagados.

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á desativada.

OT_BACKBONE_ROUTER_STATE_PRIMARY

O roteador de backbone primário.

OT_BACKBONE_ROUTER_STATE_SECONDARY

Roteador de backbone secundário.

Typedefs

otBackboneRouterConfig

struct otBackboneRouterConfig otBackboneRouterConfig

Esta estrutura representa a configuração do roteador de backbone.

otBackboneRouterDomainPrefixCallback

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

Este ponteiro de função é 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 Prefixo do domínio.
[in] aDomainPrefix
O novo prefixo do domínio se adicionado ou alterado, caso contrário nullptr.

otBackboneRouterMulticastListenerCallback

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

Este ponteiro de função é chamado sempre que os ouvintes de multicast mudam.

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

Esta estrutura representa uma informação do Backbone Router Multicast Listener.

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 Proxy ND ou nullptr se aEvent for OT_BACKBONE_ROUTER_NDPROXY_CLEARED .

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

Nota: disponível apenas quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está 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 OpenThread.
[in] aMlIid
Um ponteiro para o IID local da malha. Se NULL, responde com aStatus para qualquer DUA.req que vem, 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 de Listener Multicast.

Nota: disponível apenas quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está ativado. 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 roteador de backbone local.

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

otBackboneRouterGetDomainPrefix

otError otBackboneRouterGetDomainPrefix(
  otInstance *aInstance,
  otBorderRouterConfig *aConfig
)

Este método obtém a configuração do Prefixo do 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 do domínio.
Valores Retornados
OT_ERROR_NONE
Obteve com sucesso a configuração do Prefixo do 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 proxy ND do roteador de backbone.

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 Retornados
OT_ERROR_NONE
Obteve as informações do ND Proxy.
OT_ERROR_NOT_FOUND
Falha ao encontrar o endereço Unicast do domínio na tabela de proxy ND.

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 Retornados
OT_ERROR_NONE
Informações do roteador de backbone primário obtidas com sucesso.
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 roteador de backbone.

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

otBackboneRouterGetState

otBackboneRouterState otBackboneRouterGetState(
  otInstance *aInstance
)

Esta função obtém o estado do roteador de backbone.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Valores Retornados
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 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 ouvinte multicast.

Nota: disponível apenas quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está ativado. 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 ouvinte multicast.
[in] aTimeout
O tempo limite (em segundos) do Listener Multicast ou 0 para usar o tempo limite MLR padrão.
Valores Retornados
OT_ERROR_NONE
Se o Multicast Listener foi adicionado com sucesso.
OT_ERROR_INVALID_ARGS
Se o endereço do ouvinte multicast for inválido.
OT_ERROR_NO_BUFS
Nenhum 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 apenas quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está ativado. 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 Listener 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 onde as informações do próximo ouvinte multicast são colocadas (em caso de sucesso).
Valores Retornados
OT_ERROR_NONE
Encontrada 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 roteador de backbone local.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Valores Retornados
OT_ERROR_NO_BUFS
Espaço insuficiente para adicionar o serviço Backbone Router.
OT_ERROR_NONE
Enfileirou com êxito 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 roteador de backbone local.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aConfig
Um ponteiro para a configuração do roteador de backbone para entrar em vigor.
Valores Retornados
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 do 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 do domínio.
[in] aContext
Um ponteiro de contexto do usuário.

otBackboneRouterSetEnabled

void otBackboneRouterSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Esta função ativa ou desativa a funcionalidade 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 Backbone Router Multicast Listener.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aCallback
Um ponteiro para o retorno de chamada do Listener Multicast.
[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 proxy ND 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 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 roteador de backbone.

Detalhes
Parâmetros
[in] aJitter
o valor de jitter de registro do roteador de backbone 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.