O Google tem o compromisso de promover a igualdade racial para as comunidades negras. Saiba como.
Esta página foi traduzida pela API Cloud Translation.
Switch to English

Instância

Este módulo inclui funções que controlam a instância 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_MASTER_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
}
enum
Essa enumeração define sinalizadores que são passados ​​como parte de otStateChangedCallback .

Typedefs

otChangedFlags typedef
uint32_t
Este tipo representa um campo de bits que indica o estado / configuração específica que mudou.
otInstance typedef
struct otInstance
Esta estrutura representa a estrutura da instância OpenThread.
otStateChangedCallback )(otChangedFlags aFlags, void *aContext) typedef
void(*
Este ponteiro de função é chamado para notificar certas configurações ou mudanças de estado no OpenThread.

Funções

otGetRadioVersionString ( otInstance *aInstance)
const char *
Esta função obtém a string de versão de rádio OpenThread.
otGetVersionString (void)
const char *
Esta função obtém a string de versão do OpenThread.
otInstanceErasePersistentInfo ( otInstance *aInstance)
Esta 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
Este método exclui todas as configurações armazenadas na memória não volátil e, a seguir, dispara a redefinição da plataforma.
otInstanceFinalize ( otInstance *aInstance)
void
Esta função desabilita a biblioteca OpenThread.
otInstanceInit (void *aInstanceBuffer, size_t *aInstanceBufferSize)
Esta função inicializa a biblioteca OpenThread.
otInstanceInitSingle (void)
Esta função inicializa a única instância estática da biblioteca OpenThread.
otInstanceIsInitialized ( otInstance *aInstance)
bool
Esta função indica se a instância é válida / inicializada ou não.
otInstanceReset ( otInstance *aInstance)
void
Este método dispara uma reinicialização da plataforma.
otRemoveStateChangeCallback ( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
void
Esta função remove um retorno de chamada para indicar quando determinada configuração ou estado muda no OpenThread.
otSetStateChangedCallback ( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
Esta função registra um retorno de chamada para indicar quando determinada configuração ou estado muda no OpenThread.

Enumerações

enum anônimo

 anonymous enum

Essa enumeração define sinalizadores que são passados ​​como parte de otStateChangedCallback .

Propriedades
OT_CHANGED_ACTIVE_DATASET

Conjunto de dados operacional ativo alterado.

OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL

Channel Manager novo canal de Thread pendente alterado.

OT_CHANGED_COMMISSIONER_STATE

O estado do comissário mudou.

OT_CHANGED_IP6_ADDRESS_ADDED

Endereço IPv6 foi adicionado.

OT_CHANGED_IP6_ADDRESS_REMOVED

O endereço IPv6 foi removido.

OT_CHANGED_IP6_MULTICAST_SUBSCRIBED

Inscrito em um endereço multicast IPv6.

OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED

Cancelamento da assinatura de um endereço multicast IPv6.

OT_CHANGED_JOINER_STATE

O estado do marceneiro mudou.

OT_CHANGED_MASTER_KEY

Chave mestra alterada.

OT_CHANGED_PENDING_DATASET

Conjunto de dados operacionais pendentes alterado.

OT_CHANGED_PSKC

PSKc alterado.

OT_CHANGED_SECURITY_POLICY

Política de segurança alterada.

OT_CHANGED_SUPPORTED_CHANNEL_MASK

Máscara de canal com suporte alterada.

OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL

A configuração do roteador de backbone local foi alterada.

OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE

O estado do roteador de backbone foi alterado.

OT_CHANGED_THREAD_CHANNEL

Canal de rede de thread alterado.

OT_CHANGED_THREAD_CHILD_ADDED

Criança foi adicionada.

OT_CHANGED_THREAD_CHILD_REMOVED

A criança foi removida.

OT_CHANGED_THREAD_EXT_PANID

O PAN ID estendido da rede thread foi alterado.

OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER

Sequência de chave de linha alterada.

OT_CHANGED_THREAD_LL_ADDR

O endereço local do link mudou.

OT_CHANGED_THREAD_ML_ADDR

O endereço local da malha mudou.

OT_CHANGED_THREAD_NETDATA

Dados de rede de thread alterados.

OT_CHANGED_THREAD_NETIF_STATE

O estado da interface de rede do thread foi alterado.

OT_CHANGED_THREAD_NETWORK_NAME

O nome da rede do thread foi alterado.

OT_CHANGED_THREAD_PANID

O ID do PAN da rede da linha foi alterado.

OT_CHANGED_THREAD_PARTITION_ID

ID da partição alterado.

OT_CHANGED_THREAD_RLOC_ADDED

RLOC foi adicionado.

OT_CHANGED_THREAD_RLOC_REMOVED

RLOC foi removido.

OT_CHANGED_THREAD_ROLE

Função (desativado, desconectado, filho, roteador, líder) alterado.

Typedefs

otChangedFlags

uint32_t otChangedFlags

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

Consulte OT_CHANGED_* definições OT_CHANGED_* .

otInstance

struct otInstance otInstance

Esta estrutura representa a estrutura da instância OpenThread.

otStateChangedCallback

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

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

Detalhes
Parâmetros
[in] aFlags
Um campo de bits que indica o estado específico que mudou. Consulte OT_CHANGED_* definições OT_CHANGED_* .
[in] aContext
Um ponteiro para o contexto específico do aplicativo.

Funções

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

Esta função obtém a string de versão de rádio OpenThread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Devoluções
Um ponteiro para a versão de rádio OpenThread.

otGetVersionString

const char * otGetVersionString(
  void
)

Esta função obtém a string de versão do OpenThread.

Detalhes
Devoluções
Um ponteiro para a versão OpenThread.

otInstanceErasePersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

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

O apagamento é bem-sucedido apenas se o dispositivo estiver no estado / função disabled .

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Valores Retornados
OT_ERROR_NONE
Todas as informações / estados persistentes foram apagados com sucesso.
OT_ERROR_INVALID_STATE
O dispositivo não está em estado / função disabled .

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Este método exclui todas as configurações armazenadas na memória não volátil e, a seguir, dispara a redefinição da plataforma.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

Esta função desabilita a biblioteca OpenThread.

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

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.

otInstanceInit

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

Esta função inicializa a biblioteca OpenThread.

Esta função inicializa OpenThread e o prepara para chamadas subsequentes de API OpenThread. Esta função deve ser chamada antes de qualquer outra chamada para OpenThread.

Esta 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 para OpenThread 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 otInstance, o número de bytes necessários para otInstance.
Devoluções
Um ponteiro para a nova instância OpenThread.
Veja também:
otInstanceFinalize

otInstanceInitSingle

otInstance * otInstanceInitSingle(
  void
)

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

Esta função inicializa OpenThread e o prepara para chamadas subsequentes de API OpenThread. Esta função deve ser chamada antes de qualquer outra chamada para OpenThread.

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

Detalhes
Devoluções
Um ponteiro para a única instância OpenThread.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

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

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

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Devoluções
TRUE se a instância fornecida é válida / inicializada, FALSE caso contrário.

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

Este método dispara uma reinicialização da plataforma.

O processo de reinicialização garante que todo o estado / informação do OpenThread (armazenado na memória volátil) seja apagado. Observe que o otPlatformReset não apaga nenhum estado / informação persistente salva na memória não volátil.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.

otRemoveStateChangeCallback

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

Esta função remove um retorno de chamada para indicar quando determinada configuração ou estado muda no OpenThread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aCallback
Um ponteiro para uma função que é chamada com certas alterações de configuração ou estado.
[in] aContext
Um ponteiro para o contexto específico do aplicativo.

otSetStateChangedCallback

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

Esta função registra um retorno de chamada para indicar quando determinada configuração ou estado muda no OpenThread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aCallback
Um ponteiro para uma função que é chamada com certas alterações de configuração ou estado.
[in] aContext
Um ponteiro para o contexto específico do aplicativo.
Valores Retornados
OT_ERROR_NONE
Adicionado o retorno de chamada à lista de retornos de chamada.
OT_ERROR_ALREADY
O retorno de chamada já foi registrado.
OT_ERROR_NO_BUFS
Não foi possível adicionar o retorno de chamada devido a restrições de recursos.