O Google tem o compromisso de promover a igualdade racial para as comunidades negras. Saiba como.

Roteador/líder

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 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
Essa enumeração define as constantes usadas na otNeighborTableCallback para indicar mudanças na tabela vizinha.

Typedefs

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

Functions

otThreadBecomeLeader(otInstance *aInstance)
Torne-se um líder e inicie uma nova partição.
otThreadBecomeRouter(otInstance *aInstance)
Tente se tornar um roteador.
otThreadGetChildInfoById(otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
A função retém informações de diagnóstico de um filho anexado pelo ID filho ou RLOC16.
otThreadGetChildInfoByIndex(otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
A função retém informações de diagnóstico de um filho anexado pelo índice da tabela interna.
otThreadGetChildNextIp6Address(otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
Essa função recebe o próximo endereço IPv6 (usando um iteração) 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 Joiner.
otThreadGetLocalLeaderWeight(otInstance *aInstance)
uint8_t
Receba a ponderação de líder da conversa usada na função de líder.
otThreadGetMaxAllowedChildren(otInstance *aInstance)
uint16_t
Saiba o número máximo de crianças permitidas atualmente.
otThreadGetMaxChildIpAddresses(otInstance *aInstance)
uint8_t
Essa função recebe o número máximo de endereços IP que cada filho de 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_REFUND usado no papel do roteador.
otThreadGetNextCacheEntry(otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)
Essa função recebe a próxima entrada do cache de EID (usando um iteração).
otThreadGetParentPriority(otInstance *aInstance)
int8_t
Recebe a prioridade mãe atribuída.
otThreadGetPreferredLeaderPartitionId(otInstance *aInstance)
uint32_t
Indica o ID 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)
Receber referência de chave ao Thread PSKc armazenada.
otThreadGetRouterDowngradeThreshold(otInstance *aInstance)
uint8_t
Receba 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 aos nós na rede.
otThreadGetRouterIdSequence(otInstance *aInstance)
uint8_t
Veja a sequência atual de códigos do roteador.
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.
otThreadGetRouterSelectionJitter(otInstance *aInstance)
uint8_t
Acesse o parâmetro ROUTER_SELECTION_JITTER usado no papel de REED/Router.
otThreadGetRouterUpgradeThreshold(otInstance *aInstance)
uint8_t
Encontre o parâmetro ROUTER_UPGRADE_THRESHOLD usado no papel REED.
otThreadIsRouterEligible(otInstance *aInstance)
bool
Esse método indica se o dispositivo está qualificado para usar o roteador.
otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTableCallback aCallback)
void
Essa função registra uma função de callback da tabela vizinha.
otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)
Libere um código do 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 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)
Defina a porta UDP do Joiner.
otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)
void
Defina a ponderação de líder da linha de execução usada na função de líder.
otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)
Defina o número máximo de crianças permitidas atualmente.
otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)
Esta função define/restaura o número máximo de endereços IP que cada filho de MTD pode registrar com este dispositivo como pai.
otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)
void
Defina o parâmetro NETWORK_ID_REFUND usado no papel de líder.
otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)
Defina a prioridade pai.
otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)
void
Define o ID da partição preferencial da linha de execução usada na função de líder.
otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)
Defina o ID do roteador preferido.
otThreadSetPskc(otInstance *aInstance, const otPskc *aPskc)
Define o Thread PSKc.
otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)
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)
Esta função define se o dispositivo está ou não qualificado para roteador.
otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)
Essa função define o intervalo de IDs de roteadores que podem ser atribuídos aos nós na rede.
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 de líder.
otThreadSetSteeringData(otInstance *aInstance, const otExtAddress *aExtAddress)
void
O direcionamento de dados está fora de banda.
otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled)
void
Esta função define se o limite de versões TLV da política de segurança para roteamento (campo de RV) está ativado.

Estruturas

otCacheEntryInfo (em inglês)

Essa estrutura representa uma entrada de cache EID.

otCacheEntryiter.

Esse tipo representa um iteração usado para iterar as entradas da tabela de cache de EID.

otChildInfo (em inglês)

Essa estrutura contém informações de diagnóstico para um Thread Child.

otNeighborTableEntryInfo (em inglês)

Esse tipo representa uma informação da entrada da tabela vizinha (filho ou roteador) e é usado como um parâmetro no callback da tabela vizinha otNeighborTableCallback.

Enumerações

OtCacheEntryState

 otCacheEntryState

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

OtNeighborTableEvent

 otNeighborTableEvent

Essa 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 um filho 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 de cache EID.

OtCacheEntryiter

struct otCacheEntryIterator otCacheEntryIterator

Esse tipo representa um iteração usado para iterar as entradas da tabela de cache de EID.

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

OtCacheEntryState

enum otCacheEntryState otCacheEntryState

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

otChildIp6Addressiter

uint16_t otChildIp6AddressIterator

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

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 de tabela.

Functions

ThreadThreadLeader

otError otThreadBecomeLeader(
  otInstance *aInstance
)

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

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
OT_ERROR_NONE
Tornou-se líder e iniciou uma nova partição.
OT_ERROR_INVALID_STATE
A conversa está desativada.

OtThreadBeginRouter

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
Tentativa de se tornar um roteador.
OT_ERROR_INVALID_STATE
A conversa está desativada.

OtThreadGetChildInfoById

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

A função retém 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 do 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 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 fornecido.
OT_ERROR_NOT_FOUND
Nenhum filho válido neste índice.
OT_ERROR_INVALID_ARGS
aChildInfo é NULL ou aChildIndex está fora do intervalo (maior do que o índice máximo da tabela).
Consulte também:
otGetMaxAllowedChildren

OtThreadGetChildNextIp6Address

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

Essa função recebe o próximo endereço IPv6 (usando um iteração) 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 iteração. Em caso de sucesso, o iteração será atualizado para apontar para a próxima entrada na lista. Para obter o primeiro endereço IPv6, o iteração 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 caso de 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 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.
Consulte também:
otThreadSetContextIdReuseDelay

OtThreadGetJoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

Consiga a porta UDP do Joiner.

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

ThreadThreadLocalLocalererWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

Receba a ponderação de líder da conversa usada na função de líder.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O valor de peso da linha de execução da linha de execução.
Consulte também:
otThreadSetLeaderWeight

otThreadGetMaxAllowedChilds

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

Saiba o número máximo de crianças permitidas atualmente.

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
)

Essa função recebe o número máximo de endereços IP que cada filho de 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 de MTD pode registrar neste dispositivo como pai.
Veja também:
otThreadSetMaxChildIpAddresses

ThreadThreadMaxRouterId

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.

ThreadThreadNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

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

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O valor NETWORK_ID_REFUND.
Consulte 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 iteração).

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aEntryInfo
Um ponteiro para colocar as informações da entrada de cache EID.
[in,out] aIterator
Um ponteiro para um iteração. Ele será atualizado para indicar a próxima entrada. Para conseguir a primeira entrada, inicialize o iteração definindo todos os campos como zero (por exemplo, memset a estrutura do iteração para 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.

Linha de execução de pai/mãe

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 não atribuído.
Consulte também:
otThreadSetParentPriority

OtThreadGetPreferLeaderPartId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

Indica o ID 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 de linha de execução líder.

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 o Thread PSKc recuperado.
Consulte também:
otThreadSetPskc

OtThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

Receber referência de chave ao 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 ao PSKc
Consulte também:
otThreadSetPskcRef

OtThreadGetRouterDowngradeThreshold

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

Receba 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.
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 aos nós na rede.

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

OtThreadGetRouterIdSequence

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

Veja a sequência atual de códigos do roteador.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Sequência de códigos 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 o local em que as informações do roteador são colocadas.
Valores de retorno
OT_ERROR_NONE
As informações do roteador para o ID fornecidas foram recuperadas.
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 de REED/Router.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O valor de ROUTER_SELECTION_JITTER.
Veja também:
otThreadSetRouterSelectionJitter

OtThreadGetRouterUpgradeThreshold

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

Encontre 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 de ROUTER_UPGRADE_THRESHOLD.
Veja também:
otThreadSetRouterUpgradeThreshold

otThreadIsRouterEligible

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

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

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
TRUE
Se o dispositivo for qualificado para roteador.
FALSE
Se o dispositivo não estiver qualificado para o roteador.

otThreadRegisterNeighborTableCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

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

O retorno de chamada fornecido (se for não NULL) será invocado quando houver uma mudança 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 substituirão o callback anterior. 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 função de gerenciador de callback.

OtThreadReleaseRouterId

otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Libere um código do roteador que foi 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 código do roteador que 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
O dispositivo não está operando como líder no momento.
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 comissionado usando o CCM.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aEnabled
TRUE se o dispositivo tiver sido comissionado usando CCM. FALSE, se não tiver.

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

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

ThreadThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

Defina a ponderação de líder da linha de execução usada 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 da linha de execução da linha de execução.
Veja também:
otThreadGetLeaderWeight

otThreadSetMaxAllowedChildren

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

Defina o número máximo de crianças permitidas atualmente.

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.
Valores de retorno
OT_ERROR_NONE
O CPC 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 conversa não foi interrompida.
Consulte 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 de MTD pode registrar com este dispositivo como pai.

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 de MTD pode registrar neste 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/limpado.
OT_ERROR_INVALID_ARGS
Se exceder o número máximo permitido.
Consulte também:
otThreadGetMaxChildIpAddresses

ThreadThreadNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

Defina o parâmetro NETWORK_ID_REFUND usado no papel de líder.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aTimeout
O valor NETWORK_ID_REFUND.
Consulte também:
otThreadGetNetworkIdTimeout

ThreadThreadParentPriority

otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

Defina a prioridade pai.

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

OtThreadSetPreferLeaderPartitionId

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

Define o ID da partição preferencial da linha de execução usada na função de líder.

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

OtThreadSetPreferenceRouterId

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Defina o ID do roteador preferido.

Quando se torna um roteador/líder, o nó tenta usar esse ID do roteador. Se o ID do roteador preferido não estiver definido ou se ele não puder ser usado, um ID de roteador gerado aleatoriamente será escolhido. Esta propriedade só pode ser definida quando a função do dispositivo é separada ou desativada.

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 é separada nem desativada)

OtThreadSetPskc

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

Define o Thread PSKc.

Essa função só funcionará quando os protocolos Thread estiverem desativados. 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 do OpenThread.
[in] aPskc
Um ponteiro para o novo Thread PSKc.
Valores de retorno
OT_ERROR_NONE
A PSKc da linha de execução foi definida.
OT_ERROR_INVALID_STATE
Os protocolos da conversa estão ativados.
Consulte também:
otThreadGetPskc

OtThreadSetPskcRef

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.

Essa função só funcionará quando os protocolos Thread estiverem desativados. 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 do OpenThread.
[in] aKeyRef
Referência importante ao novo PSKc da linha de execução.
Valores de retorno
OT_ERROR_NONE
A PSKc da linha de execução foi definida.
OT_ERROR_INVALID_STATE
Os protocolos da conversa 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.
Veja também:
otThreadGetRouterDowngradeThreshold

otThreadSetRouterEligible

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

Esta função define se o dispositivo está ou não qualificado para roteador.

Se aEligible for falso e o dispositivo estiver operando no momento, o dispositivo será desconectado e tentará se reconectar como um dispositivo filho.

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 do roteador foi definida.
OT_ERROR_NOT_CAPABLE
O dispositivo não é um roteador.

OtThreadSetRouterIdRange

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

Essa função define o intervalo de IDs de roteadores que podem ser atribuídos aos nós na rede.

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
Intervalo definido.
OT_ERROR_INVALID_ARGS
aMinRouterId > aMaxRouterId, ou o intervalo não é 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 de REED/Router.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aRouterJitter
O valor de 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 de líder.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aThreshold
O valor de ROUTER_UPGRADE_THRESHOLD.
Veja também:
otThreadGetRouterUpgradeThreshold

OtThreadSetSteeringData

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

O direcionamento de dados está fora de 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 fora de banda.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do 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 direcionamento). Todos os 0xFFs para definir dados do volante/filtro de flores para 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ões TLV da política de segurança para roteamento (campo de RV) está ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aEnabled
TRUE para ativar o limite de versões de TLV da política de segurança para roteamento. Caso contrário, o valor será FALSO.

Macros

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

Inicialização de otChildIP6Addressiter.

Recursos

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