Instância

Este módulo inclui funções que controlam o OpenThread Instância.

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 }	enum Essa enumeração define sinalizadores que são passados 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_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 
 }

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 indicando o estado específico / configuração que mudou.
`otInstance`	typedef `struct otInstance` Esta estrutura representa a estrutura OpenThread exemplo.
`otStateChangedCallback )(otChangedFlags aFlags, void *aContext)`	typedef `void(*` Esta ponteiro de função é chamado para notificar certas alterações de configuração ou estado dentro OpenThread.

Funções
`otGetRadioVersionString ( otInstance *aInstance)`	`const char *` Esta função obtém a cadeia de versão de rádio OpenThread.
`otGetVersionString (void)`	`const char *` Esta função obtém a cadeia de versão OpenThread.
`otInstanceErasePersistentInfo ( otInstance *aInstance)`	`otError` Esta função apaga todas as informações OpenThread persistente (configurações de rede) armazenados em memória não volátil.
`otInstanceFactoryReset ( otInstance *aInstance)`	`void` Esse método exclui todas as configurações armazenadas na memória não-volátil, e, em seguida, dispara redefinição plataforma.
`otInstanceFinalize ( otInstance *aInstance)`	`void` Esta função desativa a biblioteca OpenThread.
`otInstanceInit (void aInstanceBuffer, size_t aInstanceBufferSize)`	`otInstance *` Esta função inicializa a biblioteca OpenThread.
`otInstanceInitSingle (void)`	`otInstance *` 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 inicializado.
`otInstanceReset ( otInstance *aInstance)`	`void` Este método provoca um reset plataforma.
`otRemoveStateChangeCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`void` Esta função remove uma chamada de retorno para indicar quando determinadas alterações de configuração ou estado dentro OpenThread.
`otSetStateChangedCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`otError` Esta função registra um callback para indicar quando determinadas alterações de configuração ou estado dentro OpenThread.

enumerações

enumeração anônima

 anonymous enum

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

propriedades
`OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL`	Channel Manager novo pendente canal Tópico alterado.
`OT_CHANGED_COMMISSIONER_STATE`	Estado Comissário alterado.
`OT_CHANGED_IP6_ADDRESS_ADDED`	endereço IPv6 foi adicionado.
`OT_CHANGED_IP6_ADDRESS_REMOVED`	endereço IPv6 foi removido.
`OT_CHANGED_IP6_MULTICAST_SUBSCRIBED`	Subscrito para um endereço de multicast IPv6.
`OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED`	Sobras de um endereço multicast IPv6.
`OT_CHANGED_JOINER_STATE`	Estado Joiner alterado.
`OT_CHANGED_MASTER_KEY`	chave mestra alterada.
`OT_CHANGED_PSKC`	PSKC alterado.
`OT_CHANGED_SECURITY_POLICY`	Política de Segurança alterado.
`OT_CHANGED_SUPPORTED_CHANNEL_MASK`	máscara de canal suportada alterado.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL`	Backbone local configuração do roteador mudou.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE`	Backbone estado Router alterado.
`OT_CHANGED_THREAD_CHANNEL`	canal de rede Tópico alterado.
`OT_CHANGED_THREAD_CHILD_ADDED`	Criança foi adicionado.
`OT_CHANGED_THREAD_CHILD_REMOVED`	Criança foi removido.
`OT_CHANGED_THREAD_EXT_PANID`	rede de fio estendido PAN ID alterado.
`OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER`	Passe Key Sequence alterado.
`OT_CHANGED_THREAD_LL_ADDR`	O endereço do link-local alterado.
`OT_CHANGED_THREAD_ML_ADDR`	O endereço malha-local alterado.
`OT_CHANGED_THREAD_NETDATA`	Tópico Data Network mudou.
`OT_CHANGED_THREAD_NETIF_STATE`	estado de interface de rede Tópico alterado.
`OT_CHANGED_THREAD_NETWORK_NAME`	nome da rede Tópico alterado.
`OT_CHANGED_THREAD_PANID`	rede de fio PAN Id alterado.
`OT_CHANGED_THREAD_PARTITION_ID`	Partition ID alterado.
`OT_CHANGED_THREAD_RLOC_ADDED`	RLOC foi adicionado.
`OT_CHANGED_THREAD_RLOC_REMOVED`	RLOC foi removido.
`OT_CHANGED_THREAD_ROLE`	Papel (desativado, individual, criança, router, líder) mudou.

typedefs

otChangedFlags

uint32_t otChangedFlags

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

Veja OT_CHANGED_* definições.

otInstance

struct otInstance otInstance

Esta estrutura representa a estrutura OpenThread exemplo.

otStateChangedCallback

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

Esta ponteiro de função é chamado para notificar certas alterações de configuração ou estado dentro OpenThread.

detalhes

parâmetros

`[in] aFlags`	Um estado específico bit-campo indicando que mudou. Veja `OT_CHANGED_*` definições.
`[in] aContext`	Um ponteiro ao contexto específico de aplicação.

Funções

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

Esta função obtém a cadeia 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 cadeia de versão OpenThread.

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

otInstanceErasePersistentInfo

 otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

Esta função apaga todas as informações OpenThread persistente (configurações de rede) armazenados em 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.

Valor Retornado

`OT_ERROR_NONE`	Todos persistente info / Estado foi apagado com sucesso.
`OT_ERROR_INVALID_STATE`	Dispositivo não está em `disabled` estado / papel.

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Esse método exclui todas as configurações armazenadas na memória não-volátil, e, em seguida, dispara redefinição plataforma.

detalhes

parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

Esta função desativa a biblioteca OpenThread.

Chame esta função quando OpenThread não está 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 prepara-lo para chamadas subsequentes API OpenThread. Esta função deve ser chamado antes de quaisquer outras chamadas para OpenThread.

Esta função está disponível e pode ser usado somente quando o suporte para várias instâncias OpenThread está habilitado.

detalhes

parâmetros

`[in] aInstanceBuffer`	O tampão para OpenThread para usar para a atribuição da estrutura otInstance.
`[in,out] aInstanceBufferSize`	Na entrada, o tamanho da aInstanceBuffer. Na saída, se não há espaço suficiente para otInstance, o número de bytes necessário para otInstance.

Devoluções

Um apontador 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-lo para chamadas subsequentes API OpenThread. Esta função deve ser chamado antes de quaisquer outras chamadas para OpenThread.

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

detalhes
Devoluções	Um apontador para a instância OpenThread único.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

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

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 o exemplo dado é válido / inicializado, FALSE caso contrário.

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

Este método provoca um reset plataforma.

Os assegura processo de redefinição que todo o estado OpenThread / info (armazenado na memória volátil) é 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.

otRemoveStateChangeCallback

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

Esta função remove uma chamada de retorno para indicar quando determinadas alterações de configuração ou estado dentro OpenThread.

detalhes

parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aCallback`	Um ponteiro para uma função que é chamado com certas alterações de configuração ou de estado.
`[in] aContext`	Um ponteiro ao contexto específico de aplicação.

otSetStateChangedCallback

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

Esta função registra um callback para indicar quando determinadas alterações de configuração ou estado dentro OpenThread.

detalhes

parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aCallback`	Um ponteiro para uma função que é chamado com certas alterações de configuração ou de estado.
`[in] aContext`	Um ponteiro ao contexto específico de aplicação.

Valor Retornado

`OT_ERROR_NONE`	Adicionado a chamada de retorno à lista de chamadas de retorno.
`OT_ERROR_ALREADY`	O retorno de chamada já foi registrado.
`OT_ERROR_NO_BUFS`	Não foi possível adicionar a chamada de retorno devido a limitações de recursos.