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

Geral

Este módulo inclui funções para todos os papéis da linha de execução.

Resumo

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

Todas as funções neste módulo exigem que a OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE esteja ativada.

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
}
tipo enumerado
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
}
tipo enumerado
Representa um papel de dispositivo Thread.
otNetDataPublisherEvent{
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
}
tipo enumerado
Esta enumeração representa os eventos informados pelos callbacks de editor.
otRoutePreference{
  OT_ROUTE_PREFERENCE_LOW = -1,
  OT_ROUTE_PREFERENCE_MED = 0,
  OT_ROUTE_PREFERENCE_HIGH = 1
}
tipo enumerado
Define valores válidos para mPreference no otExternalRouteConfig e no otBorderRouterConfig.

Typedefs

otBorderRouterConfig typedef
Essa estrutura representa uma configuração do roteador de borda.
otExternalRouteConfig typedef
Essa estrutura representa uma configuração de rota externa.
otIpCounters typedef
struct otIpCounters
Essa estrutura representa os contadores no nível do IP.
otLeaderData typedef
struct otLeaderData
Esta estrutura representa os dados da linha de execução da linha de execução.
otLinkModeConfig typedef
Essa estrutura representa uma configuração do modo de vinculação MLE.
otMleCounters typedef
struct otMleCounters
Essa estrutura representa os contadores de Thread MLE.
otNeighborInfoIterator typedef
int16_t
Usado para iterar a tabela vizinha.
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext) typedef
void(*
Esse tipo de ponteiro de função define o callback usado para notificar quando uma entrada do "DNS/SRP Service" é adicionada ou removida dos dados da rede Thread.
otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) typedef
void(*
Esse tipo de ponteiro de função define o callback usado para notificar quando uma entrada de prefixo (malha ou rota externa) é adicionada ou removida dos dados da rede de linha de execução.
otNetDataPublisherEvent typedef
Esta enumeração representa os eventos informados pelos callbacks de editor.
otNetworkDataIterator typedef
uint32_t
Usado para iterar as informações de dados da rede.
otNetworkDiagChildEntry typedef
Essa estrutura representa uma entrada da tabela filha de diagnóstico de rede.
otNetworkDiagConnectivity typedef
Essa estrutura representa um valor de conectividade de diagnóstico da rede.
otNetworkDiagIterator typedef
uint16_t
Usado para iterar por TLV de diagnóstico de rede.
otNetworkDiagMacCounters typedef
Essa estrutura representa um valor de contadores de diagnóstico de rede do Mac.
otNetworkDiagRoute typedef
Essa estrutura representa um valor de TLV da rota de diagnóstico de rede.
otNetworkDiagRouteData typedef
Essa estrutura representa uma rota de diagnóstico da rede.
otNetworkDiagTlv typedef
Essa estrutura representa um TLV de diagnóstico de rede.
otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) typedef
void(*
Este ponteiro de função é chamado quando a resposta do diagnóstico de rede é recebida.
otRoutePreference typedef
Define valores válidos para mPreference no otExternalRouteConfig e no otBorderRouterConfig.
otServerConfig typedef
Essa estrutura representa uma configuração do servidor.
otServiceConfig typedef
Essa estrutura representa uma configuração do serviço.
otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) typedef
void(*
Esse tipo de ponteiro de função define o callback para notificar o resultado de uma solicitação otThreadLocateAnycastDestination().
otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) typedef
void(*
Esse ponteiro de função é chamado sempre que uma mensagem de solicitação de descoberta do MLE é recebida.
otThreadDiscoveryRequestInfo typedef
Essa estrutura representa os dados de solicitação de descoberta da linha de execução.
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext) typedef
void(*
Este ponteiro de função é chamado sempre que uma mensagem de resposta mãe de MLE é recebida.
otThreadParentResponseInfo typedef
Essa estrutura representa os dados de resposta pai do MLE.

Functions

otNetDataContainsOmrPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Essa função verifica se um determinado prefixo pode atuar como um prefixo OMR válido e se os dados da rede do líder contêm esse prefixo.
otNetDataGet(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
Esse método fornece uma cópia completa ou estável dos dados da rede Thread.
otNetDataGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
Essa função recebe o próximo prefixo da malha nos dados de rede da partição.
otNetDataGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
Essa função recebe a próxima rota externa nos dados de rede da partição.
otNetDataGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
Essa função recebe o próximo serviço nos dados de rede da partição.
otNetDataGetStableVersion(otInstance *aInstance)
uint8_t
Fazer o download da versão estável dos dados de rede.
otNetDataGetVersion(otInstance *aInstance)
uint8_t
Acessar a versão de dados de rede.
otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)
bool
Essa função indica se a entrada "DNS/SRP Service" está ou não adicionada aos dados da rede Thread.
otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Essa função indica se uma entrada de prefixo publicada (na malha ou na rota externa) foi adicionada aos dados da rede da linha de execução.
otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)
void
Essa função solicita que o "endereço Anycast de DNS/SRP" seja publicado nos dados da rede Thread.
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
Esta função solicita que o "endereço do Unicast do DNS/SRP" seja publicado nos dados da rede da linha de execução.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
void
Esta função solicita que o "endereço do Unicast do DNS/SRP" seja publicado nos dados da rede da linha de execução.
otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
Essa função solicita que um prefixo de rota externo seja publicado nos dados da rede de linha de execução.
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
Essa função solicita que um prefixo da malha seja publicado nos dados da rede de linhas de execução.
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
Essa função define um callback para notificar quando um "serviço de DNS/SRP" publicado é realmente adicionado ou removido dos dados da rede da linha de execução.
otNetDataSetPrefixPublisherCallback(otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
Essa função define um callback para notificar quando uma entrada de prefixo publicada é realmente adicionada ou removida dos dados da rede de linha de execução.
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
Verifique se os dados de direcionamento incluem um combinador.
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
Verifique se os dados de direcionamento incluem um combinador com um determinado valor de disjuntor.
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
void
Essa função cancela a publicação de qualquer entrada de Serviço de DNS/SRP (Anycast ou Unicast) dos dados da rede Thread.
otNetDataUnpublishPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
Essa função cancela a publicação de um prefixo publicado anteriormente (na malha ou na rota externa).
otThreadBecomeChild(otInstance *aInstance)
Tente se reconectar como filha.
otThreadBecomeDetached(otInstance *aInstance)
Separe da rede Thread.
otThreadDeviceRoleToString(otDeviceRole aRole)
const char *
Converta o papel do dispositivo em uma string legível.
otThreadDiscover(otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
Essa função inicia uma verificação do Thread Discovery.
otThreadGetChildTimeout(otInstance *aInstance)
uint32_t
Define o tempo limite de execução de linha de execução usado na função de filho.
otThreadGetDeviceRole(otInstance *aInstance)
Encontre o papel do dispositivo.
otThreadGetDomainName(otInstance *aInstance)
const char *
Consiga o nome de domínio da linha de execução.
otThreadGetExtendedPanId(otInstance *aInstance)
const otExtendedPanId *
Receba o ID do PAN estendido IEEE 802.15.4.
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
Receber o identificador de interface especificado manualmente para o endereço Unicast do domínio da linha de execução.
otThreadGetIp6Counters(otInstance *aInstance)
const otIpCounters *
Encontre os contadores IPv6.
otThreadGetKeySequenceCounter(otInstance *aInstance)
uint32_t
Recebe o thaltostratSequenceCounter.
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
uint32_t
Receba o thaltostratSwitchGuardTime.
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
Essa função recebe os dados da linha de execução da linha de execução.
otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc)
Essa função retorna um ponteiro para o RLOC do líder.
otThreadGetLeaderRouterId(otInstance *aInstance)
uint8_t
Obter o ID do roteador do líder.
otThreadGetLeaderWeight(otInstance *aInstance)
uint8_t
Conquiste o peso do líder.
otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Essa função retorna o endereço multicast de Thread Link-Local todos os nós da Thread.
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
const otIp6Address *
Essa função retorna o endereço IPv6 link-local da linha de execução.
otThreadGetLinkMode(otInstance *aInstance)
Acessar a configuração do modo de vinculação MLE.
otThreadGetMeshLocalEid(otInstance *aInstance)
const otIp6Address *
Essa função retorna um ponteiro para o endereço EID local da malha.
otThreadGetMeshLocalPrefix(otInstance *aInstance)
Essa função retorna um ponteiro para o prefixo local da malha.
otThreadGetMleCounters(otInstance *aInstance)
const otMleCounters *
Consiga os contadores de Thread MLE.
otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey)
void
Receba a chave de rede Thread.
otThreadGetNetworkKeyRef(otInstance *aInstance)
Consiga o otNetworkKeyRef para a chave de rede Thread.
otThreadGetNetworkName(otInstance *aInstance)
const char *
Consiga o nome da rede Thread.
otThreadGetNextDiagnosticTlv(const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
Essa função recebe o próximo TLV de diagnóstico de rede na mensagem.
otThreadGetNextNeighborInfo(otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
Essa função recebe as informações do próximo vizinho.
otThreadGetParentAverageRssi(otInstance *aInstance, int8_t *aParentRssi)
A função recupera o RSSI médio do pai Thread.
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
A função recupera informações de diagnóstico de um roteador Thread como pai.
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
A função recupera o RSSI do último pacote do pai Thread.
otThreadGetPartitionId(otInstance *aInstance)
uint32_t
Consiga o ID da partição.
otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Essa função retorna o endereço multicast de Thread Realm-Local Nodes.
otThreadGetRloc(otInstance *aInstance)
const otIp6Address *
Essa função retorna um ponteiro para o endereço do localizador de roteamento de linhas de execução (RLOC).
otThreadGetRloc16(otInstance *aInstance)
uint16_t
Acesse o RLOC16.
otThreadGetServiceAloc(otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
Essa função recupera o ALOC de serviço para um determinado ID de serviço.
otThreadGetVersion(void)
uint16_t
Essa função recebe a versão do protocolo Thread.
otThreadIsAnycastLocateInProgress(otInstance *aInstance)
bool
Essa 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 linha de execução de MLE está em andamento.
otThreadIsSingleton(otInstance *aInstance)
bool
Essa função indica se um nó é o único roteador da rede.
otThreadLocateAnycastDestination(otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
Essa função solicita a localização mais próxima de um determinado endereço anycast a ser localizado.
otThreadRegisterParentResponseCallback(otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
Essa função registra um callback para receber dados da resposta pai do MLE.
otThreadResetIp6Counters(otInstance *aInstance)
void
Redefinir os contadores IPv6.
otThreadResetMleCounters(otInstance *aInstance)
void
Redefinir os contadores de Thread MLE.
otThreadSendAddressNotification(otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
Essa função envia uma mensagem de notificação de endereço proativa (ADDR_NTF.ntf).
otThreadSendDiagnosticGet(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
Envia uma solicitação de diagnóstico de rede.
otThreadSendDiagnosticReset(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
Enviar uma solicitação de redefinição de diagnóstico da rede.
otThreadSendProactiveBackboneNotification(otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
Essa função envia uma mensagem proativa do backbone (PRO_BB.ntf) no link do backbone.
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
void
Define o tempo limite de execução de linha de execução usado na função de filho.
otThreadSetDiscoveryRequestCallback(otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
Essa função define um callback para receber dados da solicitação de descoberta do MLE.
otThreadSetDomainName(otInstance *aInstance, const char *aDomainName)
Defina o nome do domínio da linha de execução.
otThreadSetEnabled(otInstance *aInstance, bool aEnabled)
Essa função inicia a operação do protocolo da linha de execução.
otThreadSetExtendedPanId(otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
Defina o ID do PAN estendido IEEE 802.15.4.
otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
Define/limpa o identificador de interface especificado manualmente para o endereço Unicast do domínio Thread.
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
Esse método define a publicidade de Thread Joiner ao descobrir a rede Thread.
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
void
Defina thaltostratSequenceCounter.
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
Defina thaltostratSwitchGuardTime.
otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)
Defina a configuração do modo MLE Link.
otThreadSetMeshLocalPrefix(otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
Essa função define o prefixo local da malha.
otThreadSetNetworkKey(otInstance *aInstance, const otNetworkKey *aKey)
Defina a chave de rede Thread.
otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)
Defina a chave de rede da linha de execução como uma otNetworkKeyRef.
otThreadSetNetworkName(otInstance *aInstance, const char *aNetworkName)
Defina o nome da rede Thread.

Estruturas

otBorderRouterConfig.

Essa estrutura representa uma configuração do roteador de borda.

otExternalRouteConfig.

Essa estrutura representa uma configuração de rota externa.

otIpCounters (em inglês)

Essa estrutura representa os contadores no nível do IP.

otLeaderData (em inglês)

Esta estrutura representa os dados da linha de execução da linha de execução.

otLinkModeConfig.

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

otMleCounters (em inglês)

Essa estrutura representa os contadores de Thread MLE.

OtNeighborInfo (em inglês)

Essa estrutura armazena informações de diagnóstico de um nó da linha de execução vizinho.

otNetworkDiagChildEntry

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

otNetworkDiagConnectivity

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

otNetworkDiagMacCounters.

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

otNetworkDiagRoute (em inglês)

Essa estrutura representa um valor de TLV da rota de diagnóstico de rede.

otNetworkDiagRouteData.

Essa estrutura representa uma rota de diagnóstico da rede.

otNetworkDiagTlv

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

otRouterInfo.

Essa estrutura contém informações de diagnóstico para um roteador de linha de execução.

otServerConfig (em inglês)

Essa estrutura representa uma configuração do servidor.

otServiceConfig.

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

otThreadDiscoveryRequestInfo (em inglês)

Essa estrutura representa os dados de solicitação de descoberta da linha de execução.

otThreadParentResponseInfo (em inglês)

Essa estrutura representa os dados de resposta pai do MLE.

Enumerações

enumeração anônima

 anonymous enum
Propriedades
OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

Nível de bateria TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

TLV de páginas do canal.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

TLV da tabela filha.

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

TLV de conectividade.

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

TLV do endereço estendido de MAC.

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

TLV da lista de endereços IPv6.

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

TLV de dados do líder

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

TLV de contagens MAC.

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

TLV de tempo limite máximo filho

OT_NETWORK_DIAGNOSTIC_TLV_MODE

Modo TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

TLV de dados da rede.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

TLV da Route64.

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

TLV de endereço16.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

TLV da alimentação.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

Tempo limite TLV (o período máximo de pesquisa para SEDs)

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

Digite TLV.

OtDeviceRole

 otDeviceRole

Representa um papel de dispositivo Thread.

Propriedades
OT_DEVICE_ROLE_CHILD

Papel Thread Thread.

OT_DEVICE_ROLE_DETACHED

Não participa de uma rede/partição de linha de execução no momento.

OT_DEVICE_ROLE_DISABLED

A pilha de linhas de execução está desativada.

OT_DEVICE_ROLE_LEADER

Papel de líder de conversa

OT_DEVICE_ROLE_ROUTER

Papel Thread Router.

OtNetDataPublisherEvent

 otNetDataPublisherEvent

Esta enumeração representa os eventos informados pelos callbacks de editor.

Propriedades
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED

A entrada publicada é adicionada aos dados da rede da linha de execução.

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

A entrada publicada é removida dos dados da rede de linhas de execução.

OtRoutePreference

 otRoutePreference

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

Propriedades
OT_ROUTE_PREFERENCE_HIGH

Preferência de rota alta.

OT_ROUTE_PREFERENCE_LOW

Preferência de trajeto baixo.

OT_ROUTE_PREFERENCE_MED

Preferência de rota média.

Typedefs

OtBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

Essa estrutura representa uma configuração do roteador de borda.

OtExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

Essa estrutura representa uma configuração de rota externa.

OtIpCounters

struct otIpCounters otIpCounters

Essa estrutura representa os contadores no nível do IP.

OtLeaderData

struct otLeaderData otLeaderData

Esta estrutura representa os dados da linha de execução da linha de execução.

OtLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

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

OtMleCounters

struct otMleCounters otMleCounters

Essa estrutura representa os contadores de Thread MLE.

OtNeighborInfoiter

int16_t otNeighborInfoIterator

Usado para iterar a tabela vizinha.

OtNetDataDnsSrpServicePublisherCallback

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

Esse tipo de ponteiro de função define o callback usado para notificar quando uma entrada do "DNS/SRP Service" é adicionada ou removida dos dados da rede Thread.

Depois da remoção, o callback é 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 (por exemplo, uma chamada para otNetDataUnpublishDnsSrpService()).

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

OtNetDataPrefixPublisherCallback

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

Esse tipo de ponteiro de função define o callback usado para notificar quando uma entrada de prefixo (malha ou rota externa) é adicionada ou removida dos dados da rede de linha de execução.

Depois da remoção, o callback é 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.

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

OtNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

Esta enumeração representa os eventos informados pelos callbacks de editor.

OtNetworkDataiter

uint32_t otNetworkDataIterator

Usado para iterar as informações de dados da rede.

OtNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

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

OtNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

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

OtNetworkDiagiter

uint16_t otNetworkDiagIterator

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

otNetworkDiagMacCounters.

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

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

Consulte a RFC 2863 (em inglês) para ver as definições dos campos dos membros.

OtNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

Essa estrutura representa um valor de TLV da rota de diagnóstico de rede.

OtNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

Essa estrutura representa uma rota de diagnóstico da 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)

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

Detalhes
Parâmetros
[in] aError
Ocorreu um erro ao receber a resposta.
[in] aMessage
Um ponteiro para o buffer de mensagem que contém o payload de resposta Receber diagnóstico de rede. Disponível apenas quando aError é OT_ERROR_NONE.
[in] aMessageInfo
Um ponteiro para as informações da mensagem de aMessage. Disponível apenas quando aError é OT_ERROR_NONE.
[in] aContext
Um ponteiro para contexto específico do aplicativo.

OtRoutePreference

enum otRoutePreference otRoutePreference

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

OtServerConfig

struct otServerConfig otServerConfig

Essa estrutura representa uma configuração do servidor.

OtServiceConfig

struct otServiceConfig otServiceConfig

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

OtThreadAnycastLocatorCallback

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

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

Detalhes
Parâmetros
[in] aContext
Um ponteiro para um contexto arbitrário (fornecido quando o callback é registrado).
[in] aError
O erro ao processar a solicitação. OT_ERROR_NONE indica sucesso. OT_ERROR_RESPONSE_REFUND indica que um destino não foi encontrado. OT_ERROR_ABORT indica que a solicitação foi cancelada.
[in] aMeshLocalAddress
Um ponteiro para o EID da malha local do destino mais próximo do endereço anycast quando aError for OT_ERROR_NONE. Caso contrário, será NULL.
[in] aRloc16
O RLOC16 do destino, se encontrado. Do contrário, é RLOC16 inválido (0xfffe).

OtThreadDiscoveryRequestCallback

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

Esse ponteiro de função é chamado sempre que uma mensagem de solicitação de descoberta do 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 retornar um contexto específico do aplicativo.

OtThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

Essa estrutura representa os dados de solicitação de descoberta da linha de execução.

OtThreadParentResponseCallback

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

Este ponteiro de função é chamado sempre que uma mensagem de resposta mãe de MLE é recebida.

Detalhes
Parâmetros
[in] aInfo
Um ponteiro para um local na pilha com os dados de estatísticas.
[in] aContext
Um ponteiro para retornar um contexto específico do cliente.

OtThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

Essa estrutura representa os dados de resposta pai do MLE.

Functions

otNetDataContémOmrPrefix

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

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

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aPrefix
Um ponteiro para o prefixo IPv6.
Retorna
Se aPrefix é um prefixo OMR válido e os dados da rede da liderança contêm o prefixo OMR aPrefix.

OtNetDataGet

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

Esse método fornece uma cópia completa ou estável dos dados da rede Thread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do 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, o tamanho do buffer de dados apontado por aData. Na saída, o número de bytes copiados.

otNetDataGetNextOnMeshPrefix

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

Essa função recebe o próximo prefixo da malha nos dados de rede da partição.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in,out] aIterator
Um ponteiro para o contexto de iteração dos dados de rede. Para conseguir a primeira entrada na malha, ela precisa 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
O próximo prefixo da malha foi encontrado.
OT_ERROR_NOT_FOUND
Não existe nenhum prefixo "On Mesh" nos dados da rede Thread.

OtNetDataGetNextRoute

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

Essa função recebe a próxima rota externa nos dados de rede da partição.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in,out] aIterator
Um ponteiro para o contexto de iteração dos dados de rede. Para conseguir a primeira entrada de rota externa, ela precisa ser definida como OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Um indicador para o local onde as informações da rota externa serão colocadas.
Valores de retorno
OT_ERROR_NONE
Próxima rota externa encontrada.
OT_ERROR_NOT_FOUND
Não existe nenhuma entrada de rota externa subsequente nos dados da rede de linha de execução.

OtNetDataGetNextService

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

Essa função recebe o próximo serviço nos dados de rede da partição.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in,out] aIterator
Um ponteiro para o contexto de iteração dos dados de rede. Para conseguir a primeira entrada de serviço, ela precisa 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
O próximo serviço foi encontrado.
OT_ERROR_NOT_FOUND
Não há serviço subsequente nos dados de rede da partição.

OtNetDataGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

Fazer o download da versão estável dos dados de rede.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Versão estável dos dados de rede.

OtNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

Acessar a versão de dados de rede.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
A versão dos dados de rede.

OtNetDataIsDnsSrpServiceAdded

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

Essa função indica se a entrada "DNS/SRP Service" está ou não adicionada aos dados da rede Thread.

Essa função exige que o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE esteja ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
TRUE
A entrada publicada do serviço de DNS/SRP é adicionada aos dados da rede da linha de execução.
FALSE
A entrada não é adicionada aos dados da rede da conversa ou não há uma entrada para publicar.

otNetDataIsPrefixAdded

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

Essa função indica se uma entrada de prefixo publicada (na malha ou na rota externa) foi adicionada aos dados da rede da linha de execução.

Essa função exige que o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE esteja ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aPrefix
Um ponteiro para o prefixo (NÃO DEVE ser NULL).
Valores de retorno
TRUE
A entrada do prefixo publicada é adicionada aos dados da rede da linha de execução.
FALSE
A entrada não é adicionada aos dados da rede da conversa ou não há uma entrada para publicar.

OtNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

Essa função solicita que o "endereço Anycast de DNS/SRP" seja publicado nos dados da rede Thread.

Essa função exige que o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE esteja ativado.

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

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aSequenceNUmber
O número sequencial do serviço DNS/SRP Anycast.

OtNetDataPublishDnsSrpServiceUnicast

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

Esta função solicita que o "endereço do Unicast do DNS/SRP" seja publicado nos dados da rede da linha de execução.

Essa função exige que o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE esteja ativado.

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

Essa função publica o "DNS/SRP endereço Unicast de serviço" incluindo as informações de endereço e de porta nos dados TLV de serviço.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aAddress
O endereço do servidor DNS/SRP a ser publicado (NÃO pode ser NULL).
[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 do Unicast do DNS/SRP" seja publicado nos dados da rede da linha de execução.

Essa função exige que o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE esteja ativado.

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

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

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

OtNetDataPublishExternalRoute

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

Essa função solicita que um prefixo de rota externo seja publicado nos dados da rede de linha de execução.

Essa função exige que o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE esteja ativado.

Somente entradas estáveis podem ser publicadas, ou seja,aConfig.mStable PRECISA ser VERDADEIRO).

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aConfig
A configuração da rota externa a ser publicada (NÃO pode ser NULL).
Valores de retorno
OT_ERROR_NONE
A rota externa foi publicada.
OT_ERROR_INVALID_ARGS
O aConfig é inválido (prefixo inválido, combinações de sinalização inválidas ou instá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 editor é compatível com um número limitado de entradas (compartilhadas entre o prefixo da malha e a rota externa) determinadas pela configuração OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataPublishOnMeshPrefix

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

Essa função solicita que um prefixo da malha seja publicado nos dados da rede de linhas de execução.

Essa função exige que o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE esteja ativado.

Somente entradas estáveis podem ser publicadas, ou seja,aConfig.mStable PRECISA ser VERDADEIRO).

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aConfig
Configuração de prefixo da malha a ser publicada (NÃO DEVE ser NULL).
Valores de retorno
OT_ERROR_NONE
O prefixo on-malsh foi publicado.
OT_ERROR_INVALID_ARGS
O aConfig é inválido (prefixo inválido, combinações de sinalização inválidas ou instá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 editor é compatível com um número limitado de entradas (compartilhadas entre o prefixo da malha e a rota externa) determinadas pela configuração OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

OtNetDataSetDnsSrpServicePublisherCallback

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

Essa função define um callback para notificar quando um "serviço de DNS/SRP" publicado é realmente adicionado ou removido dos dados da rede da linha de execução.

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

Essa função exige que o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE esteja ativado.

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

otNetDataSetPrefixPublisherCallback

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

Essa função define um callback para notificar quando uma entrada de prefixo publicada é realmente adicionada ou removida dos dados da rede de linha de execução.

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

Essa função exige que o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE esteja ativado.

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

OtNetDataSteeringDataCheckJoiner

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

Verifique se os dados de direcionamento incluem um combinador.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aEui64
Um ponteiro para o EUI-64 do IEEE do Combinador.
Valores de retorno
OT_ERROR_NONE
aEui64 está incluído nos dados de direcionamento.
OT_ERROR_INVALID_STATE
Não há dados de direcionamento.
OT_ERROR_NOT_FOUND
aEui64 não está incluído nos dados de direcionamento.

otNetDataSteeringDataCheckJoinerWithDiscerner

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

Verifique se os dados de direcionamento incluem um combinador com um determinado valor de disjuntor.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDiscerner
Um ponteiro para o Discerner do combinador.
Valores de retorno
OT_ERROR_NONE
aDiscerner está incluído nos dados de direcionamento.
OT_ERROR_INVALID_STATE
Não há dados de direcionamento.
OT_ERROR_NOT_FOUND
aDiscerner não está incluído nos dados de direcionamento.

OtNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

Essa função cancela a publicação de qualquer entrada de Serviço de DNS/SRP (Anycast ou Unicast) dos dados da rede Thread.

Essa função exige que o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE esteja ativado.

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

otNetDataUnpublishPrefix

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

Essa função cancela a publicação de um prefixo publicado anteriormente (na malha ou na rota externa).

Essa função exige que o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE esteja ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aPrefix
O prefixo para cancelar a publicação (NÃO pode ser NULL).
Valores de retorno
OT_ERROR_NONE
A publicação do prefixo foi cancelada.
OT_ERROR_NOT_FOUND
Não foi possível encontrar o prefixo na lista publicada.

OtThreadBeginChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

Tente se reconectar como filha.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
OT_ERROR_NONE
A tentativa de se tornar uma criança foi iniciada.
OT_ERROR_INVALID_STATE
A conversa está desativada.

OtThreadBeginDetached

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Separe da rede Thread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
OT_ERROR_NONE
Separado da rede Thread.
OT_ERROR_INVALID_STATE
A conversa está desativada.

OtThreadDeviceRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

Converta o papel do dispositivo em uma string legível.

Detalhes
Parâmetros
[in] aRole
A função do dispositivo a ser convertida.
Retorna
String que representa aRole.

ThreadThread

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

Essa função inicia uma verificação do Thread Discovery.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aScanChannels
Um vetor de bits que indica quais canais serão verificados (por exemplo, OT_CHANNEL_11_MASK).
[in] aPanId
O filtro de código PAN, definido como "Transmitir PAN", para desativar o filtro,
[in] aJoiner
Valor da sinalização do Combinador no TLV da solicitação de descoberta.
[in] aEnableEui64Filtering
TRUE para filtrar respostas em EUI-64. Caso contrário, FALSO.
[in] aCallback
Um ponteiro para uma função chamada para receber uma resposta de descoberta ou verificação de MLE concluída.
[in] aCallbackContext
Um ponteiro para contexto específico do aplicativo.
Valores de retorno
OT_ERROR_NONE
Uma verificação de descoberta da linha de execução foi iniciada.
OT_ERROR_INVALID_STATE
A interface IPv6 não está ativada (netif não está ativo).
OT_ERROR_NO_BUFS
Não foi possível alocar a mensagem para a solicitação de descoberta.
OT_ERROR_BUSY
A verificação de descoberta da conversa já está em andamento.

OtThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

Define o tempo limite de execução de linha de execução usado na função de filho.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Indica o valor do tempo limite do filho da linha de execução em segundos.
Consulte também:
otThreadSetChildTimeout

OtThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Encontre o papel do dispositivo.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
OT_DEVICE_ROLE_DISABLED
A pilha de linhas de execução está desativada.
OT_DEVICE_ROLE_DETACHED
O dispositivo não está participando de uma rede/partição de linha de execução.
OT_DEVICE_ROLE_CHILD
No momento, o dispositivo está operando como Thread Thread.
OT_DEVICE_ROLE_ROUTER
O dispositivo está funcionando como um roteador Thread.
OT_DEVICE_ROLE_LEADER
No momento, o dispositivo está operando como uma linha de execução líder.

OtThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Consiga o nome de domínio da linha de execução.

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

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para o nome de domínio da linha de execução.
Consulte também:
otThreadSetDomainName

OtThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Receba o ID do PAN estendido IEEE 802.15.4.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para o código estendido de IEEE 802.15.4.
Consulte também:
otThreadSetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

Receber o identificador de interface especificado manualmente para o endereço Unicast do domínio da linha de execução.

Essa função só está disponível desde a Thread 1.2, quando OPENTHREAD_CONFIG_DUA_ENABLE está ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para o identificador de interface que foi definido manualmente ou NULL caso nenhum tenha sido definido.
Consulte também:
otThreadSetFixedDuaInterfaceIdentifier

OtThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

Encontre os contadores IPv6.

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

OtThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Recebe o thaltostratSequenceCounter.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O valor thaltostratSequenceCounter.
Consulte também:
otThreadSetKeySequenceCounter

OtThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Receba o thaltostratSwitchGuardTime.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O valor thaltostratSwitchGuardTime (em horas).
Consulte também:
otThreadSetKeySwitchGuardTime

OtThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

Essa função recebe os dados da linha de execução da linha de execução.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aLeaderData
Um ponteiro para colocar os dados da variante líder.
Valores de retorno
OT_ERROR_NONE
Os dados do líder foram recuperados.
OT_ERROR_DETACHED
Não anexado no momento.

OtThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

Essa função retorna um ponteiro para o RLOC do líder.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aLeaderRloc
Um indicador para o RLOC do líder.
Valores de retorno
OT_ERROR_NONE
O RLOC do líder foi gravado em aLeaderRloc.
OT_ERROR_INVALID_ARGS
aLeaderRloc era NULL.
OT_ERROR_DETACHED
Não anexado a uma partição de linhas de execução.

OtThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Obter o ID do roteador do líder.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O ID do roteador do líder.

OtThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

Conquiste o peso do líder.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O peso do líder.

otThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Essa função retorna o endereço multicast de Thread Link-Local todos os nós da Thread.

O endereço é um endereço de Multcast baseado em prefixo Unicast [RFC 3306], com:

  • flgs definidos para 3 (P = 1 e T = 1)
  • escopo definido como 2.
  • plen definido para 64
  • Prefixo de rede definido como o prefixo local da rede mesh
  • código do grupo definido como 1

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para o endereço multicast de link de linha de execução local para todos os nós de linha de execução.

OtThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

Essa função retorna o endereço IPv6 link-local da linha de execução.

O endereço local do link de linha de execução é derivado usando o endereço estendido IEEE802.15.4 como identificador de interface.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para o endereço IPv6 link-local da linha de execução.

OtThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

Acessar a configuração do modo de vinculação MLE.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
A configuração do modo de vinculação MLE.
Consulte também:
otThreadSetLinkMode

OtThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

Essa função retorna um ponteiro para o endereço EID local da malha.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para o endereço EID local da malha.

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

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

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para o prefixo local de malha.

OtThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Consiga os contadores de Thread MLE.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para os contadores de Thread MLE.

OtThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

Receba a chave de rede Thread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aNetworkKey
Um ponteiro para um otNetworkkey para retornar a chave de rede da linha de execução.
Consulte também:
otThreadSetNetworkKey

OtThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

Consiga o otNetworkKeyRef para a chave de rede Thread.

Essa função exige que o recurso de tempo de compilação OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE esteja ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Referência à chave de rede Thread armazenada na memória.
Consulte também:
otThreadSetNetworkKeyRef

OtThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

Consiga o nome da rede Thread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para o nome da rede Thread.
Consulte também:
otThreadSetNetworkName

OtThreadGetNextDiagnosticTlv

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

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

Uma chamada subsequente para essa função só é permitida 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 de iteração do Diagnóstico de rede. Para obter o primeiro TLV de diagnóstico de rede, defina-o como OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
[out] aNetworkDiagTlv
Um ponteiro para as informações TLV de diagnóstico de rede.
Valores de retorno
OT_ERROR_NONE
O próximo TLV de diagnóstico de rede foi encontrado.
OT_ERROR_NOT_FOUND
Não há TLV de diagnóstico de rede posterior na mensagem.
OT_ERROR_PARSE
Não foi possível analisar o próximo diagnóstico de rede.

OtThreadGetNextNeighborInfo

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

Essa função recebe as informações do próximo vizinho.

Ele é usado para analisar as entradas da tabela vizinha.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in,out] aIterator
Um ponteiro para o contexto do iteração. Para conseguir a primeira entrada vizinha, ela precisa ser definida como OT_NEIGHBOR_INFO_ITERATOR_INIT.
[out] aInfo
Um ponteiro para as informações do vizinho.
Valores de retorno
OT_ERROR_NONE
Próxima entrada de vizinho encontrada na tabela.
OT_ERROR_NOT_FOUND
Não há entradas vizinhas subsequentes na tabela.
OT_ERROR_INVALID_ARGS
aIterator ou aInfo era NULL.

ThreadThreadParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

A função recupera o RSSI médio do pai Thread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aParentRssi
Um ponteiro para colocar a RSSI mãe.

OtThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

A função recupera informações de diagnóstico de um roteador Thread como pai.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aParentInfo
Um ponteiro para o local em que as informações do roteador pai são colocadas.

OtThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

A função recupera o RSSI do último pacote do pai Thread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aLastRssi
Um ponteiro para colocar o último RSSI.
Valores de retorno
OT_ERROR_NONE
Os dados RSSI foram recuperados.
OT_ERROR_FAILED
Não foi possível acessar os dados RSSI.
OT_ERROR_INVALID_ARGS
aLastRssi é NULL;

OtThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Consiga o ID da partição.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O ID da partição.

otThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Essa função retorna o endereço multicast de Thread Realm-Local Nodes.

O endereço é um endereço Multcast baseado em prefixo Unicast [RFC 3306], com:

  • flgs definidos para 3 (P = 1 e T = 1)
  • escopo definido como 3.
  • plen definido para 64
  • Prefixo de rede definido como o prefixo local da rede mesh
  • código do grupo definido como 1

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para o endereço multicast de Thread Realm-Local All Thread Nodes.

OtThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

Essa função retorna um ponteiro para o endereço do localizador de roteamento de linhas de execução (RLOC).

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para o endereço do localizador de roteamento de linhas de execução (RLOC).

ThreadThreadRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Acesse o RLOC16.

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

OtThreadGetServiceAloc

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

Essa função recupera o ALOC de serviço para um determinado ID de serviço.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aServiceId
ID do serviço para receber o ALOC.
[out] aServiceAloc
Um ponteiro para gerar o ALOC de serviço. NÃO DEVE ser NULL.
Valores de retorno
OT_ERROR_NONE
O ALOC de serviço foi recuperado.
OT_ERROR_DETACHED
A interface da linha de execução não está anexada a uma partição de linha de execução.

ThreadThread

uint16_t otThreadGetVersion(
  void
)

Essa função recebe a versão do protocolo Thread.

Detalhes
Retorna
a versão do protocolo da linha de execução

OtThreadIsAnycastFindInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

Essa função indica se uma solicitação de localização anycast está em andamento.

Esta função só está disponível quando OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE está ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
TRUE se uma solicitação de localização anycast estiver em andamento. Caso contrário, será FALSE.

OtThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

Esta função determina se uma descoberta de linha de execução de MLE está em andamento.

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

OtThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

Essa função indica se um nó é o único roteador da rede.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
TRUE
É o único roteador da rede.
FALSE
É um filho ou não é um roteador único na rede.

ThreadThreadAnycastDestination

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

Essa função solicita a localização mais próxima de um determinado endereço anycast a ser localizado.

Esta função só está disponível quando OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE está ativado.

Se uma solicitação anterior estiver em andamento, uma chamada subsequente para essa função cancelará e substituirá a solicitação anterior.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aAnycastAddress
O endereço Anycast a ser localizado. NÃO DEVE ser NULL.
[in] aCallback
A função de retorno de chamada para relatar o resultado.
[in] aContext
Um contexto arbitrário usado com aCallback.
Valores de retorno
OT_ERROR_NONE
A solicitação foi iniciada. aCallback será invocado para informar o resultado.
OT_ERROR_INVALID_ARGS
aAnycastAddress não é um endereço anycast válido ou aCallback é NULL.
OT_ERROR_NO_BUFS
Fora do buffer para preparar e enviar a mensagem de solicitação.

OtThreadRegisterParentResponseCallback

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

Essa função registra um callback para receber dados da resposta pai do MLE.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aCallback
Um ponteiro para uma função chamada ao receber uma mensagem de resposta mãe de MLE.
[in] aContext
Um ponteiro para retornar um contexto específico do cliente.

OtThreadResetIp6Counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Redefinir os contadores IPv6.

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

OtThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Redefinir os contadores de Thread MLE.

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

OtThreadSendAddressNotification

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

Essa função envia uma mensagem de notificação de endereço proativa (ADDR_NTF.ntf).

Esta função só está disponível quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDestination
O destino de envio da mensagem ADDR_NTF.ntf.
[in] aTarget
O endereço de destino da mensagem ADDR_NTF.ntf.
[in] aMlIid
O ML-IID da mensagem ADDR_NTF.ntf.

OtThreadSendDiagnosticGet

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

Envia uma solicitação de diagnóstico de rede.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDestination
Um ponteiro para endereço de destino.
[in] aTlvTypes
Uma matriz de tipos de TLV de diagnóstico de rede.
[in] aCount
Número de tipos em aTlvTypes.
[in] aCallback
Um ponteiro para uma função chamada quando uma resposta de diagnóstico de rede é recebida ou NULL para desativar o callback.
[in] aCallbackContext
Um ponteiro para contexto específico do aplicativo.
Valores de retorno
OT_ERROR_NONE
Na fila DIAG_GET.req.
OT_ERROR_NO_BUFS
Buffers de mensagens insuficientes disponíveis para enviar DIAG_GET.req.

OtThreadSendDiagnosticRedefinir

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

Enviar uma solicitação de redefinição de diagnóstico da rede.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDestination
Um ponteiro para endereço de destino.
[in] aTlvTypes
Uma matriz de tipos de TLV de diagnóstico de rede. No momento, somente o Tipo 9 é permitido.
[in] aCount
Número de tipos em aTlvTypes
Valores de retorno
OT_ERROR_NONE
Na fila DIAG_RST.ntf.
OT_ERROR_NO_BUFS
Buffers de mensagens insuficientes disponíveis para enviar DIAG_RST.ntf.

OtThreadSendProactiveBackboneNotification

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

Essa função envia uma mensagem proativa do backbone (PRO_BB.ntf) no link do backbone.

Esta função só está disponível quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aTarget
O endereço de destino da mensagem PRO_BB.ntf.
[in] aMlIid
O ML-IID da mensagem PRO_BB.ntf.
[in] aTimeSinceLastTransaction
Tempo desde a última transação (em segundos).
Valores de retorno
OT_ERROR_NONE
PRO_BB.ntf enviado com sucesso no link da backbone.
OT_ERROR_NO_BUFS
Se não houver buffers de mensagem suficientes.

ThreadThreadChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Define o tempo limite de execução de linha de execução usado na função de filho.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aTimeout
O valor do tempo limite em segundos.
Consulte também:
otThreadGetChildTimeout

OtThreadSetDiscoveryRequestCallback

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

Essa função define um callback para receber dados da solicitação de descoberta do MLE.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aCallback
Um ponteiro para uma função chamada ao receber uma mensagem de solicitação de descoberta do MLE.
[in] aContext
Um ponteiro para retornar um contexto específico do aplicativo.

OtThreadSetDomainName

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

Defina o nome do domínio da linha de execução.

Essa função só está disponível desde a Thread 1.2. Essa função só funciona quando os protocolos da linha de execução estão desativados.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDomainName
Um ponteiro para o nome de domínio da linha de execução.
Valores de retorno
OT_ERROR_NONE
O nome de domínio da conversa foi definido.
OT_ERROR_INVALID_STATE
Os protocolos da conversa estão ativados.
Veja também:
otThreadGetDomainName

ThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Essa função inicia a operação do protocolo da linha de execução.

A interface precisa estar ativa ao chamar a função.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aEnabled
Verdadeiro se a linha de execução estiver ativada. Caso contrário, será FALSO.
Valores de retorno
OT_ERROR_NONE
Operação de protocolo Thread iniciada.
OT_ERROR_INVALID_STATE
A interface de rede não estava ativa.

ThreadSetExtendedPanId

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

Defina o ID do PAN estendido IEEE 802.15.4.

Esta função só pode ser chamada enquanto os protocolos da linha de execução estão desativados. Uma chamada bem-sucedida para essa função invalida os conjuntos de dados operacionais ativos e pendentes na memória não volátil.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aExtendedPanId
Um ponteiro para o código estendido de IEEE 802.15.4.
Valores de retorno
OT_ERROR_NONE
O código PAN estendido foi definido.
OT_ERROR_INVALID_STATE
Os protocolos da conversa estão ativados.
Consulte também:
otThreadGetExtendedPanId

otThreadSetFixedDuaInterfaceIdentifier

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

Define/limpa o identificador de interface especificado manualmente para o endereço Unicast do domínio Thread.

Essa função só está disponível desde a Thread 1.2, quando OPENTHREAD_CONFIG_DUA_ENABLE está ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aIid
Um ponteiro para o identificador de interface a definir ou NULL para limpar.
Valores de retorno
OT_ERROR_NONE
O identificador de interface foi definido/apagado.
OT_ERROR_INVALID_ARGS
O identificador de interface especificado está reservado.
Consulte também:
otThreadGetFixedDuaInterfaceIdentifier

OtThreadSetJoinerAdvertisingment

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

Esse método define a publicidade de Thread Joiner ao descobrir a rede Thread.

Esse recurso é usado para permitir que um Companheiro anuncie as próprias informações específicas do aplicativo (como ID do fornecedor, ID do produto, Discriminador etc.) usando um TLV de publicidade de proposta recém-projetado e disponibilizar essas informações para comissários ou candidatos a comissários sem interação humana.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aOui
O valor da OUI do fornecedor de IEEE que será incluído na publicidade conjunta. Somente os três bytes menos significativos serão usados, e o byte mais significativo será ignorado.
[in] aAdvData
Um ponteiro para o AdvData que será incluído na Publicidade mesclada.
[in] aAdvDataLength
O tamanho de AdvData em bytes.
Valores de retorno
OT_ERROR_NONE
A Publicidade de participantes foi definida.
OT_ERROR_INVALID_ARGS
AdvData inválido.

ThreadThreadKeyKeyCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Defina thaltostratSequenceCounter.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aKeySequenceCounter
O valor thaltostratSequenceCounter.
Consulte também:
otThreadGetKeySequenceCounter

OtThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Defina thaltostratSwitchGuardTime.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aKeySwitchGuardTime
O valor thaltostratSwitchGuardTime (em horas).
Veja também:
otThreadGetKeySwitchGuardTime

ThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Defina a configuração do modo MLE Link.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aConfig
Um ponteiro para a configuração do modo de vinculação.
Valores de retorno
OT_ERROR_NONE
A configuração do modo de vinculação MLE foi definida.
Veja também:
otThreadGetLinkMode

otThreadSetMeshLocalPrefix

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

Essa função define o prefixo local da malha.

Essa função só funciona quando os protocolos da linha de execução estão desativados. Uma chamada bem-sucedida para essa função invalida os conjuntos de dados operacionais ativos e pendentes na memória não volátil.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aMeshLocalPrefix
Um ponteiro para o prefixo local de malha.
Valores de retorno
OT_ERROR_NONE
O prefixo local da rede mesh foi definido.
OT_ERROR_INVALID_STATE
Os protocolos da conversa estão ativados.

ThreadSetNetworkKey

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

Defina a chave de rede Thread.

Essa função só funciona quando os protocolos da linha de execução estão desativados. Uma chamada bem-sucedida para essa função invalida os conjuntos de dados operacionais ativos e pendentes na memória não volátil.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aKey
Um ponteiro para um buffer que contém a chave de rede Thread.
Valores de retorno
OT_ERROR_NONE
A chave de rede da linha de execução foi definida.
OT_ERROR_INVALID_STATE
Os protocolos da conversa estão ativados.
Consulte também:
otThreadGetNetworkKey

OtThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

Defina a chave de rede da linha de execução como uma otNetworkKeyRef.

Essa função só funciona quando os protocolos da linha de execução estão desativados. Uma chamada bem-sucedida para essa função invalida os conjuntos de dados operacionais ativos e pendentes na memória não volátil.

Essa função exige que o recurso de tempo de compilação OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE esteja ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aKeyRef
Referência à chave de rede Thread.
Valores de retorno
OT_ERROR_NONE
A chave de rede da linha de execução foi definida.
OT_ERROR_INVALID_STATE
Os protocolos da conversa estão ativados.
Consulte também:
otThreadGetNetworkKeyRef

ThreadSetNetworkName

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

Defina o nome da rede Thread.

Essa função só funciona quando os protocolos da linha de execução estão desativados. Uma chamada bem-sucedida para essa função invalida os conjuntos de dados operacionais ativos e pendentes na memória não volátil.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aNetworkName
Um ponteiro para o nome da rede Thread.
Valores de retorno
OT_ERROR_NONE
O nome da rede Thread foi definido.
OT_ERROR_INVALID_STATE
Os protocolos da conversa estão ativados.
Consulte também:
otThreadGetNetworkName

Macros

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Tamanho máximo de publicidade de anúncios combinados.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Inicialização do otNeighborInfoiter.

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

Tamanho máximo do valor do TLV da base de linhas de execução.

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

Valor para inicializar otNetworkDataIterator.

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

Tamanho da entrada da tabela filha de diagnóstico de rede.

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Inicializador de otNetworkDiagiter.

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

Número máximo de tipos de TLV de diagnóstico de rede para solicitar ou redefinir.

OT_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

ID máximo do roteador.

OT_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

Tamanho máximo dos dados do servidor em bytes. Limite teórico, praticamente muito mais baixo.

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

Tamanho máximo dos dados do serviço em bytes.

Recursos

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