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

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_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
}
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, em seguida, dispara a redefinição da plataforma.
otInstanceFinalize ( otInstance *aInstance)
void
Esta função desabilita a biblioteca OpenThread.
otInstanceGetUptime ( otInstance *aInstance)
uint64_t
Esta função retorna o tempo de atividade da instância atual (em ms).
otInstanceGetUptimeAsString ( otInstance *aInstance, char *aBuffer, uint16_t aSize)
void
Esta função retorna o tempo de atividade da instância atual como uma string legível por humanos.
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.
otInstanceResetRadioStack ( otInstance *aInstance)
void
Este método redefine os estados internos da pilha de rádio OpenThread.
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 dentro do 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_NETWORK_KEY

Chave de rede 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

A máscara do canal suportado foi 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 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

O ID da partição foi 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.

Veja OT_CHANGED_* definições.

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. Veja OT_CHANGED_* definições.
[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.

Erase é bem sucedida somente se o dispositivo está em disabled estado / papel.

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
Dispositivo não está em disabled estado / papel.

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Este método exclui todas as configurações armazenadas na memória não volátil e, em seguida, 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.

otInstanceGetUptime

uint64_t otInstanceGetUptime(
  otInstance *aInstance
)

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

Esta função requer OPENTHREAD_CONFIG_UPTIME_ENABLE para ser ativado.

O tempo de atividade é fornecido em milissegundos desde que a instância OpenThread foi inicializada.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Devoluções
O tempo de atividade (número de milissegundos).

otInstanceGetUptimeAsString

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

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

Esta função requer OPENTHREAD_CONFIG_UPTIME_ENABLE para ser ativado.

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

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

Se a string resultante não se encaixa em aBuffer (dentro de seus aSize caracteres), o texto será truncado, mas a corda outputted é sempre terminada em null.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[out] aBuffer
Um ponteiro para uma matriz de char para produzir a string.
[in] aSize
O tamanho de aBuffer (em bytes). Recomendado o uso de OT_UPTIME_STRING_SIZE .

otInstanceInit

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

Esta função inicializa a biblioteca OpenThread.

Esta função inicializa OpenThread e prepara-o 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 prepara-o 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á desabilitado.

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 adquirido e inicializado usando otInstanceInitSingle() (caso em instância única) ou otInstanceInit() (em vários casos exemplo). Uma chamada subsequente para otInstanceFinalize() faz com que o exemplo deve ser considerado 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. Note que o otPlatformReset não apaga qualquer persistente estado / info salvos na memória não-volátil.

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

otInstanceResetRadioStack

void otInstanceResetRadioStack(
  otInstance *aInstance
)

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

Retornos de chamada e configurações são preservados.

Esta API só está disponível sob rádio constrói ( OPENTHREAD_RADIO = 1 ).

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 dentro do 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.

Macros

OT_UPTIME_STRING_SIZE

 OT_UPTIME_STRING_SIZE 24

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