Instância
Este módulo inclui funções que controlam a instância do OpenThread.
Resumo
Typedefs |
|
---|---|
otChangedFlags
|
typedefuint32_t
Esse tipo representa um campo de bits que indica o estado/configuração específico que mudou. |
otInstance
|
typedefstruct otInstance
Essa estrutura representa a estrutura de instâncias do OpenThread. |
otStateChangedCallback)(otChangedFlags aFlags, void *aContext)
|
typedefvoid(*
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)
|
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)
|
Essa função inicializa a biblioteca do OpenThread.
|
otInstanceInitSingle(void)
|
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)
|
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 |
|
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 |
|
||
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 |
|
||||
Retornar valores |
|
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 |
|
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 |
|
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 |
|
||
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 "
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 |
|
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 |
|
||||
Retorna |
Um ponteiro para a nova instância do OpenThread.
|
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 |
|
||
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 |
|
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 |
|
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 |
|
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 |
|
||||||
Retornar valores |
|
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.