Roteador / Líder
Este módulo inclui funções para Thread Routers e Leaders.
Resumo
Enumerações | |
---|---|
otCacheEntryState | enum Essa enumeração define o estado de entrada do cache EID. |
otNeighborTableEvent { | enum Essa enumeração define as constantes usadas em otNeighborTableCallback para indicar se um filho ou vizinho do roteador está sendo adicionado ou removido. |
Typedefs | |
---|---|
otCacheEntryInfo | typedefstruct otCacheEntryInfo Esta estrutura representa uma entrada de cache EID. |
otCacheEntryIterator | typedefstruct otCacheEntryIterator Este tipo representa um iterador usado para iterar por meio das entradas da tabela de cache EID. |
otCacheEntryState | typedefenum otCacheEntryState Essa enumeração define o estado de entrada do cache EID. |
otChildIp6AddressIterator | typedefuint16_t Usado para iterar por meio de endereços IPv6 de uma entrada Thread Child. |
otNeighborTableCallback )(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo) | typedefvoid(* Este ponteiro de função é chamado para notificar que um vizinho filho ou roteador está sendo adicionado ou removido da tabela de vizinhos. |
Funções | |
---|---|
otThreadBecomeLeader ( otInstance *aInstance) | Torne-se um líder e comece uma nova partição. |
otThreadBecomeRouter ( otInstance *aInstance) | Tente se tornar um roteador. |
otThreadGetChildInfoById ( otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo) | A função retém informações de diagnóstico para um filho anexado por seu ID de filho ou RLOC16. |
otThreadGetChildInfoByIndex ( otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo) | A função retém informações de diagnóstico para um filho anexado pelo índice da tabela interna. |
otThreadGetChildNextIp6Address ( otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress) | Esta função obtém o próximo endereço IPv6 (usando um iterador) para um determinado filho. |
otThreadGetContextIdReuseDelay ( otInstance *aInstance) | uint32_t Obtenha o parâmetro CONTEXT_ID_REUSE_DELAY usado na função Líder. |
otThreadGetJoinerUdpPort ( otInstance *aInstance) | uint16_t Obtenha a porta UDP do Joiner. |
otThreadGetLocalLeaderWeight ( otInstance *aInstance) | uint8_t Obtenha o Peso Líder da Linha usado ao operar na função Líder. |
otThreadGetMaxAllowedChildren ( otInstance *aInstance) | uint16_t Obtenha o número máximo de crianças permitido atualmente. |
otThreadGetMaxChildIpAddresses ( otInstance *aInstance) | uint8_t Esta função obtém o número máximo de endereços IP que cada filho MTD pode registrar com este dispositivo como pai. |
otThreadGetMaxRouterId ( otInstance *aInstance) | uint8_t A função retorna o ID de roteador máximo permitido. |
otThreadGetNetworkIdTimeout ( otInstance *aInstance) | uint8_t Obtenha o parâmetro NETWORK_ID_TIMEOUT usado na função Roteador. |
otThreadGetNextCacheEntry ( otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator) | Esta função obtém a próxima entrada de cache EID (usando um iterador). |
otThreadGetParentPriority ( otInstance *aInstance) | int8_t Obtenha a prioridade pai atribuída. |
otThreadGetPreferredLeaderPartitionId ( otInstance *aInstance) | uint32_t Obtenha o ID de partição líder de encadeamento usado ao operar na função Líder. |
otThreadGetPskc ( otInstance *aInstance) | const otPskc * Obtenha o Thread PSKc. |
otThreadGetRouterDowngradeThreshold ( otInstance *aInstance) | uint8_t Obtenha o parâmetro ROUTER_DOWNGRADE_THRESHOLD usado na função Roteador. |
otThreadGetRouterIdSequence ( otInstance *aInstance) | uint8_t Obtenha a sequência de ID do roteador atual. |
otThreadGetRouterInfo ( otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo) | A função retém informações de diagnóstico para um determinado Thread Router. |
otThreadGetRouterSelectionJitter ( otInstance *aInstance) | uint8_t Obtenha o parâmetro ROUTER_SELECTION_JITTER usado na função REED / Roteador. |
otThreadGetRouterUpgradeThreshold ( otInstance *aInstance) | uint8_t Obtenha o parâmetro ROUTER_UPGRADE_THRESHOLD usado na função REED. |
otThreadIsRouterEligible ( otInstance *aInstance) | bool Este método indica se o dispositivo é ou não qualificado para o roteador. |
otThreadRegisterNeighborTableCallback ( otInstance *aInstance, otNeighborTableCallback aCallback) | void Esta função registra uma função de retorno de chamada da tabela vizinha. |
otThreadReleaseRouterId ( otInstance *aInstance, uint8_t aRouterId) | Libere um ID de roteador que foi alocado pelo dispositivo na função de Líder. |
otThreadSetContextIdReuseDelay ( otInstance *aInstance, uint32_t aDelay) | void Defina o parâmetro CONTEXT_ID_REUSE_DELAY usado na função Líder. |
otThreadSetJoinerUdpPort ( otInstance *aInstance, uint16_t aJoinerUdpPort) | Defina a porta UDP do Joiner. |
otThreadSetLocalLeaderWeight ( otInstance *aInstance, uint8_t aWeight) | void Defina o Peso Líder da Linha usado ao operar na função Líder. |
otThreadSetMaxAllowedChildren ( otInstance *aInstance, uint16_t aMaxChildren) | Defina o número máximo de crianças permitidas atualmente. |
otThreadSetMaxChildIpAddresses ( otInstance *aInstance, uint8_t aMaxIpAddresses) | Esta função define / restaura o número máximo de endereços IP que cada filho MTD pode registrar com este dispositivo como pai. |
otThreadSetNetworkIdTimeout ( otInstance *aInstance, uint8_t aTimeout) | void Defina o parâmetro NETWORK_ID_TIMEOUT usado na função Líder. |
otThreadSetParentPriority ( otInstance *aInstance, int8_t aParentPriority) | Defina a prioridade pai. |
otThreadSetPreferredLeaderPartitionId ( otInstance *aInstance, uint32_t aPartitionId) | void Defina o ID de partição líder de encadeamento preferido usado ao operar na função Líder. |
otThreadSetPreferredRouterId ( otInstance *aInstance, uint8_t aRouterId) | Defina o ID do roteador preferido. |
otThreadSetPskc ( otInstance *aInstance, const otPskc *aPskc) | Defina o Thread PSKc. |
otThreadSetRouterDowngradeThreshold ( otInstance *aInstance, uint8_t aThreshold) | void Defina o parâmetro ROUTER_DOWNGRADE_THRESHOLD usado na função Líder. |
otThreadSetRouterEligible ( otInstance *aInstance, bool aEligible) | Esta função define se o dispositivo é elegível para roteador ou não. |
otThreadSetRouterSelectionJitter ( otInstance *aInstance, uint8_t aRouterJitter) | void Defina o parâmetro ROUTER_SELECTION_JITTER usado na função REED / Roteador. |
otThreadSetRouterUpgradeThreshold ( otInstance *aInstance, uint8_t aThreshold) | void Defina o parâmetro ROUTER_UPGRADE_THRESHOLD usado na função Líder. |
otThreadSetSteeringData ( otInstance *aInstance, const otExtAddress *aExtAddress) | void Defina os dados de direção fora da banda. |
Structs | |
---|---|
otCacheEntryInfo | Esta estrutura representa uma entrada de cache EID. |
otCacheEntryIterator | Este tipo representa um iterador usado para iterar por meio das entradas da tabela de cache EID. |
otChildInfo | Esta estrutura contém informações de diagnóstico para um Thread Child. |
otNeighborTableEntryInfo | Este tipo representa uma informação de entrada da tabela vizinha (filho ou roteador) e é usado como um parâmetro no retorno de chamada da tabela vizinha |
Enumerações
otCacheEntryState
otCacheEntryState
Essa enumeração define o estado de entrada do cache EID.
otNeighborTableEvent
otNeighborTableEvent
Essa enumeração define as constantes usadas em otNeighborTableCallback
para indicar se um filho ou vizinho do roteador está sendo adicionado ou removido.
Typedefs
otCacheEntryInfo
struct otCacheEntryInfo otCacheEntryInfo
Esta estrutura representa uma entrada de cache EID.
otCacheEntryIterator
struct otCacheEntryIterator otCacheEntryIterator
Este tipo representa um iterador usado para iterar por meio das entradas da tabela de cache EID.
Para inicializar o iterador e começar a partir da primeira entrada na tabela de cache, defina todos os seus campos na estrutura para zero (por exemplo, memset
o iterador para zero).
otCacheEntryState
enum otCacheEntryState otCacheEntryState
Essa enumeração define o estado de entrada do cache EID.
otChildIp6AddressIterator
uint16_t otChildIp6AddressIterator
Usado para iterar por meio de endereços IPv6 de uma entrada Thread Child.
otNeighborTableCallback
void(* otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)
Este ponteiro de função é chamado para notificar que um vizinho filho ou roteador está sendo adicionado ou removido da tabela de vizinhos.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
Funções
otThreadBecomeLeader
otError otThreadBecomeLeader( otInstance *aInstance )
Torne-se um líder e comece uma nova partição.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Valores Retornados |
|
otThreadBecomeRouter
otError otThreadBecomeRouter( otInstance *aInstance )
Tente se tornar um roteador.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Valores Retornados |
|
otThreadGetChildInfoById
otError otThreadGetChildInfoById( otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo )
A função retém informações de diagnóstico para um filho anexado por seu ID de filho ou RLOC16.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores Retornados |
|
otThreadGetChildInfoByIndex
otError otThreadGetChildInfoByIndex( otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo )
A função retém informações de diagnóstico para um filho anexado pelo índice da tabela interna.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores Retornados |
|
otGetMaxAllowedChildren
otThreadGetChildNextIp6Address
otError otThreadGetChildNextIp6Address( otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress )
Esta função obtém o próximo endereço IPv6 (usando um iterador) para um determinado filho.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||
Valores Retornados |
|
otThreadGetChildInfoByIndex
otThreadGetContextIdReuseDelay
uint32_t otThreadGetContextIdReuseDelay( otInstance *aInstance )
Obtenha o parâmetro CONTEXT_ID_REUSE_DELAY usado na função Líder.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | O valor CONTEXT_ID_REUSE_DELAY. |
otThreadSetContextIdReuseDelay
otThreadGetJoinerUdpPort
uint16_t otThreadGetJoinerUdpPort( otInstance *aInstance )
Obtenha a porta UDP do Joiner.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | O número da porta UDP do Joiner. |
otThreadSetJoinerUdpPort
otThreadGetLocalLeaderWeight
uint8_t otThreadGetLocalLeaderWeight( otInstance *aInstance )
Obtenha o Peso Líder da Linha usado ao operar na função Líder.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | O valor do Peso do Líder da Rosca. |
otThreadSetLeaderWeight
otThreadGetMaxAllowedChildren
uint16_t otThreadGetMaxAllowedChildren( otInstance *aInstance )
Obtenha o número máximo de crianças permitido atualmente.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | O número máximo de crianças permitido atualmente. |
otThreadSetMaxAllowedChildren
otThreadGetMaxChildIpAddresses
uint8_t otThreadGetMaxChildIpAddresses( otInstance *aInstance )
Esta função obtém o número máximo de endereços IP que cada filho MTD pode registrar com este dispositivo como pai.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | O número máximo de endereços IP que cada filho MTD pode registrar com este dispositivo como pai. |
otThreadSetMaxChildIpAddresses
otThreadGetMaxRouterId
uint8_t otThreadGetMaxRouterId( otInstance *aInstance )
A função retorna o ID de roteador máximo permitido.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | O ID máximo permitido do roteador. |
otThreadGetNetworkIdTimeout
uint8_t otThreadGetNetworkIdTimeout( otInstance *aInstance )
Obtenha o parâmetro NETWORK_ID_TIMEOUT usado na função Roteador.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | O valor NETWORK_ID_TIMEOUT. |
otThreadSetNetworkIdTimeout
otThreadGetNextCacheEntry
otError otThreadGetNextCacheEntry( otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator )
Esta função obtém a próxima entrada de cache EID (usando um iterador).
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores Retornados |
|
otThreadGetParentPriority
int8_t otThreadGetParentPriority( otInstance *aInstance )
Obtenha a prioridade pai atribuída.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | O valor de prioridade pai atribuído, -2 significa não atribuído. |
otThreadSetParentPriority
otThreadGetPreferredLeaderPartitionId
uint32_t otThreadGetPreferredLeaderPartitionId( otInstance *aInstance )
Obtenha o ID de partição líder de encadeamento usado ao operar na função Líder.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | O valor do ID da partição líder do segmento. |
otThreadGetPskc
const otPskc * otThreadGetPskc( otInstance *aInstance )
Obtenha o Thread PSKc.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | Um ponteiro para Thread PSKc |
otThreadSetPskc
otThreadGetRouterDowngradeThreshold
uint8_t otThreadGetRouterDowngradeThreshold( otInstance *aInstance )
Obtenha o parâmetro ROUTER_DOWNGRADE_THRESHOLD usado na função Roteador.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | O valor ROUTER_DOWNGRADE_THRESHOLD. |
otThreadSetRouterDowngradeThreshold
otThreadGetRouterIdSequence
uint8_t otThreadGetRouterIdSequence( otInstance *aInstance )
Obtenha a sequência de ID do roteador atual.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | A sequência de ID do roteador. |
otThreadGetRouterInfo
otError otThreadGetRouterInfo( otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo )
A função retém informações de diagnóstico para um determinado Thread Router.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores Retornados |
|
otThreadGetRouterSelectionJitter
uint8_t otThreadGetRouterSelectionJitter( otInstance *aInstance )
Obtenha o parâmetro ROUTER_SELECTION_JITTER usado na função REED / Roteador.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | O valor ROUTER_SELECTION_JITTER. |
otThreadSetRouterSelectionJitter
otThreadGetRouterUpgradeThreshold
uint8_t otThreadGetRouterUpgradeThreshold( otInstance *aInstance )
Obtenha o parâmetro ROUTER_UPGRADE_THRESHOLD usado na função REED.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | O valor ROUTER_UPGRADE_THRESHOLD. |
otThreadSetRouterUpgradeThreshold
otThreadIsRouterEligible
bool otThreadIsRouterEligible( otInstance *aInstance )
Este método indica se o dispositivo é ou não qualificado para o roteador.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Valores Retornados |
|
otThreadRegisterNeighborTableCallback
void otThreadRegisterNeighborTableCallback( otInstance *aInstance, otNeighborTableCallback aCallback )
Esta função registra uma função de retorno de chamada da tabela vizinha.
O retorno de chamada fornecido (se não NULL) será invocado quando uma entrada secundária ou secundária do roteador estiver sendo adicionada / removida para / da tabela vizinha. As chamadas subsequentes a esse método substituirão o retorno de chamada anterior. Observe que esse retorno de chamada é invocado enquanto a tabela de vizinhos / filhos está sendo atualizada e sempre antes de otStateChangedCallback
.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
otThreadReleaseRouterId
otError otThreadReleaseRouterId( otInstance *aInstance, uint8_t aRouterId )
Libere um ID de roteador que foi alocado pelo dispositivo na função de Líder.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||
Valores Retornados |
|
otThreadSetContextIdReuseDelay
void otThreadSetContextIdReuseDelay( otInstance *aInstance, uint32_t aDelay )
Defina o parâmetro CONTEXT_ID_REUSE_DELAY usado na função Líder.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
otThreadGetContextIdReuseDelay
otThreadSetJoinerUdpPort
otError otThreadSetJoinerUdpPort( otInstance *aInstance, uint16_t aJoinerUdpPort )
Defina a porta UDP do Joiner.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Valores Retornados |
|
otThreadGetJoinerUdpPort
otThreadSetLocalLeaderWeight
void otThreadSetLocalLeaderWeight( otInstance *aInstance, uint8_t aWeight )
Defina o Peso Líder da Linha usado ao operar na função Líder.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
otThreadGetLeaderWeight
otThreadSetMaxAllowedChildren
otError otThreadSetMaxAllowedChildren( otInstance *aInstance, uint16_t aMaxChildren )
Defina o número máximo de crianças permitidas atualmente.
Este parâmetro só pode ser definido quando a operação do protocolo de thread foi interrompida.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores Retornados |
|
otThreadGetMaxAllowedChildren
otThreadSetMaxChildIpAddresses
otError otThreadSetMaxChildIpAddresses( otInstance *aInstance, uint8_t aMaxIpAddresses )
Esta função define / restaura o número máximo de endereços IP que cada filho MTD pode registrar com este dispositivo como pai.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Valores Retornados |
|
otThreadGetMaxChildIpAddresses
otThreadSetNetworkIdTimeout
void otThreadSetNetworkIdTimeout( otInstance *aInstance, uint8_t aTimeout )
Defina o parâmetro NETWORK_ID_TIMEOUT usado na função Líder.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
otThreadGetNetworkIdTimeout
otThreadSetParentPriority
otError otThreadSetParentPriority( otInstance *aInstance, int8_t aParentPriority )
Defina a prioridade pai.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Valores Retornados |
|
otThreadGetParentPriority
otThreadSetPreferredLeaderPartitionId
void otThreadSetPreferredLeaderPartitionId( otInstance *aInstance, uint32_t aPartitionId )
Defina o ID de partição líder de encadeamento preferido usado ao operar na função Líder.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
otThreadSetPreferredRouterId
otError otThreadSetPreferredRouterId( otInstance *aInstance, uint8_t aRouterId )
Defina o ID do roteador preferido.
Ao se tornar um roteador / líder, o nó tenta usar este ID de roteador. Se a ID do roteador preferencial não for definida ou não puder ser usada, uma ID de roteador gerada aleatoriamente é escolhida. Esta propriedade pode ser definida apenas quando a função do dispositivo está desanexada ou desabilitada.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Valores Retornados |
|
otThreadSetPskc
otError otThreadSetPskc( otInstance *aInstance, const otPskc *aPskc )
Defina o Thread PSKc.
Esta função só terá sucesso quando os protocolos de thread estiverem desabilitados. Uma chamada bem-sucedida para esta função também invalidará os conjuntos de dados operacionais ativos e pendentes na memória não volátil.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Valores Retornados |
|
otThreadGetPskc
otThreadSetRouterDowngradeThreshold
void otThreadSetRouterDowngradeThreshold( otInstance *aInstance, uint8_t aThreshold )
Defina o parâmetro ROUTER_DOWNGRADE_THRESHOLD usado na função Líder.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
otThreadGetRouterDowngradeThreshold
otThreadSetRouterEligible
otError otThreadSetRouterEligible( otInstance *aInstance, bool aEligible )
Esta função define se o dispositivo é elegível para roteador ou não.
Se aEligible
for false e o dispositivo estiver operando como um roteador, esta chamada fará com que o dispositivo se desconecte e tente se reconectar como um filho.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Valores Retornados |
|
otThreadSetRouterSelectionJitter
void otThreadSetRouterSelectionJitter( otInstance *aInstance, uint8_t aRouterJitter )
Defina o parâmetro ROUTER_SELECTION_JITTER usado na função REED / Roteador.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
otThreadGetRouterSelectionJitter
otThreadSetRouterUpgradeThreshold
void otThreadSetRouterUpgradeThreshold( otInstance *aInstance, uint8_t aThreshold )
Defina o parâmetro ROUTER_UPGRADE_THRESHOLD usado na função Líder.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
otThreadGetRouterUpgradeThreshold
otThreadSetSteeringData
void otThreadSetSteeringData( otInstance *aInstance, const otExtAddress *aExtAddress )
Defina os dados de direção fora da banda.
A opção de configuração OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE
deve ser definida para permitir a configuração dos dados de direção fora da banda.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
Macros
OT_CHILD_IP6_ADDRESS_ITERATOR_INIT
OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0
Inicializador para otChildIP6AddressIterator.