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.
Typedefs | |
---|---|
otBorderRouterConfig | typedefstruct otBorderRouterConfig Essa estrutura representa uma configuração do Border Router. |
otExternalRouteConfig | typedefstruct otExternalRouteConfig Essa estrutura representa uma configuração de Rota Externa. |
otIpCounters | typedefstruct otIpCounters Essa estrutura representa os contadores de nível IP. |
otLeaderData | typedefstruct otLeaderData Essa estrutura representa os dados do líder de thread. |
otLinkModeConfig | typedefstruct otLinkModeConfig Essa estrutura representa uma configuração de modo de link MLE. |
otMleCounters | typedefstruct otMleCounters Essa estrutura representa os contadores Thread MLE. |
otNeighborInfoIterator | typedefint16_t Usado para iterar através da tabela vizinha. |
otNetDataDnsSrpServicePublisherCallback )(otNetDataPublisherEvent aEvent, void *aContext) | typedefvoid(* 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) | typedefvoid(* 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 Essa enumeração representa os eventos relatados dos retornos de chamada do Publicador. |
otNetworkDataIterator | typedefuint32_t Usado para iterar pelas informações de dados de rede. |
otNetworkDiagChildEntry | typedefstruct otNetworkDiagChildEntry Essa estrutura representa uma entrada de tabela filho de diagnóstico de rede. |
otNetworkDiagConnectivity | typedefstruct otNetworkDiagConnectivity Essa estrutura representa um valor de conectividade de diagnóstico de rede. |
otNetworkDiagIterator | typedefuint16_t Usado para iterar por meio do TLV de diagnóstico de rede. |
otNetworkDiagMacCounters | typedefstruct otNetworkDiagMacCounters Essa estrutura representa um valor de contadores Mac de diagnóstico de rede. |
otNetworkDiagRoute | typedefstruct otNetworkDiagRoute Essa estrutura representa um valor TLV da Rota de Diagnóstico de Rede. |
otNetworkDiagRouteData | typedefstruct otNetworkDiagRouteData Essa estrutura representa os dados de uma rota de diagnóstico de rede. |
otNetworkDiagTlv | typedefstruct otNetworkDiagTlv Essa estrutura representa um TLV de diagnóstico de rede. |
otReceiveDiagnosticGetCallback )(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) | typedefvoid(* Esse ponteiro de função é chamado quando a resposta de obtenção de diagnóstico de rede é recebida. |
otRoutePreference | typedefenum otRoutePreference |
otServerConfig | typedefstruct otServerConfig Esta estrutura representa uma configuração do Servidor. |
otServiceConfig | typedefstruct otServiceConfig Essa estrutura representa uma configuração de serviço. |
otThreadAnycastLocatorCallback )(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) | typedefvoid(* 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) | typedefvoid(* Esse ponteiro de função é chamado toda vez que uma mensagem de solicitação de descoberta MLE é recebida. |
otThreadDiscoveryRequestInfo | typedefstruct otThreadDiscoveryRequestInfo Essa estrutura representa os dados de solicitação de descoberta de thread. |
otThreadParentResponseCallback )(otThreadParentResponseInfo *aInfo, void *aContext) | typedefvoid(* Este ponteiro de função é chamado toda vez que uma mensagem MLE Parent Response é recebida. |
otThreadParentResponseInfo | typedefstruct 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) | 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) | 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) | Esta função obtém a próxima rota externa nos Dados de Rede da partição. |
otNetDataGetNextService ( otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig) | 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) | Esta função solicita que um prefixo de rota externa seja publicado nos Dados da Rede de Encadeamento. |
otNetDataPublishOnMeshPrefix ( otInstance *aInstance, const otBorderRouterConfig *aConfig) | 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) | Verifique se os dados de direção incluem um Joiner. |
otNetDataSteeringDataCheckJoinerWithDiscerner ( otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner) | 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) | Esta função cancela a publicação de um prefixo publicado anteriormente (on-mesh ou rota externa). |
otThreadBecomeChild ( otInstance *aInstance) | Tente reconectar como uma criança. |
otThreadBecomeDetached ( otInstance *aInstance) | 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) | 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) | 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) | Esta função obtém os dados do líder da linha. |
otThreadGetLeaderRloc ( otInstance *aInstance, otIp6Address *aLeaderRloc) | 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) | 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) | 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) | Essa função obtém o próximo TLV de diagnóstico de rede na mensagem. |
otThreadGetNextNeighborInfo ( otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo) | Esta função obtém as informações do próximo vizinho. |
otThreadGetParentAverageRssi ( otInstance *aInstance, int8_t *aParentRssi) | A função recupera o RSSI médio para o Thread Parent. |
otThreadGetParentInfo ( otInstance *aInstance, otRouterInfo *aParentInfo) | A função recupera informações de diagnóstico para um Thread Router como pai. |
otThreadGetParentLastRssi ( otInstance *aInstance, int8_t *aLastRssi) | 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) | 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) | 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) | 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) | Envie uma solicitação de redefinição de diagnóstico de rede. |
otThreadSendProactiveBackboneNotification ( otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction) | 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) | Defina o nome de domínio do thread. |
otThreadSetEnabled ( otInstance *aInstance, bool aEnabled) | Esta função inicia a operação do protocolo Thread. |
otThreadSetExtendedPanId ( otInstance *aInstance, const otExtendedPanId *aExtendedPanId) | Defina o IEEE 802.15.4 Extended PAN ID. |
otThreadSetFixedDuaInterfaceIdentifier ( otInstance *aInstance, const otIp6InterfaceIdentifier *aIid) | 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) | 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) | Defina a configuração do modo de link MLE. |
otThreadSetMeshLocalPrefix ( otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix) | Esta função define o prefixo local da malha. |
otThreadSetNetworkKey ( otInstance *aInstance, const otNetworkKey *aKey) | Defina a chave de rede do thread. |
otThreadSetNetworkKeyRef ( otInstance *aInstance, otNetworkKeyRef aKeyRef) | Defina a chave de rede do thread como um otNetworkKeyRef . |
otThreadSetNetworkName ( otInstance *aInstance, const char *aNetworkName) | 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
otDeviceRole
otDeviceRole
Representa uma função de dispositivo Thread.
otNetDataPublisherEvent
otNetDataPublisherEvent
Essa enumeração representa os eventos relatados dos retornos de chamada do Publicador.
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.
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
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 |
|
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 |
| ||||||
Valores de retorno |
|
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 |
| ||||||
Valores de retorno |
|
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 |
| ||||||
Valores de retorno |
|
otNetDataGetStableVersion
uint8_t otNetDataGetStableVersion( otInstance *aInstance )
Obtenha a versão de dados de rede estável.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
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 |
| ||
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 |
| ||||
Valores de retorno |
|
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 |
| ||||
Valores de retorno |
|
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 |
|
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.
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}()
).
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 |
|
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.
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}()
).
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 |
|
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 |
| ||||||||
Valores de retorno |
|
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 |
| ||||||||
Valores de retorno |
|
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 |
|
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 |
|
otNetDataSteeringDataCheckJoiner
otError otNetDataSteeringDataCheckJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
Verifique se os dados de direção incluem um Joiner.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores de retorno |
|
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 |
| ||||||
Valores de retorno |
|
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 |
|
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 |
| ||||
Valores de retorno |
|
otThreadBecomeChild
otError otThreadBecomeChild( otInstance *aInstance )
Tente reconectar como uma criança.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Valores de retorno |
|
otThreadBecomeDetached
otError otThreadBecomeDetached( otInstance *aInstance )
Desconecte-se da rede Thread.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Valores de retorno |
|
otThreadDeviceRoleToString
const char * otThreadDeviceRoleToString( otDeviceRole aRole )
Converta a função do dispositivo em uma string legível.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
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 |
| ||||||||||||||
Valores de retorno |
|
otThreadGetChildTimeout
uint32_t otThreadGetChildTimeout( otInstance *aInstance )
Obtenha o Thread Child Timeout usado ao operar na função Child.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | O valor de tempo limite do segmento filho em segundos. |
otThreadSetChildTimeout
otThreadGetDeviceRole
otDeviceRole otThreadGetDeviceRole( otInstance *aInstance )
Obtenha a função de dispositivo.
Detalhes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||||
Valores de retorno |
|
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 |
| ||
Devoluções | Um ponteiro para o nome de domínio do thread. |
otThreadSetDomainName
otThreadGetExtendedPanId
const otExtendedPanId * otThreadGetExtendedPanId( otInstance *aInstance )
Obtenha o IEEE 802.15.4 Extended PAN ID.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | Um ponteiro para o IEEE 802.15.4 Extended PAN ID. |
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 |
| ||
Devoluções | Um ponteiro para o Identificador de Interface que foi definido manualmente ou NULL se nenhum foi definido. |
otThreadSetFixedDuaInterfaceIdentifier
otThreadGetIp6Counters
const otIpCounters * otThreadGetIp6Counters( otInstance *aInstance )
Obtenha os contadores IPv6.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | Um ponteiro para os contadores IPv6. |
otThreadGetKeySequenceCounter
uint32_t otThreadGetKeySequenceCounter( otInstance *aInstance )
Obtenha o thrKeySequenceCounter.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | O valor thrKeySequenceCounter. |
otThreadSetKeySequenceCounter
otThreadGetKeySwitchGuardTime
uint32_t otThreadGetKeySwitchGuardTime( otInstance *aInstance )
Obtenha o thrKeySwitchGuardTime.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | O valor thrKeySwitchGuardTime (em horas). |
otThreadSetKeySwitchGuardTime
otThreadGetLeaderData
otError otThreadGetLeaderData( otInstance *aInstance, otLeaderData *aLeaderData )
Esta função obtém os dados do líder da linha.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Valores de retorno |
|
otThreadGetLeaderRloc
otError otThreadGetLeaderRloc( otInstance *aInstance, otIp6Address *aLeaderRloc )
Esta função retorna um ponteiro para o RLOC do Líder.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores de retorno |
|
otThreadGetLeaderRouterId
uint8_t otThreadGetLeaderRouterId( otInstance *aInstance )
Obtenha o ID do roteador do líder.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | O ID do roteador do líder. |
otThreadGetLeaderWeight
uint8_t otThreadGetLeaderWeight( otInstance *aInstance )
Obtenha o Peso do Líder.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
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 |
| ||
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 |
| ||
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 |
| ||
Devoluções | A configuração do modo de link MLE. |
otThreadSetLinkMode
otThreadGetMeshLocalEid
const otIp6Address * otThreadGetMeshLocalEid( otInstance *aInstance )
Esta função retorna um ponteiro para o endereço do Mesh Local EID.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
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 |
| ||
Devoluções | Um ponteiro para o prefixo local da malha. |
otThreadGetMleCounters
const otMleCounters * otThreadGetMleCounters( otInstance *aInstance )
Obtenha os contadores Thread MLE.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
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 |
|
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 |
| ||
Devoluções | Referência à chave de rede de thread armazenada na memória. |
otThreadSetNetworkKeyRef
otThreadGetNetworkName
const char * otThreadGetNetworkName( otInstance *aInstance )
Obtenha o nome da rede do thread.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | Um ponteiro para o nome da rede de thread. |
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 |
| ||||||
Valores de retorno |
|
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 |
| ||||||
Return Values |
|
otThreadGetParentAverageRssi
otError otThreadGetParentAverageRssi( otInstance *aInstance, int8_t *aParentRssi )
The function retrieves the average RSSI for the Thread Parent.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otThreadGetParentInfo
otError otThreadGetParentInfo( otInstance *aInstance, otRouterInfo *aParentInfo )
The function retrieves diagnostic information for a Thread Router as parent.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otThreadGetParentLastRssi
otError otThreadGetParentLastRssi( otInstance *aInstance, int8_t *aLastRssi )
The function retrieves the RSSI of the last packet from the Thread Parent.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
| ||||||
Return Values |
|
otThreadGetPartitionId
uint32_t otThreadGetPartitionId( otInstance *aInstance )
Get the Partition ID.
Details | |||
---|---|---|---|
Parameters |
| ||
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 |
| ||
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 |
| ||
Returns | A pointer to the Thread Routing Locator (RLOC) address. |
otThreadGetRloc16
uint16_t otThreadGetRloc16( otInstance *aInstance )
Get the RLOC16.
Details | |||
---|---|---|---|
Parameters |
| ||
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 |
| ||||||
Return Values |
|
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 |
| ||
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 |
|
otThreadIsSingleton
bool otThreadIsSingleton( otInstance *aInstance )
This function indicates whether a node is the only router on the network.
Details | |||||
---|---|---|---|---|---|
Parameters |
| ||||
Return Values |
|
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 |
| ||||||||
Return Values |
|
otThreadRegisterParentResponseCallback
void otThreadRegisterParentResponseCallback( otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext )
This function registers a callback to receive MLE Parent Response data.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
otThreadResetIp6Counters
void otThreadResetIp6Counters( otInstance *aInstance )
Reset the IPv6 counters.
Details | |||
---|---|---|---|
Parameters |
|
otThreadResetMleCounters
void otThreadResetMleCounters( otInstance *aInstance )
Reset the Thread MLE counters.
Details | |||
---|---|---|---|
Parameters |
|
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 |
|
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 |
| ||||||||||||
Return Values |
|
otThreadSendDiagnosticReset
otError otThreadSendDiagnosticReset( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount )
Send a Network Diagnostic Reset request.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
| ||||||||
Return Values |
|
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 |
| ||||||||
Return Values |
|
otThreadSetChildTimeout
void otThreadSetChildTimeout( otInstance *aInstance, uint32_t aTimeout )
Set the Thread Child Timeout used when operating in the Child role.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otThreadGetChildTimeout
otThreadSetDiscoveryRequestCallback
void otThreadSetDiscoveryRequestCallback( otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext )
This function sets a callback to receive MLE Discovery Request data.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
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 |
| ||||
Return Values |
|
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 |
| ||||
Return Values |
|
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 |
| ||||
Return Values |
|
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 |
| ||||
Return Values |
|
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 |
| ||||||||
Return Values |
|
otThreadSetKeySequenceCounter
void otThreadSetKeySequenceCounter( otInstance *aInstance, uint32_t aKeySequenceCounter )
Set the thrKeySequenceCounter.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otThreadGetKeySequenceCounter
otThreadSetKeySwitchGuardTime
void otThreadSetKeySwitchGuardTime( otInstance *aInstance, uint32_t aKeySwitchGuardTime )
Set the thrKeySwitchGuardTime.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otThreadGetKeySwitchGuardTime
otThreadSetLinkMode
otError otThreadSetLinkMode( otInstance *aInstance, otLinkModeConfig aConfig )
Set the MLE Link Mode configuration.
Details | |||||
---|---|---|---|---|---|
Parameters |
| ||||
Return Values |
|
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 |
| ||||
Return Values |
|
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 |
| ||||
Return Values |
|
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 |
| ||||
Return Values |
|
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 |
| ||||
Return Values |
|
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 .