Esta página foi traduzida pela API Cloud Translation.

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 { OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED , OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED , OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED , OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED , OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED }`	enum Essa enumeração define as constantes usadas em `otNeighborTableCallback` para indicar mudanças na tabela de vizinhos.

Typedefs
`otCacheEntryInfo`	typedef `struct otCacheEntryInfo` Esta estrutura representa uma entrada de cache EID.
`otCacheEntryIterator`	typedef `struct otCacheEntryIterator` Este tipo representa um iterador usado para iterar por meio das entradas da tabela de cache EID.
`otCacheEntryState`	typedef `enum otCacheEntryState` Essa enumeração define o estado de entrada do cache EID.
`otChildIp6AddressIterator`	typedef `uint16_t` Usado para iterar por meio de endereços IPv6 de uma entrada Thread Child.
`otNeighborTableCallback )(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)`	typedef `void(*` Este ponteiro de função é chamado para notificar que há uma mudança na tabela de vizinhos.

Funções
`otThreadBecomeLeader ( otInstance *aInstance)`	`otError` Torne-se um líder e comece uma nova partição.
`otThreadBecomeRouter ( otInstance *aInstance)`	`otError` Tente se tornar um roteador.
`otThreadGetChildInfoById ( otInstance aInstance, uint16_t aChildId, otChildInfo aChildInfo)`	`otError` 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)`	`otError` 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)`	`otError` 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)`	`otError` 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, otPskc aPskc)`	`void` Obtenha o Thread PSKc.
`otThreadGetPskcRef ( otInstance *aInstance)`	`otPskcRef` Obtenha a referência de chave para o thread PSKc armazenado.
`otThreadGetRouterDowngradeThreshold ( otInstance *aInstance)`	`uint8_t` Obtenha o parâmetro ROUTER_DOWNGRADE_THRESHOLD usado na função Roteador.
`otThreadGetRouterIdRange ( otInstance aInstance, uint8_t aMinRouterId, uint8_t *aMaxRouterId)`	`void` Esta função obtém o intervalo de IDs de roteador que podem ser atribuídos a nós na rede de encadeamento.
`otThreadGetRouterIdSequence ( otInstance *aInstance)`	`uint8_t` Obtenha a sequência de ID do roteador atual.
`otThreadGetRouterInfo ( otInstance aInstance, uint16_t aRouterId, otRouterInfo aRouterInfo)`	`otError` 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 é elegível para roteador ou não.
`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)`	`otError` Libere um ID de roteador que foi alocado pelo dispositivo na função de Líder.
`otThreadSetCcmEnabled ( otInstance *aInstance, bool aEnabled)`	`void` Esta função define se o dispositivo foi comissionado usando CCM.
`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)`	`otError` 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)`	`otError` Defina o número máximo de crianças permitidas atualmente.
`otThreadSetMaxChildIpAddresses ( otInstance *aInstance, uint8_t aMaxIpAddresses)`	`otError` 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)`	`otError` Defina a prioridade pai.
`otThreadSetPreferredLeaderPartitionId ( otInstance *aInstance, uint32_t aPartitionId)`	`void` Defina o ID de partição líder de encadeamento usado ao operar na função Líder.
`otThreadSetPreferredRouterId ( otInstance *aInstance, uint8_t aRouterId)`	`otError` Defina o ID do roteador preferido.
`otThreadSetPskc ( otInstance aInstance, const otPskc aPskc)`	`otError` Defina o Thread PSKc.
`otThreadSetPskcRef ( otInstance *aInstance, otPskcRef aKeyRef)`	`otError` 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)`	`otError` Esta função define se o dispositivo é elegível para roteador ou não.
`otThreadSetRouterIdRange ( otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)`	`otError` Esta função define o intervalo de IDs de roteador que podem ser atribuídos a nós na rede de encadeamento.
`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 representam uma mesa vizinha informações de entrada (criança ou router) e é usado como um parâmetro no retorno de chamada tabela de vizinhos `otNeighborTableCallback` .

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 mudanças na tabela de vizinhos.

Propriedades
`OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED`	Uma criança está sendo adicionada.
`OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED`	O modo de uma criança existente é alterado.
`OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED`	Uma criança está sendo removida.
`OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED`	Um roteador está sendo adicionado.
`OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED`	Um roteador está sendo 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 iteração e começar a partir da primeira entrada na tabela de memória cache, definir todos os seus campos na estrutura a zero (por exemplo, memset a iteração a 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 há uma mudança na tabela de vizinhos.

Detalhes

Parâmetros

`[in] aEvent`	Uma bandeira de evento.
`[in] aEntryInfo`	Um ponteiro para informações de entrada da tabela.

Funções

otThreadBecomeLeader

otError otThreadBecomeLeader(
  otInstance *aInstance
)

Torne-se um líder e comece uma nova partição.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Valores Retornados

`OT_ERROR_NONE`	Tornou-se líder com sucesso e iniciou uma nova partição.
`OT_ERROR_INVALID_STATE`	O tópico está desativado.

otThreadBecomeRouter

otError otThreadBecomeRouter(
  otInstance *aInstance
)

Tente se tornar um roteador.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Valores Retornados

`OT_ERROR_NONE`	Comece com sucesso a tentativa de se tornar um roteador.
`OT_ERROR_INVALID_STATE`	O tópico está desativado.

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

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aChildId`	O ID do filho ou RLOC16 do filho anexado.
`[out] aChildInfo`	Um ponteiro para onde as informações do filho são colocadas.

Valores Retornados

`OT_ERROR_NONE`	`aChildInfo` foi atualizado com sucesso com a informação para o ID dado.
`OT_ERROR_NOT_FOUND`	Nenhuma criança válida com este ID de criança.
`OT_ERROR_INVALID_ARGS`	Se `aChildInfo` é NULL.

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

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aChildIndex`	O índice da tabela.
`[out] aChildInfo`	Um ponteiro para onde as informações do filho são colocadas.

Valores Retornados

`OT_ERROR_NONE`	`aChildInfo` foi atualizado com sucesso com a informação para o índice especificado.
`OT_ERROR_NOT_FOUND`	Nenhum filho válido neste índice.
`OT_ERROR_INVALID_ARGS`	De qualquer `aChildInfo` é nulo, ou `aChildIndex` está fora do intervalo (maior do que o índice da tabela max).

Veja também:
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

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aChildIndex`	O índice filho.
`[in,out] aIterator`	Um ponteiro para o iterador. Em caso de sucesso, o iterador será atualizado para apontar para a próxima entrada na lista. Para obter o primeiro endereço IPv6, o iterador deve ser definido como OT_CHILD_IP6_ADDRESS_ITERATOR_INIT.
`[out] aAddress`	Um ponteiro para um endereço IPv6 onde o próximo endereço da criança é colocado (em caso de sucesso).

Valores Retornados

`OT_ERROR_NONE`	Com sucesso encontrado o próximo endereço IPv6 ( `aAddress` foi atualizado com sucesso).
`OT_ERROR_NOT_FOUND`	O filho não tem entrada de endereço IPv6 subsequente.
`OT_ERROR_INVALID_ARGS`	`aIterator` ou `aAddress` são NULL, ou criança em `aChildIndex` não é válido.

Veja também:
otThreadGetChildInfoByIndex

otThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

Obtenha o parâmetro CONTEXT_ID_REUSE_DELAY usado na função Líder.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

O valor CONTEXT_ID_REUSE_DELAY.

Veja também:
otThreadSetContextIdReuseDelay

otThreadGetJoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

Obtenha a porta UDP do Joiner.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

O número da porta UDP do Joiner.

Veja também:
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

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

O valor do Peso do Líder da Rosca.

Veja também:
otThreadSetLeaderWeight

otThreadGetMaxAllowedChildren

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

Obtenha o número máximo de crianças permitido atualmente.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

O número máximo de crianças permitido atualmente.

Veja também:
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

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

O número máximo de endereços IP que cada filho MTD pode registrar com este dispositivo como pai.

Veja também:
otThreadSetMaxChildIpAddresses

otThreadGetMaxRouterId

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

A função retorna o ID de roteador máximo permitido.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

A identificação máxima permitida do roteador.

otThreadGetNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

Obtenha o parâmetro NETWORK_ID_TIMEOUT usado na função Roteador.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

O valor NETWORK_ID_TIMEOUT.

Veja também:
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

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[out] aEntryInfo`	Um ponteiro para onde as informações de entrada do cache EID são colocadas.
`[in,out] aIterator`	Um ponteiro para um iterador. Ele será atualizado para apontar para a próxima entrada em caso de sucesso. Para obter a primeira entrada, inicializar o iterador, definindo todos os seus campos a zero (por exemplo, `memset` a estrutura do iterador para zero).

Valores Retornados

`OT_ERROR_NONE`	Com sucesso povoada `aEntryInfo` para a próxima entrada de cache EID.
`OT_ERROR_NOT_FOUND`	Não há mais entradas na tabela de cache de endereço.

otThreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

Obtenha a prioridade pai atribuída.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

O valor de prioridade pai atribuído, -2 significa não atribuído.

Veja também:
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

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

O valor do ID da partição líder do encadeamento.

otThreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

Obtenha o Thread PSKc.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[out] aPskc`	Um ponteiro para uma `otPskc` para retornar o Tópico recuperado PSKC.

Veja também:
otThreadSetPskc

otThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

Obtenha a referência de chave para o thread PSKc armazenado.

Esta função exige o recurso de tempo de compilação OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE para ser ativado.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

Referência chave para PSKc

Veja também:
otThreadSetPskcRef

otThreadGetRouterDowngradeThreshold

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

Obtenha o parâmetro ROUTER_DOWNGRADE_THRESHOLD usado na função Roteador.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

O valor ROUTER_DOWNGRADE_THRESHOLD.

Veja também:
otThreadSetRouterDowngradeThreshold

otThreadGetRouterIdRange

void otThreadGetRouterIdRange(
  otInstance *aInstance,
  uint8_t *aMinRouterId,
  uint8_t *aMaxRouterId
)

Esta função obtém o intervalo de IDs de roteador que podem ser atribuídos a nós na rede de encadeamento.

Nota: Esta API requer OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE , e é usado somente para fins de teste. Todos os IDs de roteador no intervalo [aMinRouterId, aMaxRouterId] são permitidos.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[out] aMinRouterId`	A ID mínima do roteador.
`[out] aMaxRouterId`	A ID máxima do roteador.

Veja também:
otThreadSetRouterIdRange

otThreadGetRouterIdSequence

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

Obtenha a sequência de ID do roteador atual.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

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

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aRouterId`	O ID do roteador ou RLOC16 para um determinado roteador.
`[out] aRouterInfo`	Um ponteiro para onde as informações do roteador são colocadas.

Valores Retornados

`OT_ERROR_NONE`	Recuperado com sucesso as informações do roteador para o ID fornecido.
`OT_ERROR_NOT_FOUND`	Nenhuma entrada de roteador com o ID fornecido.
`OT_ERROR_INVALID_ARGS`	`aRouterInfo` é NULL.

otThreadGetRouterSelectionJitter

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

Obtenha o parâmetro ROUTER_SELECTION_JITTER usado na função REED / Roteador.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

O valor ROUTER_SELECTION_JITTER.

Veja também:
otThreadSetRouterSelectionJitter

otThreadGetRouterUpgradeThreshold

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

Obtenha o parâmetro ROUTER_UPGRADE_THRESHOLD usado na função REED.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

O valor ROUTER_UPGRADE_THRESHOLD.

Veja também:
otThreadSetRouterUpgradeThreshold

otThreadIsRouterEligible

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

Este método indica se o dispositivo é elegível para roteador ou não.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Valores Retornados

`TRUE`	Se o dispositivo for elegível para roteador.
`FALSE`	Se o dispositivo não for elegível para roteador.

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 houver uma alteração na tabela de vizinhos (por exemplo, uma entrada filho ou vizinho de roteador está sendo adicionada / removida ou um modo de filho existente é alterado).

As chamadas subsequentes a esse método substituirão o retorno de chamada anterior. Note-se que esse retorno de chamada em invocado enquanto a tabela o vizinho / criança está sendo atualizado e sempre antes da otStateChangedCallback .

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aCallback`	Um ponteiro para a função de manipulador de retorno de chamada.

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

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aRouterId`	O ID do roteador a ser liberado. O intervalo válido é [0, 62].

Valores Retornados

`OT_ERROR_NONE`	Liberado com sucesso o id do roteador.
`OT_ERROR_INVALID_ARGS`	`aRouterId` não está no intervalo [0, 62].
`OT_ERROR_INVALID_STATE`	O dispositivo não está operando atualmente como um líder.
`OT_ERROR_NOT_FOUND`	A identificação do roteador não está alocada no momento.

otThreadSetCcmEnabled

void otThreadSetCcmEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Esta função define se o dispositivo foi comissionado usando CCM.

Nota: Esta API requer OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE , e é usado somente por Tópico Harness de teste para indicar se este dispositivo foi encomendado usando CCM.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aEnabled`	TRUE se o dispositivo foi comissionado usando CCM, FALSE caso contrário.

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

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aDelay`	O valor CONTEXT_ID_REUSE_DELAY.

Veja também:
otThreadGetContextIdReuseDelay

otThreadSetJoinerUdpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

Defina a porta UDP do Joiner.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aJoinerUdpPort`	O número da porta UDP do Joiner.

Valores Retornados

OT_ERROR_NONE

Configure com sucesso a Porta UDP do Joiner.

Veja também:
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

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aWeight`	O valor do Peso do Líder da Rosca.

Veja também:
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

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aMaxChildren`	O máximo permitido de crianças.

Valores Retornados

`OT_ERROR_NONE`	Definido com sucesso o max.
`OT_ERROR_INVALID_ARGS`	Se `aMaxChildren` não está no intervalo [1, OPENTHREAD_CONFIG_MLE_MAX_CHILDREN].
`OT_ERROR_INVALID_STATE`	Se o Thread não for interrompido.

Veja também:
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.

Nota: Este API requer OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE , e é utilizado apenas por rosca Harness de teste para limitar os registos de endereços da matriz de referência, a fim de testar a reacção MTD DUT.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aMaxIpAddresses`	O número máximo de endereços IP que cada filho MTD pode registrar com este dispositivo como pai. 0 para limpar a configuração e restaurar o padrão.

Valores Retornados

`OT_ERROR_NONE`	Definido / apagado com sucesso o número.
`OT_ERROR_INVALID_ARGS`	Se exceder o número máximo permitido.

Veja também:
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

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aTimeout`	O valor NETWORK_ID_TIMEOUT.

Veja também:
otThreadGetNetworkIdTimeout

otThreadSetParentPriority

otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

Defina a prioridade pai.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aParentPriority`	O valor da prioridade pai.

Valores Retornados

`OT_ERROR_NONE`	Defina com sucesso a prioridade pai.
`OT_ERROR_INVALID_ARGS`	Se o valor da prioridade pai não estiver entre 1, 0, -1 e -2.

Veja também:
otThreadGetParentPriority

otThreadSetPreferredLeaderPartitionId

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

Defina o ID de partição líder de encadeamento usado ao operar na função Líder.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aPartitionId`	O valor do ID da partição líder do encadeamento.

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 o ID do roteador preferido não for definido ou se não puder ser usado, um ID do roteador gerado aleatoriamente é escolhido. Esta propriedade pode ser definida apenas quando a função do dispositivo está desanexada ou desabilitada.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aRouterId`	O ID do roteador preferido.

Valores Retornados

`OT_ERROR_NONE`	Defina com sucesso o ID do roteador preferido.
`OT_ERROR_INVALID_STATE`	Não foi possível definir (a função não foi desanexada ou desativada)

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

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aPskc`	Um ponteiro para o novo Thread PSKc.

Valores Retornados

`OT_ERROR_NONE`	Defina o Thread PSKc com sucesso.
`OT_ERROR_INVALID_STATE`	Os protocolos de thread estão ativados.

Veja também:
otThreadGetPskc

otThreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

Defina o Thread PSKc.

Esta função exige o recurso de tempo de compilação OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE para ser ativado.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aPskcRef`	Referência chave para o novo Thread PSKc.

Valores Retornados

`OT_ERROR_NONE`	Defina o Thread PSKc com sucesso.
`OT_ERROR_INVALID_STATE`	Os protocolos de thread estão ativados.

Veja também:
otThreadGetPskcRef

otThreadSetRouterDowngradeThreshold

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Defina o parâmetro ROUTER_DOWNGRADE_THRESHOLD usado na função Líder.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aThreshold`	O valor ROUTER_DOWNGRADE_THRESHOLD.

Veja também:
otThreadGetRouterDowngradeThreshold

otThreadSetRouterEligible

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

Esta função define se o dispositivo é elegível para roteador ou não.

Se aEligible é falso e o dispositivo está a funcionar como um roteador, esta chamada fará com que o dispositivo para separação e tente recolocá como uma criança.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aEligible`	TRUE para configurar o dispositivo como elegível para roteador, FALSE caso contrário.

Valores Retornados

`OT_ERROR_NONE`	Defina com êxito a configuração elegível para o roteador.
`OT_ERROR_NOT_CAPABLE`	O dispositivo não é capaz de se tornar um roteador.

otThreadSetRouterIdRange

otError otThreadSetRouterIdRange(
  otInstance *aInstance,
  uint8_t aMinRouterId,
  uint8_t aMaxRouterId
)

Esta função define o intervalo de IDs de roteador que podem ser atribuídos a nós na rede de encadeamento.

Nota: Esta API requer OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE , e é usado somente para fins de teste. Todos os IDs de roteador no intervalo [aMinRouterId, aMaxRouterId] são permitidos.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aMinRouterId`	A ID mínima do roteador.
`[in] aMaxRouterId`	A ID máxima do roteador.

Valores Retornados

`OT_ERROR_NONE`	Defina o intervalo com sucesso.
`OT_ERROR_INVALID_ARGS`	aMinRouterId> aMaxRouterId, ou o intervalo não é coberto por [0, 62].

Veja também:
otThreadGetRouterIdRange

otThreadSetRouterSelectionJitter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

Defina o parâmetro ROUTER_SELECTION_JITTER usado na função REED / Roteador.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aRouterJitter`	O valor ROUTER_SELECTION_JITTER.

Veja também:
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

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aThreshold`	O valor ROUTER_UPGRADE_THRESHOLD.

Veja também:
otThreadGetRouterUpgradeThreshold

otThreadSetSteeringData

void otThreadSetSteeringData(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

Defina os dados de direção fora da banda.

Opção de configuração OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE deve ser definido para permitir ajuste dos dados de direção fora da banda.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aExtAddress`	Endereço usado para atualizar os dados de direção. Todos os zeros para limpar os dados de direção (sem dados de direção). Todos os 0xFFs para definir os dados de direção / filtro bloom para aceitar / permitir todos. Um EUI64 específico que é então adicionado aos dados de direção / filtro de floração atuais.

Macros

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

Inicializador para otChildIP6AddressIterator.

Roteador / Líder

Resumo

Enumerações

Typedefs

Funções

Structs

Enumerações

otCacheEntryState

otNeighborTableEvent

Typedefs

otCacheEntryInfo

otCacheEntryIterator

otCacheEntryState

otChildIp6AddressIterator

otNeighborTableCallback

Funções

otThreadBecomeLeader

otThreadBecomeRouter

otThreadGetChildInfoById

otThreadGetChildInfoByIndex

otThreadGetChildNextIp6Address

otThreadGetContextIdReuseDelay

otThreadGetJoinerUdpPort

otThreadGetLocalLeaderWeight

otThreadGetMaxAllowedChildren

otThreadGetMaxChildIpAddresses

otThreadGetMaxRouterId

otThreadGetNetworkIdTimeout

otThreadGetNextCacheEntry

otThreadGetParentPriority

otThreadGetPreferredLeaderPartitionId

otThreadGetPskc

otThreadGetPskcRef

otThreadGetRouterDowngradeThreshold

otThreadGetRouterIdRange

otThreadGetRouterIdSequence

otThreadGetRouterInfo

otThreadGetRouterSelectionJitter

otThreadGetRouterUpgradeThreshold

otThreadIsRouterEligible

otThreadRegisterNeighborTableCallback

otThreadReleaseRouterId

otThreadSetCcmEnabled

otThreadSetContextIdReuseDelay

otThreadSetJoinerUdpPort

otThreadSetLocalLeaderWeight

otThreadSetMaxAllowedChildren

otThreadSetMaxChildIpAddresses

otThreadSetNetworkIdTimeout

otThreadSetParentPriority

otThreadSetPreferredLeaderPartitionId

otThreadSetPreferredRouterId

otThreadSetPskc

otThreadSetPskcRef

otThreadSetRouterDowngradeThreshold

otThreadSetRouterEligible

otThreadSetRouterIdRange

otThreadSetRouterSelectionJitter

otThreadSetRouterUpgradeThreshold

otThreadSetSteeringData

Macros

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT