Geral
Este módulo inclui funções para todos os papéis da Thread.
Resumo
O Network Data Publisher fornece mecanismos para limitar o número de entradas de serviço e/ou prefixo semelhantes (prefixo da malha ou rota externa) nos dados da rede Thread, monitorando os dados de rede e gerenciando se ou quando adicionar ou remover entradas.
Todas as funções neste módulo exigem a ativação de OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE
.
Typedefs |
|
---|---|
otBorderRouterConfig
|
typedefstruct otBorderRouterConfig
Essa estrutura representa uma configuração do roteador de borda. |
otDetachGracefullyCallback)(void *aContext)
|
typedefvoid(*
Esse callback informa ao aplicativo que o processo de remoção foi concluído. |
otExternalRouteConfig
|
typedefstruct otExternalRouteConfig
Essa estrutura representa uma configuração de rota externa. |
otIpCounters
|
typedefstruct otIpCounters
Essa estrutura representa os contadores de nível de IP. |
otLeaderData
|
typedefstruct otLeaderData
Essa estrutura representa os dados do líder da linha de execução. |
otLinkModeConfig
|
typedefstruct otLinkModeConfig
Essa estrutura representa uma configuração do modo de vinculação do MLE. |
otMleCounters
|
typedefstruct otMleCounters
Essa estrutura representa os contadores de Thread MLE. |
otNeighborInfoIterator
|
typedefint16_t
Usado para iterar por meio da tabela vizinha. |
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)
|
typedefvoid(*
Esse tipo de ponteiro de função define o callback usado para notificar quando uma entrada "DNS/SRP Service" é adicionada ou removida dos dados da rede Thread. |
otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)
|
typedefvoid(*
Esse tipo de ponteiro de função define o callback usado para notificar quando uma entrada de prefixo (em malha ou externa) é adicionada ou removida dos dados da rede Thread. |
otNetDataPublisherEvent
|
typedef Essa enumeração representa os eventos informados pelos callbacks do editor. |
otNetworkDataIterator
|
typedefuint32_t
Usado para iterar por informações de dados da rede. |
otNetworkDiagChildEntry
|
typedefstruct otNetworkDiagChildEntry
Essa estrutura representa uma entrada da tabela filha de diagnósticos de rede. |
otNetworkDiagConnectivity
|
typedefstruct otNetworkDiagConnectivity
Essa estrutura representa um valor de conectividade de diagnóstico da rede. |
otNetworkDiagIterator
|
typedefuint16_t
Usado para iterar pelo TLV de diagnóstico de rede. |
otNetworkDiagMacCounters
|
typedefstruct otNetworkDiagMacCounters
Essa estrutura representa um valor de contadores de diagnóstico da rede do Mac. |
otNetworkDiagRoute
|
typedefstruct otNetworkDiagRoute
Essa estrutura representa um valor de TLV da rota de diagnóstico de rede. |
otNetworkDiagRouteData
|
typedefstruct otNetworkDiagRouteData
Essa estrutura representa os dados da 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 recebimento do diagnóstico de rede é recebida. |
otRoutePreference
|
typedefenum otRoutePreference
|
otServerConfig
|
typedefstruct otServerConfig
Essa estrutura representa uma configuração do servidor. |
otServiceConfig
|
typedefstruct otServiceConfig
Essa estrutura representa uma configuração do serviço. |
otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)
|
typedefvoid(*
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)
|
typedefvoid(*
Esse ponteiro de função é chamado sempre que uma mensagem de solicitação de descoberta de MLE é recebida. |
otThreadDiscoveryRequestInfo
|
typedefstruct otThreadDiscoveryRequestInfo
Essa estrutura representa os dados da solicitação de descoberta de linhas de execução. |
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)
|
typedefvoid(*
Esse ponteiro de função é chamado sempre que uma mensagem de resposta pai do MLE é recebida. |
otThreadParentResponseInfo
|
typedefstruct otThreadParentResponseInfo
Essa estrutura representa os dados de resposta pai do 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 os dados de rede da Leader's 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 da Partition.
|
otNetDataGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
|
Essa função recebe o próximo prefixo da malha on-line nos dados de rede da partição.
|
otNetDataGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
|
Esta 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
Acessar a versão estável dos dados da rede.
|
otNetDataGetVersion(otInstance *aInstance)
|
uint8_t
Acessar a versão dos dados de rede.
|
otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)
|
bool
Esta função indica se a entrada do "DNS/SRP Service" é adicionada ou não aos dados da rede Thread.
|
otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix)
|
bool
Esta função indica se uma entrada de prefixo publicada (em malha ou rota externa) foi adicionada ou não aos dados da rede Thread.
|
otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)
|
void
Esta função solicita que o endereço Anycast de serviço de DNS/SRP" seja publicado nos dados da rede Thread.
|
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
|
void
Essa função solicita a publicação de "DNS/SRP serviço Unicast" nos dados da rede Thread.
|
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
|
void
Essa função solicita a publicação de "DNS/SRP serviço Unicast" nos dados da rede Thread.
|
otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
|
Essa função solicita que um prefixo de rota externo seja publicado nos dados da rede Thread.
|
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
|
Essa função solicita que um prefixo da malha seja publicado nos dados da rede Thread.
|
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
|
void
Essa função define um callback para notificar quando um "serviço de DNS/SRP publicado</a> for adicionado ou removido dos dados da rede Thread.
|
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 Thread.
|
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
|
Verificar se os dados de direcionamento incluem um Joiner.
|
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
|
Verificar se os dados de direcionamento incluem um combinador com um determinado valor de disjuntor.
|
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
|
void
Cancela a publicação de qualquer entrada do serviço DNS/SRP (Anycast ou Unicast) adicionada anteriormente dos dados da rede Thread.
|
otNetDataUnpublishPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
|
Cancela a publicação de um prefixo de trajeto externo ou de malha já publicado anteriormente.
|
otThreadBecomeChild(otInstance *aInstance)
|
Tente reconectar como criança.
|
otThreadBecomeDetached(otInstance *aInstance)
|
Desconecte-se da rede Thread.
|
otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
|
Essa função notifica outros nós na rede (se houver) e, em seguida, interrompe a operação do protocolo 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
Recebe o tempo limite de linha de execução filha (em segundos) usado ao operar na função filha.
|
otThreadGetDeviceRole(otInstance *aInstance)
|
Acessar o papel do dispositivo.
|
otThreadGetDomainName(otInstance *aInstance)
|
const char *
Recebe o nome de domínio do Thread.
|
otThreadGetExtendedPanId(otInstance *aInstance)
|
const otExtendedPanId *
Recebe o ID do PAN estendido IEEE 802.15.4.
|
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
|
const otIp6InterfaceIdentifier *
Recebe o identificador da interface especificado manualmente para o endereço Unicast do domínio Thread.
|
otThreadGetIp6Counters(otInstance *aInstance)
|
const otIpCounters *
Recebe os contadores IPv6.
|
otThreadGetKeySequenceCounter(otInstance *aInstance)
|
uint32_t
Recebe a thJavascriptSequenceCounter.
|
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
|
uint32_t
Recebe o thCREDENTIALSSwitchGuardTime (em horas).
|
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
|
Essa função recebe os dados do líder da linha de execução.
|
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 *
Recebe o endereço multicast de Thread Link-Local All Thread Nodes.
|
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
|
const otIp6Address *
Recebe o endereço IPv6 link-local Thread.
|
otThreadGetLinkMode(otInstance *aInstance)
|
Acessar a configuração do modo de vinculação do MLE.
|
otThreadGetMeshLocalEid(otInstance *aInstance)
|
const otIp6Address *
Recebe o endereço EID local da malha.
|
otThreadGetMeshLocalPrefix(otInstance *aInstance)
|
const otMeshLocalPrefix *
Essa função retorna um ponteiro para o prefixo local da malha.
|
otThreadGetMleCounters(otInstance *aInstance)
|
const otMleCounters *
Recebe os contadores de Thread MLE.
|
otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey)
|
void
Receba a chave de rede do Thread.
|
otThreadGetNetworkKeyRef(otInstance *aInstance)
|
Consiga o
otNetworkKeyRef para a chave de rede do Thread. |
otThreadGetNetworkName(otInstance *aInstance)
|
const char *
Encontre 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 a RSSI média do pai da linha de execução.
|
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
|
A função recupera informações de diagnóstico de um roteador de linha de execução como pai.
|
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
|
A função recupera o RSSI do último pacote do pai do Thread.
|
otThreadGetPartitionId(otInstance *aInstance)
|
uint32_t
Consiga o ID da partição.
|
otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
|
const otIp6Address *
Recebe o endereço multicast de Thread Realm-Local All Nodes.
|
otThreadGetRloc(otInstance *aInstance)
|
const otIp6Address *
Recebe o endereço do Thread Routing Locator (RLOC).
|
otThreadGetRloc16(otInstance *aInstance)
|
uint16_t
Acessar o RLOC16.
|
otThreadGetServiceAloc(otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
|
Esta função recupera a ALOC de serviço para o ID de serviço fornecido.
|
otThreadGetVersion(void)
|
uint16_t
Essa função recebe 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 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
Esta função registra um callback para receber dados da resposta pai do MLE.
|
otThreadResetIp6Counters(otInstance *aInstance)
|
void
Redefine os contadores IPv6.
|
otThreadResetMleCounters(otInstance *aInstance)
|
void
Redefine os contadores de Thread MLE.
|
otThreadSearchForBetterParent(otInstance *aInstance)
|
Inicia o processo de busca de um pai/mãe melhor enquanto continua conectado ao pai atual.
|
otThreadSendAddressNotification(otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
|
void
Esta função envia uma mensagem proativa 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 recebimento 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 proativa da espinha dorsal (PRO_BB.ntf) no link da Estrutura.
|
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
|
void
Define o tempo limite filho da linha de execução (em segundos) usado ao operar no papel filho 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)
|
Define o nome de domínio da linha de execução.
|
otThreadSetEnabled(otInstance *aInstance, bool aEnabled)
|
Esta função inicia a operação do protocolo Thread.
|
otThreadSetExtendedPanId(otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
|
Define o ID do PAN estendido IEEE 802.15.4.
|
otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
|
Define ou 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 junção de linhas de execução ao descobrir a rede Thread.
|
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
|
void
Define o thCREDENTIALSSequenceCounter.
|
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
|
void
Define o thCREDENTIALSSwitchGuardTime (em horas).
|
otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)
|
Defina a configuração do modo de vinculação do MLE.
|
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 Thread como um
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 (link em inglês) |
Essa estrutura representa uma configuração de rota externa. |
otIpCounters (em inglês) |
Essa estrutura representa os contadores de nível de IP. |
OtLeaderData (em inglês) |
Essa estrutura representa os dados do líder da linha de execução. |
otLinkModeConfig. |
Essa estrutura representa uma configuração do modo de vinculação do MLE. |
otMleCounters (em inglês) |
Essa estrutura representa os contadores de Thread MLE. |
OtNeighborInfo (em inglês) |
Essa estrutura contém informações de diagnóstico para um nó Thread vizinho. |
otNetworkDiagChildEntry |
Essa estrutura representa uma entrada da tabela filha de diagnósticos 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 da rede do Mac. |
otNetworkDiagRoute |
Essa estrutura representa um valor de TLV da rota de diagnóstico de rede. |
otNetworkDiagRouteData |
Essa estrutura representa os dados da rota de diagnóstico de rede. |
otNetworkDiagTlv |
Essa estrutura representa um TLV de diagnóstico de rede. |
otRouterInfo (link em inglês) |
Essa estrutura contém informações de diagnóstico para um roteador de linha de execução. |
OtServerConfig (link em inglês) |
Essa estrutura representa uma configuração do servidor. |
otServiceConfig. |
Essa estrutura representa uma configuração do serviço. |
otThreadDiscoveryRequestInfo (link em inglês) |
Essa estrutura representa os dados da solicitação de descoberta de linhas de execução. |
otThreadParentResponseInfo (link em inglês) |
Essa estrutura representa os dados de resposta pai do MLE. |
Enumerações
enumeração anônima
anonymous enum
Função DeviceOt
otDeviceRole
Representa um papel de dispositivo Thread.
Propriedades | |
---|---|
OT_DEVICE_ROLE_CHILD
|
Papel filho Thread. |
OT_DEVICE_ROLE_DETACHED
|
Não participa de uma rede/partição de linha de execução. |
OT_DEVICE_ROLE_DISABLED
|
A pilha de conversas está desativada. |
OT_DEVICE_ROLE_LEADER
|
Papel de líder de linha de execução |
OT_DEVICE_ROLE_ROUTER
|
Papel de roteador de linha de execução |
OtNetDataPublisherEvent
otNetDataPublisherEvent
Essa enumeração representa os eventos informados pelos callbacks do editor.
Propriedades | |
---|---|
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED
|
A entrada publicada é adicionada aos dados da rede Thread. |
OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED
|
A entrada publicada é removida dos dados da rede Thread. |
OtRoutePreference
otRoutePreference
Define valores válidos para mPreference
em otExternalRouteConfig
e otBorderRouterConfig
.
Propriedades | |
---|---|
OT_ROUTE_PREFERENCE_HIGH
|
Preferência de trajeto alto. |
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.
otDetachGracefulCallback
void(* otDetachGracefullyCallback)(void *aContext)
Esse callback informa ao aplicativo que o processo de remoção foi concluído.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
OtExternalRouteConfig
struct otExternalRouteConfig otExternalRouteConfig
Essa estrutura representa uma configuração de rota externa.
OtIpCounters
struct otIpCounters otIpCounters
Essa estrutura representa os contadores de nível de IP.
Dados de lead
struct otLeaderData otLeaderData
Essa estrutura representa os dados do líder da linha de execução.
OtLinkModeConfig
struct otLinkModeConfig otLinkModeConfig
Essa estrutura representa uma configuração do modo de vinculação do MLE.
Contadores on-line
struct otMleCounters otMleCounters
Essa estrutura representa os contadores de Thread MLE.
OtNeighborInfoIterator
int16_t otNeighborInfoIterator
Usado para iterar por meio da 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 "DNS/SRP Service" é adicionada ou removida dos dados da rede Thread.
Na 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 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 callback usado para notificar quando uma entrada de prefixo (em malha ou externa) é adicionada ou removida dos dados da rede Thread.
Na 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 uma chamada explícita para cancelar a publicação da entrada.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
OtNetDataPublisherEvent
enum otNetDataPublisherEvent otNetDataPublisherEvent
Essa enumeração representa os eventos informados pelos callbacks do editor.
OtNetworkDataIterator
uint32_t otNetworkDataIterator
Usado para iterar por informações de dados da rede.
OtNetworkDiagChildEntry
struct otNetworkDiagChildEntry otNetworkDiagChildEntry
Essa estrutura representa uma entrada da tabela filha de diagnósticos de rede.
OtNetworkDiagConnectivity
struct otNetworkDiagConnectivity otNetworkDiagConnectivity
Essa estrutura representa um valor de conectividade de diagnóstico da rede.
OtNetworkDiagIterator
uint16_t otNetworkDiagIterator
Usado para iterar pelo TLV de diagnóstico de rede.
OtNetworkDiagMacCounters
struct otNetworkDiagMacCounters otNetworkDiagMacCounters
Essa estrutura representa um valor de contadores de diagnóstico da rede do Mac.
Consulte o RFC 2863 para ver as definições dos campos do membro.
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 os dados da 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 recebimento do 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
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 |
|
OtThreadDiscoveryRequestCallback
void(* otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)
Esse ponteiro de função é chamado sempre que uma mensagem de solicitação de descoberta de MLE é recebida.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
OtThreadDiscoveryRequestInfo
struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo
Essa estrutura representa os dados da solicitação de descoberta de linhas de execução.
OtThreadParentResponseCallback
void(* otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)
Esse ponteiro de função é chamado sempre que uma mensagem de resposta pai do MLE é recebida.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
OtThreadParentResponseInfo
struct otThreadParentResponseInfo otThreadParentResponseInfo
Essa estrutura representa os dados de resposta pai do 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 os dados de rede da Leader's contêm esse prefixo.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Retorna |
Se
aPrefix é um prefixo OMR válido e os dados de rede do líder são 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 da Partition.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
Prefixo otNetDataGetNextOnMeshshPrefix
otError otNetDataGetNextOnMeshPrefix( otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig )
Essa função recebe o próximo prefixo da malha on-line 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 recebe a próxima rota externa nos dados de rede da partição.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
Serviç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 |
|
||||||
Valores de retorno |
|
Versão otNetDataGetStable
uint8_t otNetDataGetStableVersion( otInstance *aInstance )
Acessar a versão estável dos dados da rede.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
A versão estável dos dados de rede.
|
Versão OtNetDataGetVersion
uint8_t otNetDataGetVersion( otInstance *aInstance )
Acessar a versão dos dados de rede.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
A versão dos dados de rede.
|
OtNetDataIsDnsSrpServiceAdded
bool otNetDataIsDnsSrpServiceAdded( otInstance *aInstance )
Esta função indica se a entrada do "DNS/SRP Service" é adicionada ou não aos dados da rede Thread.
Para esta função, o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
precisa estar ativado.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
OtNetDataIsPrefixAdded
bool otNetDataIsPrefixAdded( otInstance *aInstance, const otIp6Prefix *aPrefix )
Esta função indica se uma entrada de prefixo publicada (em malha ou rota externa) foi adicionada ou não aos dados da rede Thread.
Para esta função, o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
precisa estar ativado.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
OtNetDataPublishDnsSrpServiceAnycast
void otNetDataPublishDnsSrpServiceAnycast( otInstance *aInstance, uint8_t aSequenceNUmber )
Esta função solicita que o endereço Anycast de serviço de DNS/SRP" seja publicado nos dados da rede Thread.
Para esta função, o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
precisa estar ativado.
Uma chamada para essa função removerá e substituirá qualquer entrada anterior de "DNS/SRP de serviço" que estava sendo publicada (da chamada anterior para qualquer uma das funções otNetDataPublishDnsSrpService{Type}()
).
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
OtNetDataPublishDnsSrpServiceUnicast
void otNetDataPublishDnsSrpServiceUnicast( otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort )
Essa função solicita a publicação de "DNS/SRP serviço Unicast" nos dados da rede Thread.
Para esta função, o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
precisa estar ativado.
Uma chamada para essa função removerá e substituirá qualquer entrada anterior de "DNS/SRP de serviço" que estava sendo publicada (da chamada anterior para qualquer uma das funções otNetDataPublishDnsSrpService{Type}()
).
Esta função publica o "Endereço de Unicast de serviço DNS/SRP" incluindo as informações de endereço e porta nos dados TLV do serviço.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
OtNetDataPublishDnsSrpServiceUnicastMeshLocalEid
void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid( otInstance *aInstance, uint16_t aPort )
Essa função solicita a publicação de "DNS/SRP serviço Unicast" nos dados da rede Thread.
Para esta função, o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
precisa estar ativado.
Uma chamada para essa função removerá e substituirá qualquer entrada anterior de "DNS/SRP de serviço" que estava sendo publicada (da chamada anterior para qualquer uma das funções otNetDataPublishDnsSrpService{Type}()
).
Ao contrário de otNetDataPublishDnsSrpServiceUnicast()
, que requer o endereço publicado, e inclui as informações nos dados de TLV do serviço, essa função usa o EID da rede local do dispositivo e inclui as informações nos dados de TLV do servidor.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
Rota otNetDataPublishExternal
otError otNetDataPublishExternalRoute( otInstance *aInstance, const otExternalRouteConfig *aConfig )
Essa função solicita que um prefixo de rota externo seja publicado nos dados da rede Thread.
Para esta função, o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
precisa estar ativado.
Somente as entradas estáveis podem ser publicadas (ou seja,aConfig.mStable
PRECISA ser VERDADEIRO).
Uma chamada subsequente para esse método substituirá uma solicitação anterior pelo mesmo prefixo. Se a nova chamada só mudar as sinalizações (por exemplo, nível de preferência) e o prefixo já tiver sido adicionado aos dados da rede, a mudança nas sinalizações será refletida imediatamente nos dados da rede. Isso garante que as entradas existentes nos dados de rede não sejam removidas abruptamente. Observe que uma alteração no nível de preferência pode fazer com que a entrada seja removida dos dados da rede após determinar que há outros nós publicando o mesmo prefixo com a mesma preferência ou maior.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
OtNetDataPublishOnMeshshPrefix
otError otNetDataPublishOnMeshPrefix( otInstance *aInstance, const otBorderRouterConfig *aConfig )
Essa função solicita que um prefixo da malha seja publicado nos dados da rede Thread.
Para esta função, o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
precisa estar ativado.
Somente as entradas estáveis podem ser publicadas (ou seja,aConfig.mStable
PRECISA ser VERDADEIRO).
Uma chamada subsequente para esse método substituirá uma solicitação anterior pelo mesmo prefixo. Se a nova chamada só mudar as sinalizações (por exemplo, nível de preferência) e o prefixo já tiver sido adicionado aos dados da rede, a mudança nas sinalizações será refletida imediatamente nos dados da rede. Isso garante que as entradas existentes nos dados de rede não sejam removidas abruptamente. Observe que uma alteração no nível de preferência pode fazer com que a entrada seja removida dos dados da rede após determinar que há outros nós publicando o mesmo prefixo com a mesma preferência ou maior.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
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</a> for adicionado ou removido dos dados da rede Thread.
Uma chamada subsequente para essa função substitui qualquer função de callback definida anteriormente.
Para esta função, o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
precisa estar ativado.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
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 Thread.
Uma chamada subsequente para essa função substitui qualquer função de callback definida anteriormente.
Para esta função, o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
precisa estar ativado.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
OtNetDataSteeringDataCheckJoiner
otError otNetDataSteeringDataCheckJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
Verificar se os dados de direcionamento incluem um Joiner.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
OtNetDataSteeringDataCheckJoinerWithDiscerner
otError otNetDataSteeringDataCheckJoinerWithDiscerner( otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner )
Verificar se os dados de direcionamento incluem um combinador com um determinado valor de disjuntor.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
OtNetDataPublishDnsSrpService
void otNetDataUnpublishDnsSrpService( otInstance *aInstance )
Cancela a publicação de qualquer entrada do serviço DNS/SRP (Anycast ou Unicast) adicionada anteriormente dos dados da rede Thread.
O OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
precisa estar ativado.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
OtNetDataDataPrefix
otError otNetDataUnpublishPrefix( otInstance *aInstance, const otIp6Prefix *aPrefix )
Cancela a publicação de um prefixo de trajeto externo ou de malha já publicado anteriormente.
O OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
precisa estar ativado.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
OtThreadMakeChild
otError otThreadBecomeChild( otInstance *aInstance )
Tente reconectar como criança.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
OtThreadMakeDetached
otError otThreadBecomeDetached( otInstance *aInstance )
Desconecte-se da rede Thread.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
OtThreadDetachGraceously
otError otThreadDetachGracefully( otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext )
Essa função notifica outros nós na rede (se houver) e, em seguida, interrompe a operação do protocolo Thread.
Ele vai enviar uma versão de endereço se for um roteador ou definir o tempo limite filho como 0 se for um filho.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
OtThreadDeviceRoleToString
const char * otThreadDeviceRoleToString( otDeviceRole aRole )
Converta o papel do dispositivo em uma string legível.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
Uma string que representa
aRole . |
OtThreadDiscover
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 |
|
||||||||||||||
Valores de retorno |
|
OtThreadGetChildTimeout
uint32_t otThreadGetChildTimeout( otInstance *aInstance )
Recebe o tempo limite de linha de execução filha (em segundos) usado ao operar na função filha.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
O valor de tempo limite filho da linha de execução em segundos.
|
otThreadSetChildTimeout
OtThreadGetDeviceRole
otDeviceRole otThreadGetDeviceRole( otInstance *aInstance )
Acessar o papel do dispositivo.
Detalhes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||
Valores de retorno |
|
OtThreadGetDomainName
const char * otThreadGetDomainName( otInstance *aInstance )
Recebe o nome de domínio do Thread.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
Um ponteiro para o nome de domínio do Thread.
|
otThreadSetDomainName
OtThreadGetExtendedPanId
const otExtendedPanId * otThreadGetExtendedPanId( otInstance *aInstance )
Recebe o ID do PAN estendido IEEE 802.15.4.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
Um ponteiro para o ID PAN estendido da IEEE 802.15.4.
|
otThreadSetExtendedPanId
OtThreadGetFixedDuaInterfaceIdentifier
const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier( otInstance *aInstance )
Recebe o identificador da interface especificado manualmente para o endereço Unicast do domínio Thread.
Disponível quando o OPENTHREAD_CONFIG_DUA_ENABLE
estiver ativado.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
Um ponteiro para o identificador de interface que foi definido manualmente ou NULL se nenhum tiver sido definido.
|
otThreadSetFixedDuaInterfaceIdentifier
Contadores de otThreadGetIp6
const otIpCounters * otThreadGetIp6Counters( otInstance *aInstance )
Recebe os contadores IPv6.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
Um ponteiro para os contadores de IPv6.
|
OtThreadGetKeySequenceCounter
uint32_t otThreadGetKeySequenceCounter( otInstance *aInstance )
Recebe a thJavascriptSequenceCounter.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
O valor thCREDENTIALSSequenceCounter.
|
otThreadSetKeySequenceCounter
OtThreadGetKeySwitchGuardTime
uint32_t otThreadGetKeySwitchGuardTime( otInstance *aInstance )
Recebe o thCREDENTIALSSwitchGuardTime (em horas).
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
O valor thCREDENTIALSSwitchGuardTime (em horas).
|
otThreadSetKeySwitchGuardTime
OtThreadGetLeaderData
otError otThreadGetLeaderData( otInstance *aInstance, otLeaderData *aLeaderData )
Essa função recebe os dados do líder da linha de execução.
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 |
|
||
Retorna |
O ID do roteador do líder.
|
OtThreadGetLeaderWeight
uint8_t otThreadGetLeaderWeight( otInstance *aInstance )
Obtenha o peso do líder.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
O peso do líder.
|
OtThreadGetLinkLocalAllThreadNodesMulticastAddress
const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress( otInstance *aInstance )
Recebe o endereço multicast de Thread Link-Local All Thread Nodes.
O endereço é um endereço multicast baseado em prefixo Unicast link-local [RFC 3306], com:
- flgs definidos como 3 (P = 1 e T = 1)
- escopo definido como 2
- plen definido como 64
- prefixo de rede definido como o prefixo local da malha
- ID do grupo definido como 1
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
Um ponteiro para endereços multicast de Thread Link-Local All Thread Nodes.
|
Endereço otThreadGetLinkLocalIp6
const otIp6Address * otThreadGetLinkLocalIp6Address( otInstance *aInstance )
Recebe o endereço IPv6 link-local Thread.
O endereço local do link Thread é derivado usando o endereço estendido IEEE802.15.4 como identificador de interface.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
Um ponteiro para endereço IPv6 link-local Thread.
|
OtThreadGetLinkMode
otLinkModeConfig otThreadGetLinkMode( otInstance *aInstance )
Acessar a configuração do modo de vinculação do MLE.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
A configuração do modo de vinculação do MLE.
|
otThreadSetLinkMode
OtThreadGetMeshLocalEid
const otIp6Address * otThreadGetMeshLocalEid( otInstance *aInstance )
Recebe o endereço EID local da malha.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
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 |
|
||
Retorna |
Um ponteiro para o prefixo local de malha.
|
OtThreadGetMleCounters
const otMleCounters * otThreadGetMleCounters( otInstance *aInstance )
Recebe os contadores de Thread MLE.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
Um ponteiro para os contadores de Thread MLE.
|
Troca de redeOtThreadGet
void otThreadGetNetworkKey( otInstance *aInstance, otNetworkKey *aNetworkKey )
Receba a chave de rede do Thread.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
otThreadSetNetworkKey
OtThreadGetNetworkKeyRef
otNetworkKeyRef otThreadGetNetworkKeyRef( otInstance *aInstance )
Consiga o otNetworkKeyRef
para a chave de rede do Thread.
Essa função requer que o recurso de tempo de compilação OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
esteja ativado.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
Referência à chave de rede de linhas de execução armazenada na memória.
|
otThreadSetNetworkKeyRef
Nome da rede otThreadGet
const char * otThreadGetNetworkName( otInstance *aInstance )
Encontre o nome da rede Thread.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
Um ponteiro para o nome da rede da linha de execução.
|
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 |
|
||||||
Valores de retorno |
|
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 |
|
||||||
Valores de retorno |
|
OtThreadGetParentAverageRssi
otError otThreadGetParentAverageRssi( otInstance *aInstance, int8_t *aParentRssi )
A função recupera a RSSI média do pai da linha de execução.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
OtThreadGetParentInfo
otError otThreadGetParentInfo( otInstance *aInstance, otRouterInfo *aParentInfo )
A função recupera informações de diagnóstico de um roteador de linha de execução como pai.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
OtThreadGetParentLastRssi
otError otThreadGetParentLastRssi( otInstance *aInstance, int8_t *aLastRssi )
A função recupera o RSSI do último pacote do pai do Thread.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
OtThreadGetPartitionId
uint32_t otThreadGetPartitionId( otInstance *aInstance )
Consiga o ID da partição.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
O código da partição.
|
OtThreadGetRealmLocalAllThreadNodesMulticastAddress
const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress( otInstance *aInstance )
Recebe o endereço multicast de Thread Realm-Local All Nodes.
O endereço é um endereço multicast baseado em prefixo Unicast local [RFC 3306], com:
- flgs definidos como 3 (P = 1 e T = 1)
- escopo definido como 3
- plen definido como 64
- prefixo de rede definido como o prefixo local da malha
- ID do grupo definido como 1
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
Um ponteiro para endereço multicast de Thread Realm-Local All Thread Nodes.
|
OtThreadGetRloc
const otIp6Address * otThreadGetRloc( otInstance *aInstance )
Recebe o endereço do Thread Routing Locator (RLOC).
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
Um ponteiro para o endereço do Thread Routing Locator (RLOC).
|
OtThreadGetRloc16
uint16_t otThreadGetRloc16( otInstance *aInstance )
Acessar o RLOC16.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
O RLOC16.
|
OtThreadGetServiceAloc
otError otThreadGetServiceAloc( otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc )
Esta função recupera a ALOC de serviço para o ID de serviço fornecido.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
Versão de otThreadGet
uint16_t otThreadGetVersion( void )
Essa função recebe a versão do protocolo Thread.
Detalhes | |
---|---|
Retorna |
a versão do protocolo Thread.
|
OtThreadIsAnycastFindInProgress
bool otThreadIsAnycastLocateInProgress( otInstance *aInstance )
Esta 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 |
|
||
Retorna |
TRUE se uma solicitação de localização de anycast estiver em andamento. Caso contrário, 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 |
|
OtThreadIsSingleton
bool otThreadIsSingleton( otInstance *aInstance )
Essa função indica se um nó é o único roteador da rede.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
OtThreadLocalAnycastDestination
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 |
|
||||||||
Valores de retorno |
|
OtThreadRegisterParentResponseCallback
void otThreadRegisterParentResponseCallback( otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext )
Esta função registra um callback para receber dados da resposta pai do MLE.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
Contadores de otThreadResetIp6
void otThreadResetIp6Counters( otInstance *aInstance )
Redefine os contadores IPv6.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
OtThreadResetMleCounters
void otThreadResetMleCounters( otInstance *aInstance )
Redefine os contadores de Thread MLE.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
OtThreadSearchForBetterParent
otError otThreadSearchForBetterParent( otInstance *aInstance )
Inicia o processo de busca de um pai/mãe melhor enquanto continua conectado ao pai atual.
Precisa ser usado quando o dispositivo está anexado como uma criança.
Detalhes | |||||
---|---|---|---|---|---|
Valores de retorno |
|
ThreadThreadAddressAddress
void otThreadSendAddressNotification( otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid )
Esta função envia uma mensagem proativa de endereço proativo (ADDR_NTF.ntf).
Esta função só está disponível quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
está ativado.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
OtThreadSendDiagnosticGet
otError otThreadSendDiagnosticGet( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext )
Envie uma solicitação de recebimento de diagnóstico de rede.
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||
Valores de retorno |
|
OtThreadSendDiagnosticReset
otError 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.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
OtThreadSendProactiveBackboneNotification
otError otThreadSendProactiveBackboneNotification( otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction )
Esta função envia uma mensagem proativa da espinha dorsal (PRO_BB.ntf) no link da Estrutura.
Esta função só está disponível quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
está ativado.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
OtThreadSetChildTimeout
void otThreadSetChildTimeout( otInstance *aInstance, uint32_t aTimeout )
Define o tempo limite filho da linha de execução (em segundos) usado ao operar no papel filho filho.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
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 |
|
OtThreadSetDomainName
otError otThreadSetDomainName( otInstance *aInstance, const char *aDomainName )
Define o nome de domínio da linha de execução.
Só funciona quando os protocolos Thread estão desativados.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
otThreadGetDomainName
OtThreadSetEnabled
otError otThreadSetEnabled( otInstance *aInstance, bool aEnabled )
Esta função inicia a operação do protocolo Thread.
A interface precisa estar ativa ao chamar essa função.
Chamar essa função com aEnabled
definido como FALSE interrompe qualquer processo contínuo de remoção iniciado por otThreadDetachGraceously(). O callback dele será chamado.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
OtThreadSetExtendedPanId
otError otThreadSetExtendedPanId( otInstance *aInstance, const otExtendedPanId *aExtendedPanId )
Define o ID do PAN estendido IEEE 802.15.4.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
otThreadGetExtendedPanId
OtThreadSetFixedDuaInterfaceIdentifier
otError otThreadSetFixedDuaInterfaceIdentifier( otInstance *aInstance, const otIp6InterfaceIdentifier *aIid )
Define ou limpa o identificador de interface especificado manualmente para o endereço Unicast do domínio Thread.
Disponível quando o OPENTHREAD_CONFIG_DUA_ENABLE
estiver ativado.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
otThreadGetFixedDuaInterfaceIdentifier
OtThreadSetJoinerAdvertisingment
otError otThreadSetJoinerAdvertisement( otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength )
Esse método define a publicidade de junção de linhas de execução ao descobrir a rede Thread.
A Publicidade de Combinadores de linhas de execução é usada para permitir que um Comissário de publicidade anuncie suas informações específicas da inscrição (como ID do fornecedor, ID do produto, Discriminador etc.) por meio de um TLV de publicidade de proposta recente e para disponibilizar essas informações aos Comissários ou candidatos a Comissários sem interação humana.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
OtThreadSetKeySequenceCounter
void otThreadSetKeySequenceCounter( otInstance *aInstance, uint32_t aKeySequenceCounter )
Define o thCREDENTIALSSequenceCounter.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
otThreadGetKeySequenceCounter
OtThreadSetKeySwitchGuardTime
void otThreadSetKeySwitchGuardTime( otInstance *aInstance, uint32_t aKeySwitchGuardTime )
Define o thCREDENTIALSSwitchGuardTime (em horas).
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
otThreadGetKeySwitchGuardTime
OtThreadSetLinkMode
otError otThreadSetLinkMode( otInstance *aInstance, otLinkModeConfig aConfig )
Defina a configuração do modo de vinculação do MLE.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
otThreadGetLinkMode
OtThreadSetMeshLocalPrefix
otError otThreadSetMeshLocalPrefix( otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix )
Essa função define o prefixo local da malha.
Esta função só funciona quando os protocolos Thread 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 |
|
||||
Valores de retorno |
|
Conjunto de redes otThread
otError otThreadSetNetworkKey( otInstance *aInstance, const otNetworkKey *aKey )
Defina a chave de rede Thread.
Esta função só funciona quando os protocolos Thread 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 |
|
||||
Valores de retorno |
|
otThreadGetNetworkKey
OtThreadSetNetworkKeyRef
otError otThreadSetNetworkKeyRef( otInstance *aInstance, otNetworkKeyRef aKeyRef )
Defina a chave de rede Thread como um otNetworkKeyRef
.
Esta função só funciona quando os protocolos Thread 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 requer que o recurso de tempo de compilação OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
esteja ativado.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
otThreadGetNetworkKeyRef
NomedaRedeDeLinha
otError otThreadSetNetworkName( otInstance *aInstance, const char *aNetworkName )
Defina o nome da rede Thread.
Esta função só funciona quando os protocolos Thread 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 |
|
||||
Valores de retorno |
|
otThreadGetNetworkName
Macros
OT_JOINER_ADVDATA_MAX_LENGTH
OT_JOINER_ADVDATA_MAX_LENGTH 64
Duração máxima do anúncio dos dados do anunciante do Joiner.
OT_NEIGHBOR_INFO_ITERATOR_INIT
OT_NEIGHBOR_INFO_ITERATOR_INIT 0
Inicialização do otNeighborInfoJUnit
OT_NETWORK_BASE_TLV_MAX_LENGTH
OT_NETWORK_BASE_TLV_MAX_LENGTH 254
Comprimento máximo do valor do TLV de base da linha 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 otNetworkDiagIterator.
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 menor.
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 provenientes do código-fonte, disponível no GitHub. Para saber mais ou contribuir com nossa documentação, consulte Recursos.