Esta página foi traduzida pela API Cloud Translation.

Instância

Este módulo inclui funções que controlam a instância do OpenThread.

Resumo

Enumerações
anonymous enum{ OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0, OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1, OT_CHANGED_THREAD_ROLE = 1 << 2, OT_CHANGED_THREAD_LL_ADDR = 1 << 3, OT_CHANGED_THREAD_ML_ADDR = 1 << 4, OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5, OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6, OT_CHANGED_THREAD_PARTITION_ID = 1 << 7, OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8, OT_CHANGED_THREAD_NETDATA = 1 << 9, OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10, OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11, OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12, OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13, OT_CHANGED_THREAD_CHANNEL = 1 << 14, OT_CHANGED_THREAD_PANID = 1 << 15, OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16, OT_CHANGED_THREAD_EXT_PANID = 1 << 17, OT_CHANGED_NETWORK_KEY = 1 << 18, OT_CHANGED_PSKC = 1 << 19, OT_CHANGED_SECURITY_POLICY = 1 << 20, OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21, OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22, OT_CHANGED_COMMISSIONER_STATE = 1 << 23, OT_CHANGED_THREAD_NETIF_STATE = 1 << 24, OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25, OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26, OT_CHANGED_JOINER_STATE = 1 << 27, OT_CHANGED_ACTIVE_DATASET = 1 << 28, OT_CHANGED_PENDING_DATASET = 1 << 29, OT_CHANGED_NAT64_TRANSLATOR_STATE = 1 << 30 }	tipo enumerado Esta enumeração define sinalizações que são transmitidas como parte de `otStateChangedCallback`.

Enumerações

anonymous enum{
  OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0,
  OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1,
  OT_CHANGED_THREAD_ROLE = 1 << 2,
  OT_CHANGED_THREAD_LL_ADDR = 1 << 3,
  OT_CHANGED_THREAD_ML_ADDR = 1 << 4,
  OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5,
  OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6,
  OT_CHANGED_THREAD_PARTITION_ID = 1 << 7,
  OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8,
  OT_CHANGED_THREAD_NETDATA = 1 << 9,
  OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10,
  OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11,
  OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12,
  OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13,
  OT_CHANGED_THREAD_CHANNEL = 1 << 14,
  OT_CHANGED_THREAD_PANID = 1 << 15,
  OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16,
  OT_CHANGED_THREAD_EXT_PANID = 1 << 17,
  OT_CHANGED_NETWORK_KEY = 1 << 18,
  OT_CHANGED_PSKC = 1 << 19,
  OT_CHANGED_SECURITY_POLICY = 1 << 20,
  OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21,
  OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22,
  OT_CHANGED_COMMISSIONER_STATE = 1 << 23,
  OT_CHANGED_THREAD_NETIF_STATE = 1 << 24,
  OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25,
  OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26,
  OT_CHANGED_JOINER_STATE = 1 << 27,
  OT_CHANGED_ACTIVE_DATASET = 1 << 28,
  OT_CHANGED_PENDING_DATASET = 1 << 29,
  OT_CHANGED_NAT64_TRANSLATOR_STATE = 1 << 30
}

tipo enumerado

Esta enumeração define sinalizações que são transmitidas como parte de otStateChangedCallback.

Typedefs
`otChangedFlags`	typedef `uint32_t` Esse tipo representa um campo de bits que indica o estado/configuração específico que mudou.
`otInstance`	typedef `struct otInstance` Essa estrutura representa a estrutura de instâncias do OpenThread.
`otStateChangedCallback)(otChangedFlags aFlags, void *aContext)`	typedef `void(*` Esse ponteiro de função é chamado para notificar determinadas configurações ou mudanças de estado no OpenThread.

Funções
`otGetRadioVersionString(otInstance *aInstance)`	`const char *` Essa função recebe a string de versão de rádio do OpenThread.
`otGetVersionString(void)`	`const char *` Essa função recebe a string de versão do OpenThread.
`otInstanceErasePersistentInfo(otInstance *aInstance)`	`otError` Essa função apaga todas as informações persistentes do OpenThread (configurações de rede) armazenadas na memória não volátil.
`otInstanceFactoryReset(otInstance *aInstance)`	`void` Exclui todas as configurações armazenadas na memória não volátil e aciona uma redefinição da plataforma.
`otInstanceFinalize(otInstance *aInstance)`	`void` Essa função desativa a biblioteca OpenThread.
`otInstanceGetUptime(otInstance *aInstance)`	`uint64_t` Essa função retorna o tempo de atividade atual da instância (em ms).
`otInstanceGetUptimeAsString(otInstance aInstance, char aBuffer, uint16_t aSize)`	`void` Essa função retorna o tempo de atividade atual da instância como uma string legível.
`otInstanceInit(void aInstanceBuffer, size_t aInstanceBufferSize)`	`otInstance *` Essa função inicializa a biblioteca do OpenThread.
`otInstanceInitSingle(void)`	`otInstance *` Essa função inicializa a única instância estática da biblioteca do OpenThread.
`otInstanceIsInitialized(otInstance *aInstance)`	`bool` Essa função indica se a instância é válida ou inicializada.
`otInstanceReset(otInstance *aInstance)`	`void` Esse método aciona uma redefinição de plataforma.
`otInstanceResetRadioStack(otInstance *aInstance)`	`void` Esse método redefine os estados internos da pilha de rádio do OpenThread.
`otRemoveStateChangeCallback(otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`void` Essa função remove um callback para indicar quando determinada configuração ou estado muda no OpenThread.
`otSetStateChangedCallback(otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`otError` Essa função registra um callback para indicar quando determinada configuração ou estado muda no OpenThread.

Enumerações

enumeração anônima

 anonymous enum

Esta enumeração define sinalizações que são transmitidas como parte de otStateChangedCallback.

Propriedades
`OT_CHANGED_ACTIVE_DATASET`	O conjunto de dados operacional ativo foi alterado.
`OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL`	O novo canal de Thread pendente do Gerenciador de canais foi alterado.
`OT_CHANGED_COMMISSIONER_STATE`	Estado do comissário alterado.
`OT_CHANGED_IP6_ADDRESS_ADDED`	O endereço IPv6 foi adicionado.
`OT_CHANGED_IP6_ADDRESS_REMOVED`	O endereço IPv6 foi removido.
`OT_CHANGED_IP6_MULTICAST_SUBSCRIBED`	Assinante de um endereço multicast IPv6
`OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED`	Você cancelou sua inscrição em um endereço multicast IPv6.
`OT_CHANGED_JOINER_STATE`	Estado do combinador alterado.
`OT_CHANGED_NAT64_TRANSLATOR_STATE`	O estado do tradutor NAT64 foi alterado.
`OT_CHANGED_NETWORK_KEY`	Chave de rede alterada.
`OT_CHANGED_PENDING_DATASET`	O conjunto de dados operacional pendente mudou.
`OT_CHANGED_PSKC`	PSKc alterado.
`OT_CHANGED_SECURITY_POLICY`	Política de segurança alterada.
`OT_CHANGED_SUPPORTED_CHANNEL_MASK`	A máscara de canal compatível foi alterada.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL`	A configuração do roteador de backbone local mudou.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE`	O estado do roteador de backbone foi alterado.
`OT_CHANGED_THREAD_CHANNEL`	Canal de rede de linha de execução alterado.
`OT_CHANGED_THREAD_CHILD_ADDED`	O filho foi adicionado.
`OT_CHANGED_THREAD_CHILD_REMOVED`	O filho foi removido.
`OT_CHANGED_THREAD_EXT_PANID`	O ID PAN estendido da rede de linhas de execução foi alterado.
`OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER`	Sequência de chaves de linha de execução alterada.
`OT_CHANGED_THREAD_LL_ADDR`	O endereço link-local mudou.
`OT_CHANGED_THREAD_ML_ADDR`	O endereço local da rede mesh mudou.
`OT_CHANGED_THREAD_NETDATA`	Os dados da rede da linha de execução foram alterados.
`OT_CHANGED_THREAD_NETIF_STATE`	O estado da interface de rede da linha de execução mudou.
`OT_CHANGED_THREAD_NETWORK_NAME`	O nome da rede da conversa foi alterado.
`OT_CHANGED_THREAD_PANID`	O ID do PAN da rede de linhas de execução foi alterado.
`OT_CHANGED_THREAD_PARTITION_ID`	ID da partição alterado.
`OT_CHANGED_THREAD_RLOC_ADDED`	O RLOC foi adicionado.
`OT_CHANGED_THREAD_RLOC_REMOVED`	O RLOC foi removido.
`OT_CHANGED_THREAD_ROLE`	Papel (desativado, removido, filho, roteador, líder) alterado.

Typedefs

otChangedFlags

uint32_t otChangedFlags

Esse tipo representa um campo de bits que indica o estado/configuração específico que mudou.

Consulte as definições de OT_CHANGED_*.

Instância de instância

struct otInstance otInstance

Essa estrutura representa a estrutura de instâncias do OpenThread.

OtStateChangedCallback

void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)

Esse ponteiro de função é chamado para notificar determinadas configurações ou mudanças de estado no OpenThread.

Detalhes

Parâmetros

`[in] aFlags`	Um campo de bit que indica um estado específico que mudou. Consulte as definições de `OT_CHANGED_*`.
`[in] aContext`	Um ponteiro para um contexto específico do aplicativo.

Funções

OtGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

Essa função recebe a string de versão de rádio do OpenThread.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retorna

Um ponteiro para a versão de rádio do OpenThread.

OtGetVersionString

const char * otGetVersionString(
  void
)

Essa função recebe a string de versão do OpenThread.

Detalhes
Retorna	Um ponteiro para a versão do OpenThread.

OtInstanceApagarPersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

Essa função apaga todas as informações persistentes do OpenThread (configurações de rede) armazenadas na memória não volátil.

A limpeza só será bem-sucedida se o dispositivo estiver no estado/papel disabled.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retornar valores

`OT_ERROR_NONE`	Todas as informações/estados permanentes foram apagados.
`OT_ERROR_INVALID_STATE`	O dispositivo não está no estado/papel `disabled`.

OtInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Exclui todas as configurações armazenadas na memória não volátil e aciona uma redefinição da plataforma.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

OtInstanceFinalizar

void otInstanceFinalize(
  otInstance *aInstance
)

Essa função desativa a biblioteca OpenThread.

Chame essa função quando o OpenThread não estiver mais em uso.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Tempo de atividade otInstanceGet

uint64_t otInstanceGetUptime(
  otInstance *aInstance
)

Essa função retorna o tempo de atividade atual da instância (em ms).

Esta função exige que o OPENTHREAD_CONFIG_UPTIME_ENABLE esteja ativado.

O tempo de atividade é determinado como um número em milissegundos desde que a instância do OpenThread foi inicializada.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retorna

Tempo de atividade (número de milissegundos).

OtInstanceGetUptimeAsString

void otInstanceGetUptimeAsString(
  otInstance *aInstance,
  char *aBuffer,
  uint16_t aSize
)

Essa função retorna o tempo de atividade atual da instância como uma string legível.

Esta função exige que o OPENTHREAD_CONFIG_UPTIME_ENABLE esteja ativado.

A string segue o formato "::." para horas, minutos, segundos e milissegundos (se o tempo de atividade for menor que um dia) ou "

d.::." (se demorar mais de um dia).

Se a string resultante não couber em aBuffer (dentro dos caracteres aSize), ela será truncada, mas a string resultante sempre será nula.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância do OpenThread.
`[out] aBuffer`	Um ponteiro para uma matriz de caracteres para gerar a string.
`[in] aSize`	O tamanho de `aBuffer` (em bytes). Recomendada para usar `OT_UPTIME_STRING_SIZE`.

OtInstanceInit

otInstance * otInstanceInit(
  void *aInstanceBuffer,
  size_t *aInstanceBufferSize
)

Essa função inicializa a biblioteca do OpenThread.

Essa função inicializa o OpenThread e o prepara para chamadas subsequentes da API OpenThread. Essa função precisa ser chamada antes de qualquer outra chamada para o OpenThread.

Essa função está disponível e só pode ser usada quando o suporte para várias instâncias do OpenThread está ativado.

Detalhes

Parâmetros

`[in] aInstanceBuffer`	O buffer que o OpenThread deve usar para alocar a estrutura otInstance.
`[in,out] aInstanceBufferSize`	Na entrada, o tamanho de aInstanceBuffer. Na saída, se não houver espaço suficiente para o otInstance, o número de bytes necessários para otInstance.

Retorna

Um ponteiro para a nova instância do OpenThread.

Consulte também:
otInstanceFinalize

OtInstanceInitSingle

otInstance * otInstanceInitSingle(
  void
)

Essa função inicializa a única instância estática da biblioteca do OpenThread.

Essa função inicializa o OpenThread e o prepara para chamadas subsequentes da API OpenThread. Essa função precisa ser chamada antes de qualquer outra chamada para o OpenThread.

Essa função está disponível e só pode ser usada quando o suporte para várias instâncias do OpenThread estiver desativado.

Detalhes
Retorna	Um ponteiro para a única instância do OpenThread.

OtInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

Essa função indica se a instância é válida ou inicializada.

A instância será considerada válida se for adquirida e inicializada usando otInstanceInitSingle() (no caso de instância única) ou otInstanceInit() (no caso de várias instâncias). Uma chamada subsequente para otInstanceFinalize() faz com que a instância seja considerada não inicializada.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

Retorna

Verdadeiro se a instância especificada for válida/inicializada. Caso contrário, FALSO.

OtInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

Esse método aciona uma redefinição de plataforma.

O processo de redefinição garante que todos os estados/informações do OpenThread (armazenados em memória volátil) sejam apagados. Observe que o otPlatformReset não apaga nenhum estado/informações persistentes salvos na memória não volátil.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

OtInstanceResetRadioStack

void otInstanceResetRadioStack(
  otInstance *aInstance
)

Esse método redefine os estados internos da pilha de rádio do OpenThread.

Os callbacks e as configurações são preservados.

Essa API está disponível apenas em builds de rádio (OPENTHREAD_RADIO = 1).

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância do OpenThread.

OtRemoveStateChangeCallback

void otRemoveStateChangeCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

Essa função remove um callback para indicar quando determinada configuração ou estado muda no OpenThread.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância do OpenThread.
`[in] aCallback`	Um ponteiro para uma função que é chamada com determinadas mudanças de configuração ou estado.
`[in] aContext`	Um ponteiro para um contexto específico do aplicativo.

OtSetStateChangedCallback

otError otSetStateChangedCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

Essa função registra um callback para indicar quando determinada configuração ou estado muda no OpenThread.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância do OpenThread.
`[in] aCallback`	Um ponteiro para uma função que é chamada com determinadas mudanças de configuração ou estado.
`[in] aContext`	Um ponteiro para um contexto específico do aplicativo.

Retornar valores

`OT_ERROR_NONE`	O callback foi adicionado à lista de callbacks.
`OT_ERROR_ALREADY`	O callback já foi registrado.
`OT_ERROR_NO_BUFS`	Não foi possível adicionar o callback devido a restrições de recursos.

Macros

PRÓXIMA_PERIGO_STRING_SIZE

 OT_UPTIME_STRING_SIZE 24

Tamanho recomendado para representação de string de tempo de atividade.

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.