O Google tem o compromisso de promover a igualdade racial para as comunidades negras. Saiba como.
Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Conjunto de dados operacional

Este módulo inclui funções para o Dataset Updater.

Resumo

As funções neste módulo estão disponíveis quando o recurso Dataset Updater está ativado (ou seja, OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE está definido como 1). Além disso, esse recurso está disponível apenas em uma versão FTD.

Enumerações

otMeshcopTlvType{
  OT_MESHCOP_TLV_CHANNEL = 0,
  OT_MESHCOP_TLV_PANID = 1,
  OT_MESHCOP_TLV_EXTPANID = 2,
  OT_MESHCOP_TLV_NETWORKNAME = 3,
  OT_MESHCOP_TLV_PSKC = 4,
  OT_MESHCOP_TLV_NETWORKKEY = 5,
  OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE = 6,
  OT_MESHCOP_TLV_MESHLOCALPREFIX = 7,
  OT_MESHCOP_TLV_STEERING_DATA = 8,
  OT_MESHCOP_TLV_BORDER_AGENT_RLOC = 9,
  OT_MESHCOP_TLV_COMMISSIONER_ID = 10,
  OT_MESHCOP_TLV_COMM_SESSION_ID = 11,
  OT_MESHCOP_TLV_SECURITYPOLICY = 12,
  OT_MESHCOP_TLV_GET = 13,
  OT_MESHCOP_TLV_ACTIVETIMESTAMP = 14,
  OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT = 15,
  OT_MESHCOP_TLV_STATE = 16,
  OT_MESHCOP_TLV_JOINER_DTLS = 17,
  OT_MESHCOP_TLV_JOINER_UDP_PORT = 18,
  OT_MESHCOP_TLV_JOINER_IID = 19,
  OT_MESHCOP_TLV_JOINER_RLOC = 20,
  OT_MESHCOP_TLV_JOINER_ROUTER_KEK = 21,
  OT_MESHCOP_TLV_PROVISIONING_URL = 32,
  OT_MESHCOP_TLV_VENDOR_NAME_TLV = 33,
  OT_MESHCOP_TLV_VENDOR_MODEL_TLV = 34,
  OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV = 35,
  OT_MESHCOP_TLV_VENDOR_DATA_TLV = 36,
  OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV = 37,
  OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV = 48,
  OT_MESHCOP_TLV_IPV6_ADDRESS_TLV = 49,
  OT_MESHCOP_TLV_PENDINGTIMESTAMP = 51,
  OT_MESHCOP_TLV_DELAYTIMER = 52,
  OT_MESHCOP_TLV_CHANNELMASK = 53,
  OT_MESHCOP_TLV_COUNT = 54,
  OT_MESHCOP_TLV_PERIOD = 55,
  OT_MESHCOP_TLV_SCAN_DURATION = 56,
  OT_MESHCOP_TLV_ENERGY_LIST = 57,
  OT_MESHCOP_TLV_DISCOVERYREQUEST = 128,
  OT_MESHCOP_TLV_DISCOVERYRESPONSE = 129,
  OT_MESHCOP_TLV_JOINERADVERTISEMENT = 241
}
tipo enumerado
Esta enumeração representa tipos de TLV da malhacop.

Typedefs

otChannelMask typedef
uint32_t
Esse tipo representa a máscara de canal.
otDatasetMgmtSetCallback)(otError aResult, void *aContext) typedef
void(*
Esse ponteiro de função é chamado quando uma resposta a uma solicitação MGMT_SET é recebida ou expira.
otDatasetUpdaterCallback)(otError aError, void *aContext) typedef
void(*
Esse ponteiro de função de callback é chamado quando uma solicitação de atualização do conjunto de dados é concluída, informando o status de conclusão ou falha da solicitação de atualização do conjunto de dados.
otExtendedPanId typedef
Essa estrutura representa um código do PAN estendido.
otMeshLocalPrefix typedef
Essa estrutura representa um prefixo local de malha.
otMeshcopTlvType typedef
Esta enumeração representa tipos de TLV da malhacop.
otNetworkKey typedef
struct otNetworkKey
Essa estrutura representa uma chave de rede Thread.
otNetworkKeyRef typedef
Esse tipo de dados representa KeyRef para NetworkKey.
otNetworkName typedef
struct otNetworkName
Essa estrutura representa um nome de rede.
otOperationalDataset typedef
Essa estrutura representa um conjunto de dados operacional ativo ou pendente.
otOperationalDatasetComponents typedef
Essa estrutura representa a presença de diferentes componentes no conjunto de dados operacional ativo ou pendente.
otOperationalDatasetTlvs typedef
Essa estrutura representa um conjunto de dados operacional ativo ou pendente.
otPskc typedef
struct otPskc
Essa estrutura representa um PSKc.
otPskcRef typedef
Esse tipo de dados representa KeyRef para PSKc.
otSecurityPolicy typedef
Essa estrutura representa a política de segurança.
otTimestamp typedef
struct otTimestamp
Essa estrutura representa um componente de carimbo de data/hora do conjunto de dados da linha de execução.

Variables

OT_TOOL_PACKED_END

Functions

otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset)
Esse método cria um novo conjunto de dados operacional a ser usado ao formar uma nova rede.
otDatasetGeneratePskc(const char *aPassPhrase, const otNetworkName *aNetworkName, const otExtendedPanId *aExtPanId, otPskc *aPskc)
Essa função gera PSKc a partir de uma determinada senha longa, nome de rede e ID do PAN estendido.
otDatasetGetActive(otInstance *aInstance, otOperationalDataset *aDataset)
Essa função recebe o conjunto de dados operacional ativo.
otDatasetGetActiveTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Essa função recebe o conjunto de dados operacional ativo.
otDatasetGetDelayTimerMinimal(otInstance *aInstance)
uint32_t
Receba um timer de atraso mínimo.
otDatasetGetPending(otInstance *aInstance, otOperationalDataset *aDataset)
Esta função recebe o conjunto de dados operacional pendente.
otDatasetGetPendingTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Esta função recebe o conjunto de dados operacional pendente.
otDatasetIsCommissioned(otInstance *aInstance)
bool
Esta função indica se uma rede válida está presente no conjunto de dados operacional ativo ou não.
otDatasetParseTlvs(const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset)
Essa função analisa um conjunto de dados operacional de um otOperationalDatasetTlvs.
otDatasetSendMgmtActiveGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Essa função envia MGMT_ACTIVE_GET.
otDatasetSendMgmtActiveSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Essa função envia MGMT_ACTIVE_SET.
otDatasetSendMgmtPendingGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Essa função envia MGMT_PENDING_GET.
otDatasetSendMgmtPendingSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Essa função envia MGMT_PENDING_SET.
otDatasetSetActive(otInstance *aInstance, const otOperationalDataset *aDataset)
Essa função define o conjunto de dados operacional ativo.
otDatasetSetActiveTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Essa função define o conjunto de dados operacional ativo.
otDatasetSetDelayTimerMinimal(otInstance *aInstance, uint32_t aDelayTimerMinimal)
Defina um timer de atraso mínimo.
otDatasetSetPending(otInstance *aInstance, const otOperationalDataset *aDataset)
Esta função define o conjunto de dados operacional pendente.
otDatasetSetPendingTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Esta função define o conjunto de dados operacional pendente.
otDatasetUpdaterCancelUpdate(otInstance *aInstance)
void
Essa função cancela uma solicitação de atualização de conjunto de dados operacional em andamento (se houver).
otDatasetUpdaterIsUpdateOngoing(otInstance *aInstance)
bool
Essa função indica se há uma solicitação de atualização do conjunto de dados de operação em andamento.
otDatasetUpdaterRequestUpdate(otInstance *aInstance, const otOperationalDataset *aDataset, otDatasetUpdaterCallback aCallback, void *aContext)
Esta função solicita uma atualização do conjunto de dados operacional.
otNetworkNameFromString(otNetworkName *aNetworkName, const char *aNameString)
Essa função define uma instância de otNetworkName de uma determinada string C encerrada.

Estruturas

otExtendedPanId.

Essa estrutura representa um código do PAN estendido.

OtNetworkKey

Essa estrutura representa uma chave de rede Thread.

OtNetworkName (em inglês)

Essa estrutura representa um nome de rede.

otOperationalDataset (em inglês)

Essa estrutura representa um conjunto de dados operacional ativo ou pendente.

otOperationalDatasetComponents

Essa estrutura representa a presença de diferentes componentes no conjunto de dados operacional ativo ou pendente.

otOperationalDatasetTlvs

Essa estrutura representa um conjunto de dados operacional ativo ou pendente.

OtPskc (em inglês)

Essa estrutura representa o PSKc.

OtSecurityPolicy

Essa estrutura representa a política de segurança.

otTimestamp (em inglês)

Essa estrutura representa um componente de carimbo de data/hora do conjunto de dados da linha de execução.

Enumerações

OtMeshcopTlvType

 otMeshcopTlvType

Esta enumeração representa tipos de TLV da malhacop.

Propriedades
OT_MESHCOP_TLV_ACTIVETIMESTAMP

TLV do carimbo de data/hora ativo da meshcop

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

Malha, agente de borda do TLV

OT_MESHCOP_TLV_CHANNEL

TLV do canal meshcop

OT_MESHCOP_TLV_CHANNELMASK

TLV da máscara de canal da meshcop

OT_MESHCOP_TLV_COMMISSIONER_ID

Malha ID ID "Comissário"

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

TLV da porta UDP do Commissioner meshcop

OT_MESHCOP_TLV_COMM_SESSION_ID

TLV do ID da sessão do Commissioner da meshcop

OT_MESHCOP_TLV_COUNT

malha de contagem de TLV

OT_MESHCOP_TLV_DELAYTIMER

TLV do timer de atraso da meshcop

OT_MESHCOP_TLV_DISCOVERYREQUEST

TLV da solicitação de descoberta da meshcop

OT_MESHCOP_TLV_DISCOVERYRESPONSE

TLV da resposta de descoberta da meshcop

OT_MESHCOP_TLV_ENERGY_LIST

TLV da rede de energia meshcop

OT_MESHCOP_TLV_EXTPANID

TLV do código estendido de malhacop

OT_MESHCOP_TLV_GET

meshcop Receba TLV

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

TLV do endereço IPv6 da malhacop

OT_MESHCOP_TLV_JOINERADVERTISEMENT

TLV de publicidade de junção de malhacop

OT_MESHCOP_TLV_JOINER_DTLS

Malha DTLS Encapsulation TLV

OT_MESHCOP_TLV_JOINER_IID

Combinador de malha IID TLV

OT_MESHCOP_TLV_JOINER_RLOC

TLV do localizador de roteador de junçãor meshcop

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

Malha roteador roteador KEK TLV

OT_MESHCOP_TLV_JOINER_UDP_PORT

TLV da porta UDP conjunta da malhacop

OT_MESHCOP_TLV_MESHLOCALPREFIX

TLV do prefixo local da malha meshcop

OT_MESHCOP_TLV_NETWORKKEY

Chave de rede TLV da malhacop

OT_MESHCOP_TLV_NETWORKNAME

TLV do nome da rede meshcop

OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE

TLV da sequência de chaves de rede da meshcop

OT_MESHCOP_TLV_PANID

meshcop Id do painel TLV

OT_MESHCOP_TLV_PENDINGTIMESTAMP

TLV de carimbo de data/hora pendente da meshcop

OT_MESHCOP_TLV_PERIOD

TLV do período meshcop

OT_MESHCOP_TLV_PROVISIONING_URL

TLV de provisionamento do meshcop

OT_MESHCOP_TLV_PSKC

meshcop PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

TLV de duração da verificação do meshcop

OT_MESHCOP_TLV_SECURITYPOLICY

TLV da política de segurança da meshcop

OT_MESHCOP_TLV_STATE

Malha estado TLV

OT_MESHCOP_TLV_STEERING_DATA

TLV de dados da direção de malhacop

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

TLV de encapsulamento UDP mesh Mesh

OT_MESHCOP_TLV_VENDOR_DATA_TLV

TLV de dados do fornecedor da meshcop

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

TLV do modelo de fornecedores do meshcop

OT_MESHCOP_TLV_VENDOR_NAME_TLV

TLV do nome do fornecedor da meshcop

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

TLV da versão do stack de fornecedores do meshcop

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

TLV da versão SW do fornecedor de meshcop

Typedefs

Máscara de canal

uint32_t otChannelMask

Esse tipo representa a máscara de canal.

otDatasetMgmtSetCallback

void(* otDatasetMgmtSetCallback)(otError aResult, void *aContext)

Esse ponteiro de função é chamado quando uma resposta a uma solicitação MGMT_SET é recebida ou expira.

Detalhes
Parâmetros
[in] aResult
Um resultado da operação.
[in] aContext
Um ponteiro para contexto específico do aplicativo.
Valores de retorno
OT_ERROR_NONE
A solicitação foi aceita pelo líder.
OT_ERROR_REJECTED
A solicitação foi rejeitada pelo líder.
OT_ERROR_PARSE
Ocorreu um erro ao analisar a resposta.
OT_ERROR_ABORT
A solicitação foi redefinida por peering.
OT_ERROR_RESPONSE_TIMEOUT
Nenhuma resposta ou confirmação foi recebida durante o período de tempo limite.

OtDatasetUpdaterCallback

void(* otDatasetUpdaterCallback)(otError aError, void *aContext)

Esse ponteiro de função de callback é chamado quando uma solicitação de atualização do conjunto de dados é concluída, informando o status de conclusão ou falha da solicitação de atualização do conjunto de dados.

Detalhes
Parâmetros
[in] aError
É o status do erro. OT_ERROR_NONE indica que o conjunto de dados foi atualizado. OT_ERROR_INVALID_STATE indica falha devido a um estado inválido (o MLE está desativado). OT_ERROR_ALREADY indica falha devido a outro dispositivo na rede que está solicitando uma atualização do conjunto de dados conflitante.
[in] aContext
Um ponteiro para o contexto arbitrário (fornecido pelo usuário em otDatasetUpdaterRequestUpdate()).

OtExtendedPanId

struct otExtendedPanId otExtendedPanId

Essa estrutura representa um código do PAN estendido.

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

Essa estrutura representa um prefixo local de malha.

OtMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

Esta enumeração representa tipos de TLV da malhacop.

Chave de rede

struct otNetworkKey otNetworkKey

Essa estrutura representa uma chave de rede Thread.

OtKeyKeyRef

otCryptoKeyRef otNetworkKeyRef

Esse tipo de dados representa KeyRef para NetworkKey.

Referência à chave

Nome da rede

struct otNetworkName otNetworkName

Essa estrutura representa um nome de rede.

O otNetworkName é uma string em C terminada nulo (ou seja, m8 matriz de caracteres PRECISA terminar com um caractere \0.

otOperationalDataset

struct otOperationalDataset otOperationalDataset

Essa estrutura representa um conjunto de dados operacional ativo ou pendente.

Os componentes do conjunto de dados são opcionais. A estrutura mComponets especifica quais componentes estão presentes no conjunto de dados.

otOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

Essa estrutura representa a presença de diferentes componentes no conjunto de dados operacional ativo ou pendente.

OtOperationalDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

Essa estrutura representa um conjunto de dados operacional ativo ou pendente.

O conjunto de dados operacional é TLV codificado conforme especificado pela Thread.

OtPskc

struct otPskc otPskc

Essa estrutura representa um PSKc.

OtPskcRef

otCryptoKeyRef otPskcRef

Esse tipo de dados representa KeyRef para PSKc.

Referência à chave

Política de segurança

struct otSecurityPolicy otSecurityPolicy

Essa estrutura representa a política de segurança.

OtTimestamp

struct otTimestamp otTimestamp

Essa estrutura representa um componente de carimbo de data/hora do conjunto de dados da linha de execução.

Variables

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

Functions

OtDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Esse método cria um novo conjunto de dados operacional a ser usado ao formar uma nova rede.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aDataset
O conjunto de dados operacional.
Valores de retorno
OT_ERROR_NONE
Um novo conjunto de dados operacional foi criado.
OT_ERROR_FAILED
Falha ao gerar valores aleatórios para novos parâmetros.

OtDatasetGeneratePskc

otError otDatasetGeneratePskc(
  const char *aPassPhrase,
  const otNetworkName *aNetworkName,
  const otExtendedPanId *aExtPanId,
  otPskc *aPskc
)

Essa função gera PSKc a partir de uma determinada senha longa, nome de rede e ID do PAN estendido.

A PSKc é usada para estabelecer a sessão do comissário.

Detalhes
Parâmetros
[in] aPassPhrase
A frase-senha de comissionamento.
[in] aNetworkName
O nome da rede para computação PSKc.
[in] aExtPanId
O código PAN estendido para computação PSKc.
[out] aPskc
Um ponteiro para variável que gera o PSKc gerado.
Valores de retorno
OT_ERROR_NONE
O PSKc foi gerado.
OT_ERROR_INVALID_ARGS
Se algum dos argumentos de entrada for inválido.

OtDatasetGetActive

otError otDatasetGetActive(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Essa função recebe o conjunto de dados operacional ativo.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aDataset
Um ponteiro para colocar o conjunto de dados operacional ativo.
Valores de retorno
OT_ERROR_NONE
Conjunto operacional do conjunto de dados ativo recuperado.
OT_ERROR_NOT_FOUND
Nenhum valor correspondente no armazenamento de configuração.

OtDatasetGetActiveTlvs

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Essa função recebe o conjunto de dados operacional ativo.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aDataset
Um ponteiro para colocar o conjunto de dados operacional ativo.
Valores de retorno
OT_ERROR_NONE
Conjunto operacional do conjunto de dados ativo recuperado.
OT_ERROR_NOT_FOUND
Nenhum valor correspondente no armazenamento de configuração.

otDatasetGetDelayTimerMinimum

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

Receba um timer de atraso mínimo.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
the
valor de timer de atraso mínimo (em ms)

OtDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Esta função recebe o conjunto de dados operacional pendente.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aDataset
Um ponteiro para onde o conjunto de dados operacional pendente será colocado.
Valores de retorno
OT_ERROR_NONE
O conjunto de dados operacional pendente foi recuperado.
OT_ERROR_NOT_FOUND
Nenhum valor correspondente no armazenamento de configuração.

OtDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Esta função recebe o conjunto de dados operacional pendente.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aDataset
Um ponteiro para onde o conjunto de dados operacional pendente será colocado.
Valores de retorno
OT_ERROR_NONE
O conjunto de dados operacional pendente foi recuperado.
OT_ERROR_NOT_FOUND
Nenhum valor correspondente no armazenamento de configuração.

OtDatasetIsCommissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

Esta função indica se uma rede válida está presente no conjunto de dados operacional ativo ou não.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Verdadeiro se houver uma rede válida no conjunto de dados operacional ativo. Caso contrário, será FALSO.

OtDatasetParseTlvs

otError otDatasetParseTlvs(
  const otOperationalDatasetTlvs *aDatasetTlvs,
  otOperationalDataset *aDataset
)

Essa função analisa um conjunto de dados operacional de um otOperationalDatasetTlvs.

Detalhes
Parâmetros
[in] aDatasetTlvs
Um ponteiro para TLVs de conjunto de dados.
[out] aDataset
Um ponteiro para colocar o conjunto de dados.
Valores de retorno
OT_ERROR_NONE
O aDataset foi definido em aDatasetTlvs.
OT_ERROR_INVALID_ARGS
aDatasetTlvs não é uma entrada válida.

OtDatasetSendMgmtActiveGet

otError otDatasetSendMgmtActiveGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

Essa função envia MGMT_ACTIVE_GET.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDatasetComponents
Um ponteiro para uma estrutura de componentes do conjunto de dados que especifica quais componentes solicitar.
[in] aTlvTypes
Um ponteiro para matriz contendo outros tipos de TLV brutos a serem solicitados.
[in] aLength
O comprimento de aTlvTypes.
[in] aAddress
Um ponteiro para o destino IPv6, se for NULL, usará o ALOC líder como padrão.
Valores de retorno
OT_ERROR_NONE
O comando do conjunto de dados meshcop foi enviado.
OT_ERROR_NO_BUFS
Espaço para buffer insuficiente para envio.

conjunto de dadosOtDatasetSendMgmtActiveSet

otError otDatasetSendMgmtActiveSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

Essa função envia MGMT_ACTIVE_SET.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDataset
Um ponteiro para conjunto de dados operacional.
[in] aTlvs
Um ponteiro para TLVs.
[in] aLength
O comprimento dos TLVs.
[in] aCallback
Um ponteiro para uma função chamada na recepção da resposta ou no tempo limite.
[in] aContext
Um ponteiro para o contexto específico do aplicativo para aCallback.
Valores de retorno
OT_ERROR_NONE
O comando do conjunto de dados meshcop foi enviado.
OT_ERROR_NO_BUFS
Espaço para buffer insuficiente para envio.
OT_ERROR_BUSY
Uma solicitação anterior está em andamento.

OtDatasetSendMgmtPendingGet

otError otDatasetSendMgmtPendingGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

Essa função envia MGMT_PENDING_GET.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDatasetComponents
Um ponteiro para uma estrutura de componentes do conjunto de dados que especifica quais componentes solicitar.
[in] aTlvTypes
Um ponteiro para matriz contendo outros tipos de TLV brutos a serem solicitados.
[in] aLength
O comprimento de aTlvTypes.
[in] aAddress
Um ponteiro para o destino IPv6, se for NULL, usará o ALOC líder como padrão.
Valores de retorno
OT_ERROR_NONE
O comando do conjunto de dados meshcop foi enviado.
OT_ERROR_NO_BUFS
Espaço para buffer insuficiente para envio.

otDatasetSendMgmtPendingSet

otError otDatasetSendMgmtPendingSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

Essa função envia MGMT_PENDING_SET.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDataset
Um ponteiro para conjunto de dados operacional.
[in] aTlvs
Um ponteiro para TLVs.
[in] aLength
O comprimento dos TLVs.
[in] aCallback
Um ponteiro para uma função chamada na recepção da resposta ou no tempo limite.
[in] aContext
Um ponteiro para o contexto específico do aplicativo para aCallback.
Valores de retorno
OT_ERROR_NONE
O comando do conjunto de dados meshcop foi enviado.
OT_ERROR_NO_BUFS
Espaço para buffer insuficiente para envio.
OT_ERROR_BUSY
Uma solicitação anterior está em andamento.

conjunto de dados otDataset

otError otDatasetSetActive(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

Essa função define o conjunto de dados operacional ativo.

Se o conjunto de dados não incluir um carimbo de data/hora ativo, ele estará apenas parcialmente completo.

Se a linha de execução estiver ativada em um dispositivo que tem um conjunto de dados ativo parcialmente completo, o dispositivo tentará se conectar a uma rede Thread existente usando qualquer informação existente no conjunto de dados. Apenas a chave de rede Thread é necessária para anexar a uma rede.

Se o canal não estiver incluído no conjunto de dados, o dispositivo enviará mensagens de anúncio de MLE em diferentes canais para encontrar vizinhos em outros canais.

Se o dispositivo for conectado a uma rede Thread, o conjunto de dados ativo completo do pai será recuperado. Observe que um dispositivo compatível com roteador não fará a transição para os papéis de roteador ou líder até que tenha um conjunto de dados ativo completo.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDataset
Um ponteiro para o conjunto de dados operacional ativo.
Valores de retorno
OT_ERROR_NONE
O conjunto de dados operacional ativo foi definido com sucesso.
OT_ERROR_NO_BUFS
Espaço em buffer insuficiente para definir o conjunto de dados operacional ativo.
OT_ERROR_NOT_IMPLEMENTED
A plataforma não implementa a funcionalidade de configurações.

OtDatasetSetActiveTlvs

otError otDatasetSetActiveTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

Essa função define o conjunto de dados operacional ativo.

Se o conjunto de dados não incluir um carimbo de data/hora ativo, ele estará apenas parcialmente completo.

Se a linha de execução estiver ativada em um dispositivo que tem um conjunto de dados ativo parcialmente completo, o dispositivo tentará se conectar a uma rede Thread existente usando qualquer informação existente no conjunto de dados. Apenas a chave de rede Thread é necessária para anexar a uma rede.

Se o canal não estiver incluído no conjunto de dados, o dispositivo enviará mensagens de anúncio de MLE em diferentes canais para encontrar vizinhos em outros canais.

Se o dispositivo for conectado a uma rede Thread, o conjunto de dados ativo completo do pai será recuperado. Observe que um dispositivo compatível com roteador não fará a transição para os papéis de roteador ou líder até que tenha um conjunto de dados ativo completo.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDataset
Um ponteiro para o conjunto de dados operacional ativo.
Valores de retorno
OT_ERROR_NONE
O conjunto de dados operacional ativo foi definido com sucesso.
OT_ERROR_NO_BUFS
Espaço em buffer insuficiente para definir o conjunto de dados operacional ativo.
OT_ERROR_NOT_IMPLEMENTED
A plataforma não implementa a funcionalidade de configurações.

conjunto de dados otDatasetSetDelayTimerMinimum

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

Defina um timer de atraso mínimo.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDelayTimerMinimal
O valor do timer de atraso mínimo (em ms).
Valores de retorno
OT_ERROR_NONE
O timer de atraso mínimo foi definido.
OT_ERROR_INVALID_ARGS
Se aDelayTimerMinimal não for válido.

OtDatasetSetPending

otError otDatasetSetPending(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

Esta função define o conjunto de dados operacional pendente.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDataset
Um ponteiro para o conjunto de dados operacional pendente.
Valores de retorno
OT_ERROR_NONE
O conjunto de dados operacional pendente foi definido.
OT_ERROR_NO_BUFS
Espaço em buffer insuficiente para definir o conjunto de dados operacional pendente.
OT_ERROR_NOT_IMPLEMENTED
A plataforma não implementa a funcionalidade de configurações.

OtDatasetSetPendingTlvs

otError otDatasetSetPendingTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

Esta função define o conjunto de dados operacional pendente.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDataset
Um ponteiro para o conjunto de dados operacional pendente.
Valores de retorno
OT_ERROR_NONE
O conjunto de dados operacional pendente foi definido.
OT_ERROR_NO_BUFS
Espaço em buffer insuficiente para definir o conjunto de dados operacional pendente.
OT_ERROR_NOT_IMPLEMENTED
A plataforma não implementa a funcionalidade de configurações.

OtDatasetUpdaterCancelUpdate

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

Essa função cancela uma solicitação de atualização de conjunto de dados operacional em andamento (se houver).

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

OtDatasetUpdaterIsUpdateOngoing

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

Essa função indica se há uma solicitação de atualização do conjunto de dados de operação em andamento.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
TRUE
Há uma atualização em andamento.
FALSE
Não há atualização em andamento.

OtDatasetUpdaterRequestUpdate

otError otDatasetUpdaterRequestUpdate(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  otDatasetUpdaterCallback aCallback,
  void *aContext
)

Esta função solicita uma atualização do conjunto de dados operacional.

aDataset precisa conter os campos a serem atualizados e o novo valor. Ela não pode conter campos de carimbo de data/hora ativos ou pendentes. O campo Delay é opcional, se não for fornecido um valor padrão (1000 ms) será usado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDataset
Um ponteiro para o conjunto de dados que contém os campos a serem alterados.
[in] aCallback
Um callback para indicar quando a solicitação de atualização do conjunto de dados termina.
[in] aContext
Um contexto arbitrário transmitido para o callback.
Valores de retorno
OT_ERROR_NONE
Atualização do conjunto de dados iniciada (aCallback será invocado na conclusão).
OT_ERROR_INVALID_STATE
O dispositivo está desativado (o MLE está desativado).
OT_ERROR_INVALID_ARGS
O aDataset não é válido (contém carimbo de data/hora ativo ou pendente).
OT_ERROR_BUSY
Não é possível iniciar a atualização. Uma anterior está em andamento.
OT_ERROR_NO_BUFS
Não foi possível alocar o buffer para salvar o conjunto de dados.

OtNetworkNameFromString

otError otNetworkNameFromString(
  otNetworkName *aNetworkName,
  const char *aNameString
)

Essa função define uma instância de otNetworkName de uma determinada string C encerrada.

Essa função também valida se o aNameString fornecido segue a codificação UTF-8 e o comprimento não é maior que OT_NETWORK_NAME_MAX_SIZE.

Detalhes
Parâmetros
[out] aNetworkName
Um ponteiro para a otNetworkName a ser definida.
[in] aNameString
Uma string de nome C.
Valores de retorno
OT_ERROR_NONE
O aNetworkName foi definido em aNameString.
OT_ERROR_INVALID_ARGS
aNameStrng é inválido (muito longo ou não segue a codificação UTF-8).

Macros

OT_CAN_10_MASK

 OT_CHANNEL_10_MASK (1 << 10)

Canal 10.

OT_CAN_11_MASK

 OT_CHANNEL_11_MASK (1 << 11)

Canal 11.

OT_CAN_12_MASK

 OT_CHANNEL_12_MASK (1 << 12)

Canal 12.

OT_CAN_13_MASK

 OT_CHANNEL_13_MASK (1 << 13)

Canal 13.

OT_CAN_14_MASK

 OT_CHANNEL_14_MASK (1 << 14)

Canal 14.

OT_CAN_15_MASK

 OT_CHANNEL_15_MASK (1 << 15)

Canal 15.

OT_CAN_16_MASK

 OT_CHANNEL_16_MASK (1 << 16)

Canal 16.

OT_CAN_17_MASK

 OT_CHANNEL_17_MASK (1 << 17)

Canal 17.

OT_CHANNEL_18_MASK

 OT_CHANNEL_18_MASK (1 << 18)

Canal 18.

OT_CHANNEL_19_MASK

 OT_CHANNEL_19_MASK (1 << 19)

Canal 19.

OT_CAN_1_MASK

 OT_CHANNEL_1_MASK (1 << 1)

Canal 1.

OT_CAN_20_MASK

 OT_CHANNEL_20_MASK (1 << 20)

Canal 20.

OT_CAN_21_MASK

 OT_CHANNEL_21_MASK (1 << 21)

Canal 21.

OT_CHANNEL_22_MASK

 OT_CHANNEL_22_MASK (1 << 22)

Canal 22.

OT_CHANNEL_23_MASK

 OT_CHANNEL_23_MASK (1 << 23)

Canal 23.

OT_CHANNEL_24_MASK

 OT_CHANNEL_24_MASK (1 << 24)

Canal 24.

OT_CHANNEL_25_MASK

 OT_CHANNEL_25_MASK (1 << 25)

Canal 25.

OT_CHANNEL_26_MASK

 OT_CHANNEL_26_MASK (1 << 26)

Canal 26.

OT_CAN_2_MASK

 OT_CHANNEL_2_MASK (1 << 2)

Canal 2.

OT_CAN_3_MASK

 OT_CHANNEL_3_MASK (1 << 3)

Canal 3.

OT_CHANNEL_4_MASK

 OT_CHANNEL_4_MASK (1 << 4)

Canal 4.

OT_CHANNEL_5_MASK

 OT_CHANNEL_5_MASK (1 << 5)

Canal 5.

OT_CHANNEL_6_MASK

 OT_CHANNEL_6_MASK (1 << 6)

Canal 6.

OT_CHANNEL_7_MASK

 OT_CHANNEL_7_MASK (1 << 7)

Canal 7.

OT_CHANNEL_8_MASK

 OT_CHANNEL_8_MASK (1 << 8)

Canal 8.

OT_CHANNEL_9_MASK

 OT_CHANNEL_9_MASK (1 << 9)

Canal 9.

OT_EXT_PAN_ID_SIZE

 OT_EXT_PAN_ID_SIZE 8

Tamanho de um ID do PAN de linhas de execução (bytes)

OT_MESH_LOCAL_PREFIX_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

Tamanho do prefixo local de malha (bytes)

OT_NETWORK_KEY_SIZE

 OT_NETWORK_KEY_SIZE 16

Tamanho da chave de rede Thread (bytes)

OT_NETWORK_NAME_MAX_SIZE

 OT_NETWORK_NAME_MAX_SIZE 16

Tamanho máximo do campo "Nome da rede da conversa" (bytes)

OT_OperationAL_DATASET_MAX_LENGTH

 OT_OPERATIONAL_DATASET_MAX_LENGTH 254

Tamanho máximo do conjunto de dados operacional em bytes.

OT_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

Tamanho máximo do PSKc (bytes)

Recursos

Os tópicos de referência da API OpenThread são originados do código-fonte, disponível no GitHub. Para saber mais ou contribuir com nossa documentação, consulte Recursos.