Esta página foi traduzida pela API Cloud Translation.

Roteador/líder

Este módulo inclui funções para roteadores e líderes da linha de execução.

Resumo

Enumerações
`otCacheEntryState`	tipo enumerado Esta enumeração define o estado de entrada do cache de 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 }`	tipo enumerado Esta enumeração define as constantes usadas na `otNeighborTableCallback` para indicar mudanças na tabela vizinha.

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

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` Recebe informações de diagnóstico de um filho anexado pelo ID ou RLOC16.
`otThreadGetChildInfoByIndex(otInstance aInstance, uint16_t aChildIndex, otChildInfo aChildInfo)`	`otError` A função retém informações de diagnóstico de um filho anexado pelo índice interno da tabela.
`otThreadGetChildNextIp6Address(otInstance aInstance, uint16_t aChildIndex, otChildIp6AddressIterator aIterator, otIp6Address *aAddress)`	`otError` Essa função recebe o próximo endereço IPv6 (usando um iterador) para um determinado filho.
`otThreadGetContextIdReuseDelay(otInstance *aInstance)`	`uint32_t` Receba o parâmetro CONTEXT_ID_REUSE_DELAY usado no papel de líder.
`otThreadGetJoinerUdpPort(otInstance *aInstance)`	`uint16_t` Recebe a porta UDP do Combinador.
`otThreadGetLocalLeaderWeight(otInstance *aInstance)`	`uint8_t` Recebe a ponderação de líder de linha de execução usada ao operar na função de líder.
`otThreadGetMaxAllowedChildren(otInstance *aInstance)`	`uint16_t` Recebe o número máximo de filhos permitidos no momento.
`otThreadGetMaxChildIpAddresses(otInstance *aInstance)`	`uint8_t` Recebe o número máximo de endereços IP que cada filho do MTD pode registrar com este dispositivo como pai.
`otThreadGetMaxRouterId(otInstance *aInstance)`	`uint8_t` A função retorna o ID máximo permitido do roteador.
`otThreadGetNetworkIdTimeout(otInstance *aInstance)`	`uint8_t` Acesse o parâmetro NETWORK_ID_TIMESTAMP usado no papel de roteador.
`otThreadGetNextCacheEntry(otInstance aInstance, otCacheEntryInfo aEntryInfo, otCacheEntryIterator *aIterator)`	`otError` Essa função recebe a próxima entrada do cache do EID (usando um iterador).
`otThreadGetNextHopAndPathCost(otInstance aInstance, uint16_t aDestRloc16, uint16_t aNextHopRloc16, uint8_t *aPathCost)`	`void` Essa função recebe o custo do próximo salto e caminho de um determinado destino RLOC16.
`otThreadGetParentPriority(otInstance *aInstance)`	`int8_t` Receba a prioridade pai atribuída.
`otThreadGetPreferredLeaderPartitionId(otInstance *aInstance)`	`uint32_t` Encontre o ID da partição de linha de execução preferencial usado ao operar na função Líder.
`otThreadGetPskc(otInstance aInstance, otPskc aPskc)`	`void` Acessa o PSKc da linha de execução.
`otThreadGetPskcRef(otInstance *aInstance)`	`otPskcRef` Receber a referência principal para a Thread PSKc armazenada.
`otThreadGetRouterDowngradeThreshold(otInstance *aInstance)`	`uint8_t` Acesse o parâmetro ROUTER_DOWNGRADE_THRESHOLD usado no papel de roteador.
`otThreadGetRouterIdRange(otInstance aInstance, uint8_t aMinRouterId, uint8_t *aMaxRouterId)`	`void` Essa função recebe o intervalo de IDs do roteador que podem ser atribuídos a nós na rede da linha de execução.
`otThreadGetRouterIdSequence(otInstance *aInstance)`	`uint8_t` Encontre a sequência de IDs 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 roteador de linha de execução.
`otThreadGetRouterSelectionJitter(otInstance *aInstance)`	`uint8_t` Acesse o parâmetro ROUTER_SELECTION_JITTER usado no papel REED/Router.
`otThreadGetRouterUpgradeThreshold(otInstance *aInstance)`	`uint8_t` Acesse o parâmetro ROUTER_UPGRADE_THRESHOLD usado no papel REED.
`otThreadIsRouterEligible(otInstance *aInstance)`	`bool` Esse método indica se o dispositivo está qualificado para o roteador.
`otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTableCallback aCallback)`	`void` Esta função registra uma função de callback da tabela vizinha.
`otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)`	`otError` Libere um ID do roteador alocado pelo dispositivo na função de líder.
`otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled)`	`void` Essa função define se o dispositivo foi comissionado usando o CCM.
`otThreadSetContextIdReuseDelay(otInstance *aInstance, uint32_t aDelay)`	`void` Defina o parâmetro CONTEXT_ID_REUSE_DELAY usado na função de líder.
`otThreadSetJoinerUdpPort(otInstance *aInstance, uint16_t aJoinerUdpPort)`	`otError` Define a porta UDP do Combinador.
`otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)`	`void` Define o peso da linha de execução usado na função de líder.
`otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)`	`otError` Define o número máximo de filhos permitido no momento.
`otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)`	`otError` Define ou restaura o número máximo de endereços IP que cada filho do MTD pode registrar com este dispositivo como pai.
`otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)`	`void` Defina o parâmetro NETWORK_ID_HOWMANY usado na função de líder.
`otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)`	`otError` Defina a prioridade mãe.
`otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)`	`void` Define o ID da partição de linha de execução preferencial 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` Define o Thread PSKc.
`otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)`	`otError` Define o Thread PSKc.
`otThreadSetRouterDowngradeThreshold(otInstance *aInstance, uint8_t aThreshold)`	`void` Defina o parâmetro ROUTER_DOWNGRADE_THRESHOLD usado na função de líder.
`otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)`	`otError` Essa função define se o dispositivo é ou não qualificado para o roteador.
`otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)`	`otError` Essa função define o intervalo de IDs do roteador que podem ser atribuídos a nós na rede da linha de execução.
`otThreadSetRouterSelectionJitter(otInstance *aInstance, uint8_t aRouterJitter)`	`void` Defina o parâmetro ROUTER_SELECTION_JITTER usado no papel REED/Router.
`otThreadSetRouterUpgradeThreshold(otInstance *aInstance, uint8_t aThreshold)`	`void` Defina o parâmetro ROUTER_UPGRADE_THRESHOLD usado na função de líder.
`otThreadSetSteeringData(otInstance aInstance, const otExtAddress aExtAddress)`	`void` Definir os dados de direção fora da banda.
`otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled)`	`void` Esta função define se o limite de versão do TLV da política de segurança para roteamento (campo RV) está ativado.

Estruturas
otCacheEntryInfo (link em inglês)	Essa estrutura representa uma entrada de cache do EID.
otCacheEntryIterator	Esse tipo representa um iterador usado para iterar pelas entradas da tabela de cache do EID.
OtChildInfo.	Essa estrutura contém informações de diagnóstico para um filho de linha de execução.
OtNeighborTableEntryInfo (em inglês)	Esse tipo representa uma informação de entrada da tabela vizinha (filho ou roteador) e é usado como um parâmetro no callback da tabela vizinha `otNeighborTableCallback`.

Enumerações

OtCacheEntryState

 otCacheEntryState

Esta enumeração define o estado de entrada do cache de EID.

OtNeighborTableEvent

 otNeighborTableEvent

Esta enumeração define as constantes usadas na otNeighborTableCallback para indicar mudanças na tabela vizinha.

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

Informações de Entrada

struct otCacheEntryInfo otCacheEntryInfo

Essa estrutura representa uma entrada de cache do EID.

OtCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

Esse tipo representa um iterador usado para iterar pelas entradas da tabela de cache do EID.

Para inicializar o iterador e começar da primeira entrada na tabela de cache, defina todos os campos na estrutura como zero (por exemplo, memset o iterador para zero).

OtCacheEntryState

enum otCacheEntryState otCacheEntryState

Esta enumeração define o estado de entrada do cache de EID.

OtChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

Usado para iterar endereços IPv6 de uma entrada filha Thread.

OtNeighborTableCallback

void(* otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)

Esse ponteiro de função é chamado para notificar que há uma mudança na tabela vizinha.

Detalhes

Parâmetros

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

Funções

Conversão de leads

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 do OpenThread.

Retornar valores

`OT_ERROR_NONE`	Tornou-se um líder e iniciou uma nova partição.
`OT_ERROR_INVALID_STATE`	A linha de execução está desativada.

OtThread tornando-se

otError otThreadBecomeRouter(
  otInstance *aInstance
)

Tente se tornar um roteador.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retornar valores

`OT_ERROR_NONE`	A tentativa de se tornar um roteador foi iniciada.
`OT_ERROR_INVALID_STATE`	A linha de execução está desativada.

ThreadGetChildInfoById

otError otThreadGetChildInfoById(
  otInstance *aInstance,
  uint16_t aChildId,
  otChildInfo *aChildInfo
)

Recebe informações de diagnóstico de um filho anexado pelo ID ou RLOC16.

Detalhes

Parâmetros

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

Retornar valores

`OT_ERROR_NONE`	`aChildInfo` foi atualizado com as informações do ID fornecido.
`OT_ERROR_NOT_FOUND`	Nenhum filho válido com este ID filho.
`OT_ERROR_INVALID_ARGS`	Se `aChildInfo` for NULL.

ThreadGetChildInfoByIndex

otError otThreadGetChildInfoByIndex(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildInfo *aChildInfo
)

A função retém informações de diagnóstico de um filho anexado pelo índice interno da tabela.

Detalhes

Parâmetros

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

Retornar valores

`OT_ERROR_NONE`	`aChildInfo` foi atualizado com as informações do índice especificado.
`OT_ERROR_NOT_FOUND`	Não há filho válido neste índice.
`OT_ERROR_INVALID_ARGS`	`aChildInfo` é NULL ou `aChildIndex` está fora do intervalo (maior que o índice máximo da tabela).

Consulte também:
otGetMaxAllowedChildren

Endereço otThreadGetChildNextIp6

otError otThreadGetChildNextIp6Address(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildIp6AddressIterator *aIterator,
  otIp6Address *aAddress
)

Essa função recebe o próximo endereço IPv6 (usando um iterador) para um determinado filho.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância do OpenThread.
`[in] aChildIndex`	O índice filho.
`[in,out] aIterator`	Um ponteiro para o iterador. Se for bem-sucedido, 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 em que o próximo endereço do filho é colocado (sucesso).

Retornar valores

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

Consulte também:
otThreadGetChildInfoByIndex

OtThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

Receba o parâmetro CONTEXT_ID_REUSE_DELAY usado no papel de líder.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retorna

O valor CONTEXT_ID_REUSE_DELAY.

Consulte também:
otThreadSetContextIdReuseDelay

PortaOThreadDeParticipar

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

Recebe a porta UDP do Combinador.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retorna

O número da porta UDP do Combinador.

Consulte também:
otThreadSetJoinerUdpPort

OtThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

Recebe a ponderação de líder de linha de execução usada ao operar na função de líder.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retorna

O valor de peso do líder da linha de execução.

Consulte também:
otThreadSetLeaderWeight

OtThreadGetMaxAllowedChildren

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

Recebe o número máximo de filhos permitidos no momento.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retorna

O número máximo de filhos permitido no momento.

Consulte também:
otThreadSetMaxAllowedChildren

OtThreadGetMaxChildIpAddresses

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

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

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retorna

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

Consulte também:
otThreadSetMaxChildIpAddresses

OtThreadGetMaxRouterId

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

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

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retorna

O ID do roteador máximo permitido.

ThreadThreadNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

Acesse o parâmetro NETWORK_ID_TIMESTAMP usado no papel de roteador.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retorna

O valor NETWORK_ID_EXPECTED.

Consulte também:
otThreadSetNetworkIdTimeout

OtThreadGetNextCacheEntry

otError otThreadGetNextCacheEntry(
  otInstance *aInstance,
  otCacheEntryInfo *aEntryInfo,
  otCacheEntryIterator *aIterator
)

Essa função recebe a próxima entrada do cache do EID (usando um iterador).

Detalhes

Parâmetros

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

Retornar valores

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

Custo da próxima chamada de rota

void otThreadGetNextHopAndPathCost(
  otInstance *aInstance,
  uint16_t aDestRloc16,
  uint16_t *aNextHopRloc16,
  uint8_t *aPathCost
)

Essa função recebe o custo do próximo salto e caminho de um determinado destino RLOC16.

Essa função pode ser usada com aNextHopRloc16 ou aPathCost como NULL, indicando que o autor da chamada não quer receber o valor.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância do OpenThread.
`[in] aDesRloct16`	O RLOC16 do destino.
`[out] aNextHopRloc16`	Um ponteiro para retornar RLOC16 do próximo salto, 0xfffe se não houver próximo salto.
`[out] aPathCost`	Um ponteiro para retornar o custo do caminho para o destino.

Linha de execução mãe

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

Receba a prioridade pai atribuída.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retorna

O valor de prioridade pai atribuído -2 significa que não há atribuição.

Consulte também:
otThreadSetParentPriority

OtThreadGetpreferredLeaderPartitionId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

Encontre o ID da partição de linha de execução preferencial usado ao operar na função Líder.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retorna

O valor do ID da partição da linha de execução do líder.

ThreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

Acessa o PSKc da linha de execução.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância do OpenThread.
`[out] aPskc`	Um ponteiro para um `otPskc` para retornar a PSK Thread recuperada.

Consulte também:
otThreadSetPskc

Linha de execução otThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

Receber a referência principal para a Thread PSKc armazenada.

Essa função exige que o recurso de tempo de compilação OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE esteja ativado.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retorna

Referência importante do PSKc

Consulte também:
otThreadSetPskcRef

OtThreadGetRouterDowngradeThreshold

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

Acesse o parâmetro ROUTER_DOWNGRADE_THRESHOLD usado no papel de roteador.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retorna

O valor ROUTER_DOWNGRADE_THRESHOLD.

Consulte também:
otThreadSetRouterDowngradeThreshold

OtThreadGetRouterIdRange

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

Essa função recebe o intervalo de IDs do roteador que podem ser atribuídos a nós na rede da linha de execução.

Observação:essa API exige OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE e é usada apenas para fins de teste. Todos os IDs de roteadores no intervalo [aMinRouterId, aMaxRouterId] são permitidos.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância do OpenThread.
`[out] aMinRouterId`	O ID mínimo do roteador.
`[out] aMaxRouterId`	O ID do roteador máximo.

Consulte também:
otThreadSetRouterIdRange

Sequência de caracteres da rota de acesso à rota

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

Encontre a sequência de IDs do roteador atual.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retorna

A sequência do ID do roteador.

Linha de execução otThreadGet

otError otThreadGetRouterInfo(
  otInstance *aInstance,
  uint16_t aRouterId,
  otRouterInfo *aRouterInfo
)

A função retém informações de diagnóstico para um determinado roteador de linha de execução.

Detalhes

Parâmetros

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

Retornar valores

`OT_ERROR_NONE`	As informações do roteador foram recuperadas 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
)

Acesse o parâmetro ROUTER_SELECTION_JITTER usado no papel REED/Router.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retorna

O valor ROUTER_SELECTION_JITTER.

Consulte também:
otThreadSetRouterSelectionJitter

OtThreadGetRouterUpgradeThreshold

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

Acesse o parâmetro ROUTER_UPGRADE_THRESHOLD usado no papel REED.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retorna

O valor ROUTER_UPGRADE_THRESHOLD.

Consulte também:
otThreadSetRouterUpgradeThreshold

otThreadIsRouterQualificada

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

Esse método indica se o dispositivo está qualificado para o roteador.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retornar valores

`TRUE`	Se o dispositivo for qualificado para roteador.
`FALSE`	Se o dispositivo não for qualificado para roteador.

OtThreadRegisterNeighborTableCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

Esta função registra uma função de callback da tabela vizinha.

O callback fornecido (se não NULL) será invocado quando houver uma alteração na tabela vizinha (por exemplo, uma entrada filha ou uma entrada vizinha do roteador está sendo adicionada/removida ou um modo filho existente é alterado).

As chamadas subsequentes para esse método vão substituir o callback anterior. Observe que esse callback é invocado enquanto a tabela do vizinho/filho está sendo atualizada e sempre antes do otStateChangedCallback.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância do OpenThread.
`[in] aCallback`	Um ponteiro para a função do gerenciador de callback.

OtThreadReleaseRouterId

otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Libere um ID do roteador alocado pelo dispositivo na função de líder.

Detalhes

Parâmetros

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

Retornar valores

`OT_ERROR_NONE`	O ID do roteador foi liberado.
`OT_ERROR_INVALID_ARGS`	`aRouterId` não está no intervalo [0, 62].
`OT_ERROR_INVALID_STATE`	No momento, o dispositivo não está operando como um líder.
`OT_ERROR_NOT_FOUND`	O ID do roteador não está alocado no momento.

OtThreadSetCcmEnabled

void otThreadSetCcmEnabled(
  otInstance *aInstance,
  bool aEnabled
)

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

Observação:essa API exige OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE e é usada apenas pelo Thread Test Harness para indicar se esse dispositivo foi encomendado usando o CCM.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância do OpenThread.
`[in] aEnabled`	Verdadeiro se o dispositivo tiver sido encomendado usando o CCM. Caso contrário, FALSO.

OtThreadSetContextIdReuseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

Defina o parâmetro CONTEXT_ID_REUSE_DELAY usado na função de líder.

Detalhes

Parâmetros

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

Consulte também:
otThreadGetContextIdReuseDelay

ThreadSetJoinerUdpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

Define a porta UDP do Combinador.

Detalhes

Parâmetros

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

Retornar valores

OT_ERROR_NONE

A porta UDP do Combinador foi definida.

Consulte também:
otThreadGetJoinerUdpPort

OtThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

Define o peso da linha de execução usado na função de líder.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância do OpenThread.
`[in] aWeight`	O valor de peso do líder da linha de execução.

Consulte também:
otThreadGetLeaderWeight

ThreadSetMaxAllowedChildren

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

Define o número máximo de filhos permitido no momento.

Esse parâmetro só pode ser definido quando a operação do protocolo da linha de execução for interrompida.

Detalhes

Parâmetros

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

Retornar valores

`OT_ERROR_NONE`	O número máximo de conversões definido
`OT_ERROR_INVALID_ARGS`	Se `aMaxChildren` não estiver no intervalo [1, OPENOUTPUT_CONFIG_MLE_MAX_CHILDREN].
`OT_ERROR_INVALID_STATE`	Se a linha de execução não estiver parada.

Consulte também:
otThreadGetMaxAllowedChildren

OtThreadSetMaxChildIpAddresses

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

Define ou restaura o número máximo de endereços IP que cada filho do MTD pode registrar com este dispositivo como pai.

Transmita 0 para limpar a configuração e restaurar o padrão.

Disponível quando o OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está ativado.

Detalhes

Parâmetros

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

Retornar valores

`OT_ERROR_NONE`	O número foi definido/limpado.
`OT_ERROR_INVALID_ARGS`	Se exceder o número máximo permitido.

Veja também:
otThreadGetMaxChildIpAddresses

ThreadSetNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

Defina o parâmetro NETWORK_ID_HOWMANY usado na função de líder.

Detalhes

Parâmetros

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

Consulte também:
otThreadGetNetworkIdTimeout

Linha de execução de conjunto de conversas

otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

Defina a prioridade mãe.

Detalhes

Parâmetros

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

Retornar valores

`OT_ERROR_NONE`	A prioridade mãe foi definida.
`OT_ERROR_INVALID_ARGS`	Se o valor de prioridade pai não estiver entre 1, 0, -1 e -2.

Consulte também:
otThreadGetParentPriority

ID da conversão

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

Define o ID da partição de linha de execução preferencial usado ao operar na função Líder.

Detalhes

Parâmetros

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

ThreadSetPreferRouterId.

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Defina o ID do roteador preferido.

Ao se tornar um roteador/líder, o nó tenta usar esse ID do roteador. Se o ID preferido do roteador não for definido ou não puder ser usado, um ID gerado automaticamente será escolhido. Esta propriedade só pode ser definida quando o papel do dispositivo é removido ou desativado.

Detalhes

Parâmetros

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

Retornar valores

`OT_ERROR_NONE`	O ID do roteador preferido foi definido.
`OT_ERROR_INVALID_STATE`	Não foi possível definir (a função não está separada ou desativada)

ThreadSetPskc

otError otThreadSetPskc(
  otInstance *aInstance,
  const otPskc *aPskc
)

Define o Thread PSKc.

Essa função só vai funcionar quando os protocolos Thread estiverem desativados. Uma chamada bem-sucedida para essa 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 do OpenThread.
`[in] aPskc`	Um ponteiro para o novo Thread PSKc.

Retornar valores

`OT_ERROR_NONE`	A Thread PSKc foi configurada.
`OT_ERROR_INVALID_STATE`	Os protocolos da linha de execução estão ativados.

Consulte também:
otThreadGetPskc

ThreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

Define o Thread PSKc.

Essa função exige que o recurso de tempo de compilação OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE esteja ativado.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância do OpenThread.
`[in] aKeyRef`	Referência da chave para a nova Thread PSKc.

Retornar valores

`OT_ERROR_NONE`	A Thread PSKc foi configurada.
`OT_ERROR_INVALID_STATE`	Os protocolos da linha de execução estão ativados.

Consulte também:
otThreadGetPskcRef

OtThreadSetRouterDowngradeThreshold

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

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

Detalhes

Parâmetros

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

Consulte também:
otThreadGetRouterDowngradeThreshold

otThreadSetRouterEligible

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

Essa função define se o dispositivo é ou não qualificado para o roteador.

Se aEligible for falsa e o dispositivo estiver operando como roteador, essa chamada vai desconectar o dispositivo e tentar se reconectar como uma criança.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância do OpenThread.
`[in] aEligible`	Verdadeiro para configurar o dispositivo como qualificado para roteador. Caso contrário, FALSO.

Retornar valores

`OT_ERROR_NONE`	A configuração qualificada para o roteador foi definida.
`OT_ERROR_NOT_CAPABLE`	O dispositivo não é capaz de se tornar um roteador.

ThreadSetRouterIdRange.

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

Essa função define o intervalo de IDs do roteador que podem ser atribuídos a nós na rede da linha de execução.

Observação: essa API exige OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE e é usada apenas para fins de teste. Todos os IDs de roteadores no intervalo [aMinRouterId, aMaxRouterId] são permitidos.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância do OpenThread.
`[in] aMinRouterId`	O ID mínimo do roteador.
`[in] aMaxRouterId`	O ID do roteador máximo.

Retornar valores

`OT_ERROR_NONE`	O intervalo foi definido.
`OT_ERROR_INVALID_ARGS`	aMinRouterId > aMaxRouterId, ou o intervalo não será coberto por [0, 62].

Consulte também:
otThreadGetRouterIdRange

OtThreadSetRouterSelectionJitter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

Defina o parâmetro ROUTER_SELECTION_JITTER usado no papel REED/Router.

Detalhes

Parâmetros

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

Consulte também:
otThreadGetRouterSelectionJitter

OtThreadSetRouterUpgradeThreshold

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Defina o parâmetro ROUTER_UPGRADE_THRESHOLD usado na função de líder.

Detalhes

Parâmetros

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

Consulte também:
otThreadGetRouterUpgradeThreshold

Dados do tópico

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

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

A opção de configuração OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE precisa ser definida para permitir a definição de dados de direcionamento fora da banda.

Detalhes

Parâmetros

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

ThreadSetThreadVersionCheckEnabled

void otThreadSetThreadVersionCheckEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Esta função define se o limite de versão do TLV da política de segurança para roteamento (campo RV) está ativado.

Observação: essa API exige OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE e é usada apenas pelo arcabouço de testes de linhas de execução para indicar que a RV de verificação de versão do protocolo de linha de execução precisa ser ignorada.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância do OpenThread.
`[in] aEnabled`	Verdadeiro para ativar o limite de versão de TLV da política de segurança para roteamento. Caso contrário, FALSO.

Macros

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

Inicializador de otChildIP6AddressIterator.

Recursos

Os tópicos de referência da API OpenThread são provenientes do código-fonte, disponível no GitHub. Para mais informações ou para contribuir com nossa documentação, consulte Recursos.

Roteador/líder

Resumo

Enumerações

Typedefs

Funções

Estruturas

Enumerações

OtCacheEntryState

OtNeighborTableEvent

Typedefs

Informações de Entrada

OtCacheEntryIterator

OtCacheEntryState

OtChildIp6AddressIterator

OtNeighborTableCallback

Funções

Conversão de leads

OtThread tornando-se

ThreadGetChildInfoById

ThreadGetChildInfoByIndex

Endereço otThreadGetChildNextIp6

OtThreadGetContextIdReuseDelay

PortaOThreadDeParticipar

OtThreadGetLocalLeaderWeight

OtThreadGetMaxAllowedChildren

OtThreadGetMaxChildIpAddresses

OtThreadGetMaxRouterId

ThreadThreadNetworkIdTimeout

OtThreadGetNextCacheEntry

Custo da próxima chamada de rota

Linha de execução mãe

OtThreadGetpreferredLeaderPartitionId

ThreadGetPskc

Linha de execução otThreadGetPskcRef

OtThreadGetRouterDowngradeThreshold

OtThreadGetRouterIdRange

Sequência de caracteres da rota de acesso à rota

Linha de execução otThreadGet

OtThreadGetRouterSelectionJitter

OtThreadGetRouterUpgradeThreshold

otThreadIsRouterQualificada

OtThreadRegisterNeighborTableCallback

OtThreadReleaseRouterId

OtThreadSetCcmEnabled

OtThreadSetContextIdReuseDelay

ThreadSetJoinerUdpPort

OtThreadSetLocalLeaderWeight

ThreadSetMaxAllowedChildren

OtThreadSetMaxChildIpAddresses

ThreadSetNetworkIdTimeout

Linha de execução de conjunto de conversas

ID da conversão

ThreadSetPreferRouterId.

ThreadSetPskc

ThreadSetPskcRef

OtThreadSetRouterDowngradeThreshold

otThreadSetRouterEligible

ThreadSetRouterIdRange.

OtThreadSetRouterSelectionJitter

OtThreadSetRouterUpgradeThreshold

Dados do tópico

ThreadSetThreadVersionCheckEnabled

Macros

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

Recursos