Général
Ce module inclut des fonctions pour tous les rôles Thread.
Résumé
L'éditeur de données réseau fournit des mécanismes pour limiter le nombre d'entrées de service et/ou de préfixe similaires dans le préfixe de réseau maillé ou d'une route externe dans les données du réseau Thread en surveillant les données réseau et en définissant si et quand ajouter des entrées.
Toutes les fonctions de ce module nécessitent l'activation de OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE
.
Définitions |
|
---|---|
otBorderRouterConfig
|
CANNOT TRANSLATEstruct otBorderRouterConfig
Cette structure représente la configuration d'un routeur de bordure. |
otDetachGracefullyCallback)(void *aContext)
|
CANNOT TRANSLATEvoid(*
Ce rappel informe l'application que le processus de dissociation est terminé. |
otExternalRouteConfig
|
CANNOT TRANSLATEstruct otExternalRouteConfig
Cette structure représente une configuration de route externe. |
otIpCounters
|
CANNOT TRANSLATEstruct otIpCounters
Cette structure représente les compteurs de niveau d'adresse IP. |
otLeaderData
|
CANNOT TRANSLATEstruct otLeaderData
Cette structure représente les données des dirigeants de fils de discussion. |
otLinkModeConfig
|
CANNOT TRANSLATEstruct otLinkModeConfig
Cette structure représente une configuration du mode liaison MLE. |
otMleCounters
|
CANNOT TRANSLATEstruct otMleCounters
Cette structure représente les compteurs MLE de thread. |
otNeighborInfoIterator
|
CANNOT TRANSLATEint16_t
Utilisé pour effectuer une itération dans la table voisine. |
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)
|
CANNOT TRANSLATEvoid(*
Ce type de pointeur de fonction définit le rappel utilisé pour envoyer une notification lorsqu'une entrée de service DNS/SRP est ajoutée aux données du réseau Thread ou supprimée de celles-ci. |
otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)
|
CANNOT TRANSLATEvoid(*
Ce type de pointeur de fonction définit le rappel utilisé pour envoyer une notification lorsqu'une entrée de préfixe (réseau maillé ou route externe) est ajoutée aux données du réseau Thread ou supprimée de celles-ci. |
otNetDataPublisherEvent
|
CANNOT TRANSLATE Cette énumération représente les événements signalés par les rappels de l'éditeur. |
otNetworkDataIterator
|
CANNOT TRANSLATEuint32_t
Permet de parcourir les informations des données réseau. |
otNetworkDiagChildEntry
|
CANNOT TRANSLATEstruct otNetworkDiagChildEntry
Cette structure représente une entrée de table enfant de diagnostic réseau. |
otNetworkDiagConnectivity
|
CANNOT TRANSLATEstruct otNetworkDiagConnectivity
Cette structure représente une valeur de connectivité de diagnostic du réseau. |
otNetworkDiagIterator
|
CANNOT TRANSLATEuint16_t
Utilisé pour effectuer des itérations dans le fichier TLV de diagnostic du réseau. |
otNetworkDiagMacCounters
|
CANNOT TRANSLATEstruct otNetworkDiagMacCounters
Cette structure représente une valeur de compteurs de diagnostic réseau. |
otNetworkDiagRoute
|
CANNOT TRANSLATEstruct otNetworkDiagRoute
Cette structure représente une valeur TLV de route de diagnostic réseau. |
otNetworkDiagRouteData
|
CANNOT TRANSLATEstruct otNetworkDiagRouteData
Cette structure représente des données de routage de diagnostic de réseau. |
otNetworkDiagTlv
|
CANNOT TRANSLATEstruct otNetworkDiagTlv
Cette structure représente un fichier TLV de diagnostic réseau. |
otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)
|
CANNOT TRANSLATEvoid(*
Ce pointeur de fonction est appelé lorsque la réponse de diagnostic de réseau est reçue. |
otRoutePreference
|
CANNOT TRANSLATEenum otRoutePreference
|
otServerConfig
|
CANNOT TRANSLATEstruct otServerConfig
Cette structure représente la configuration du serveur, |
otServiceConfig
|
CANNOT TRANSLATEstruct otServiceConfig
Cette structure représente une configuration de service. |
otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)
|
CANNOT TRANSLATEvoid(*
Ce type de pointeur de fonction définit le rappel pour informer le résultat d'une requête otThreadLocateAnycastDestination() . |
otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)
|
CANNOT TRANSLATEvoid(*
Ce pointeur de fonction est appelé chaque fois qu'un message de demande de découverte MLE est reçu. |
otThreadDiscoveryRequestInfo
|
CANNOT TRANSLATEstruct otThreadDiscoveryRequestInfo
Cette structure représente les données de la requête Thread Discovery. |
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)
|
CANNOT TRANSLATEvoid(*
Ce pointeur de fonction est appelé à chaque fois qu'un message de réponse parent MLE est reçu. |
otThreadParentResponseInfo
|
CANNOT TRANSLATEstruct otThreadParentResponseInfo
Cette structure représente les données de la réponse parent MLE. |
Fonctions |
|
---|---|
otNetDataContainsOmrPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
|
bool
Cette fonction vérifie si un préfixe donné peut faire office de préfixe OMR valide, et si les données réseau de Leader contiennent ce préfixe.
|
otNetDataGet(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
|
Cette méthode fournit une copie complète ou stable des données du réseau Thread.
|
otNetDataGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
|
La fonction récupère le préfixe de réseau maillé suivant dans les données réseau de la partition.
|
otNetDataGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
|
Cette fonction obtient la route externe suivante dans les données réseau de la partition.
|
otNetDataGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
|
Cette fonction obtient le service suivant dans les données réseau de la partition.
|
otNetDataGetStableVersion(otInstance *aInstance)
|
uint8_t
Obtenez la version stable des données du réseau.
|
otNetDataGetVersion(otInstance *aInstance)
|
uint8_t
Obtenez la version des données réseau.
|
otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)
|
bool
Cette fonction indique si l'entrée de type "DNS/SRP Service" (Service DNS/SRP) est ajoutée aux données du réseau Thread.
|
otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix)
|
bool
Cette fonction indique si une entrée de préfixe publiée (sur le réseau maillé ou la route externe) est ajoutée aux données du réseau Thread.
|
otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)
|
void
Cette fonction demande la publication d'une adresse Anycast DNS/SRP pour la publication de données dans le réseau Thread.
|
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
|
void
Cette fonction demande la publication de l'adresse DNS/du service SRP dans les données du réseau Thread.
|
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
|
void
Cette fonction demande la publication de l'adresse DNS/du service SRP dans les données du réseau Thread.
|
otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
|
Cette fonction demande la publication d'un préfixe de route externe dans les données du réseau Thread.
|
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
|
Cette fonction demande la publication d'un préfixe sur le réseau maillé dans les données du réseau Thread.
|
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
|
void
Cette fonction définit un rappel pour envoyer une notification lorsque le service DNS/SRP publié est ajouté aux données du réseau Thread ou supprimé de celles-ci.
|
otNetDataSetPrefixPublisherCallback(otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
|
void
Cette fonction définit un rappel pour signaler à quel moment une entrée de préfixe publiée est réellement ajoutée aux données du réseau Thread ou supprimée de celles-ci.
|
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
|
Vérifiez si les données de direction incluent une jointure.
|
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
|
Vérifiez si les données de direction comprennent une jointure avec une valeur de discerner donnée.
|
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
|
void
Annule la publication de toute entrée de service DNS/SRP (Anycast ou Unicast) précédemment ajoutée aux données du réseau Thread.
|
otNetDataUnpublishPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
|
annule la publication d'un préfixe de route externe (ou maillé) publié.
|
otThreadBecomeChild(otInstance *aInstance)
|
Essayez de l'associer à nouveau en tant qu'enfant.
|
otThreadBecomeDetached(otInstance *aInstance)
|
Dissocier du réseau Thread.
|
otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
|
Cette fonction informe les autres nœuds du réseau (le cas échéant) et arrête l'opération de protocole Thread.
|
otThreadDeviceRoleToString(otDeviceRole aRole)
|
const char *
Convertissez le rôle d'appareil en chaîne lisible.
|
otThreadDiscover(otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
|
Cette fonction lance une analyse Thread Discovery.
|
otThreadGetChildTimeout(otInstance *aInstance)
|
uint32_t
Obtenez le délai avant expiration du fil de discussion Thread utilisé lorsque le rôle enfant est utilisé.
|
otThreadGetDeviceRole(otInstance *aInstance)
|
Obtenez le rôle de l'appareil.
|
otThreadGetDomainName(otInstance *aInstance)
|
const char *
Obtenez le nom de domaine du fil de discussion.
|
otThreadGetExtendedPanId(otInstance *aInstance)
|
const otExtendedPanId *
Obtenez l'identifiant PAN étendu de la norme IEEE 802.15.4.
|
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
|
const otIp6InterfaceIdentifier *
Obtenez l'identifiant d'interface spécifié manuellement pour l'adresse unicast de domaine de fils de discussion.
|
otThreadGetIp6Counters(otInstance *aInstance)
|
const otIpCounters *
Obtenez les compteurs IPv6.
|
otThreadGetKeySequenceCounter(otInstance *aInstance)
|
uint32_t
Obtenez le paramètre thmozillaSéquenceCounter.
|
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
|
uint32_t
Obtenez la commande thmozillaSwitchGuardTime.
|
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
|
Cette fonction obtient les données des dirigeants de fils de discussion.
|
otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc)
|
Cette fonction renvoie un repère au RLOC du dirigeant.
|
otThreadGetLeaderRouterId(otInstance *aInstance)
|
uint8_t
Obtenez l'ID du routeur du leader.
|
otThreadGetLeaderWeight(otInstance *aInstance)
|
uint8_t
Obtenez le poids du leader.
|
otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
|
const otIp6Address *
Cette fonction renvoie l'adresse de multidiffusion Thread Link-Local All Thread Nodes.
|
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
|
const otIp6Address *
Cette fonction renvoie l'adresse IPv6 locale du lien Thread.
|
otThreadGetLinkMode(otInstance *aInstance)
|
Obtenez la configuration du mode d'association MLE.
|
otThreadGetMeshLocalEid(otInstance *aInstance)
|
const otIp6Address *
Cette fonction renvoie un pointeur vers l'adresse EID local du réseau maillé.
|
otThreadGetMeshLocalPrefix(otInstance *aInstance)
|
const otMeshLocalPrefix *
Cette fonction renvoie un pointeur vers le préfixe local du réseau maillé.
|
otThreadGetMleCounters(otInstance *aInstance)
|
const otMleCounters *
Obtenez les compteurs MLE de Thread.
|
otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey)
|
void
Obtenez la clé réseau Thread.
|
otThreadGetNetworkKeyRef(otInstance *aInstance)
|
Obtenez le
otNetworkKeyRef de la clé réseau Thread. |
otThreadGetNetworkName(otInstance *aInstance)
|
const char *
Obtenez le nom du réseau Thread.
|
otThreadGetNextDiagnosticTlv(const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
|
Cette fonction reçoit le prochain TLV de diagnostic réseau dans le message.
|
otThreadGetNextNeighborInfo(otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
|
Cette fonction obtient les informations voisines suivantes.
|
otThreadGetParentAverageRssi(otInstance *aInstance, int8_t *aParentRssi)
|
La fonction récupère le RSSI moyen du parent Thread.
|
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
|
La fonction récupère les informations de diagnostic d'un routeur Thread en tant que parent.
|
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
|
La fonction récupère le flux RSSI du dernier paquet à partir du thread Thread.
|
otThreadGetPartitionId(otInstance *aInstance)
|
uint32_t
Obtenez l'ID de la partition.
|
otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
|
const otIp6Address *
Cette fonction renvoie l'adresse de multidiffusion Thread Realm-Local All Thread Nodes.
|
otThreadGetRloc(otInstance *aInstance)
|
const otIp6Address *
Cette fonction renvoie un pointeur vers l'adresse du RLOC (Thread Routing Locator).
|
otThreadGetRloc16(otInstance *aInstance)
|
uint16_t
Obtenez le RLOC16.
|
otThreadGetServiceAloc(otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
|
Cette fonction récupère l'ALOC du service pour l'ID de service donné.
|
otThreadGetVersion(void)
|
uint16_t
Cette fonction obtient la version du protocole Thread.
|
otThreadIsAnycastLocateInProgress(otInstance *aInstance)
|
bool
Cette fonction indique si une requête de localisation Anycast est en cours.
|
otThreadIsDiscoverInProgress(otInstance *aInstance)
|
bool
Cette fonction détermine si une découverte de thread MLE est en cours.
|
otThreadIsSingleton(otInstance *aInstance)
|
bool
Cette fonction indique si le nœud est le seul routeur du réseau.
|
otThreadLocateAnycastDestination(otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
|
Cette fonction demande la destination la plus proche d'une adresse Anycast donnée.
|
otThreadRegisterParentResponseCallback(otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
|
void
Cette fonction enregistre un rappel pour recevoir les données de la réponse parent MLE.
|
otThreadResetIp6Counters(otInstance *aInstance)
|
void
Réinitialisez les compteurs IPv6.
|
otThreadResetMleCounters(otInstance *aInstance)
|
void
Réinitialisez les compteurs Thread MLE.
|
otThreadSendAddressNotification(otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
|
void
Cette fonction envoie un message de notification d'adresse proactive (ADDR_NTF.ntf).
|
otThreadSendDiagnosticGet(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
|
Envoyez une requête de diagnostic réseau.
|
otThreadSendDiagnosticReset(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
|
Envoyer une demande de réinitialisation du diagnostic du réseau.
|
otThreadSendProactiveBackboneNotification(otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
|
Cette fonction envoie un message de notification backbone proactive (PRO_BB.ntf) sur le lien backbone.
|
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
|
void
Définissez le délai avant expiration du thread enfant utilisé lors de l'utilisation du rôle Enfant.
|
otThreadSetDiscoveryRequestCallback(otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
|
void
Cette fonction définit un rappel pour recevoir les données de la requête de découverte MLE.
|
otThreadSetDomainName(otInstance *aInstance, const char *aDomainName)
|
Définissez le nom de domaine Thread.
|
otThreadSetEnabled(otInstance *aInstance, bool aEnabled)
|
Cette fonction lance l'opération de protocole Thread.
|
otThreadSetExtendedPanId(otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
|
Définissez l'ID PAN étendu de la norme IEEE 802.15.4.
|
otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
|
Définir/Effacer l'identifiant d'interface spécifié manuellement pour l'adresse unicast du domaine de fils de discussion.
|
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
|
Cette méthode permet de définir la publicité pour Thread Joiner lors de la découverte du réseau Thread.
|
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
|
void
Définissez le paramètre thmozillaRuleCounter.
|
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
|
void
Définissez la valeur thmozillaSwitchGuardTime.
|
otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)
|
Définissez la configuration du mode d'association MLE.
|
otThreadSetMeshLocalPrefix(otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
|
Cette fonction définit le préfixe local du maillage.
|
otThreadSetNetworkKey(otInstance *aInstance, const otNetworkKey *aKey)
|
Définissez la clé réseau Thread.
|
otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)
|
Définissez la clé réseau Thread en tant que
otNetworkKeyRef . |
otThreadSetNetworkName(otInstance *aInstance, const char *aNetworkName)
|
Définissez le nom du réseau Thread.
|
Structures |
|
---|---|
otBorderRouterConfig |
Cette structure représente la configuration d'un routeur de bordure. |
otExternalRouteConfig |
Cette structure représente une configuration de route externe. |
otIpCounters |
Cette structure représente les compteurs de niveau d'adresse IP. |
otLeaderData |
Cette structure représente les données des dirigeants de fils de discussion. |
otLinkModeConfig |
Cette structure représente une configuration du mode liaison MLE. |
otMleCounters |
Cette structure représente les compteurs MLE de thread. |
otNeighborInfo |
Cette structure contient des informations de diagnostic pour un nœud Thread voisin. |
otNetworkDiagChildEntry |
Cette structure représente une entrée de table enfant de diagnostic réseau. |
otNetworkDiagConnectivity |
Cette structure représente une valeur de connectivité de diagnostic du réseau. |
otNetworkDiagMacCounters |
Cette structure représente une valeur de compteurs de diagnostic réseau. |
otNetworkDiagRoute |
Cette structure représente une valeur TLV de route de diagnostic réseau. |
otNetworkDiagRouteData |
Cette structure représente des données de routage de diagnostic de réseau. |
otNetworkDiagTlv |
Cette structure représente un fichier TLV de diagnostic réseau. |
otRouterInfo |
Cette structure contient des informations de diagnostic pour un routeur de fils de discussion. |
otServerConfig |
Cette structure représente la configuration du serveur, |
otServiceConfig |
Cette structure représente une configuration de service. |
otThreadDiscoveryRequestInfo |
Cette structure représente les données de la requête Thread Discovery. |
otThreadParentResponseInfo |
Cette structure représente les données de la réponse parent MLE. |
Énumérations
énumération anonyme
anonymous enum
OTDeviceRole
otDeviceRole
Représente un rôle d'appareil Thread.
Properties | |
---|---|
OT_DEVICE_ROLE_CHILD
|
Le rôle Thread enfant. |
OT_DEVICE_ROLE_DETACHED
|
Vous ne participez actuellement à aucun réseau/partition Thread. |
OT_DEVICE_ROLE_DISABLED
|
La pile de fils de discussion est désactivée. |
OT_DEVICE_ROLE_LEADER
|
Le rôle de responsable du fil de discussion. |
OT_DEVICE_ROLE_ROUTER
|
Le rôle du routeur de thread. |
otNetDataPublisherEvent
otNetDataPublisherEvent
Cette énumération représente les événements signalés par les rappels de l'éditeur.
Properties | |
---|---|
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED
|
L'entrée publiée est ajoutée aux données du réseau Thread. |
OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED
|
L'entrée publiée est supprimée des données du réseau Thread. |
OTRoutePreference
otRoutePreference
Définit des valeurs valides pour mPreference
dans otExternalRouteConfig
et otBorderRouterConfig
.
Properties | |
---|---|
OT_ROUTE_PREFERENCE_HIGH
|
Préférence d'itinéraire élevée. |
OT_ROUTE_PREFERENCE_LOW
|
Préférence d'itinéraire faible. |
OT_ROUTE_PREFERENCE_MED
|
Préférence d'itinéraire moyenne. |
Définitions
OTBorderRouterConfig
struct otBorderRouterConfig otBorderRouterConfig
Cette structure représente la configuration d'un routeur de bordure.
otDetachGracelyCallback
void(* otDetachGracefullyCallback)(void *aContext)
Ce rappel informe l'application que le processus de dissociation est terminé.
Détails | |||
---|---|---|---|
Paramètres |
|
OTExternalRouteConfig
struct otExternalRouteConfig otExternalRouteConfig
Cette structure représente une configuration de route externe.
Compteurs automatiques
struct otIpCounters otIpCounters
Cette structure représente les compteurs de niveau d'adresse IP.
OTLeader Data
struct otLeaderData otLeaderData
Cette structure représente les données des dirigeants de fils de discussion.
OTLinkModeConfig
struct otLinkModeConfig otLinkModeConfig
Cette structure représente une configuration du mode liaison MLE.
otMleCompteurs
struct otMleCounters otMleCounters
Cette structure représente les compteurs MLE de thread.
otNeighborInfoitération
int16_t otNeighborInfoIterator
Utilisé pour effectuer une itération dans la table voisine.
otNetDataDnsSrpServicePublisherCallback
void(* otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)
Ce type de pointeur de fonction définit le rappel utilisé pour envoyer une notification lorsqu'une entrée de service DNS/SRP est ajoutée aux données du réseau Thread ou supprimée de celles-ci.
Lorsque le rappel est supprimé, il est invoqué indépendamment de la suppression de l'entrée par Publisher
(par exemple, lorsque de trop nombreuses entrées similaires sont déjà présentes dans les données réseau) ou via un appel explicite pour annuler la publication de l'entrée (c'est-à-dire, un appel vers otNetDataUnpublishDnsSrpService()
).
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otNetDataPrefixPublisherCallback
void(* otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)
Ce type de pointeur de fonction définit le rappel utilisé pour envoyer une notification lorsqu'une entrée de préfixe (réseau maillé ou route externe) est ajoutée aux données du réseau Thread ou supprimée de celles-ci.
Lorsqu'il est supprimé, le rappel est invoqué indépendamment de la suppression de l'entrée par Publisher
(par exemple, lorsqu'il y a trop d'entrées similaires déjà présentes dans les données réseau) ou via un appel explicite pour annuler la publication de l'entrée.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
otNetDataPublisherEvent
enum otNetDataPublisherEvent otNetDataPublisherEvent
Cette énumération représente les événements signalés par les rappels de l'éditeur.
OTNetworkDataitération
uint32_t otNetworkDataIterator
Permet de parcourir les informations des données réseau.
otNetworkDiagChildEntry
struct otNetworkDiagChildEntry otNetworkDiagChildEntry
Cette structure représente une entrée de table enfant de diagnostic réseau.
otNetworkDiagConnectivity
struct otNetworkDiagConnectivity otNetworkDiagConnectivity
Cette structure représente une valeur de connectivité de diagnostic du réseau.
OTNetworkDiagitération
uint16_t otNetworkDiagIterator
Utilisé pour effectuer des itérations dans le fichier TLV de diagnostic du réseau.
otNetworkDiagMacCompteurs
struct otNetworkDiagMacCounters otNetworkDiagMacCounters
Cette structure représente une valeur de compteurs de diagnostic réseau.
Reportez-vous à la RFC 2863 pour obtenir la définition des champs des membres.
OTNetworkDiagRoute
struct otNetworkDiagRoute otNetworkDiagRoute
Cette structure représente une valeur TLV de route de diagnostic réseau.
OTNetworkDiagRouteData
struct otNetworkDiagRouteData otNetworkDiagRouteData
Cette structure représente des données de routage de diagnostic de réseau.
OTNetworkDiagTlv
struct otNetworkDiagTlv otNetworkDiagTlv
Cette structure représente un fichier TLV de diagnostic réseau.
otReceiveDiagnosticGetCallback
void(* otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)
Ce pointeur de fonction est appelé lorsque la réponse de diagnostic de réseau est reçue.
Détails | |||||||||
---|---|---|---|---|---|---|---|---|---|
Paramètres |
|
OTRoutePreference
enum otRoutePreference otRoutePreference
Définit des valeurs valides pour mPreference
dans otExternalRouteConfig
et otBorderRouterConfig
.
OTServerConfig
struct otServerConfig otServerConfig
Cette structure représente la configuration du serveur,
OTServiceConfig
struct otServiceConfig otServiceConfig
Cette structure représente une configuration de service.
otThreadanycastLocatorCallback
void(* otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)
Ce type de pointeur de fonction définit le rappel pour informer le résultat d'une requête otThreadLocateAnycastDestination()
.
Détails | |||||||||
---|---|---|---|---|---|---|---|---|---|
Paramètres |
|
otThreadDiscoveryRequestCallback
void(* otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)
Ce pointeur de fonction est appelé chaque fois qu'un message de demande de découverte MLE est reçu.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otThreadDiscoveryRequestInfo
struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo
Cette structure représente les données de la requête Thread Discovery.
otThreadParentResponseCallback
void(* otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)
Ce pointeur de fonction est appelé à chaque fois qu'un message de réponse parent MLE est reçu.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otThreadParentResponseInfo
struct otThreadParentResponseInfo otThreadParentResponseInfo
Cette structure représente les données de la réponse parent MLE.
Fonctions
otNetDataContainsOmrPrefix
bool otNetDataContainsOmrPrefix( otInstance *aInstance, const otIp6Prefix *aPrefix )
Cette fonction vérifie si un préfixe donné peut faire office de préfixe OMR valide, et si les données réseau de Leader contiennent ce préfixe.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Renvoie |
Indique si
aPrefix est un préfixe OMR valide et si les données réseau de Leader contiennent le préfixe OMR aPrefix . |
OTNetDataGet
otError otNetDataGet( otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength )
Cette méthode fournit une copie complète ou stable des données du réseau Thread.
Détails | |||||||||
---|---|---|---|---|---|---|---|---|---|
Paramètres |
|
otNetDataGetNextOnMeshPrefix
otError otNetDataGetNextOnMeshPrefix( otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig )
La fonction récupère le préfixe de réseau maillé suivant dans les données réseau de la partition.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs renvoyées |
|
otNetDataGetNextRoute
otError otNetDataGetNextRoute( otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig )
Cette fonction obtient la route externe suivante dans les données réseau de la partition.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs renvoyées |
|
otNetDataGetNextService
otError otNetDataGetNextService( otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig )
Cette fonction obtient le service suivant dans les données réseau de la partition.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs renvoyées |
|
otNetDataGetStableVersion
uint8_t otNetDataGetStableVersion( otInstance *aInstance )
Obtenez la version stable des données du réseau.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Version stable des données réseau.
|
otNetDataGetVersion
uint8_t otNetDataGetVersion( otInstance *aInstance )
Obtenez la version des données réseau.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Version des données réseau.
|
otNetDataIsDnsSrpServiceAdded
bool otNetDataIsDnsSrpServiceAdded( otInstance *aInstance )
Cette fonction indique si l'entrée de type "DNS/SRP Service" (Service DNS/SRP) est ajoutée aux données du réseau Thread.
Cette fonction nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs renvoyées |
|
otNetDataIsPrefixAjouté
bool otNetDataIsPrefixAdded( otInstance *aInstance, const otIp6Prefix *aPrefix )
Cette fonction indique si une entrée de préfixe publiée (sur le réseau maillé ou la route externe) est ajoutée aux données du réseau Thread.
Cette fonction nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs renvoyées |
|
otNetDataPublishDnsSrpServiceanycast
void otNetDataPublishDnsSrpServiceAnycast( otInstance *aInstance, uint8_t aSequenceNUmber )
Cette fonction demande la publication d'une adresse Anycast DNS/SRP pour la publication de données dans le réseau Thread.
Cette fonction nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
.
Un appel à cette fonction supprimera et remplacera toutes les entrées précédentes du service DNS/SRP (de l'appel précédent à l'une des fonctions otNetDataPublishDnsSrpService{Type}()
).
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otNetDataPublishDnsSrpServiceUnicast
void otNetDataPublishDnsSrpServiceUnicast( otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort )
Cette fonction demande la publication de l'adresse DNS/du service SRP dans les données du réseau Thread.
Cette fonction nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
.
Un appel à cette fonction supprimera et remplacera toutes les entrées précédentes du service DNS/SRP (de l'appel précédent à l'une des fonctions otNetDataPublishDnsSrpService{Type}()
).
Cette fonction publie l'adresse Unicast DNS/SRP du service en incluant l'adresse et les informations de port dans les données TLV du service.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid
void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid( otInstance *aInstance, uint16_t aPort )
Cette fonction demande la publication de l'adresse DNS/du service SRP dans les données du réseau Thread.
Cette fonction nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
.
Un appel à cette fonction supprimera et remplacera toutes les entrées précédentes du service DNS/SRP (de l'appel précédent à l'une des fonctions otNetDataPublishDnsSrpService{Type}()
).
Contrairement à otNetDataPublishDnsSrpServiceUnicast()
, qui nécessite de fournir l'adresse publiée et inclut les informations des données TLV du service, cette fonction utilise l'EID du réseau local de l'appareil et inclut les informations des données TLV du serveur.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otNetDataPublishExternalRoute
otError otNetDataPublishExternalRoute( otInstance *aInstance, const otExternalRouteConfig *aConfig )
Cette fonction demande la publication d'un préfixe de route externe dans les données du réseau Thread.
Cette fonction nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
.
Seules les entrées stables peuvent être publiées (par exemple,aConfig.mStable
DOIT être TRUE).
Un appel ultérieur à cette méthode remplacera une requête précédente pour le même préfixe. Par exemple, si le nouvel appel ne modifie que les indicateurs (par exemple, le niveau de préférence) et que le préfixe est déjà ajouté dans les données du réseau, le changement en fonction des indicateurs est immédiatement répercuté dans les données du réseau. Cela garantit que les entrées existantes dans les données réseau ne sont pas supprimées brusquement. Notez qu'une modification du niveau de préférence peut entraîner la suppression ultérieure de l'entrée des données réseau après la détermination d'autres nœuds qui publient le même préfixe avec une préférence identique ou supérieure.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs renvoyées |
|
otNetDataPublishOnMeshPrefix
otError otNetDataPublishOnMeshPrefix( otInstance *aInstance, const otBorderRouterConfig *aConfig )
Cette fonction demande la publication d'un préfixe sur le réseau maillé dans les données du réseau Thread.
Cette fonction nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
.
Seules les entrées stables peuvent être publiées (par exemple,aConfig.mStable
DOIT être TRUE).
Un appel ultérieur à cette méthode remplacera une requête précédente pour le même préfixe. Par exemple, si le nouvel appel ne modifie que les indicateurs (par exemple, le niveau de préférence) et que le préfixe est déjà ajouté dans les données du réseau, le changement en fonction des indicateurs est immédiatement répercuté dans les données du réseau. Cela garantit que les entrées existantes dans les données réseau ne sont pas supprimées brusquement. Notez qu'une modification du niveau de préférence peut entraîner la suppression ultérieure de l'entrée des données réseau après la détermination d'autres nœuds qui publient le même préfixe avec une préférence identique ou supérieure.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs renvoyées |
|
otNetDataSetDnsSrpServicePublisherCallback
void otNetDataSetDnsSrpServicePublisherCallback( otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext )
Cette fonction définit un rappel pour envoyer une notification lorsque le service DNS/SRP publié est ajouté aux données du réseau Thread ou supprimé de celles-ci.
Un appel ultérieur à cette fonction remplace toute fonction de rappel définie précédemment.
Cette fonction nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
otNetDataSetPrefixPublisherCallback
void otNetDataSetPrefixPublisherCallback( otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext )
Cette fonction définit un rappel pour signaler à quel moment une entrée de préfixe publiée est réellement ajoutée aux données du réseau Thread ou supprimée de celles-ci.
Un appel ultérieur à cette fonction remplace toute fonction de rappel définie précédemment.
Cette fonction nécessite l'activation de la fonctionnalité OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
otNetDataSteeringDataCheckJoiner
otError otNetDataSteeringDataCheckJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
Vérifiez si les données de direction incluent une jointure.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs renvoyées |
|
otNetDataSteeringDataCheckJoinerDisDisner
otError otNetDataSteeringDataCheckJoinerWithDiscerner( otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner )
Vérifiez si les données de direction comprennent une jointure avec une valeur de discerner donnée.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs renvoyées |
|
otNetDataUnpublishDnsSrpService
void otNetDataUnpublishDnsSrpService( otInstance *aInstance )
Annule la publication de toute entrée de service DNS/SRP (Anycast ou Unicast) précédemment ajoutée aux données du réseau Thread.
OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
doit être activé.
Détails | |||
---|---|---|---|
Paramètres |
|
otNetDataUnpublishPrefix
otError otNetDataUnpublishPrefix( otInstance *aInstance, const otIp6Prefix *aPrefix )
annule la publication d'un préfixe de route externe (ou maillé) publié.
OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
doit être activé.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs renvoyées |
|
otThreaddemain
otError otThreadBecomeChild( otInstance *aInstance )
Essayez de l'associer à nouveau en tant qu'enfant.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs renvoyées |
|
otThreaddestinataire
otError otThreadBecomeDetached( otInstance *aInstance )
Dissocier du réseau Thread.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs renvoyées |
|
otThreadDetachGraceful
otError otThreadDetachGracefully( otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext )
Cette fonction informe les autres nœuds du réseau (le cas échéant) et arrête l'opération de protocole Thread.
Il envoie une libération d'adresses s'il s'agit d'un routeur, ou définit son délai d'inactivité sur 0 si le routeur est un enfant.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs renvoyées |
|
otThreadDeviceRoleToString
const char * otThreadDeviceRoleToString( otDeviceRole aRole )
Convertissez le rôle d'appareil en chaîne lisible.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Chaîne représentant
aRole . |
OTThreadDiscover
otError otThreadDiscover( otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext )
Cette fonction lance une analyse Thread Discovery.
Détails | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Paramètres |
|
||||||||||||||
Valeurs renvoyées |
|
otThreadGetChildTimeout
uint32_t otThreadGetChildTimeout( otInstance *aInstance )
Obtenez le délai avant expiration du fil de discussion Thread utilisé lorsque le rôle enfant est utilisé.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Valeur du délai avant expiration du thread enfant, en secondes.
|
otThreadSetChildTimeout
OTThreadGetDeviceRole
otDeviceRole otThreadGetDeviceRole( otInstance *aInstance )
Obtenez le rôle de l'appareil.
Détails | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Paramètres |
|
||||||||||
Valeurs renvoyées |
|
otThreadGetNom
const char * otThreadGetDomainName( otInstance *aInstance )
Obtenez le nom de domaine du fil de discussion.
Cette fonction n'est disponible que depuis Thread 1.2.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Un pointeur vers le nom de domaine du fil de discussion.
|
otThreadSetEndpoint
otThreadGetExtendedPanId
const otExtendedPanId * otThreadGetExtendedPanId( otInstance *aInstance )
Obtenez l'identifiant PAN étendu de la norme IEEE 802.15.4.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Un pointeur vers l'identifiant PAN étendu de la norme IEEE 802.15.4.
|
otThreadSetExtendedPanId
otThreadGetFixDuaInterfaceIdentifier
const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier( otInstance *aInstance )
Obtenez l'identifiant d'interface spécifié manuellement pour l'adresse unicast de domaine de fils de discussion.
Cette fonction n'est disponible que depuis Thread 1.2 lorsque OPENTHREAD_CONFIG_DUA_ENABLE
est activé.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Pointeur vers l'identifiant d'interface défini manuellement ou NULL si aucun n'a été défini.
|
otThreadSetFixDuaInterfaceIdentifier
otThreadGetIp6Compteurs
const otIpCounters * otThreadGetIp6Counters( otInstance *aInstance )
Obtenez les compteurs IPv6.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Pointeur vers les compteurs IPv6.
|
otThreadGetKeySéquenceCounter
uint32_t otThreadGetKeySequenceCounter( otInstance *aInstance )
Obtenez le paramètre thmozillaSéquenceCounter.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
La valeur de la règle th알ATIONCounter
|
otThreadSetKeySéquenceCounter
otThreadGetKeySwitchGuardTime
uint32_t otThreadGetKeySwitchGuardTime( otInstance *aInstance )
Obtenez la commande thmozillaSwitchGuardTime.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Valeur thmozillaSwitchGuardTime (en heures).
|
otThreadSetKeySwitchGuardTime
otThreadGetLeaderData
otError otThreadGetLeaderData( otInstance *aInstance, otLeaderData *aLeaderData )
Cette fonction obtient les données des dirigeants de fils de discussion.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs renvoyées |
|
otThreadGetLeaderRloc
otError otThreadGetLeaderRloc( otInstance *aInstance, otIp6Address *aLeaderRloc )
Cette fonction renvoie un repère au RLOC du dirigeant.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs renvoyées |
|
otThreadGetLeaderRouterId
uint8_t otThreadGetLeaderRouterId( otInstance *aInstance )
Obtenez l'ID du routeur du leader.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
ID du routeur du leader.
|
otThreadGetLeaderWeight
uint8_t otThreadGetLeaderWeight( otInstance *aInstance )
Obtenez le poids du leader.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Poids du leader
|
otThreadGetLinkLocalAllThreadNodesMulticastAddress
const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress( otInstance *aInstance )
Cette fonction renvoie l'adresse de multidiffusion Thread Link-Local All Thread Nodes.
Il s'agit d'une adresse URL locale Préfixe Unicast RFC [3306], avec:
- flgs défini sur 3 (P = 1 et T = 1)
- Scop défini sur 2
- Veuillez définir la valeur 64
- le préfixe réseau défini sur "Préfixe local du réseau maillé"
- ID de groupe défini sur 1
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Un pointeur vers l'adresse de multidiffusion Thread Link-Local All Thread Nodes.
|
otThreadGetLinkLocalIp6Address
const otIp6Address * otThreadGetLinkLocalIp6Address( otInstance *aInstance )
Cette fonction renvoie l'adresse IPv6 locale du lien Thread.
L'adresse locale du lien Thread est dérivée à l'aide de l'IEEE802.15.4 d'adresse étendue comme identifiant d'interface.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Un pointeur vers l'adresse IPv6 du lien local.
|
OTThreadGetLinkMode
otLinkModeConfig otThreadGetLinkMode( otInstance *aInstance )
Obtenez la configuration du mode d'association MLE.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Configuration du mode lien MLE.
|
otThreadSetLinkMode
otThreadGetMeshLocalEid
const otIp6Address * otThreadGetMeshLocalEid( otInstance *aInstance )
Cette fonction renvoie un pointeur vers l'adresse EID local du réseau maillé.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Pointeur vers l'adresse EID du réseau maillé local.
|
otThreadGetMeshLocalPrefix
const otMeshLocalPrefix * otThreadGetMeshLocalPrefix( otInstance *aInstance )
Cette fonction renvoie un pointeur vers le préfixe local du réseau maillé.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Pointeur vers le préfixe local du réseau maillé.
|
otThreadGetMleCompteurs
const otMleCounters * otThreadGetMleCounters( otInstance *aInstance )
Obtenez les compteurs MLE de Thread.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Un pointeur vers les compteurs MLE de Thread.
|
OTThreadGetNetworkKey
void otThreadGetNetworkKey( otInstance *aInstance, otNetworkKey *aNetworkKey )
Obtenez la clé réseau Thread.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otThreadSetNetworkKey
otThreadGetNetworkKeyRef
otNetworkKeyRef otThreadGetNetworkKeyRef( otInstance *aInstance )
Obtenez le otNetworkKeyRef
de la clé réseau Thread.
Cette fonction nécessite l'activation de la fonctionnalité de compilation OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Référence à la clé réseau Thread stockée en mémoire.
|
otThreadSetNetworkKeyRef
OTThreadGetNetworkName
const char * otThreadGetNetworkName( otInstance *aInstance )
Obtenez le nom du réseau Thread.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Un pointeur vers le nom du réseau Thread.
|
otThreadSetNetworkName
otThreadGetNextDiagnosticTlv
otError otThreadGetNextDiagnosticTlv( const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv )
Cette fonction reçoit le prochain TLV de diagnostic réseau dans le message.
Un appel ultérieur à cette fonction n'est autorisé que lorsque la valeur de retour actuelle est OT_ERROR_NONE.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs renvoyées |
|
otThreadGetNextNeighborInfo
otError otThreadGetNextNeighborInfo( otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo )
Cette fonction obtient les informations voisines suivantes.
Elle permet de parcourir les entrées de la table voisine.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs renvoyées |
|
otThreadGetParentAverageRssi
otError otThreadGetParentAverageRssi( otInstance *aInstance, int8_t *aParentRssi )
La fonction récupère le RSSI moyen du parent Thread.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otThreadGetParentInfo
otError otThreadGetParentInfo( otInstance *aInstance, otRouterInfo *aParentInfo )
La fonction récupère les informations de diagnostic d'un routeur Thread en tant que parent.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otThreadGetParentDernièreRssi
otError otThreadGetParentLastRssi( otInstance *aInstance, int8_t *aLastRssi )
La fonction récupère le flux RSSI du dernier paquet à partir du thread Thread.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs renvoyées |
|
otThreadGetPartitionId
uint32_t otThreadGetPartitionId( otInstance *aInstance )
Obtenez l'ID de la partition.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
ID de la partition.
|
otThreadGetRealmLocalAllThreadNodesMulticastAddress
const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress( otInstance *aInstance )
Cette fonction renvoie l'adresse de multidiffusion Thread Realm-Local All Thread Nodes.
L'adresse est une adresse Multcast de norme Unicast locale locale [RFC 3306], avec:
- flgs défini sur 3 (P = 1 et T = 1)
- Scop 3
- Veuillez définir la valeur 64
- le préfixe réseau défini sur "Préfixe local du réseau maillé"
- ID de groupe défini sur 1
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Un pointeur vers l'adresse multicast des nœuds Thread Realm-Local de tous les nœuds Thread.
|
OTThreadGetRloc
const otIp6Address * otThreadGetRloc( otInstance *aInstance )
Cette fonction renvoie un pointeur vers l'adresse du RLOC (Thread Routing Locator).
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Un pointeur vers l'adresse de l'outil de localisation de routage des fils de discussion (RLOC, Thread Routing Locator).
|
otThreadGetRloc16
uint16_t otThreadGetRloc16( otInstance *aInstance )
Obtenez le RLOC16.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
RLOC16 :
|
otThreadGetServiceAloc
otError otThreadGetServiceAloc( otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc )
Cette fonction récupère l'ALOC du service pour l'ID de service donné.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs renvoyées |
|
otThreadGetVersion
uint16_t otThreadGetVersion( void )
Cette fonction obtient la version du protocole Thread.
Détails | |
---|---|
Renvoie |
la version du protocole Thread.
|
otThreadIsanycastFindInProgress
bool otThreadIsAnycastLocateInProgress( otInstance *aInstance )
Cette fonction indique si une requête de localisation Anycast est en cours.
Cette fonction n'est disponible que lorsque l'option OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE
est activée.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
TRUE si une requête de localisation Anycast est en cours, FALSE dans le cas contraire.
|
otThreadIsDiscoverInProgress
bool otThreadIsDiscoverInProgress( otInstance *aInstance )
Cette fonction détermine si une découverte de thread MLE est en cours.
Détails | |||
---|---|---|---|
Paramètres |
|
otThreadIsSingleton
bool otThreadIsSingleton( otInstance *aInstance )
Cette fonction indique si le nœud est le seul routeur du réseau.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs renvoyées |
|
otThreadFindanycastDestination
otError otThreadLocateAnycastDestination( otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext )
Cette fonction demande la destination la plus proche d'une adresse Anycast donnée.
Cette fonction n'est disponible que lorsque l'option OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE
est activée.
Si une requête précédente est en cours, un appel ultérieur à cette fonction annule et remplace la requête précédente.
Détails | |||||||||
---|---|---|---|---|---|---|---|---|---|
Paramètres |
|
||||||||
Valeurs renvoyées |
|
otThreadRegisterParentResponseCallback
void otThreadRegisterParentResponseCallback( otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext )
Cette fonction enregistre un rappel pour recevoir les données de la réponse parent MLE.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
otThreadResetIp6Compteurs
void otThreadResetIp6Counters( otInstance *aInstance )
Réinitialisez les compteurs IPv6.
Détails | |||
---|---|---|---|
Paramètres |
|
otThreadResetMleCompteurs
void otThreadResetMleCounters( otInstance *aInstance )
Réinitialisez les compteurs Thread MLE.
Détails | |||
---|---|---|---|
Paramètres |
|
otThreadSendAddressNotification
void otThreadSendAddressNotification( otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid )
Cette fonction envoie un message de notification d'adresse proactive (ADDR_NTF.ntf).
Cette fonction n'est disponible que lorsque l'option OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
est activée.
Détails | |||||||||
---|---|---|---|---|---|---|---|---|---|
Paramètres |
|
otThreadSendDiagnosticGet
otError otThreadSendDiagnosticGet( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext )
Envoyez une requête de diagnostic réseau.
Détails | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Paramètres |
|
||||||||||||
Valeurs renvoyées |
|
otThreadSendDiagnosticReset
otError otThreadSendDiagnosticReset( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount )
Envoyer une demande de réinitialisation du diagnostic du réseau.
Détails | |||||||||
---|---|---|---|---|---|---|---|---|---|
Paramètres |
|
||||||||
Valeurs renvoyées |
|
otThreadSendProactiveBackboneNotification
otError otThreadSendProactiveBackboneNotification( otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction )
Cette fonction envoie un message de notification backbone proactive (PRO_BB.ntf) sur le lien backbone.
Cette fonction n'est disponible que lorsque l'option OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
est activée.
Détails | |||||||||
---|---|---|---|---|---|---|---|---|---|
Paramètres |
|
||||||||
Valeurs renvoyées |
|
otThreadSetChildTimeout
void otThreadSetChildTimeout( otInstance *aInstance, uint32_t aTimeout )
Définissez le délai avant expiration du thread enfant utilisé lors de l'utilisation du rôle Enfant.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otThreadGetChildTimeout
otThreadSetDiscoveryRequestCallback
void otThreadSetDiscoveryRequestCallback( otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext )
Cette fonction définit un rappel pour recevoir les données de la requête de découverte MLE.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
otThreadSet bureaux
otError otThreadSetDomainName( otInstance *aInstance, const char *aDomainName )
Définissez le nom de domaine Thread.
Cette fonction n'est disponible que depuis Thread 1.2. Cette fonction n'aboutit que lorsque les protocoles Thread sont désactivés.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs renvoyées |
|
otThreadGetQwiklab
otThreadSetEnabled
otError otThreadSetEnabled( otInstance *aInstance, bool aEnabled )
Cette fonction lance l'opération de protocole Thread.
L'interface doit être active lorsque vous appelez cette fonction.
L'appel de cette fonction avec la fonction aEnabled
définie sur FALSE arrête tous les processus en cours de dissociation lancés par otThreadDetachGraceful(). Son rappel sera appelé.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs renvoyées |
|
otThreadSetExtendPanId
otError otThreadSetExtendedPanId( otInstance *aInstance, const otExtendedPanId *aExtendedPanId )
Définissez l'ID PAN étendu de la norme IEEE 802.15.4.
Cette fonction ne peut être appelée que lorsque les protocoles Thread sont désactivés. L'appel de cette fonction aboutit dans les ensembles de données opérationnels actifs et en attente dans la mémoire non volatile.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs renvoyées |
|
otThreadGetExtendedPanId
otThreadSetFixDuaInterfaceIdentifier
otError otThreadSetFixedDuaInterfaceIdentifier( otInstance *aInstance, const otIp6InterfaceIdentifier *aIid )
Définir/Effacer l'identifiant d'interface spécifié manuellement pour l'adresse unicast du domaine de fils de discussion.
Cette fonction n'est disponible que depuis Thread 1.2 lorsque OPENTHREAD_CONFIG_DUA_ENABLE
est activé.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs renvoyées |
|
otThreadGetFixDuaInterfaceIdentifier
otThreadSetJoinerAdvertising
otError otThreadSetJoinerAdvertisement( otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength )
Cette méthode permet de définir la publicité pour Thread Joiner lors de la découverte du réseau Thread.
Une Publicité de fil de discussion est utilisée pour permettre à un Joint d'effectuer la promotion de ses propres informations spécifiques à l'application (telles que l'ID de fournisseur, l'ID de produit, le Discriminateur, etc.) via un TLV de publicité proposé, et de rendre ces informations accessibles aux Commissaires ou aux Candidats sans aucune interaction humaine.
Détails | |||||||||
---|---|---|---|---|---|---|---|---|---|
Paramètres |
|
||||||||
Valeurs renvoyées |
|
otThreadSetKeySerialCounter
void otThreadSetKeySequenceCounter( otInstance *aInstance, uint32_t aKeySequenceCounter )
Définissez le paramètre thmozillaRuleCounter.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otThreadGetKeySéquenceCounter
otThreadSetKeySwitchGuardTime
void otThreadSetKeySwitchGuardTime( otInstance *aInstance, uint32_t aKeySwitchGuardTime )
Définissez la valeur thmozillaSwitchGuardTime.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otThreadGetKeySwitchGuardTime
otThreadSetLinkMode
otError otThreadSetLinkMode( otInstance *aInstance, otLinkModeConfig aConfig )
Définissez la configuration du mode d'association MLE.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs renvoyées |
|
otThreadGetLinkMode
otThreadSetMeshLocalPrefix
otError otThreadSetMeshLocalPrefix( otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix )
Cette fonction définit le préfixe local du maillage.
Cette fonction n'aboutit que lorsque les protocoles Thread sont désactivés. L'appel de cette fonction aboutit dans les ensembles de données opérationnels actifs et en attente dans la mémoire non volatile.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs renvoyées |
|
OTThreadSetNetworkKey
otError otThreadSetNetworkKey( otInstance *aInstance, const otNetworkKey *aKey )
Définissez la clé réseau Thread.
Cette fonction n'aboutit que lorsque les protocoles Thread sont désactivés. L'appel de cette fonction aboutit dans les ensembles de données opérationnels actifs et en attente dans la mémoire non volatile.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs renvoyées |
|
otThreadGetNetworkKey
otThreadSetNetworkKeyRef
otError otThreadSetNetworkKeyRef( otInstance *aInstance, otNetworkKeyRef aKeyRef )
Définissez la clé réseau Thread en tant que otNetworkKeyRef
.
Cette fonction n'aboutit que lorsque les protocoles Thread sont désactivés. L'appel de cette fonction aboutit dans les ensembles de données opérationnels actifs et en attente dans la mémoire non volatile.
Cette fonction nécessite l'activation de la fonctionnalité de compilation OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs renvoyées |
|
otThreadGetNetworkKeyRef
otThreadSetNetworkName
otError otThreadSetNetworkName( otInstance *aInstance, const char *aNetworkName )
Définissez le nom du réseau Thread.
Cette fonction n'aboutit que lorsque les protocoles Thread sont désactivés. L'appel de cette fonction aboutit dans les ensembles de données opérationnels actifs et en attente dans la mémoire non volatile.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs renvoyées |
|
otThreadGetNetworkName
Macros
OT_JOINER_ADVDATA_MAX_LENGTH
OT_JOINER_ADVDATA_MAX_LENGTH 64
Durée maximale des annonces associées à des jointures.
OT_NEIGHBOR_INFO_ITERATOR_INIT
OT_NEIGHBOR_INFO_ITERATOR_INIT 0
Initialisation de otNeighborInfoiter.
OT_NETWORK_BASE_TLV_MAX_LENGTH
OT_NETWORK_BASE_TLV_MAX_LENGTH 254
Longueur maximale du TLV de base du thread.
OT_NETWORK_DATA_ITERATOR_INIT
OT_NETWORK_DATA_ITERATOR_INIT 0
Valeur permettant d'initialiser otNetworkDataIterator
.
OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE
OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3
Taille de l'entrée de la table enfant du diagnostic réseau.
OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT
OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0
Initialisation de otNetworkDiagiter.
OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES
OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19
Nombre maximal de types de TLV de diagnostic réseau à demander ou à réinitialiser.
OT_NETWORK_MAX_ROUTER_ID
OT_NETWORK_MAX_ROUTER_ID 62
ID de routeur maximal.
OT_SERVER_DATA_MAX_SIZE
OT_SERVER_DATA_MAX_SIZE 248
Taille maximale des données du serveur en octets. Limite théorique, presque bien plus faible.
OT_SERVICE_DATA_MAX_SIZE
OT_SERVICE_DATA_MAX_SIZE 252
Taille maximale des données de service en octets.
Resources
Les rubriques de référence de l'API OpenThread proviennent du code source, disponible sur GitHub. Pour en savoir plus ou contribuer à notre documentation, consultez la page Ressources.