Rosca de coluna
Este módulo inclui funções para o serviço OpenThread Backbone Router.
Resumo
Enumerações |
|
---|---|
otBackboneRouterDomainPrefixEvent{
|
tipo enumerado Representa os eventos do prefixo do domínio. |
otBackboneRouterMulticastListenerEvent{
|
tipo enumerado Representa os eventos do listener de multicast. |
otBackboneRouterNdProxyEvent{
|
tipo enumerado Representa os eventos do proxy ND. |
otBackboneRouterState{
|
tipo enumerado Representa o status do roteador da espinha dorsal. |
Typedefs |
|
---|---|
otBackboneRouterConfig
|
typedefstruct otBackboneRouterConfig
Essa estrutura representa a configuração do roteador Backbone. |
otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix)
|
typedefvoid(*
Esse ponteiro de função é chamado sempre que o prefixo do domínio muda. |
otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress)
|
typedefvoid(*
Esse ponteiro de função é chamado sempre que os listeners do Multicast mudam. |
otBackboneRouterMulticastListenerInfo
|
typedef Essa estrutura representa uma informação do listener de multicast do roteador Backbone. |
otBackboneRouterMulticastListenerIterator
|
typedefuint16_t
Usado para iterar por listeners multicast. |
otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua)
|
typedefvoid(*
Esse ponteiro de função é chamado sempre que o proxy Nd muda. |
otBackboneRouterNdProxyInfo
|
typedefstruct otBackboneRouterNdProxyInfo
Representa as informações do proxy ND do roteador Backbone. |
Funções |
|
---|---|
otBackboneRouterConfigNextDuaRegistrationResponse(otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus)
|
void
Esse método configura o status de resposta do próximo registro da DUA.
|
otBackboneRouterConfigNextMulticastListenerRegistrationResponse(otInstance *aInstance, uint8_t aStatus)
|
void
Configura o status da resposta do próximo registro de listener do multicast.
|
otBackboneRouterGetConfig(otInstance *aInstance, otBackboneRouterConfig *aConfig)
|
void
Recebe a configuração local do Backbone Router.
|
otBackboneRouterGetDomainPrefix(otInstance *aInstance, otBorderRouterConfig *aConfig)
|
Esse método recebe a configuração local do prefixo de domínio.
|
otBackboneRouterGetNdProxyInfo(otInstance *aInstance, const otIp6Address *aDua, otBackboneRouterNdProxyInfo *aNdProxyInfo)
|
Esse método recebe as informações do proxy ND do roteador Backbone.
|
otBackboneRouterGetPrimary(otInstance *aInstance, otBackboneRouterConfig *aConfig)
|
Essa função recebe as informações do roteador principal na rede Thread.
|
otBackboneRouterGetRegistrationJitter(otInstance *aInstance)
|
uint8_t
Esse método retorna o valor de instabilidade do registro do roteador de backbone.
|
otBackboneRouterGetState(otInstance *aInstance)
|
Recebe o Backbone Router otBackboneRouterState.
|
otBackboneRouterMulticastListenerAdd(otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout)
|
Adiciona um listener Multicast com um valor de tempo limite em segundos.
|
otBackboneRouterMulticastListenerClear(otInstance *aInstance)
|
void
Limpa os listeners multicast.
|
otBackboneRouterMulticastListenerGetNext(otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo)
|
Essa função recebe as próximas informações do listener de multicast (usando um iterador).
|
otBackboneRouterRegister(otInstance *aInstance)
|
Registra explicitamente a configuração local do Backbone Router.
|
otBackboneRouterSetConfig(otInstance *aInstance, const otBackboneRouterConfig *aConfig)
|
Define a configuração local do roteador Backbone otBackboneRouterConfig.
|
otBackboneRouterSetDomainPrefixCallback(otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext)
|
void
Esse método define o callback do prefixo de domínio do roteador do backbone.
|
otBackboneRouterSetEnabled(otInstance *aInstance, bool aEnable)
|
void
Ativa ou desativa a funcionalidade do Backbone.
|
otBackboneRouterSetMulticastListenerCallback(otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext)
|
void
Esse método define o callback do listener de multicast do roteador Backbone.
|
otBackboneRouterSetNdProxyCallback(otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext)
|
void
Esse método define o callback do proxy ND do roteador Backbone.
|
otBackboneRouterSetRegistrationJitter(otInstance *aInstance, uint8_t aJitter)
|
void
Esse método define o valor da instabilidade do registro do roteador Backbone.
|
Estruturas |
|
---|---|
otBackboneRouterConfig. |
Essa estrutura representa a configuração do roteador Backbone. |
otBackboneRouterMulticastListenerInfo. |
Essa estrutura representa uma informação do listener de multicast do roteador Backbone. |
otBackboneRouterNdProxyInfo |
Representa as informações do proxy ND do roteador Backbone. |
Enumerações
OtBackboneRouterDomainPrefixEvent
otBackboneRouterDomainPrefixEvent
Representa os eventos do 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
|
Prefixo do domínio removido. |
OtBackboneRouterMulticastListenerEvent
otBackboneRouterMulticastListenerEvent
Representa os eventos do listener de multicast.
Propriedades | |
---|---|
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED
|
O listener multicast foi adicionado. |
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED
|
O listener do 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 excluídos. |
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 da espinha dorsal.
Propriedades | |
---|---|
OT_BACKBONE_ROUTER_STATE_DISABLED
|
A função do 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
Essa estrutura representa a configuração do roteador Backbone.
OtBackboneRouterDomainPrefixCallback
void(* otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix)
Esse ponteiro de função é chamado sempre que o prefixo do domínio muda.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
OtBackboneRouterMulticastListenerCallback
void(* otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress)
Esse ponteiro de função é chamado sempre que os listeners do Multicast mudam.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
OtBackboneRouterMulticastListenerInfo
struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo
Essa estrutura representa uma informação do listener de multicast do roteador Backbone.
OtBackboneRouterMulticastListenerJUnit
uint16_t otBackboneRouterMulticastListenerIterator
Usado para iterar por listeners multicast.
OtBackboneRouterNdProxyCallback
void(* otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua)
Esse ponteiro de função é chamado sempre que o proxy Nd muda.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
OtBackboneRouterNdProxyInfo
struct otBackboneRouterNdProxyInfo otBackboneRouterNdProxyInfo
Representa as informações do proxy ND do roteador Backbone.
Funções
OtBackboneRouterConfigNextDuaRegistryResponse
void otBackboneRouterConfigNextDuaRegistrationResponse( otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus )
Esse método configura o status de resposta do próximo registro da DUA.
Observação: disponível apenas quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
está ativado. Usado apenas para teste e certificação.
TODO: (DUA) compatível com código de erro de Coap e processo correspondente para fins de certificação.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
OtBackboneRouterConfigNextMulticastListenerRegistryResponse
void otBackboneRouterConfigNextMulticastListenerRegistrationResponse( otInstance *aInstance, uint8_t aStatus )
Configura o status da resposta do próximo registro de listener do multicast.
Disponível quando OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE
e OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
estiverem ativados.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
OtBackboneRouterGetConfig
void otBackboneRouterGetConfig( otInstance *aInstance, otBackboneRouterConfig *aConfig )
Recebe a configuração local do Backbone Router.
Disponível quando o OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
estiver ativado.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterSetConfig
otBackboneRouterRegister
OtBackboneRouterGetDomainPrefix
otError otBackboneRouterGetDomainPrefix( otInstance *aInstance, otBorderRouterConfig *aConfig )
Esse método recebe a configuração local do prefixo de domínio.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
OtBackboneRouterGetNdProxyInfo
otError otBackboneRouterGetNdProxyInfo( otInstance *aInstance, const otIp6Address *aDua, otBackboneRouterNdProxyInfo *aNdProxyInfo )
Esse método recebe as informações do proxy ND do roteador Backbone.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
otBackboneRouterGetPrimary
otError otBackboneRouterGetPrimary( otInstance *aInstance, otBackboneRouterConfig *aConfig )
Essa função recebe as informações do roteador principal na rede Thread.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
OtBackboneRouterGetRegistryJitter
uint8_t otBackboneRouterGetRegistrationJitter( otInstance *aInstance )
Esse método retorna o valor de instabilidade do registro do roteador de backbone.
Detalhes | |
---|---|
Retorna |
Instabilidade do registro do roteador Backbone.
|
otBackboneRouterSetRegistryJitter
OtBackboneRouterGetState
otBackboneRouterState otBackboneRouterGetState( otInstance *aInstance )
Recebe o Backbone Router otBackboneRouterState.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
otBackboneRouterSetEnabled
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister
OtBackboneRouterMulticastListenerAdd
otError otBackboneRouterMulticastListenerAdd( otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout )
Adiciona um listener 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
estiverem ativados.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerGetNext
OtBackboneRouterMulticastListenerClear
void otBackboneRouterMulticastListenerClear( otInstance *aInstance )
Limpa os listeners multicast.
Disponível quando OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE
e OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
estiverem ativados.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
otBackboneRouterMulticastListenerAdd
otBackboneRouterMulticastListenerGetNext
otBackboneRouterMulticastListenerGetNext
otError otBackboneRouterMulticastListenerGetNext( otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo )
Essa função recebe as próximas informações do listener de multicast (usando um iterador).
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerAdd
OtBackboneRouterRegister
otError otBackboneRouterRegister( otInstance *aInstance )
Registra explicitamente a configuração local do Backbone Router.
Uma mensagem de solicitação de dados do servidor SRV_DATA.ntf
é acionada para o dispositivo anexado.
Disponível quando o OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
estiver ativado.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig
OtBackboneRouterSetConfig
otError otBackboneRouterSetConfig( otInstance *aInstance, const otBackboneRouterConfig *aConfig )
Define a configuração local do roteador Backbone otBackboneRouterConfig.
Uma mensagem de solicitação de dados do servidor SRV_DATA.ntf
é iniciada automaticamente se o conjunto de dados BBR mudar para o roteador de backbone principal.
Disponível quando o OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
estiver ativado.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterRegister
OtBackboneRouterSetDomainPrefixCallback
void otBackboneRouterSetDomainPrefixCallback( otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext )
Esse método define o callback do prefixo de domínio do roteador do backbone.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
OtBackboneRouterSetEnabled
void otBackboneRouterSetEnabled( otInstance *aInstance, bool aEnable )
Ativa ou desativa a funcionalidade do Backbone.
Se ativado, uma mensagem de solicitação de dados do servidor SRV_DATA.ntf
será acionada para o dispositivo anexado se não houver serviço de roteador Backbone nos dados da rede Thread.
Se desativado, o SRV_DATA.ntf
será acionado se o roteador do backbone estiver no estado principal.
Disponível quando o OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
estiver ativado.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister
otBackboneRouterSetMulticastListenerCallback
void otBackboneRouterSetMulticastListenerCallback( otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext )
Esse método define o callback do listener de multicast do roteador Backbone.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
OtBackboneRouterSetNdProxyCallback
void otBackboneRouterSetNdProxyCallback( otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext )
Esse método define o callback do proxy ND do roteador Backbone.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
OtBackboneRouterSetRegistryJitter
void otBackboneRouterSetRegistrationJitter( otInstance *aInstance, uint8_t aJitter )
Esse método define o valor da instabilidade do registro do roteador Backbone.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
otBackboneRouterGetRegistryJitter
Macros
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT 0
Inicialização do otBackboneRouterMulticastListenerJUnit.
Recursos
Os tópicos de referência da API OpenThread são provenientes do código-fonte, disponível no GitHub. Para saber mais ou contribuir com nossa documentação, consulte Recursos.