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.
Typedefs |
|
---|---|
otBorderRouterConfig
|
typedefstruct otBorderRouterConfig
Essa estrutura representa uma configuração do roteador de borda. |
otExternalRouteConfig
|
typedefstruct otExternalRouteConfig
Essa estrutura representa uma configuração de rota externa. |
otIpCounters
|
typedefstruct otIpCounters
Essa estrutura representa os contadores no nível do IP. |
otLeaderData
|
typedefstruct otLeaderData
Esta estrutura representa os dados da linha de execução da linha de execução. |
otLinkModeConfig
|
typedefstruct otLinkModeConfig
Essa estrutura representa uma configuração do modo de vinculação MLE. |
otMleCounters
|
typedefstruct otMleCounters
Essa estrutura representa os contadores de Thread MLE. |
otNeighborInfoIterator
|
typedefint16_t
Usado para iterar a tabela vizinha. |
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)
|
typedefvoid(*
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)
|
typedefvoid(*
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
|
typedefuint32_t
Usado para iterar as informações de dados da rede. |
otNetworkDiagChildEntry
|
typedefstruct otNetworkDiagChildEntry
Essa estrutura representa uma entrada da tabela filha de diagnóstico de rede. |
otNetworkDiagConnectivity
|
typedefstruct otNetworkDiagConnectivity
Essa estrutura representa um valor de conectividade de diagnóstico da rede. |
otNetworkDiagIterator
|
typedefuint16_t
Usado para iterar por TLV de diagnóstico de rede. |
otNetworkDiagMacCounters
|
typedefstruct otNetworkDiagMacCounters
Essa estrutura representa um valor de contadores de diagnóstico de 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 uma rota de diagnóstico da 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(*
Este ponteiro de função é chamado quando a resposta 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 do MLE é recebida. |
otThreadDiscoveryRequestInfo
|
typedefstruct otThreadDiscoveryRequestInfo
Essa estrutura representa os dados de solicitação de descoberta da linha de execução. |
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)
|
typedefvoid(*
Este ponteiro de função é chamado sempre que uma mensagem de resposta mãe de MLE é recebida. |
otThreadParentResponseInfo
|
typedefstruct otThreadParentResponseInfo
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)
|
const otIp6InterfaceIdentifier *
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)
|
const otMeshLocalPrefix *
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
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
||||
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 |
|
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 |
|
||||||
Valores de retorno |
|
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 |
|
||||||
Valores de retorno |
|
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 |
|
OtNetDataGetStableVersion
uint8_t otNetDataGetStableVersion( otInstance *aInstance )
Fazer o download da versão estável dos dados de rede.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
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 |
|
||
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 |
|
||||
Valores de retorno |
|
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 |
|
||||
Valores de retorno |
|
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 |
|
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 |
|
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 |
|
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 |
|
||||||||
Valores de retorno |
|
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 |
|
||||||||
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 é 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 |
|
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 |
|
OtNetDataSteeringDataCheckJoiner
otError otNetDataSteeringDataCheckJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
Verifique se os dados de direcionamento incluem um combinador.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
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 |
|
||||||
Valores de retorno |
|
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 |
|
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 |
|
||||
Valores de retorno |
|
OtThreadBeginChild
otError otThreadBecomeChild( otInstance *aInstance )
Tente se reconectar como filha.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
OtThreadBeginDetached
otError otThreadBecomeDetached( otInstance *aInstance )
Separe da rede Thread.
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 |
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 |
|
||||||||||||||
Valores de retorno |
|
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 |
|
||
Retorna |
Indica o valor do tempo limite do filho da linha de execução em segundos.
|
otThreadSetChildTimeout
OtThreadGetDeviceRole
otDeviceRole otThreadGetDeviceRole( otInstance *aInstance )
Encontre o papel do dispositivo.
Detalhes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||
Valores de retorno |
|
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 |
|
||
Retorna |
Um ponteiro para o nome de domínio da linha de execução.
|
otThreadSetDomainName
OtThreadGetExtendedPanId
const otExtendedPanId * otThreadGetExtendedPanId( otInstance *aInstance )
Receba o ID do PAN estendido IEEE 802.15.4.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
Um ponteiro para o código estendido de IEEE 802.15.4.
|
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 |
|
||
Retorna |
Um ponteiro para o identificador de interface que foi definido manualmente ou NULL caso nenhum tenha sido definido.
|
otThreadSetFixedDuaInterfaceIdentifier
OtThreadGetIp6Counters
const otIpCounters * otThreadGetIp6Counters( otInstance *aInstance )
Encontre os contadores IPv6.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
Um ponteiro para os contadores IPv6.
|
OtThreadGetKeySequenceCounter
uint32_t otThreadGetKeySequenceCounter( otInstance *aInstance )
Recebe o thaltostratSequenceCounter.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
O valor thaltostratSequenceCounter.
|
otThreadSetKeySequenceCounter
OtThreadGetKeySwitchGuardTime
uint32_t otThreadGetKeySwitchGuardTime( otInstance *aInstance )
Receba o thaltostratSwitchGuardTime.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
O valor thaltostratSwitchGuardTime (em horas).
|
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 |
|
||||
Valores de retorno |
|
OtThreadGetLeaderRloc
otError otThreadGetLeaderRloc( otInstance *aInstance, otIp6Address *aLeaderRloc )
Essa função retorna um ponteiro para o RLOC do líder.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
OtThreadGetLeaderRouterId
uint8_t otThreadGetLeaderRouterId( otInstance *aInstance )
Obter o ID do roteador do líder.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
O ID do roteador do líder.
|
OtThreadGetLeaderWeight
uint8_t otThreadGetLeaderWeight( otInstance *aInstance )
Conquiste o peso do líder.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
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 |
|
||
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 |
|
||
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 |
|
||
Retorna |
A configuração do modo de vinculação MLE.
|
otThreadSetLinkMode
OtThreadGetMeshLocalEid
const otIp6Address * otThreadGetMeshLocalEid( otInstance *aInstance )
Essa função retorna um ponteiro para 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 )
Consiga os contadores de Thread MLE.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
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 |
|
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 |
|
||
Retorna |
Referência à chave de rede Thread armazenada na memória.
|
otThreadSetNetworkKeyRef
OtThreadGetNetworkName
const char * otThreadGetNetworkName( otInstance *aInstance )
Consiga o nome da rede Thread.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
Um ponteiro para o nome da rede Thread.
|
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 |
|
ThreadThreadParentAverageRssi
otError otThreadGetParentAverageRssi( otInstance *aInstance, int8_t *aParentRssi )
A função recupera o RSSI médio do pai Thread.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
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 |
|
OtThreadGetParentLastRssi
otError otThreadGetParentLastRssi( otInstance *aInstance, int8_t *aLastRssi )
A função recupera o RSSI do último pacote do pai Thread.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
OtThreadGetPartitionId
uint32_t otThreadGetPartitionId( otInstance *aInstance )
Consiga o ID da partição.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
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 |
|
||
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 |
|
||
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 |
|
||
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 |
|
||||||
Valores de retorno |
|
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 |
|
||
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 |
|
OtThreadIsSingleton
bool otThreadIsSingleton( otInstance *aInstance )
Essa função indica se um nó é o único roteador da rede.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
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 |
|
||||||||
Valores de retorno |
|
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 |
|
OtThreadResetIp6Counters
void otThreadResetIp6Counters( otInstance *aInstance )
Redefinir os contadores IPv6.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
OtThreadResetMleCounters
void otThreadResetMleCounters( otInstance *aInstance )
Redefinir os contadores de Thread MLE.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
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 |
|
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 |
|
||||||||||||
Valores de retorno |
|
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 |
|
||||||||
Valores de retorno |
|
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 |
|
||||||||
Valores de retorno |
|
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 |
|
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 )
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 |
|
||||
Valores de retorno |
|
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 |
|
||||
Valores de retorno |
|
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 |
|
||||
Valores de retorno |
|
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 |
|
||||
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 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 |
|
||||||||
Valores de retorno |
|
ThreadThreadKeyKeyCounter
void otThreadSetKeySequenceCounter( otInstance *aInstance, uint32_t aKeySequenceCounter )
Defina thaltostratSequenceCounter.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
otThreadGetKeySequenceCounter
OtThreadSetKeySwitchGuardTime
void otThreadSetKeySwitchGuardTime( otInstance *aInstance, uint32_t aKeySwitchGuardTime )
Defina thaltostratSwitchGuardTime.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
otThreadGetKeySwitchGuardTime
ThreadSetLinkMode
otError otThreadSetLinkMode( otInstance *aInstance, otLinkModeConfig aConfig )
Defina a configuração do modo MLE Link.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
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 |
|
||||
Valores de retorno |
|
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 |
|
||||
Valores de retorno |
|
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 |
|
||||
Valores de retorno |
|
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 |
|
||||
Valores de retorno |
|
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.