Esta página foi traduzida pela API Cloud Translation.

Em geral

Este módulo inclui funções para todas as funções de Thread.

Resumo

O Network Data Publisher fornece mecanismos para limitar o número de entradas semelhantes de Serviço e/ou Prefixo (prefixo na malha ou rota externa) nos Dados de Rede de Encadeamento, monitorando os Dados de Rede e gerenciando se ou quando adicionar ou remover entradas.

Todas as funções deste módulo requerem que OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE esteja habilitada.

Nota: As funções neste módulo requerem OPENTHREAD_FTD=1 ou OPENTHREAD_MTD=1 .

Enumerações
anonymous enum { OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS = 0, OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS = 1, OT_NETWORK_DIAGNOSTIC_TLV_MODE = 2, OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT = 3, OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY = 4, OT_NETWORK_DIAGNOSTIC_TLV_ROUTE = 5, OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA = 6, OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA = 7, OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST = 8, OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS = 9, OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL = 14, OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE = 15, OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE = 16, OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES = 17, OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST = 18, OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT = 19 }	enumerar
`otDeviceRole { OT_DEVICE_ROLE_DISABLED = 0, OT_DEVICE_ROLE_DETACHED = 1, OT_DEVICE_ROLE_CHILD = 2, OT_DEVICE_ROLE_ROUTER = 3, OT_DEVICE_ROLE_LEADER = 4 }`	enumerar Representa uma função de dispositivo Thread.
`otNetDataPublisherEvent { OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0, OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1 }`	enumerar Essa enumeração representa os eventos relatados dos retornos de chamada do Publicador.
`otRoutePreference { OT_ROUTE_PREFERENCE_LOW = -1, OT_ROUTE_PREFERENCE_MED = 0, OT_ROUTE_PREFERENCE_HIGH = 1 }`	enumerar Define valores válidos para `mPreference` em `otExternalRouteConfig` e `otBorderRouterConfig` .

Typedefs
`otBorderRouterConfig`	typedef `struct otBorderRouterConfig` Essa estrutura representa uma configuração do Border Router.
`otExternalRouteConfig`	typedef `struct otExternalRouteConfig` Essa estrutura representa uma configuração de Rota Externa.
`otIpCounters`	typedef `struct otIpCounters` Essa estrutura representa os contadores de nível IP.
`otLeaderData`	typedef `struct otLeaderData` Essa estrutura representa os dados do líder de thread.
`otLinkModeConfig`	typedef `struct otLinkModeConfig` Essa estrutura representa uma configuração de modo de link MLE.
`otMleCounters`	typedef `struct otMleCounters` Essa estrutura representa os contadores Thread MLE.
`otNeighborInfoIterator`	typedef `int16_t` Usado para iterar através da tabela vizinha.
`otNetDataDnsSrpServicePublisherCallback )(otNetDataPublisherEvent aEvent, void *aContext)`	typedef `void(*` Esse tipo de ponteiro de função define o retorno de chamada usado para notificar quando uma entrada "Serviço DNS/SRP" é adicionada ou removida dos Dados de Rede de Encadeamento.
`otNetDataPrefixPublisherCallback )(otNetDataPublisherEvent aEvent, const otIp6Prefix aPrefix, void aContext)`	typedef `void(*` Esse tipo de ponteiro de função define o retorno de chamada usado para notificar quando uma entrada de prefixo (na malha ou rota externa) é adicionada ou removida dos dados de rede de thread.
`otNetDataPublisherEvent`	typedef `enum otNetDataPublisherEvent` Essa enumeração representa os eventos relatados dos retornos de chamada do Publicador.
`otNetworkDataIterator`	typedef `uint32_t` Usado para iterar pelas informações de dados de rede.
`otNetworkDiagChildEntry`	typedef `struct otNetworkDiagChildEntry` Essa estrutura representa uma entrada de tabela filho de diagnóstico de rede.
`otNetworkDiagConnectivity`	typedef `struct otNetworkDiagConnectivity` Essa estrutura representa um valor de conectividade de diagnóstico de rede.
`otNetworkDiagIterator`	typedef `uint16_t` Usado para iterar por meio do TLV de diagnóstico de rede.
`otNetworkDiagMacCounters`	typedef `struct otNetworkDiagMacCounters` Essa estrutura representa um valor de contadores Mac de diagnóstico de rede.
`otNetworkDiagRoute`	typedef `struct otNetworkDiagRoute` Essa estrutura representa um valor TLV da Rota de Diagnóstico de Rede.
`otNetworkDiagRouteData`	typedef `struct otNetworkDiagRouteData` Essa estrutura representa os dados de uma rota de diagnóstico de rede.
`otNetworkDiagTlv`	typedef `struct otNetworkDiagTlv` Essa estrutura representa um TLV de diagnóstico de rede.
`otReceiveDiagnosticGetCallback )(otError aError, otMessage aMessage, const otMessageInfo aMessageInfo, void *aContext)`	typedef `void(*` Esse ponteiro de função é chamado quando a resposta de obtenção de diagnóstico de rede é recebida.
`otRoutePreference`	typedef `enum otRoutePreference` Define valores válidos para `mPreference` em `otExternalRouteConfig` e `otBorderRouterConfig` .
`otServerConfig`	typedef `struct otServerConfig` Esta estrutura representa uma configuração do Servidor.
`otServiceConfig`	typedef `struct otServiceConfig` Essa estrutura representa uma configuração de serviço.
`otThreadAnycastLocatorCallback )(void aContext, otError aError, const otIp6Address aMeshLocalAddress, uint16_t aRloc16)`	typedef `void(*` Esse tipo de ponteiro de função define o retorno de chamada para notificar o resultado de uma solicitação `otThreadLocateAnycastDestination()` .
`otThreadDiscoveryRequestCallback )(const otThreadDiscoveryRequestInfo aInfo, void aContext)`	typedef `void(*` Esse ponteiro de função é chamado toda vez que uma mensagem de solicitação de descoberta MLE é recebida.
`otThreadDiscoveryRequestInfo`	typedef `struct otThreadDiscoveryRequestInfo` Essa estrutura representa os dados de solicitação de descoberta de thread.
`otThreadParentResponseCallback )(otThreadParentResponseInfo aInfo, void aContext)`	typedef `void(*` Este ponteiro de função é chamado toda vez que uma mensagem MLE Parent Response é recebida.
`otThreadParentResponseInfo`	typedef `struct otThreadParentResponseInfo` Essa estrutura representa os dados de resposta do pai MLE.

Funções
`otNetDataContainsOmrPrefix ( otInstance aInstance, const otIp6Prefix aPrefix)`	`bool` Esta função verifica se um determinado prefixo pode atuar como um prefixo OMR válido e também se os dados de rede do líder contêm esse prefixo.
`otNetDataGet ( otInstance aInstance, bool aStable, uint8_t aData, uint8_t *aDataLength)`	`otError` Este método fornece uma cópia completa ou estável dos dados de rede de thread da partição.
`otNetDataGetNextOnMeshPrefix ( otInstance aInstance, otNetworkDataIterator aIterator, otBorderRouterConfig *aConfig)`	`otError` Esta função obtém o próximo prefixo On Mesh nos dados de rede da partição.
`otNetDataGetNextRoute ( otInstance aInstance, otNetworkDataIterator aIterator, otExternalRouteConfig *aConfig)`	`otError` Esta função obtém a próxima rota externa nos Dados de Rede da partição.
`otNetDataGetNextService ( otInstance aInstance, otNetworkDataIterator aIterator, otServiceConfig *aConfig)`	`otError` Esta função obtém o próximo serviço nos Dados de Rede da partição.
`otNetDataGetStableVersion ( otInstance *aInstance)`	`uint8_t` Obtenha a versão de dados de rede estável.
`otNetDataGetVersion ( otInstance *aInstance)`	`uint8_t` Obtenha a versão de dados de rede.
`otNetDataIsDnsSrpServiceAdded ( otInstance *aInstance)`	`bool` Esta função indica se a entrada "Serviço DNS/SRP" está ou não adicionada aos Dados de Rede de Thread.
`otNetDataIsPrefixAdded ( otInstance aInstance, const otIp6Prefix aPrefix)`	`bool` Esta função indica se uma entrada de prefixo publicada atualmente (em malha ou rota externa) é adicionada aos Dados de Rede de Thread.
`otNetDataPublishDnsSrpServiceAnycast ( otInstance *aInstance, uint8_t aSequenceNUmber)`	`void` Esta função solicita que o "Endereço Anycast do Serviço DNS/SRP" seja publicado nos Dados da Rede de Encadeamento.
`otNetDataPublishDnsSrpServiceUnicast ( otInstance aInstance, const otIp6Address aAddress, uint16_t aPort)`	`void` Esta função solicita que o "endereço unicast de serviço DNS/SRP" seja publicado nos dados de rede de thread.
`otNetDataPublishDnsSrpServiceUnicastMeshLocalEid ( otInstance *aInstance, uint16_t aPort)`	`void` Esta função solicita que o "endereço unicast de serviço DNS/SRP" seja publicado nos dados de rede de thread.
`otNetDataPublishExternalRoute ( otInstance aInstance, const otExternalRouteConfig aConfig)`	`otError` Esta função solicita que um prefixo de rota externa seja publicado nos Dados da Rede de Encadeamento.
`otNetDataPublishOnMeshPrefix ( otInstance aInstance, const otBorderRouterConfig aConfig)`	`otError` Esta função solicita que um prefixo na malha seja publicado nos Dados da Rede de Encadeamento.
`otNetDataSetDnsSrpServicePublisherCallback ( otInstance aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void aContext)`	`void` Essa função define um retorno de chamada para notificar quando um "Serviço DNS/SRP" publicado é realmente adicionado ou removido dos Dados de Rede de Encadeamento.
`otNetDataSetPrefixPublisherCallback ( otInstance aInstance, otNetDataPrefixPublisherCallback aCallback, void aContext)`	`void` Essa função define um retorno de chamada para notificar quando uma entrada de prefixo publicada é realmente adicionada ou removida dos dados de rede de thread.
`otNetDataSteeringDataCheckJoiner ( otInstance aInstance, const otExtAddress aEui64)`	`otError` Verifique se os dados de direção incluem um Joiner.
`otNetDataSteeringDataCheckJoinerWithDiscerner ( otInstance aInstance, const struct otJoinerDiscerner aDiscerner)`	`otError` Verifique se os dados de direção incluem um Joiner com um determinado valor de discernimento.
`otNetDataUnpublishDnsSrpService ( otInstance *aInstance)`	`void` Esta função cancela a publicação de qualquer entrada "Serviço DNS/SRP (Anycast ou Unicast)" adicionada anteriormente dos Dados de Rede de Encadeamento.
`otNetDataUnpublishPrefix ( otInstance aInstance, const otIp6Prefix aPrefix)`	`otError` Esta função cancela a publicação de um prefixo publicado anteriormente (on-mesh ou rota externa).
`otThreadBecomeChild ( otInstance *aInstance)`	`otError` Tente reconectar como uma criança.
`otThreadBecomeDetached ( otInstance *aInstance)`	`otError` Desconecte-se da rede Thread.
`otThreadDeviceRoleToString ( otDeviceRole aRole)`	`const char *` Converta a função do dispositivo em uma string legível.
`otThreadDiscover ( otInstance aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void aCallbackContext)`	`otError` Esta função inicia uma varredura de descoberta de thread.
`otThreadGetChildTimeout ( otInstance *aInstance)`	`uint32_t` Obtenha o Thread Child Timeout usado ao operar na função Child.
`otThreadGetDeviceRole ( otInstance *aInstance)`	`otDeviceRole` Obtenha a função de dispositivo.
`otThreadGetDomainName ( otInstance *aInstance)`	`const char *` Obtenha o nome de domínio do thread.
`otThreadGetExtendedPanId ( otInstance *aInstance)`	`const otExtendedPanId *` Obtenha o IEEE 802.15.4 Extended PAN ID.
`otThreadGetFixedDuaInterfaceIdentifier ( otInstance *aInstance)`	`const otIp6InterfaceIdentifier *` Obtenha o Identificador de Interface especificado manualmente para o Endereço Unicast de Domínio de Encadeamento.
`otThreadGetIp6Counters ( otInstance *aInstance)`	`const otIpCounters *` Obtenha os contadores IPv6.
`otThreadGetKeySequenceCounter ( otInstance *aInstance)`	`uint32_t` Obtenha o thrKeySequenceCounter.
`otThreadGetKeySwitchGuardTime ( otInstance *aInstance)`	`uint32_t` Obtenha o thrKeySwitchGuardTime.
`otThreadGetLeaderData ( otInstance aInstance, otLeaderData aLeaderData)`	`otError` Esta função obtém os dados do líder da linha.
`otThreadGetLeaderRloc ( otInstance aInstance, otIp6Address aLeaderRloc)`	`otError` Esta função retorna um ponteiro para o RLOC do Líder.
`otThreadGetLeaderRouterId ( otInstance *aInstance)`	`uint8_t` Obtenha o ID do roteador do líder.
`otThreadGetLeaderWeight ( otInstance *aInstance)`	`uint8_t` Obtenha o Peso do Líder.
`otThreadGetLinkLocalAllThreadNodesMulticastAddress ( otInstance *aInstance)`	`const otIp6Address *` Esta função retorna o endereço multicast de todos os nós de thread locais de link de thread.
`otThreadGetLinkLocalIp6Address ( otInstance *aInstance)`	`const otIp6Address *` Esta função retorna o endereço IPv6 local de link de thread.
`otThreadGetLinkMode ( otInstance *aInstance)`	`otLinkModeConfig` Obtenha a configuração do modo de link MLE.
`otThreadGetMeshLocalEid ( otInstance *aInstance)`	`const otIp6Address *` Esta função retorna um ponteiro para o endereço do Mesh Local EID.
`otThreadGetMeshLocalPrefix ( otInstance *aInstance)`	`const otMeshLocalPrefix *` Esta função retorna um ponteiro para o prefixo local da malha.
`otThreadGetMleCounters ( otInstance *aInstance)`	`const otMleCounters *` Obtenha os contadores Thread MLE.
`otThreadGetNetworkKey ( otInstance aInstance, otNetworkKey aNetworkKey)`	`void` Obtenha a chave de rede do thread.
`otThreadGetNetworkKeyRef ( otInstance *aInstance)`	`otNetworkKeyRef` Obtenha o `otNetworkKeyRef` para a chave de rede de thread.
`otThreadGetNetworkName ( otInstance *aInstance)`	`const char *` Obtenha o nome da rede do thread.
`otThreadGetNextDiagnosticTlv (const otMessage aMessage, otNetworkDiagIterator aIterator, otNetworkDiagTlv *aNetworkDiagTlv)`	`otError` Essa função obtém o próximo TLV de diagnóstico de rede na mensagem.
`otThreadGetNextNeighborInfo ( otInstance aInstance, otNeighborInfoIterator aIterator, otNeighborInfo *aInfo)`	`otError` Esta função obtém as informações do próximo vizinho.
`otThreadGetParentAverageRssi ( otInstance aInstance, int8_t aParentRssi)`	`otError` A função recupera o RSSI médio para o Thread Parent.
`otThreadGetParentInfo ( otInstance aInstance, otRouterInfo aParentInfo)`	`otError` A função recupera informações de diagnóstico para um Thread Router como pai.
`otThreadGetParentLastRssi ( otInstance aInstance, int8_t aLastRssi)`	`otError` A função recupera o RSSI do último pacote do Thread Parent.
`otThreadGetPartitionId ( otInstance *aInstance)`	`uint32_t` Obtenha o ID da partição.
`otThreadGetRealmLocalAllThreadNodesMulticastAddress ( otInstance *aInstance)`	`const otIp6Address *` Esta função retorna o endereço multicast do Thread Realm-Local All Thread Nodes.
`otThreadGetRloc ( otInstance *aInstance)`	`const otIp6Address *` Esta função retorna um ponteiro para o endereço do localizador de roteamento de thread (RLOC).
`otThreadGetRloc16 ( otInstance *aInstance)`	`uint16_t` Obtenha o RLOC16.
`otThreadGetServiceAloc ( otInstance aInstance, uint8_t aServiceId, otIp6Address aServiceAloc)`	`otError` Esta função recupera o serviço ALOC para determinado ID de serviço.
`otThreadGetVersion (void)`	`uint16_t` Esta função obtém a versão do protocolo Thread.
`otThreadIsAnycastLocateInProgress ( otInstance *aInstance)`	`bool` Esta função indica se uma solicitação de localização anycast está em andamento.
`otThreadIsDiscoverInProgress ( otInstance *aInstance)`	`bool` Esta função determina se uma descoberta de thread MLE está em andamento.
`otThreadIsSingleton ( otInstance *aInstance)`	`bool` Esta função indica se um nó é o único roteador na rede.
`otThreadLocateAnycastDestination ( otInstance aInstance, const otIp6Address aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)`	`otError` Esta função solicita que o destino mais próximo de um determinado endereço anycast seja localizado.
`otThreadRegisterParentResponseCallback ( otInstance aInstance, otThreadParentResponseCallback aCallback, void aContext)`	`void` Esta função registra um retorno de chamada para receber dados de resposta do pai MLE.
`otThreadResetIp6Counters ( otInstance *aInstance)`	`void` Redefina os contadores IPv6.
`otThreadResetMleCounters ( otInstance *aInstance)`	`void` Redefina os contadores de Thread MLE.
`otThreadSendAddressNotification ( otInstance aInstance, otIp6Address aDestination, otIp6Address aTarget, otIp6InterfaceIdentifier aMlIid)`	`void` Esta função envia uma mensagem de notificação de endereço proativo (ADDR_NTF.ntf).
`otThreadSendDiagnosticGet ( otInstance aInstance, const otIp6Address aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)`	`otError` Envie uma solicitação de obtenção de diagnóstico de rede.
`otThreadSendDiagnosticReset ( otInstance aInstance, const otIp6Address aDestination, const uint8_t aTlvTypes[], uint8_t aCount)`	`otError` Envie uma solicitação de redefinição de diagnóstico de rede.
`otThreadSendProactiveBackboneNotification ( otInstance aInstance, otIp6Address aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)`	`otError` Esta função envia uma mensagem Proactive Backbone Notification (PRO_BB.ntf) no link do Backbone.
`otThreadSetChildTimeout ( otInstance *aInstance, uint32_t aTimeout)`	`void` Defina o Thread Child Timeout usado ao operar na função Child.
`otThreadSetDiscoveryRequestCallback ( otInstance aInstance, otThreadDiscoveryRequestCallback aCallback, void aContext)`	`void` Esta função define um retorno de chamada para receber dados de solicitação de descoberta MLE.
`otThreadSetDomainName ( otInstance aInstance, const char aDomainName)`	`otError` Defina o nome de domínio do thread.
`otThreadSetEnabled ( otInstance *aInstance, bool aEnabled)`	`otError` Esta função inicia a operação do protocolo Thread.
`otThreadSetExtendedPanId ( otInstance aInstance, const otExtendedPanId aExtendedPanId)`	`otError` Defina o IEEE 802.15.4 Extended PAN ID.
`otThreadSetFixedDuaInterfaceIdentifier ( otInstance aInstance, const otIp6InterfaceIdentifier aIid)`	`otError` Defina/limpe o identificador de interface especificado manualmente para o endereço de difusão ponto a ponto de domínio.
`otThreadSetJoinerAdvertisement ( otInstance aInstance, uint32_t aOui, const uint8_t aAdvData, uint8_t aAdvDataLength)`	`otError` Este método define o anúncio do Thread Joiner ao descobrir a rede Thread.
`otThreadSetKeySequenceCounter ( otInstance *aInstance, uint32_t aKeySequenceCounter)`	`void` Defina o thrKeySequenceCounter.
`otThreadSetKeySwitchGuardTime ( otInstance *aInstance, uint32_t aKeySwitchGuardTime)`	`void` Defina o thrKeySwitchGuardTime.
`otThreadSetLinkMode ( otInstance *aInstance, otLinkModeConfig aConfig)`	`otError` Defina a configuração do modo de link MLE.
`otThreadSetMeshLocalPrefix ( otInstance aInstance, const otMeshLocalPrefix aMeshLocalPrefix)`	`otError` Esta função define o prefixo local da malha.
`otThreadSetNetworkKey ( otInstance aInstance, const otNetworkKey aKey)`	`otError` Defina a chave de rede do thread.
`otThreadSetNetworkKeyRef ( otInstance *aInstance, otNetworkKeyRef aKeyRef)`	`otError` Defina a chave de rede do thread como um `otNetworkKeyRef` .
`otThreadSetNetworkName ( otInstance aInstance, const char aNetworkName)`	`otError` Defina o nome da rede do thread.

Estruturas
otBorderRouterConfig	Essa estrutura representa uma configuração do Border Router.
otExternalRouteConfig	Essa estrutura representa uma configuração de Rota Externa.
otIpCounters	Essa estrutura representa os contadores de nível IP.
otLeaderData	Essa estrutura representa os dados do líder de thread.
otLinkModeConfig	Essa estrutura representa uma configuração de modo de link MLE.
otMleCounters	Essa estrutura representa os contadores Thread MLE.
otNeighborInfo	Essa estrutura contém informações de diagnóstico para um nó Thread vizinho.
otNetworkDiagChildEntry	Essa estrutura representa uma entrada de tabela filho de diagnóstico de rede.
otNetworkDiagConnectivity	Essa estrutura representa um valor de conectividade de diagnóstico de rede.
otNetworkDiagMacCounters	Essa estrutura representa um valor de contadores Mac de diagnóstico de rede.
otNetworkDiagRoute	Essa estrutura representa um valor TLV da Rota de Diagnóstico de Rede.
otNetworkDiagRouteData	Essa estrutura representa os dados de uma rota de diagnóstico de rede.
otNetworkDiagTlv	Essa estrutura representa um TLV de diagnóstico de rede.
otRouterInfo	Essa estrutura contém informações de diagnóstico para um Thread Router.
otServerConfig	Esta estrutura representa uma configuração do Servidor.
otServiceConfig	Essa estrutura representa uma configuração de serviço.
otThreadDiscoveryRequestInfo	Essa estrutura representa os dados de solicitação de descoberta de thread.
otThreadParentResponseInfo	Essa estrutura representa os dados de resposta do pai MLE.

Enumerações

enumeração anônima

 anonymous enum

Propriedades
`OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL`	Nível da bateria TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES`	Páginas do canal TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE`	Tabela filho TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY`	Conectividade TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS`	Endereço MAC Estendido TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST`	Lista de endereços IPv6 TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA`	Dados Líder TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS`	Contadores MAC TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT`	Tempo limite máximo filho TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_MODE`	Modo TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA`	Dados de Rede TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_ROUTE`	Rota64 TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS`	Endereço 16 TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE`	Tensão de Alimentação TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT`	Timeout TLV (o período máximo de sondagem para SEDs)
`OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST`	Lista de tipos TLV.

otDeviceRole

 otDeviceRole

Representa uma função de dispositivo Thread.

Propriedades
`OT_DEVICE_ROLE_CHILD`	A função Thread Child.
`OT_DEVICE_ROLE_DETACHED`	Não participando atualmente de uma rede/partição de Thread.
`OT_DEVICE_ROLE_DISABLED`	A pilha de threads está desabilitada.
`OT_DEVICE_ROLE_LEADER`	A função de Líder de Tópico.
`OT_DEVICE_ROLE_ROUTER`	A função Thread Router.

otNetDataPublisherEvent

 otNetDataPublisherEvent

Essa enumeração representa os eventos relatados dos retornos de chamada do Publicador.

Propriedades
`OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED`	A entrada publicada é adicionada aos dados de rede de thread.
`OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED`	A entrada publicada é removida dos dados de rede de thread.

otRoutePreference

 otRoutePreference

Define valores válidos para mPreference em otExternalRouteConfig e otBorderRouterConfig .

Propriedades
`OT_ROUTE_PREFERENCE_HIGH`	Alta preferência de rota.
`OT_ROUTE_PREFERENCE_LOW`	Baixa preferência de rota.
`OT_ROUTE_PREFERENCE_MED`	Preferência de rota média.

Typedefs

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

Essa estrutura representa uma configuração do Border Router.

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

Essa estrutura representa uma configuração de Rota Externa.

otIpCounters

struct otIpCounters otIpCounters

Essa estrutura representa os contadores de nível IP.

otLeaderData

struct otLeaderData otLeaderData

Essa estrutura representa os dados do líder de thread.

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

Essa estrutura representa uma configuração de modo de link MLE.

otMleCounters

struct otMleCounters otMleCounters

Essa estrutura representa os contadores Thread MLE.

otNeighborInfoIterator

int16_t otNeighborInfoIterator

Usado para iterar através da tabela vizinha.

otNetDataDnsSrpServicePublisherCallback

void(* otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)

Esse tipo de ponteiro de função define o retorno de chamada usado para notificar quando uma entrada "Serviço DNS/SRP" é adicionada ou removida dos Dados de Rede de Encadeamento.

Ao remover, o retorno de chamada é invocado independentemente de a entrada ser removida pelo Publisher (por exemplo, quando há muitas entradas semelhantes já presentes nos Dados da Rede) ou por meio de uma chamada explícita para cancelar a publicação da entrada (ou seja, uma chamada para otNetDataUnpublishDnsSrpService() ).

Detalhes

Parâmetros

`[in] aEvent`	Indica o evento (se a entrada foi adicionada ou removida).
`[in] aContext`	Um ponteiro para o contexto específico do aplicativo.

otNetDataPrefixPublisherCallback

void(* otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)

Esse tipo de ponteiro de função define o retorno de chamada usado para notificar quando uma entrada de prefixo (na malha ou rota externa) é adicionada ou removida dos dados de rede de thread.

Ao remover, o retorno de chamada é invocado independentemente de a entrada ser removida pelo Publisher (por exemplo, quando há muitas entradas semelhantes já presentes nos dados de rede) ou por meio de uma chamada explícita para cancelar a publicação da entrada.

Detalhes

Parâmetros

`[in] aEvent`	Indica o evento (se a entrada foi adicionada ou removida).
`[in] aPrefix`	Um ponteiro para a entrada de prefixo.
`[in] aContext`	Um ponteiro para o contexto específico do aplicativo.

otNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

Essa enumeração representa os eventos relatados dos retornos de chamada do Publicador.

otNetworkDataIterator

uint32_t otNetworkDataIterator

Usado para iterar pelas informações de dados de rede.

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

Essa estrutura representa uma entrada de tabela filho de diagnóstico de rede.

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

Essa estrutura representa um valor de conectividade de diagnóstico de rede.

otNetworkDiagIterator

uint16_t otNetworkDiagIterator

Usado para iterar por meio do TLV de diagnóstico de rede.

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

Essa estrutura representa um valor de contadores Mac de diagnóstico de rede.

Consulte RFC 2863 para definições de campos de membro.

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

Essa estrutura representa um valor TLV da Rota de Diagnóstico de Rede.

otNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

Essa estrutura representa os dados de uma rota de diagnóstico de rede.

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

Essa estrutura representa um TLV de diagnóstico de rede.

otReceiveDiagnosticGetCallback

void(* otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)

Esse ponteiro de função é chamado quando a resposta de obtenção de diagnóstico de rede é recebida.

Detalhes

Parâmetros

`[in] aError`	O erro quando falhou ao obter a resposta.
`[in] aMessage`	Um ponteiro para o buffer de mensagem que contém a carga de resposta de obtenção de diagnóstico de rede recebida. Disponível apenas quando `aError` é `OT_ERROR_NONE` .
`[in] aMessageInfo`	Um ponteiro para as informações da mensagem para `aMessage` . Disponível apenas quando `aError` é `OT_ERROR_NONE` .
`[in] aContext`	Um ponteiro para o contexto específico do aplicativo.

otRoutePreference

enum otRoutePreference otRoutePreference

Define valores válidos para mPreference em otExternalRouteConfig e otBorderRouterConfig .

otServerConfig

struct otServerConfig otServerConfig

Esta estrutura representa uma configuração do Servidor.

otServiceConfig

struct otServiceConfig otServiceConfig

Essa estrutura representa uma configuração de serviço.

otThreadAnycastLocatorCallback

void(* otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)

Esse tipo de ponteiro de função define o retorno de chamada para notificar o resultado de uma solicitação otThreadLocateAnycastDestination() .

Detalhes

Parâmetros

`[in] aContext`	Um ponteiro para um contexto arbitrário (fornecido quando o retorno de chamada é registrado).
`[in] aError`	O erro ao processar a solicitação. OT_ERROR_NONE indica sucesso. OT_ERROR_RESPONSE_TIMEOUT indica que um destino não pôde ser encontrado. OT_ERROR_ABORT indica que a solicitação foi abortada.
`[in] aMeshLocalAddress`	Um ponteiro para o EID local de malha do destino mais próximo do endereço anycast quando `aError` for OT_ERROR_NONE, caso contrário NULL.
`[in] aRloc16`	O RLOC16 do destino se encontrado, caso contrário, RLOC16 inválido (0xfffe).

otThreadDiscoveryRequestCallback

void(* otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)

Esse ponteiro de função é chamado toda vez que uma mensagem de solicitação de descoberta MLE é recebida.

Detalhes

Parâmetros

`[in] aInfo`	Um ponteiro para os dados de informações da solicitação de descoberta.
`[in] aContext`	Um ponteiro para o contexto específico do aplicativo de retorno de chamada.

otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

Essa estrutura representa os dados de solicitação de descoberta de thread.

otThreadParentResponseCallback

void(* otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)

Este ponteiro de função é chamado toda vez que uma mensagem MLE Parent Response é recebida.

Detalhes

Parâmetros

`[in] aInfo`	Um ponteiro para um local na pilha que contém os dados estatísticos.
`[in] aContext`	Um ponteiro para o contexto específico do cliente de retorno de chamada.

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

Essa estrutura representa os dados de resposta do pai MLE.

Funções

otNetDataContainsOmrPrefix

bool otNetDataContainsOmrPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Esta função verifica se um determinado prefixo pode atuar como um prefixo OMR válido e também se os dados de rede do líder contêm esse prefixo.

Nota: Esta API só está disponível quando OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE é usado.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aPrefix`	Um ponteiro para o prefixo IPv6.

Devoluções

Se aPrefix é um prefixo OMR válido e os Dados de Rede do Líder contêm o prefixo OMR aPrefix .

otNetDataGet

otError otNetDataGet(
  otInstance *aInstance,
  bool aStable,
  uint8_t *aData,
  uint8_t *aDataLength
)

Este método fornece uma cópia completa ou estável dos dados de rede de thread da partição.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aStable`	TRUE ao copiar a versão estável, FALSE ao copiar a versão completa.
`[out] aData`	Um ponteiro para o buffer de dados.
`[in,out] aDataLength`	Na entrada, tamanho do buffer de dados apontado por `aData` . Na saída, número de bytes copiados.

otNetDataGetNextOnMeshPrefix

otError otNetDataGetNextOnMeshPrefix(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otBorderRouterConfig *aConfig
)

Esta função obtém o próximo prefixo On Mesh nos dados de rede da partição.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in,out] aIterator`	Um ponteiro para o contexto do iterador de dados de rede. Para obter a primeira entrada na malha, ela deve ser definida como OT_NETWORK_DATA_ITERATOR_INIT.
`[out] aConfig`	Um ponteiro para onde as informações do Prefixo da malha serão colocadas.

Valores de retorno

`OT_ERROR_NONE`	Encontrado com sucesso o próximo prefixo On Mesh.
`OT_ERROR_NOT_FOUND`	Não existe nenhum prefixo On Mesh subsequente nos Dados de Rede de Encadeamento.

otNetDataGetNextRoute

otError otNetDataGetNextRoute(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otExternalRouteConfig *aConfig
)

Esta função obtém a próxima rota externa nos Dados de Rede da partição.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in,out] aIterator`	Um ponteiro para o contexto do iterador de dados de rede. Para obter a primeira entrada de rota externa, ela deve ser definida como OT_NETWORK_DATA_ITERATOR_INIT.
`[out] aConfig`	Um ponteiro para onde as informações da Rota Externa serão colocadas.

Valores de retorno

`OT_ERROR_NONE`	Localizada com sucesso a próxima Rota Externa.
`OT_ERROR_NOT_FOUND`	Não existe nenhuma entrada de rota externa subsequente nos Dados de Rede do Thread.

otNetDataGetNextService

otError otNetDataGetNextService(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otServiceConfig *aConfig
)

Esta função obtém o próximo serviço nos Dados de Rede da partição.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in,out] aIterator`	Um ponteiro para o contexto do iterador de dados de rede. Para obter a primeira entrada de serviço, ela deve ser definida como OT_NETWORK_DATA_ITERATOR_INIT.
`[out] aConfig`	Um ponteiro para onde as informações do serviço serão colocadas.

Valores de retorno

`OT_ERROR_NONE`	Encontrou com sucesso o próximo serviço.
`OT_ERROR_NOT_FOUND`	Não existe nenhum serviço subsequente nos Dados de Rede da partição.

otNetDataGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

Obtenha a versão de dados de rede estável.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

A versão de dados de rede estável.

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

Obtenha a versão de dados de rede.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

A versão de dados de rede.

otNetDataIsDnsSrpServiceAdicionado

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

Esta função indica se a entrada "Serviço DNS/SRP" está ou não adicionada aos Dados de Rede de Thread.

Esta função requer que o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE esteja habilitado.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Valores de retorno

`TRUE`	A entrada de serviço DNS/SRP publicada é adicionada aos dados de rede de thread.
`FALSE`	A entrada não é adicionada a Thread Network Data ou não há entrada para publicar.

otNetDataIsPrefixAdicionado

bool otNetDataIsPrefixAdded(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Esta função indica se uma entrada de prefixo publicada atualmente (em malha ou rota externa) é adicionada aos Dados de Rede de Thread.

Esta função requer que o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE esteja habilitado.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aPrefix`	Um ponteiro para o prefixo (NÃO DEVE ser NULL).

Valores de retorno

`TRUE`	A entrada de prefixo publicada é adicionada aos dados de rede de thread.
`FALSE`	A entrada não é adicionada a Thread Network Data ou não há entrada para publicar.

otNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

Esta função solicita que o "Endereço Anycast do Serviço DNS/SRP" seja publicado nos Dados da Rede de Encadeamento.

Esta função requer que o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE esteja habilitado.

Uma chamada para esta função removerá e substituirá qualquer entrada anterior "Serviço DNS/SRP" que estava sendo publicada (da chamada anterior para qualquer uma das otNetDataPublishDnsSrpService{Type}() ).

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aSequenceNUmber`	O número de sequência do serviço Anycast DNS/SRP.

otNetDataPublishDnsSrpServiceUnicast

void otNetDataPublishDnsSrpServiceUnicast(
  otInstance *aInstance,
  const otIp6Address *aAddress,
  uint16_t aPort
)

Esta função solicita que o "endereço unicast de serviço DNS/SRP" seja publicado nos dados de rede de thread.

Esta função requer que o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE esteja habilitado.

Esta função publica o "Endereço Unicast do Serviço DNS/SRP" incluindo o endereço e as informações da porta nos dados TLV do Serviço.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aAddress`	O endereço do servidor DNS/SRP a ser publicado (NÃO DEVE ser NULO).
`[in] aPort`	O número da porta do servidor SRP a ser publicado.

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

Esta função solicita que o "endereço unicast de serviço DNS/SRP" seja publicado nos dados de rede de thread.

Esta função requer que o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE esteja habilitado.

Ao contrário otNetDataPublishDnsSrpServiceUnicast() , que exige que o endereço publicado seja fornecido e inclua as informações nos dados de TLV do serviço, essa função usa o EID local de malha do dispositivo e inclui as informações nos dados de TLV do servidor.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aPort`	O número da porta do servidor SRP a ser publicado.

otNetDataPublishExternalRoute

otError otNetDataPublishExternalRoute(
  otInstance *aInstance,
  const otExternalRouteConfig *aConfig
)

Esta função solicita que um prefixo de rota externa seja publicado nos Dados da Rede de Encadeamento.

Esta função requer que o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE esteja habilitado.

Somente entradas estáveis podem ser publicadas (ou seja, aConfig.mStable DEVE ser TRUE).

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aConfig`	A configuração de rota externa a ser publicada (NÃO DEVE ser NULL).

Valores de retorno

`OT_ERROR_NONE`	A rota externa foi publicada com sucesso.
`OT_ERROR_INVALID_ARGS`	O `aConfig` não é válido (prefixo incorreto, combinações de sinalizadores inválidas ou não é estável).
`OT_ERROR_ALREADY`	Uma entrada com o mesmo prefixo já está na lista publicada.
`OT_ERROR_NO_BUFS`	Não foi possível alocar uma entrada para a nova solicitação. O Publisher dá suporte a um número limitado de entradas (compartilhadas entre o prefixo na malha e a rota externa) determinado pela configuração `OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES` .

otNetDataPublishOnMeshPrefix

otError otNetDataPublishOnMeshPrefix(
  otInstance *aInstance,
  const otBorderRouterConfig *aConfig
)

Esta função solicita que um prefixo na malha seja publicado nos Dados da Rede de Encadeamento.

Esta função requer que o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE esteja habilitado.

Somente entradas estáveis podem ser publicadas (ou seja, aConfig.mStable DEVE ser TRUE).

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aConfig`	A configuração do prefixo na malha para publicar (NÃO DEVE ser NULL).

Valores de retorno

`OT_ERROR_NONE`	O prefixo na malha é publicado com sucesso.
`OT_ERROR_INVALID_ARGS`	O `aConfig` não é válido (prefixo incorreto, combinações de sinalizadores inválidas ou não é estável).
`OT_ERROR_ALREADY`	Uma entrada com o mesmo prefixo já está na lista publicada.
`OT_ERROR_NO_BUFS`	Não foi possível alocar uma entrada para a nova solicitação. O Publisher dá suporte a um número limitado de entradas (compartilhadas entre o prefixo na malha e a rota externa) determinado pela configuração `OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES` .

otNetDataSetDnsSrpServicePublisherCallback

void otNetDataSetDnsSrpServicePublisherCallback(
  otInstance *aInstance,
  otNetDataDnsSrpServicePublisherCallback aCallback,
  void *aContext
)

Essa função define um retorno de chamada para notificar quando um "Serviço DNS/SRP" publicado é realmente adicionado ou removido dos Dados de Rede de Encadeamento.

Uma chamada subsequente para essa função substitui qualquer função de retorno de chamada definida anteriormente.

Esta função requer que o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE esteja habilitado.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aCallback`	O ponteiro da função de retorno de chamada (pode ser NULL se não for necessário).
`[in] aContext`	Um ponteiro para o contexto específico do aplicativo (usado quando `aCallback` é invocado).

otNetDataSetPrefixPublisherCallback

void otNetDataSetPrefixPublisherCallback(
  otInstance *aInstance,
  otNetDataPrefixPublisherCallback aCallback,
  void *aContext
)

Essa função define um retorno de chamada para notificar quando uma entrada de prefixo publicada é realmente adicionada ou removida dos dados de rede de thread.

Uma chamada subsequente para essa função substitui qualquer função de retorno de chamada definida anteriormente.

Esta função requer que o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE esteja habilitado.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aCallback`	O ponteiro da função de retorno de chamada (pode ser NULL se não for necessário).
`[in] aContext`	Um ponteiro para o contexto específico do aplicativo (usado quando `aCallback` é invocado).

otNetDataSteeringDataCheckJoiner

otError otNetDataSteeringDataCheckJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64
)

Verifique se os dados de direção incluem um Joiner.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aEui64`	Um ponteiro para o IEEE EUI-64 do Joiner.

Valores de retorno

`OT_ERROR_NONE`	`aEui64` está incluído nos dados de direção.
`OT_ERROR_INVALID_STATE`	Nenhum dado de direção presente.
`OT_ERROR_NOT_FOUND`	`aEui64` não está incluído nos dados de direção.

otNetDataSteeringDataCheckJoinerWithDiscerner

otError otNetDataSteeringDataCheckJoinerWithDiscerner(
  otInstance *aInstance,
  const struct otJoinerDiscerner *aDiscerner
)

Verifique se os dados de direção incluem um Joiner com um determinado valor de discernimento.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aDiscerner`	Um ponteiro para o Joiner Discerner.

Valores de retorno

`OT_ERROR_NONE`	`aDiscerner` está incluído nos dados de direção.
`OT_ERROR_INVALID_STATE`	Nenhum dado de direção presente.
`OT_ERROR_NOT_FOUND`	`aDiscerner` não está incluído nos dados de direção.

otNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

Esta função cancela a publicação de qualquer entrada "Serviço DNS/SRP (Anycast ou Unicast)" adicionada anteriormente dos Dados de Rede de Encadeamento.

Esta função requer que o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE esteja habilitado.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

otNetDataUnpublishPrefix

otError otNetDataUnpublishPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Esta função cancela a publicação de um prefixo publicado anteriormente (on-mesh ou rota externa).

Esta função requer que o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE esteja habilitado.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aPrefix`	O prefixo para cancelar a publicação (NÃO DEVE ser NULL).

Valores de retorno

`OT_ERROR_NONE`	A publicação do prefixo foi cancelada com sucesso.
`OT_ERROR_NOT_FOUND`	Não foi possível encontrar o prefixo na lista publicada.

otThreadBecomeChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

Tente reconectar como uma criança.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Valores de retorno

`OT_ERROR_NONE`	Comece com sucesso a tentativa de se tornar uma criança.
`OT_ERROR_INVALID_STATE`	O tópico está desabilitado.

otThreadBecomeDetached

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Desconecte-se da rede Thread.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Valores de retorno

`OT_ERROR_NONE`	Desconectado com sucesso da rede Thread.
`OT_ERROR_INVALID_STATE`	O tópico está desabilitado.

otThreadDeviceRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

Converta a função do dispositivo em uma string legível.

Detalhes

Parâmetros

[in] aRole

A função do dispositivo a ser convertida.

Devoluções

Uma string representando aRole .

otThreadDiscover

otError otThreadDiscover(
  otInstance *aInstance,
  uint32_t aScanChannels,
  uint16_t aPanId,
  bool aJoiner,
  bool aEnableEui64Filtering,
  otHandleActiveScanResult aCallback,
  void *aCallbackContext
)

Esta função inicia uma varredura de descoberta de thread.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aScanChannels`	Um vetor de bits indicando quais canais devem ser varridos (por exemplo, OT_CHANNEL_11_MASK).
`[in] aPanId`	O filtro PAN ID (definido como Broadcast PAN para desabilitar o filtro).
`[in] aJoiner`	Valor do Sinalizador do Joiner no TLV da Solicitação de Descoberta.
`[in] aEnableEui64Filtering`	TRUE para filtrar respostas em EUI-64, FALSE caso contrário.
`[in] aCallback`	Um ponteiro para uma função chamada ao receber uma resposta de descoberta MLE ou uma varredura é concluída.
`[in] aCallbackContext`	Um ponteiro para o contexto específico do aplicativo.

Valores de retorno

`OT_ERROR_NONE`	Iniciado com êxito uma verificação de descoberta de thread.
`OT_ERROR_INVALID_STATE`	A interface IPv6 não está habilitada (netif não está ativo).
`OT_ERROR_NO_BUFS`	Não foi possível alocar mensagem para solicitação de descoberta.
`OT_ERROR_BUSY`	A verificação de descoberta de thread já está em andamento.

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

Obtenha o Thread Child Timeout usado ao operar na função Child.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

O valor de tempo limite do segmento filho em segundos.

Veja também:
otThreadSetChildTimeout

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Obtenha a função de dispositivo.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Valores de retorno

`OT_DEVICE_ROLE_DISABLED`	A pilha de threads está desabilitada.
`OT_DEVICE_ROLE_DETACHED`	O dispositivo não está participando atualmente de uma rede/partição de Thread.
`OT_DEVICE_ROLE_CHILD`	O dispositivo está atualmente operando como Thread Child.
`OT_DEVICE_ROLE_ROUTER`	O dispositivo está atualmente operando como um Thread Router.
`OT_DEVICE_ROLE_LEADER`	O dispositivo está atualmente operando como Thread Leader.

otThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Obtenha o nome de domínio do thread.

Esta função só está disponível desde o Thread 1.2.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

Um ponteiro para o nome de domínio do thread.

Veja também:
otThreadSetDomainName

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Obtenha o IEEE 802.15.4 Extended PAN ID.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

Um ponteiro para o IEEE 802.15.4 Extended PAN ID.

Veja também:
otThreadSetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

Obtenha o Identificador de Interface especificado manualmente para o Endereço Unicast de Domínio de Encadeamento.

Esta função só está disponível desde o Thread 1.2 quando OPENTHREAD_CONFIG_DUA_ENABLE está habilitado.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

Um ponteiro para o Identificador de Interface que foi definido manualmente ou NULL se nenhum foi definido.

Veja também:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

Obtenha os contadores IPv6.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

Um ponteiro para os contadores IPv6.

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Obtenha o thrKeySequenceCounter.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

O valor thrKeySequenceCounter.

Veja também:
otThreadSetKeySequenceCounter

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Obtenha o thrKeySwitchGuardTime.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

O valor thrKeySwitchGuardTime (em horas).

Veja também:
otThreadSetKeySwitchGuardTime

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

Esta função obtém os dados do líder da linha.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[out] aLeaderData`	Um ponteiro para onde os dados do líder são colocados.

Valores de retorno

`OT_ERROR_NONE`	Os dados do líder foram recuperados com sucesso.
`OT_ERROR_DETACHED`	Não anexado no momento.

otThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

Esta função retorna um ponteiro para o RLOC do Líder.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[out] aLeaderRloc`	Um ponteiro para o RLOC do Líder.

Valores de retorno

`OT_ERROR_NONE`	O RLOC do Líder foi gravado com sucesso em `aLeaderRloc` .
`OT_ERROR_INVALID_ARGS`	`aLeaderRloc` era NULL.
`OT_ERROR_DETACHED`	Não está atualmente anexado a uma partição de thread.

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Obtenha o ID do roteador do líder.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

O ID do roteador do líder.

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

Obtenha o Peso do Líder.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

O Peso do Líder.

otThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Esta função retorna o endereço multicast de todos os nós de thread locais de link de thread.

O endereço é um endereço multicast baseado em prefixo unicast link-local [RFC 3306], com:

flgs definido como 3 (P = 1 e T = 1)
escopo definido para 2
plen ajustado para 64
prefixo de rede definido para o prefixo local de malha
ID do grupo definido como 1

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

Um ponteiro para o endereço multicast de todos os nós de thread local de link de thread.

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

Esta função retorna o endereço IPv6 local de link de thread.

O endereço local do Thread link é derivado usando IEEE802.15.4 Extended Address as Interface Identifier.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

Um ponteiro para o endereço IPv6 local de link de thread.

otThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

Obtenha a configuração do modo de link MLE.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

A configuração do modo de link MLE.

Veja também:
otThreadSetLinkMode

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

Esta função retorna um ponteiro para o endereço do Mesh Local EID.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

Um ponteiro para o endereço Mesh Local EID.

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

Esta função retorna um ponteiro para o prefixo local da malha.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

Um ponteiro para o prefixo local da malha.

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Obtenha os contadores Thread MLE.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

Um ponteiro para os contadores Thread MLE.

otThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

Obtenha a chave de rede do thread.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[out] aNetworkKey`	Um ponteiro para um `otNetworkkey` para retornar a chave de rede de thread.

Veja também:
otThreadSetNetworkKey

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

Obtenha o otNetworkKeyRef para a chave de rede de thread.

Esta função requer que o recurso de tempo de construção OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE seja habilitado.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

Referência à chave de rede de thread armazenada na memória.

Veja também:
otThreadSetNetworkKeyRef

otThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

Obtenha o nome da rede do thread.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

Um ponteiro para o nome da rede de thread.

Veja também:
otThreadSetNetworkName

otThreadGetNextDiagnosticTlv

otError otThreadGetNextDiagnosticTlv(
  const otMessage *aMessage,
  otNetworkDiagIterator *aIterator,
  otNetworkDiagTlv *aNetworkDiagTlv
)

Essa função obtém o próximo TLV de diagnóstico de rede na mensagem.

Uma chamada subsequente para esta função é permitida somente quando o valor de retorno atual é OT_ERROR_NONE.

Detalhes

Parâmetros

`[in] aMessage`	Um ponteiro para uma mensagem.
`[in,out] aIterator`	Um ponteiro para o contexto do iterador de diagnóstico de rede. Para obter o primeiro TLV de diagnóstico de rede, ele deve ser definido como OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
`[out] aNetworkDiagTlv`	Um ponteiro para onde as informações de TLV de diagnóstico de rede serão colocadas.

Valores de retorno

`OT_ERROR_NONE`	Encontrado com sucesso o próximo TLV de diagnóstico de rede.
`OT_ERROR_NOT_FOUND`	Não existe nenhum TLV de diagnóstico de rede subsequente na mensagem.
`OT_ERROR_PARSE`	Falha ao analisar o próximo diagnóstico de rede.

otThreadGetNextNeighborInfo

otError otThreadGetNextNeighborInfo(
  otInstance *aInstance,
  otNeighborInfoIterator *aIterator,
  otNeighborInfo *aInfo
)

Esta função obtém as informações do próximo vizinho.

É usado para percorrer as entradas da tabela vizinha.

Detalhes

Parâmetros

`[in] aInstance`	A pointer to an OpenThread instance.
`[in,out] aIterator`	A pointer to the iterator context. To get the first neighbor entry it should be set to OT_NEIGHBOR_INFO_ITERATOR_INIT.
`[out] aInfo`	A pointer to the neighbor information.

Return Values

`OT_ERROR_NONE`	Successfully found the next neighbor entry in table.
`OT_ERROR_NOT_FOUND`	No subsequent neighbor entry exists in the table.
`OT_ERROR_INVALID_ARGS`	`aIterator` or `aInfo` was NULL.

otThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

The function retrieves the average RSSI for the Thread Parent.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[out] aParentRssi`	A pointer to where the parent RSSI should be placed.

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

The function retrieves diagnostic information for a Thread Router as parent.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[out] aParentInfo`	A pointer to where the parent router information is placed.

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

The function retrieves the RSSI of the last packet from the Thread Parent.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[out] aLastRssi`	A pointer to where the last RSSI should be placed.

Return Values

`OT_ERROR_NONE`	Successfully retrieved the RSSI data.
`OT_ERROR_FAILED`	Unable to get RSSI data.
`OT_ERROR_INVALID_ARGS`	`aLastRssi` is NULL.

otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Get the Partition ID.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

Returns

The Partition ID.

otThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

This function returns the Thread Realm-Local All Thread Nodes multicast address.

The address is a realm-local Unicast Prefix-Based Multcast Address [RFC 3306], with:

flgs set to 3 (P = 1 and T = 1)
scop set to 3
plen set to 64
network prefix set to the Mesh Local Prefix
group ID set to 1

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

Returns

A pointer to Thread Realm-Local All Thread Nodes multicast address.

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

This function returns a pointer to the Thread Routing Locator (RLOC) address.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

Returns

A pointer to the Thread Routing Locator (RLOC) address.

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Get the RLOC16.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

Returns

The RLOC16.

otThreadGetServiceAloc

otError otThreadGetServiceAloc(
  otInstance *aInstance,
  uint8_t aServiceId,
  otIp6Address *aServiceAloc
)

This function retrieves the Service ALOC for given Service ID.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aServiceId`	Service ID to get ALOC for.
`[out] aServiceAloc`	A pointer to output the Service ALOC. MUST NOT BE NULL.

Return Values

`OT_ERROR_NONE`	Successfully retrieved the Service ALOC.
`OT_ERROR_DETACHED`	The Thread interface is not currently attached to a Thread Partition.

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

This function gets the Thread protocol version.

Details
Returns	the Thread protocol version.

otThreadIsAnycastLocateInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

This function indicates whether an anycast locate request is currently in progress.

This function is only available when OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE is enabled.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

Returns

TRUE if an anycast locate request is currently in progress, FALSE otherwise.

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

This function determines if an MLE Thread Discovery is currently in progress.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

otThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

This function indicates whether a node is the only router on the network.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

Return Values

`TRUE`	It is the only router in the network.
`FALSE`	It is a child or is not a single router in the network.

otThreadLocateAnycastDestination

otError otThreadLocateAnycastDestination(
  otInstance *aInstance,
  const otIp6Address *aAnycastAddress,
  otThreadAnycastLocatorCallback aCallback,
  void *aContext
)

This function requests the closest destination of a given anycast address to be located.

This function is only available when OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE is enabled.

If a previous request is ongoing, a subsequent call to this function will cancel and replace the earlier request.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aAnycastAddress`	The anycast address to locate. MUST NOT be NULL.
`[in] aCallback`	The callback function to report the result.
`[in] aContext`	An arbitrary context used with `aCallback` .

Return Values

`OT_ERROR_NONE`	The request started successfully. `aCallback` will be invoked to report the result.
`OT_ERROR_INVALID_ARGS`	The `aAnycastAddress` is not a valid anycast address or `aCallback` is NULL.
`OT_ERROR_NO_BUFS`	Out of buffer to prepare and send the request message.

otThreadRegisterParentResponseCallback

void otThreadRegisterParentResponseCallback(
  otInstance *aInstance,
  otThreadParentResponseCallback aCallback,
  void *aContext
)

This function registers a callback to receive MLE Parent Response data.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aCallback`	A pointer to a function that is called upon receiving an MLE Parent Response message.
`[in] aContext`	A pointer to callback client-specific context.

otThreadResetIp6Counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Reset the IPv6 counters.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

otThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Reset the Thread MLE counters.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

otThreadSendAddressNotification

void otThreadSendAddressNotification(
  otInstance *aInstance,
  otIp6Address *aDestination,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid
)

This function sends a Proactive Address Notification (ADDR_NTF.ntf) message.

This function is only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aDestination`	The destination to send the ADDR_NTF.ntf message.
`[in] aTarget`	The target address of the ADDR_NTF.ntf message.
`[in] aMlIid`	The ML-IID of the ADDR_NTF.ntf message.

otThreadSendDiagnosticGet

otError otThreadSendDiagnosticGet(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount,
  otReceiveDiagnosticGetCallback aCallback,
  void *aCallbackContext
)

Send a Network Diagnostic Get request.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aDestination`	A pointer to destination address.
`[in] aTlvTypes`	An array of Network Diagnostic TLV types.
`[in] aCount`	Number of types in aTlvTypes.
`[in] aCallback`	A pointer to a function that is called when Network Diagnostic Get response is received or NULL to disable the callback.
`[in] aCallbackContext`	A pointer to application-specific context.

Return Values

`OT_ERROR_NONE`	Successfully queued the DIAG_GET.req.
`OT_ERROR_NO_BUFS`	Insufficient message buffers available to send DIAG_GET.req.

otThreadSendDiagnosticReset

otError otThreadSendDiagnosticReset(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount
)

Send a Network Diagnostic Reset request.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aDestination`	A pointer to destination address.
`[in] aTlvTypes`	An array of Network Diagnostic TLV types. Currently only Type 9 is allowed.
`[in] aCount`	Number of types in aTlvTypes

Return Values

`OT_ERROR_NONE`	Successfully queued the DIAG_RST.ntf.
`OT_ERROR_NO_BUFS`	Insufficient message buffers available to send DIAG_RST.ntf.

otThreadSendProactiveBackboneNotification

otError otThreadSendProactiveBackboneNotification(
  otInstance *aInstance,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid,
  uint32_t aTimeSinceLastTransaction
)

This function sends a Proactive Backbone Notification (PRO_BB.ntf) message on the Backbone link.

This function is only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aTarget`	The target address of the PRO_BB.ntf message.
`[in] aMlIid`	The ML-IID of the PRO_BB.ntf message.
`[in] aTimeSinceLastTransaction`	Time since last transaction (in seconds).

Return Values

`OT_ERROR_NONE`	Successfully sent PRO_BB.ntf on backbone link.
`OT_ERROR_NO_BUFS`	If insufficient message buffers available.

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Set the Thread Child Timeout used when operating in the Child role.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aTimeout`	The timeout value in seconds.

See also:
otThreadGetChildTimeout

otThreadSetDiscoveryRequestCallback

void otThreadSetDiscoveryRequestCallback(
  otInstance *aInstance,
  otThreadDiscoveryRequestCallback aCallback,
  void *aContext
)

This function sets a callback to receive MLE Discovery Request data.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aCallback`	A pointer to a function that is called upon receiving an MLE Discovery Request message.
`[in] aContext`	A pointer to callback application-specific context.

otThreadSetDomainName

otError otThreadSetDomainName(
  otInstance *aInstance,
  const char *aDomainName
)

Set the Thread Domain Name.

This function is only available since Thread 1.2. This function succeeds only when Thread protocols are disabled.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aDomainName`	A pointer to the Thread Domain Name.

Return Values

`OT_ERROR_NONE`	Successfully set the Thread Domain Name.
`OT_ERROR_INVALID_STATE`	Thread protocols are enabled.

See also:
otThreadGetDomainName

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

This function starts Thread protocol operation.

The interface must be up when calling this function.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aEnabled`	TRUE if Thread is enabled, FALSE otherwise.

Return Values

`OT_ERROR_NONE`	Successfully started Thread protocol operation.
`OT_ERROR_INVALID_STATE`	The network interface was not not up.

otThreadSetExtendedPanId

otError otThreadSetExtendedPanId(
  otInstance *aInstance,
  const otExtendedPanId *aExtendedPanId
)

Set the IEEE 802.15.4 Extended PAN ID.

This function can only be called while Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aExtendedPanId`	A pointer to the IEEE 802.15.4 Extended PAN ID.

Return Values

`OT_ERROR_NONE`	Successfully set the Extended PAN ID.
`OT_ERROR_INVALID_STATE`	Thread protocols are enabled.

See also:
otThreadGetExtendedPanId

otThreadSetFixedDuaInterfaceIdentifier

otError otThreadSetFixedDuaInterfaceIdentifier(
  otInstance *aInstance,
  const otIp6InterfaceIdentifier *aIid
)

Set/Clear the Interface Identifier manually specified for the Thread Domain Unicast Address.

This function is only available since Thread 1.2 when OPENTHREAD_CONFIG_DUA_ENABLE is enabled.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aIid`	A pointer to the Interface Identifier to set or NULL to clear.

Return Values

`OT_ERROR_NONE`	Successfully set/cleared the Interface Identifier.
`OT_ERROR_INVALID_ARGS`	The specified Interface Identifier is reserved.

See also:
otThreadGetFixedDuaInterfaceIdentifier

otThreadSetJoinerAdvertisement

otError otThreadSetJoinerAdvertisement(
  otInstance *aInstance,
  uint32_t aOui,
  const uint8_t *aAdvData,
  uint8_t aAdvDataLength
)

This method sets the Thread Joiner Advertisement when discovering Thread network.

Thread Joiner Advertisement is used to allow a Joiner to advertise its own application-specific information (such as Vendor ID, Product ID, Discriminator, etc.) via a newly-proposed Joiner Advertisement TLV, and to make this information available to Commissioners or Commissioner Candidates without human interaction.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aOui`	The Vendor IEEE OUI value that will be included in the Joiner Advertisement. Only the least significant 3 bytes will be used, and the most significant byte will be ignored.
`[in] aAdvData`	A pointer to the AdvData that will be included in the Joiner Advertisement.
`[in] aAdvDataLength`	The length of AdvData in bytes.

Return Values

`OT_ERROR_NONE`	Successfully set Joiner Advertisement.
`OT_ERROR_INVALID_ARGS`	Invalid AdvData.

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Set the thrKeySequenceCounter.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aKeySequenceCounter`	The thrKeySequenceCounter value.

See also:
otThreadGetKeySequenceCounter

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Set the thrKeySwitchGuardTime.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aKeySwitchGuardTime`	The thrKeySwitchGuardTime value (in hours).

See also:
otThreadGetKeySwitchGuardTime

otThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Set the MLE Link Mode configuration.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aConfig`	A pointer to the Link Mode configuration.

Return Values

OT_ERROR_NONE

Successfully set the MLE Link Mode configuration.

See also:
otThreadGetLinkMode

otThreadSetMeshLocalPrefix

otError otThreadSetMeshLocalPrefix(
  otInstance *aInstance,
  const otMeshLocalPrefix *aMeshLocalPrefix
)

This function sets the Mesh Local Prefix.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aMeshLocalPrefix`	A pointer to the Mesh Local Prefix.

Return Values

`OT_ERROR_NONE`	Successfully set the Mesh Local Prefix.
`OT_ERROR_INVALID_STATE`	Thread protocols are enabled.

otThreadSetNetworkKey

otError otThreadSetNetworkKey(
  otInstance *aInstance,
  const otNetworkKey *aKey
)

Set the Thread Network Key.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aKey`	A pointer to a buffer containing the Thread Network Key.

Return Values

`OT_ERROR_NONE`	Successfully set the Thread Network Key.
`OT_ERROR_INVALID_STATE`	Thread protocols are enabled.

See also:
otThreadGetNetworkKey

otThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

Set the Thread Network Key as a otNetworkKeyRef .

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

This function requires the build-time feature OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE to be enabled.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aKeyRef`	Reference to the Thread Network Key.

Return Values

`OT_ERROR_NONE`	Successfully set the Thread Network Key.
`OT_ERROR_INVALID_STATE`	Thread protocols are enabled.

See also:
otThreadGetNetworkKeyRef

otThreadSetNetworkName

otError otThreadSetNetworkName(
  otInstance *aInstance,
  const char *aNetworkName
)

Set the Thread Network Name.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aNetworkName`	A pointer to the Thread Network Name.

Return Values

`OT_ERROR_NONE`	Successfully set the Thread Network Name.
`OT_ERROR_INVALID_STATE`	Thread protocols are enabled.

See also:
otThreadGetNetworkName

Macros

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Maximum AdvData Length of Joiner Advertisement.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Initializer for otNeighborInfoIterator.

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

Maximum value length of Thread Base TLV.

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

Value to initialize otNetworkDataIterator .

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

Size of Network Diagnostic Child Table entry.

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Initializer for otNetworkDiagIterator.

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

Maximum Number of Network Diagnostic TLV Types to Request or Reset.

OT_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

Maximum Router ID.

OT_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

Max size of Server Data in bytes. Theoretical limit, practically much lower.

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

Max size of Service Data in bytes.

Resources

OpenThread API Reference topics originate from the source code, available on GitHub . For more information, or to contribute to our documentation, refer to Resources .

Em geral

Resumo

Enumerações

Typedefs

Funções

Estruturas

Enumerações

enumeração anônima

otDeviceRole

otNetDataPublisherEvent

otRoutePreference

Typedefs

otBorderRouterConfig

otExternalRouteConfig

otIpCounters

otLeaderData

otLinkModeConfig

otMleCounters

otNeighborInfoIterator

otNetDataDnsSrpServicePublisherCallback

otNetDataPrefixPublisherCallback

otNetDataPublisherEvent

otNetworkDataIterator

otNetworkDiagChildEntry

otNetworkDiagConnectivity

otNetworkDiagIterator

otNetworkDiagMacCounters

otNetworkDiagRoute

otNetworkDiagRouteData

otNetworkDiagTlv

otReceiveDiagnosticGetCallback

otRoutePreference

otServerConfig

otServiceConfig

otThreadAnycastLocatorCallback

otThreadDiscoveryRequestCallback

otThreadDiscoveryRequestInfo

otThreadParentResponseCallback

otThreadParentResponseInfo

Funções

otNetDataContainsOmrPrefix

otNetDataGet

otNetDataGetNextOnMeshPrefix

otNetDataGetNextRoute

otNetDataGetNextService

otNetDataGetStableVersion

otNetDataGetVersion

otNetDataIsDnsSrpServiceAdicionado

otNetDataIsPrefixAdicionado

otNetDataPublishDnsSrpServiceAnycast

otNetDataPublishDnsSrpServiceUnicast

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

otNetDataPublishExternalRoute

otNetDataPublishOnMeshPrefix

otNetDataSetDnsSrpServicePublisherCallback

otNetDataSetPrefixPublisherCallback

otNetDataSteeringDataCheckJoiner

otNetDataSteeringDataCheckJoinerWithDiscerner

otNetDataUnpublishDnsSrpService

otNetDataUnpublishPrefix

otThreadBecomeChild

otThreadBecomeDetached

otThreadDeviceRoleToString

otThreadDiscover

otThreadGetChildTimeout

otThreadGetDeviceRole

otThreadGetDomainName

otThreadGetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

otThreadGetKeySequenceCounter

otThreadGetKeySwitchGuardTime

otThreadGetLeaderData

otThreadGetLeaderRloc

otThreadGetLeaderRouterId

otThreadGetLeaderWeight

otThreadGetLinkLocalAllThreadNodesMulticastAddress

otThreadGetLinkLocalIp6Address

otThreadGetLinkMode

otThreadGetMeshLocalEid