Esta página foi traduzida pela API Cloud Translation.

Roteador/lead

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

Resumo

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

Typedefs
`otCacheEntryInfo`	typedef `struct otCacheEntryInfo` Essa estrutura representa uma entrada do cache de EID.
`otCacheEntryIterator`	typedef `struct otCacheEntryIterator` Esse tipo representa um iterador usado para iterar as entradas da tabela de cache do EID.
`otCacheEntryState`	typedef `enum otCacheEntryState` Essa enumeração define o estado da entrada do cache do 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` Seja um líder e inicie uma 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 filho ou RLOC16.
`otThreadGetChildInfoByIndex(otInstance aInstance, uint16_t aChildIndex, otChildInfo aChildInfo)`	`otError` A função retém as informações de diagnóstico de um filho anexado pelo índice da tabela interna.
`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 na função de líder.
`otThreadGetJoinerUdpPort(otInstance *aInstance)`	`uint16_t` Consiga a porta UDP do Combinador.
`otThreadGetLocalLeaderWeight(otInstance *aInstance)`	`uint8_t` Peso de líder de linha de execução usado na operação do papel 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 do roteador máximo permitido.
`otThreadGetNetworkIdTimeout(otInstance *aInstance)`	`uint8_t` Receba o parâmetro NETWORK_ID_THRESHOLD usado no papel do roteador.
`otThreadGetNextCacheEntry(otInstance aInstance, otCacheEntryInfo aEntryInfo, otCacheEntryIterator *aIterator)`	`otError` Essa função recebe a próxima entrada do cache de EID (usando um iterador).
`otThreadGetParentPriority(otInstance *aInstance)`	`int8_t` Recebe a prioridade mãe atribuída.
`otThreadGetPreferredLeaderPartitionId(otInstance *aInstance)`	`uint32_t` Receba o código da partição de líder de linha de execução preferencial usado ao operar na função de líder.
`otThreadGetPskc(otInstance aInstance, otPskc aPskc)`	`void` Receba o Thread PSKc.
`otThreadGetPskcRef(otInstance *aInstance)`	`otPskcRef` Receba uma referência importante à Thread PSKc armazenada.
`otThreadGetRouterDowngradeThreshold(otInstance *aInstance)`	`uint8_t` Acesse o parâmetro ROUTER_DOWNGRADE_THRESHOLD usado no papel do 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 dentro da rede de linhas de execução.
`otThreadGetRouterIdSequence(otInstance *aInstance)`	`uint8_t` Veja a sequência atual de IDs do roteador.
`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` Obtenha o parâmetro ROUTER_SELECTION_JITTER usado no papel de 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 uso do roteador.
`otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTableCallback aCallback)`	`void` Ela registra uma função de callback de tabela vizinha.
`otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)`	`otError` Libere um ID do roteador que foi alocado pelo dispositivo na função "Líder".
`otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled)`	`void` Esta função define se o dispositivo foi encomendado pelo 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` Defina a porta UDP do Combinador.
`otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)`	`void` Define a ponderação do líder de linha de execução usada ao operar na função Líder.
`otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)`	`otError` Define o número máximo de crianças permitidas 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_ENTRY 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` Defina o ID da partição de líder 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` Defina o PSKc da linha de execução.
`otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)`	`otError` Defina o PSKc da linha de execução.
`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` Esta 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 dentro da rede de linhas de execução.
`otThreadSetRouterSelectionJitter(otInstance *aInstance, uint8_t aRouterJitter)`	`void` Defina o parâmetro ROUTER_SELECTION_JITTER usado no papel de REED/Router.
`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` Desativar dados de direcionamento da banda.
`otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled)`	`void` Esta função define se o limite de versão de TLV da política de segurança para roteamento (campo de RV) está ativado.

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

Enumerações

OtCacheEntryState

 otCacheEntryState

Essa enumeração define o estado da entrada do cache do EID.

OtNeighborTableEvent

 otNeighborTableEvent

Essa enumeração define as constantes usadas em 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`	Um modo de 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

Essa estrutura representa uma entrada do cache de EID.

OtCacheEntryJUnit

struct otCacheEntryIterator otCacheEntryIterator

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

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

OtCacheEntryState

enum otCacheEntryState otCacheEntryState

Essa enumeração define o estado da entrada do cache do 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

OtThreadTorne-se líder

otError otThreadBecomeLeader(
  otInstance *aInstance
)

Seja um líder e inicie uma partição.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Valores de retorno

`OT_ERROR_NONE`	Ele se tornou líder e iniciou uma nova partição.
`OT_ERROR_INVALID_STATE`	A conversa está desativada.

OtThreadTorneRouter

otError otThreadBecomeRouter(
  otInstance *aInstance
)

Tente se tornar um roteador.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Valores de retorno

`OT_ERROR_NONE`	A tentativa de se tornar um roteador foi iniciada.
`OT_ERROR_INVALID_STATE`	A conversa está desativada.

OtThreadGetChildInfoById

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

Recebe informações de diagnóstico de um filho anexado pelo ID filho 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 onde as informações filhas são colocadas.

Valores de retorno

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

OtThreadGetChildInfoByIndex

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

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

Detalhes

Parâmetros

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

Valores de retorno

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

Veja 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. 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 em que o próximo endereço do filho é colocado (em sucesso).

Valores de retorno

`OT_ERROR_NONE`	O próximo endereço IPv6 foi encontrado (`aAddress` foi atualizado).
`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 o filho em `aChildIndex` não é válido.

Veja também:
otThreadGetChildInfoByIndex

OtThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

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

Retorna

O valor CONTEXT_ID_REUSE_DELAY.

Veja também:
otThreadSetContextIdReuseDelay

Conversão de entrada na sequência do otThread

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

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

Veja também:
otThreadSetJoinerUdpPort

OtThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

Peso de líder de linha de execução usado na operação do papel 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.

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

Veja 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

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

Veja também:
otThreadSetMaxChildIpAddresses

OtThreadGetMaxRouterId

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

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

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retorna

O ID do roteador máximo permitido.

OtThreadGetNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

Receba o parâmetro NETWORK_ID_THRESHOLD usado no papel do roteador.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retorna

O valor NETWORK_ID_THRESHOLD.

Veja também:
otThreadSetNetworkIdTimeout

OtThreadGetNextCacheEntry

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

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

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância do OpenThread.
`[out] aEntryInfo`	Um ponteiro para onde as informações de entrada do cache de EID são colocadas.
`[in,out] aIterator`	Um ponteiro para um iterador. Ela será atualizada para apontar para a próxima entrada no sucesso. Para conseguir a primeira entrada, inicialize o iterador definindo todos os campos como zero (por exemplo, `memset` é a estrutura do iterador a zero.

Valores de retorno

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

OtThreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

Recebe a prioridade mãe 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 foi atribuído.

Veja também:
otThreadSetParentPriority

OtThreadGetPreferLeaderPartitionId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

Receba o código da partição de líder de linha de execução preferencial usado ao operar na função de líder.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retorna

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

OtThreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

Receba o Thread PSKc.

Detalhes

Parâmetros

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

Veja também:
otThreadSetPskc

OtThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

Receba uma referência importante à Thread PSKc armazenada.

Essa função requer 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

Principais referências do PSKc

Veja também:
otThreadSetPskcRef

OtThreadGetRouterDowngradeThreshold

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

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

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retorna

O valor ROUTER_DOWNGRADE_THRESHOLD.

Veja 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 dentro da rede de linhas de execução.

Observação: essa API requer 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 máximo do roteador.

Veja também:
otThreadSetRouterIdRange

OtThreadGetRouterIdSequence

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

Veja a sequência atual de IDs do roteador.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retorna

A sequência de IDs 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 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 onde as informações do roteador são colocadas.

Valores de retorno

`OT_ERROR_NONE`	As informações do roteador foram recuperadas para o ID fornecido.
`OT_ERROR_NOT_FOUND`	Não há uma entrada de roteador com o ID fornecido.
`OT_ERROR_INVALID_ARGS`	`aRouterInfo` é NULO.

OtThreadGetRouterSelectionJitter

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

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

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retorna

O valor ROUTER_SELECTION_JITTER

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

Veja também:
otThreadSetRouterUpgradeThreshold

OtThreadIsRouterEligible

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

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

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Valores de retorno

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

OtThreadRegisterNeighborTableCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

Ela registra uma função de callback de tabela vizinha.

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

Chamadas subsequentes para esse método substituirão o callback anterior. Observe que esse callback é invocado enquanto a tabela de 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 de gerenciador de callback.

OtThreadReleaseRouterId

otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Libere um ID do roteador que foi alocado pelo dispositivo na função "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].

Valores de retorno

`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 líder.
`OT_ERROR_NOT_FOUND`	O ID do roteador não está alocado no momento.

OtThreadSetCcmEnabled

void otThreadSetCcmEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Esta função define se o dispositivo foi encomendado pelo CCM.

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

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância do OpenThread.
`[in] aEnabled`	Verdadeiro se o dispositivo tiver sido comissionado 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.

Veja também:
otThreadGetContextIdReuseDelay

PortaSetSetJoinerUdpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

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

Valores de retorno

OT_ERROR_NONE

A porta UDP do combinador foi definida.

Veja também:
otThreadGetJoinerUdpPort

OtThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

Define a ponderação do líder de linha de execução usada ao operar na função 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.

Veja também:
otThreadGetLeaderWeight

OtThreadSetMaxAllowedChildren

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

Define o número máximo de crianças permitidas no momento.

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

Detalhes

Parâmetros

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

Valores de retorno

`OT_ERROR_NONE`	O lance máximo foi definido
`OT_ERROR_INVALID_ARGS`	Se `aMaxChildren` não estiver no intervalo [1, OPENThread_CONFIG_MLE_MAX_CHILDREN].
`OT_ERROR_INVALID_STATE`	Se a linha de execução não estiver interrompida.

Veja 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 estiver ativado.

Detalhes

Parâmetros

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

Valores de retorno

`OT_ERROR_NONE`	O número foi definido/liberado.
`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_ENTRY 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_THRESHOLD.

Veja também:
otThreadGetNetworkIdTimeout

OtThreadSetParentPriority

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 da prioridade pai.

Valores de retorno

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

Veja também:
otThreadGetParentPriority

OtThreadSetPreferLeaderPartitionId

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

Defina o ID da partição de líder 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 do líder de linhas de execução.

OtThreadSetPreferRouterId

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 estiver definido ou não for possível usar, um ID do roteador gerado aleatoriamente 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.

Valores de retorno

`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)

OtThreadSetPskc

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

Defina o PSKc da linha de execução.

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 SK PSKc.

Valores de retorno

`OT_ERROR_NONE`	O Thread PSKc foi configurado.
`OT_ERROR_INVALID_STATE`	Os protocolos de linha de execução estão ativados.

Veja também:
otThreadGetPskc

OtThreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

Defina o PSKc da linha de execução.

Essa função requer 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 ao novo Thread PSKc.

Valores de retorno

`OT_ERROR_NONE`	O Thread PSKc foi configurado.
`OT_ERROR_INVALID_STATE`	Os protocolos de linha de execução 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 de líder.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância do 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 é ou não qualificado para o roteador.

Se a aEligible for falsa e o dispositivo estiver operando como roteador, essa chamada fará com que o dispositivo seja desconectado e tente 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.

Valores de retorno

`OT_ERROR_NONE`	A configuração qualificada para o roteador foi definida.
`OT_ERROR_NOT_CAPABLE`	O dispositivo não pode se tornar roteador.

OtThreadSetRouterIdRange

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 dentro da rede de linhas de execução.

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 máximo do roteador.

Valores de retorno

`OT_ERROR_NONE`	O intervalo foi definido.
`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 no papel de REED/Router.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância do 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 do OpenThread.
`[in] aThreshold`	O valor ROUTER_UPGRADE_THRESHOLD.

Veja também:
otThreadGetRouterUpgradeThreshold

OtThreadSetSteeringData

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

Desativar dados de direcionamento da banda.

A opção de configuração OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE precisa ser definida para permitir a configuração de direcionamento de dados 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 do volante. Todos os zeros para limpar os dados de direção (sem dados de direção). Todos os 0xFFs para definir o filtro de dados de direção/bloom e aceitar/permitir todos. Um EUI64 específico que é adicionado ao filtro de dados de direção/bloom atual.

OtThreadSetThreadVersionCheckEnabled

void otThreadSetThreadVersionCheckEnabled(
  otInstance *aInstance,
  bool aEnabled
)

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

Observação: essa API exige OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE e é usada apenas pelo Thread Test Harness para indicar que a RV de verificação da 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ões 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 saber mais ou contribuir com nossa documentação, consulte Recursos.

Roteador/lead

Resumo

Enumerações

Typedefs

Funções

Estruturas

Enumerações

OtCacheEntryState

OtNeighborTableEvent

Typedefs

OtCacheEntryInfo

OtCacheEntryJUnit

OtCacheEntryState

OtChildIp6AddressIterator

OtNeighborTableCallback

Funções

OtThreadTorne-se líder

OtThreadTorneRouter

OtThreadGetChildInfoById

OtThreadGetChildInfoByIndex

Endereço otThreadGetChildNextIp6

OtThreadGetContextIdReuseDelay

Conversão de entrada na sequência do otThread

OtThreadGetLocalLeaderWeight

OtThreadGetMaxAllowedChildren

OtThreadGetMaxChildIpAddresses

OtThreadGetMaxRouterId

OtThreadGetNetworkIdTimeout

OtThreadGetNextCacheEntry

OtThreadGetParentPriority

OtThreadGetPreferLeaderPartitionId

OtThreadGetPskc

OtThreadGetPskcRef

OtThreadGetRouterDowngradeThreshold

OtThreadGetRouterIdRange

OtThreadGetRouterIdSequence

OtThreadGetRouterInfo

OtThreadGetRouterSelectionJitter

OtThreadGetRouterUpgradeThreshold

OtThreadIsRouterEligible

OtThreadRegisterNeighborTableCallback

OtThreadReleaseRouterId

OtThreadSetCcmEnabled

OtThreadSetContextIdReuseDelay

PortaSetSetJoinerUdpPort

OtThreadSetLocalLeaderWeight

OtThreadSetMaxAllowedChildren

OtThreadSetMaxChildIpAddresses

OtThreadSetNetworkIdTimeout

OtThreadSetParentPriority

OtThreadSetPreferLeaderPartitionId

OtThreadSetPreferRouterId

OtThreadSetPskc

OtThreadSetPskcRef

OtThreadSetRouterDowngradeThreshold

OtThreadSetRouterEligible

OtThreadSetRouterIdRange

OtThreadSetRouterSelectionJitter

OtThreadSetRouterUpgradeThreshold

OtThreadSetSteeringData

OtThreadSetThreadVersionCheckEnabled

Macros

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

Recursos