Routeur backbone

Ce module comprend des fonctions pour le service de routeur backbone OpenThread.

Résumé

Énumérations

otBackboneRouterDomainPrefixEvent{
  OT_BACKBONE_ROUTER_DOMAIN_PREFIX_ADDED = 0,
  OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED = 1,
  OT_BACKBONE_ROUTER_DOMAIN_PREFIX_CHANGED = 2
}
enum
Représente les événements du préfixe de domaine.
otBackboneRouterMulticastListenerEvent{
  OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED = 0,
  OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED = 1
}
enum
Représente les événements de l'écouteur Multicast.
otBackboneRouterNdProxyEvent{
  OT_BACKBONE_ROUTER_NDPROXY_ADDED = 0,
  OT_BACKBONE_ROUTER_NDPROXY_REMOVED = 1,
  OT_BACKBONE_ROUTER_NDPROXY_RENEWED = 2,
  OT_BACKBONE_ROUTER_NDPROXY_CLEARED = 3
}
enum
Représente les événements proxy ND.
otBackboneRouterState{
  OT_BACKBONE_ROUTER_STATE_DISABLED = 0,
  OT_BACKBONE_ROUTER_STATE_SECONDARY = 1,
  OT_BACKBONE_ROUTER_STATE_PRIMARY = 2
}
enum
Représente l'état du routeur backbone.

Typedefs

otBackboneRouterConfig typedef
Représente la configuration du routeur backbone.
otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix) typedef
void(*
Pointer est appelé à chaque fois que le préfixe de domaine change.
otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress) typedef
void(*
Le pointeur est appelé chaque fois que les écouteurs multicast changent.
otBackboneRouterMulticastListenerInfo typedef
Représente les informations d'un écouteur de multidiffusion de backbone.
otBackboneRouterMulticastListenerIterator typedef
uint16_t
Permet d'effectuer des itérations via des écouteurs multicast.
otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua) typedef
void(*
Pointer est appelé chaque fois que le proxy ND change.
otBackboneRouterNdProxyInfo typedef
Représente les informations de proxy ND du routeur backbone.

Fonctions

otBackboneRouterConfigNextDuaRegistrationResponse(otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus)
void
Configure l'état de la réponse pour l'enregistrement du DUA suivant.
otBackboneRouterConfigNextMulticastListenerRegistrationResponse(otInstance *aInstance, uint8_t aStatus)
void
Configure l'état de la réponse pour le prochain enregistrement d'écouteur Multicast.
otBackboneRouterGetConfig(otInstance *aInstance, otBackboneRouterConfig *aConfig)
void
Récupère la configuration du routeur backbone local.
otBackboneRouterGetDomainPrefix(otInstance *aInstance, otBorderRouterConfig *aConfig)
Récupère la configuration du préfixe de domaine local.
otBackboneRouterGetNdProxyInfo(otInstance *aInstance, const otIp6Address *aDua, otBackboneRouterNdProxyInfo *aNdProxyInfo)
Récupère les informations du proxy ND du routeur backbone.
otBackboneRouterGetPrimary(otInstance *aInstance, otBackboneRouterConfig *aConfig)
Récupère les informations du routeur backbone principal du réseau Thread.
otBackboneRouterGetRegistrationJitter(otInstance *aInstance)
uint8_t
Renvoie la valeur de gigue de l'enregistrement du routeur backbone.
otBackboneRouterGetState(otInstance *aInstance)
Récupère le routeur backbone otBackboneRouterState.
otBackboneRouterMulticastListenerAdd(otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout)
Ajoute un écouteur Multicast avec un délai avant expiration, en secondes.
otBackboneRouterMulticastListenerClear(otInstance *aInstance)
void
Efface les écouteurs Multicast.
otBackboneRouterMulticastListenerGetNext(otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo)
Récupère les informations suivantes de l'écouteur Multicast (à l'aide d'un itérateur).
otBackboneRouterRegister(otInstance *aInstance)
Enregistre explicitement la configuration du routeur backbone local.
otBackboneRouterSetConfig(otInstance *aInstance, const otBackboneRouterConfig *aConfig)
Définit la configuration locale du routeur backbone otBackboneRouterConfig.
otBackboneRouterSetDomainPrefixCallback(otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext)
void
Définit le rappel du préfixe de domaine du routeur backbone.
otBackboneRouterSetEnabled(otInstance *aInstance, bool aEnable)
void
Active ou désactive la fonctionnalité backbone.
otBackboneRouterSetMulticastListenerCallback(otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext)
void
Définit le rappel Listener multicast de backbone.
otBackboneRouterSetNdProxyCallback(otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext)
void
Définit le rappel du proxy ND du routeur backbone.
otBackboneRouterSetRegistrationJitter(otInstance *aInstance, uint8_t aJitter)
void
Définit la valeur de gigue de l'enregistrement du routeur backbone.

Structs

otBackboneRouterConfig.

Représente la configuration du routeur backbone.

otBackboneRouterMulticastListenerInfo

Représente les informations d'un écouteur de multidiffusion de backbone.

otBackboneRouterNdProxyInfo

Représente les informations de proxy ND du routeur backbone.

Énumérations

otBackboneRouterDomainPrefixEvent

 otBackboneRouterDomainPrefixEvent

Représente les événements du préfixe de domaine.

Propriétés
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_ADDED

Le préfixe de domaine a été ajouté.

OT_BACKBONE_ROUTER_DOMAIN_PREFIX_CHANGED

Le préfixe de domaine a été modifié.

OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED

Le préfixe de domaine a été supprimé.

otBackboneRouterMulticastListenerEvent

 otBackboneRouterMulticastListenerEvent

Représente les événements de l'écouteur Multicast.

Propriétés
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED

Ajout de l'écouteur de multidiffusion.

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED

L'écouteur de multidiffusion a été supprimé ou a expiré.

otBackboneRouterNdProxyEvent.

 otBackboneRouterNdProxyEvent

Représente les événements proxy ND.

Propriétés
OT_BACKBONE_ROUTER_NDPROXY_ADDED

Le proxy ND a été ajouté.

OT_BACKBONE_ROUTER_NDPROXY_CLEARED

Tous les proxys ND ont été effacés.

OT_BACKBONE_ROUTER_NDPROXY_REMOVED

Le proxy ND a été supprimé.

OT_BACKBONE_ROUTER_NDPROXY_RENEWED

Le proxy ND a été renouvelé.

OTBackboneRouterState

 otBackboneRouterState

Représente l'état du routeur backbone.

Propriétés
OT_BACKBONE_ROUTER_STATE_DISABLED

La fonction backbone est désactivée.

OT_BACKBONE_ROUTER_STATE_PRIMARY

Routeur backbone principal.

OT_BACKBONE_ROUTER_STATE_SECONDARY

Routeur backbone secondaire.

Typedefs

OTBackboneRouter Config

struct otBackboneRouterConfig otBackboneRouterConfig

Représente la configuration du routeur backbone.

otBackboneRouterDomainPrefixCallback

void(* otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix)

Pointer est appelé à chaque fois que le préfixe de domaine change.

Détails
Paramètres
[in] aContext
Pointeur de contexte utilisateur.
[in] aEvent
Événement de préfixe de domaine.
[in] aDomainPrefix
Nouveau préfixe de domaine en cas d'ajout ou de modification, sinon nullptr.

otBackboneRouterMulticastListenerCallback

void(* otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress)

Le pointeur est appelé chaque fois que les écouteurs multicast changent.

Détails
Paramètres
[in] aContext
Pointeur de contexte utilisateur.
[in] aEvent
Événement Écouteur multidiffusion.
[in] aAddress
Adresse de multidiffusion IPv6 de l'écouteur de multidiffusion.

otBackboneRouterMulticastListenerInfo

struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo

Représente les informations d'un écouteur de multidiffusion de backbone.

otBackboneRouterMulticastListenerIterator

uint16_t otBackboneRouterMulticastListenerIterator

Permet d'effectuer des itérations via des écouteurs multicast.

otBackboneRouterNdProxyCallback

void(* otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua)

Pointer est appelé chaque fois que le proxy ND change.

Détails
Paramètres
[in] aContext
Pointeur de contexte utilisateur.
[in] aEvent
Événement de proxy ND.
[in] aDua
Adresse unicast de domaine du proxy ND, ou nullptr si aEvent est OT_BACKBONE_ROUTER_NDPROXY_CLEARED.

otBackboneRouterNdProxyInfo

struct otBackboneRouterNdProxyInfo otBackboneRouterNdProxyInfo

Représente les informations de proxy ND du routeur backbone.

Fonctions

otBackboneRouterConfigNextDuaRegistrationResponse

void otBackboneRouterConfigNextDuaRegistrationResponse(
  otInstance *aInstance,
  const otIp6InterfaceIdentifier *aMlIid,
  uint8_t aStatus
)

Configure l'état de la réponse pour l'enregistrement du DUA suivant.

Remarque: disponible uniquement lorsque OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE est activé. Utilisée uniquement à des fins de test et de certification.

À FAIRE: (DUA) accepte le code d'erreur coap et le processus correspondant à des fins de certification.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aMlIid
Un pointeur vers l'IDI local du maillage. Si la valeur est NULL, répondez avec aStatus pour tout DUA.req. Dans le cas contraire, ne répondez que avec le aMlIid correspondant.
[in] aStatus
État auquel répondre.

otBackboneRouterConfigNextMulticastListenerRegistrationResponse

void otBackboneRouterConfigNextMulticastListenerRegistrationResponse(
  otInstance *aInstance,
  uint8_t aStatus
)

Configure l'état de la réponse pour le prochain enregistrement d'écouteur Multicast.

Disponible lorsque OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE et OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE sont activés.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aStatus
État auquel répondre.

otBackboneRouterGetConfig

void otBackboneRouterGetConfig(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Récupère la configuration du routeur backbone local.

Disponible lorsque OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE est activé.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[out] aConfig
Un pointeur où placer la configuration du routeur backbone local.
Voir aussi:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterSetConfig
otBackboneRouterRegister

otBackboneRouterGetDomainPrefix

otError otBackboneRouterGetDomainPrefix(
  otInstance *aInstance,
  otBorderRouterConfig *aConfig
)

Récupère la configuration du préfixe de domaine local.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[out] aConfig
Un pointeur vers la configuration du préfixe de domaine.
Valeurs renvoyées
OT_ERROR_NONE
La configuration du préfixe de domaine a bien été obtenue.
OT_ERROR_NOT_FOUND
Aucun préfixe de domaine n'a été configuré.

otBackboneRouterGetNdProxyInfo

otError otBackboneRouterGetNdProxyInfo(
  otInstance *aInstance,
  const otIp6Address *aDua,
  otBackboneRouterNdProxyInfo *aNdProxyInfo
)

Récupère les informations du proxy ND du routeur backbone.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aDua
Adresse Unicast du domaine.
[out] aNdProxyInfo
Un pointeur vers les informations du proxy ND.
Valeurs renvoyées
OT_ERROR_NONE
Les informations de proxy ND ont bien été obtenues.
OT_ERROR_NOT_FOUND
L'adresse unicast de domaine est introuvable dans le tableau "Proxy ND".

OTBackboneRouterGetPrimary

otError otBackboneRouterGetPrimary(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Récupère les informations du routeur backbone principal du réseau Thread.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[out] aConfig
Un pointeur vers l'emplacement de destination des informations sur le routeur backbone principal.
Valeurs renvoyées
OT_ERROR_NONE
Les informations du routeur backbone principal ont bien été obtenues.
OT_ERROR_NOT_FOUND
Aucun routeur backbone principal n'existe.

otBackboneRouterGetRegistrationJitter

uint8_t otBackboneRouterGetRegistrationJitter(
  otInstance *aInstance
)

Renvoie la valeur de gigue de l'enregistrement du routeur backbone.

Détails
Renvoie
Gigue la valeur de gigue de l'enregistrement du routeur backbone.
Voir aussi:
otBackboneRouterSetRegistrationJitter

otBackboneRouterGetState

otBackboneRouterState otBackboneRouterGetState(
  otInstance *aInstance
)

Récupère le routeur backbone otBackboneRouterState.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Valeurs renvoyées
OT_BACKBONE_ROUTER_STATE_DISABLED
La fonctionnalité backbone est désactivée.
OT_BACKBONE_ROUTER_STATE_SECONDARY
Routeur backbone secondaire.
OT_BACKBONE_ROUTER_STATE_PRIMARY
Routeur backbone principal.
Voir aussi:
otBackboneRouterSetEnabled
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister

otBackboneRouterMulticastListenerAdd

otError otBackboneRouterMulticastListenerAdd(
  otInstance *aInstance,
  const otIp6Address *aAddress,
  uint32_t aTimeout
)

Ajoute un écouteur Multicast avec un délai avant expiration, en secondes.

Transmettez 0 pour utiliser le délai avant expiration MLR par défaut.

Disponible lorsque OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE et OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE sont activés.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aAddress
Adresse de l'écouteur Multicast.
[in] aTimeout
Délai d'inactivité (en secondes) de l'écouteur Multicast, ou 0 pour utiliser le délai d'inactivité MLR par défaut.
Valeurs renvoyées
OT_ERROR_NONE
Si l'écouteur Multicast a bien été ajouté.
OT_ERROR_INVALID_ARGS
Si l'adresse de l'écouteur Multicast n'est pas valide.
OT_ERROR_NO_BUFS
Aucun espace disponible pour enregistrer l'écouteur Multicast.
Voir aussi:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerGetNext

otBackboneRouterMulticastListenerClear

void otBackboneRouterMulticastListenerClear(
  otInstance *aInstance
)

Efface les écouteurs Multicast.

Disponible lorsque OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE et OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE sont activés.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Voir également:
otBackboneRouterMulticastListenerAdd
otBackboneRouterMulticastListenerGetNext

otBackboneRouterMulticastListenerGetNext

otError otBackboneRouterMulticastListenerGetNext(
  otInstance *aInstance,
  otBackboneRouterMulticastListenerIterator *aIterator,
  otBackboneRouterMulticastListenerInfo *aListenerInfo
)

Récupère les informations suivantes de l'écouteur Multicast (à l'aide d'un itérateur).

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in,out] aIterator
Un pointeur vers l'itérateur. Si l'itérateur réussit, il est mis à jour pour pointer vers l'écouteur de multidiffusion suivant. Pour obtenir la première entrée, l'itérateur doit être défini sur OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT.
[out] aListenerInfo
Un pointeur vers un otBackboneRouterMulticastListenerInfo, où les informations du prochain écouteur Multicast sont placées (en cas de réussite).
Valeurs renvoyées
OT_ERROR_NONE
Les informations suivantes de l'écouteur Multicast ont bien été trouvées (aListenerInfo a bien été mis à jour).
OT_ERROR_NOT_FOUND
Aucune information sur l'écouteur de multidiffusion suivant n'a été trouvée.
Voir aussi:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerAdd

OTBackboneRouterRegister

otError otBackboneRouterRegister(
  otInstance *aInstance
)

Enregistre explicitement la configuration du routeur backbone local.

Un message de demande de données du serveur SRV_DATA.ntf est déclenché pour l'appareil connecté.

Disponible lorsque OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE est activé.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Valeurs renvoyées
OT_ERROR_NO_BUFS
Espace insuffisant pour ajouter le service de routeur backbone.
OT_ERROR_NONE
Un message de demande de données du serveur a bien été placé dans la file d'attente.
Voir aussi:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig

otBackboneRouterSetConfig

otError otBackboneRouterSetConfig(
  otInstance *aInstance,
  const otBackboneRouterConfig *aConfig
)

Définit la configuration locale du routeur backbone otBackboneRouterConfig.

Le message de demande de données du serveur SRV_DATA.ntf est envoyé automatiquement si l'ensemble de données BBR change pour le routeur backbone principal.

Disponible lorsque OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE est activé.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aConfig
Un pointeur vers la configuration du routeur backbone pour prendre effet.
Valeurs renvoyées
OT_ERROR_NONE
La configuration a bien été mise à jour.
OT_ERROR_INVALID_ARGS
La configuration dans aConfig n'est pas valide.
Voir aussi:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterRegister

otBackboneRouterSetDomainPrefixCallback

void otBackboneRouterSetDomainPrefixCallback(
  otInstance *aInstance,
  otBackboneRouterDomainPrefixCallback aCallback,
  void *aContext
)

Définit le rappel du préfixe de domaine du routeur backbone.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aCallback
Un pointeur vers le rappel du préfixe de domaine.
[in] aContext
Un pointeur de contexte utilisateur.

otBackboneRouterSetEnabled

void otBackboneRouterSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Active ou désactive la fonctionnalité backbone.

Si cette option est activée, un message de demande de données du serveur SRV_DATA.ntf est déclenché pour l'appareil associé si les données du réseau Thread ne contiennent aucun service de routeur backbone.

Si cette option est désactivée, SRV_DATA.ntf est déclenché si le routeur backbone est à l'état principal.

Disponible lorsque OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE est activé.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aEnable
TRUE pour activer la fonctionnalité backbone, FALSE dans le cas contraire.
Voir aussi:
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister

otBackboneRouterSetMulticastListenerCallback

void otBackboneRouterSetMulticastListenerCallback(
  otInstance *aInstance,
  otBackboneRouterMulticastListenerCallback aCallback,
  void *aContext
)

Définit le rappel Listener multicast de backbone.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aCallback
Un pointeur vers le rappel "Auditeur multicast".
[in] aContext
Un pointeur de contexte utilisateur.

otBackboneRouterSetNdProxyCallback

void otBackboneRouterSetNdProxyCallback(
  otInstance *aInstance,
  otBackboneRouterNdProxyCallback aCallback,
  void *aContext
)

Définit le rappel du proxy ND du routeur backbone.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aCallback
Un pointeur vers le rappel du proxy ND.
[in] aContext
Un pointeur de contexte utilisateur.

otBackboneRouterSetRegistrationJitter

void otBackboneRouterSetRegistrationJitter(
  otInstance *aInstance,
  uint8_t aJitter
)

Définit la valeur de gigue de l'enregistrement du routeur backbone.

Détails
Paramètres
[in] aJitter
La valeur de gigue de l'enregistrement du routeur backbone à définir.
Voir aussi:
otBackboneRouterGetRegistrationJitter

Macros

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT

 OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT 0

Initialisation de otBackboneRouterMulticastListenerIterator.

Ressources

Les sujets de référence de l'API OpenThread proviennent du code source, disponible sur GitHub. Pour en savoir plus ou pour contribuer à notre documentation, consultez Ressources.