Google is committed to advancing racial equity for Black communities. See how.
Cette page a été traduite par l'API Cloud Translation.
Switch to English

Routeur de dorsale

Ce module comprend des fonctions pour le service OpenThread Backbone Router.

Résumé

Énumérations

otBackboneRouterMulticastListenerEvent {
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED = 0,
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED = 1
}
énumération
Représente les événements de l'écouteur de multidiffusion.
otBackboneRouterState {
OT_BACKBONE_ROUTER_STATE_DISABLED = 0,
OT_BACKBONE_ROUTER_STATE_SECONDARY = 1,
OT_BACKBONE_ROUTER_STATE_PRIMARY = 2
}
énumération
Représente l'état du routeur de base.

Typedefs

otBackboneRouterConfig typedef
Cette structure représente la configuration du routeur de base.
otBackboneRouterMulticastListenerCallback )(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress) typedef
void(*
Ce pointeur de fonction est appelé chaque fois que les écouteurs de multidiffusion changent.
otBackboneRouterMulticastListenerInfo typedef
Cette structure représente une information d'écouteur de multidiffusion de routeur de dorsale.
otBackboneRouterMulticastListenerIterator typedef
uint16_t
Utilisé pour parcourir les écouteurs multicast.

Les fonctions

otBackboneRouterConfigNextDuaRegistrationResponse ( otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus)
void
Cette méthode configure l'état de la réponse pour le prochain enregistrement DUA.
otBackboneRouterConfigNextMulticastListenerRegistrationResponse ( otInstance *aInstance, uint8_t aStatus)
void
Cette méthode configure l'état de la réponse pour le prochain enregistrement d'écouteur de multidiffusion.
otBackboneRouterGetConfig ( otInstance *aInstance, otBackboneRouterConfig *aConfig)
void
Cette fonction récupère la configuration locale du Backbone Router.
otBackboneRouterGetDomainPrefix ( otInstance *aInstance, otBorderRouterConfig *aConfig)
Cette méthode obtient la configuration locale du préfixe de domaine.
otBackboneRouterGetPrimary ( otInstance *aInstance, otBackboneRouterConfig *aConfig)
Cette fonction obtient les informations du routeur principal principal dans le réseau de threads.
otBackboneRouterGetRegistrationJitter ( otInstance *aInstance)
uint8_t
Cette méthode renvoie la valeur de gigue d'enregistrement du routeur de base.
otBackboneRouterGetState ( otInstance *aInstance)
Cette fonction obtient l'état du routeur de base.
otBackboneRouterMulticastListenerAdd ( otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout)
Cette méthode ajoute un écouteur de multidiffusion.
otBackboneRouterMulticastListenerClear ( otInstance *aInstance)
void
Cette méthode efface les écouteurs de multidiffusion.
otBackboneRouterMulticastListenerGetNext ( otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo)
Cette fonction obtient les informations suivantes sur l'écouteur de multidiffusion (à l'aide d'un itérateur).
otBackboneRouterRegister ( otInstance *aInstance)
Cette fonction enregistre explicitement la configuration du routeur dorsal local.
otBackboneRouterSetConfig ( otInstance *aInstance, const otBackboneRouterConfig *aConfig)
Cette fonction définit la configuration du routeur dorsal local.
otBackboneRouterSetEnabled ( otInstance *aInstance, bool aEnable)
void
Cette fonction active ou désactive la fonctionnalité Backbone.
otBackboneRouterSetMulticastListenerCallback ( otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext)
void
Cette méthode définit le rappel de l'écouteur de multidiffusion de Backbone Router.
otBackboneRouterSetRegistrationJitter ( otInstance *aInstance, uint8_t aJitter)
void
Cette méthode définit la valeur de gigue d'enregistrement du routeur dorsal.

Structs

otBackboneRouterConfig

Cette structure représente la configuration du routeur de base.

otBackboneRouterMulticastListenerInfo

Cette structure représente une information d'écouteur de multidiffusion de routeur de dorsale.

Énumérations

otBackboneRouterMulticastListenerEvent

 otBackboneRouterMulticastListenerEvent

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

Propriétés
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED

Un écouteur de multidiffusion a été ajouté.

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED

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

otBackboneRouterState

 otBackboneRouterState

Représente l'état du routeur de base.

Propriétés
OT_BACKBONE_ROUTER_STATE_DISABLED

La fonction Backbone est désactivée.

OT_BACKBONE_ROUTER_STATE_PRIMARY

Le routeur principal principal.

OT_BACKBONE_ROUTER_STATE_SECONDARY

Routeur backbone secondaire.

Typedefs

otBackboneRouterConfig

struct otBackboneRouterConfig otBackboneRouterConfig

Cette structure représente la configuration du routeur de base.

otBackboneRouterMulticastListenerCallback

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

Ce pointeur de fonction est appelé chaque fois que les écouteurs de multidiffusion changent.

Détails
Paramètres
[in] aContext
Le pointeur de contexte utilisateur.
[in] aEvent
L'événement d'écoute de multidiffusion.
[in] aAddress
L'adresse de multidiffusion IP6 de l'écouteur de multidiffusion.

otBackboneRouterMulticastListenerInfo

struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo

Cette structure représente une information d'écouteur de multidiffusion de routeur de dorsale.

otBackboneRouterMulticastListenerIterator

uint16_t otBackboneRouterMulticastListenerIterator

Utilisé pour parcourir les écouteurs multicast.

Les fonctions

otBackboneRouterConfigNextDuaRegistrationResponse

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

Cette méthode configure l'état de la réponse pour le prochain enregistrement DUA.

Remarque: disponible uniquement lorsque OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE est activé. Utilisé uniquement pour les tests et la certification.

TODO: (DUA) prend en charge le code d'erreur coap et le processus correspondant à des fins de certification.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aMlIid
Un pointeur vers l'IID local de maillage. Si NULL, répondez avec un aStatus pour tout DUA.req à venir, sinon répondez uniquement à celui avec un aMlIid correspondant.
[in] aStatus
Le statut de réponse.

otBackboneRouterConfigNextMulticastListenerRegistrationResponse

void otBackboneRouterConfigNextMulticastListenerRegistrationResponse(
  otInstance *aInstance,
  uint8_t aStatus
)

Cette méthode configure l'état de la réponse pour le prochain enregistrement d'écouteur de multidiffusion.

Remarque: disponible uniquement lorsque OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE est activé. Utilisé uniquement pour les tests et la certification.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aStatus
Le statut de réponse.

otBackboneRouterGetConfig

void otBackboneRouterGetConfig(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Cette fonction obtient la configuration locale du routeur de dorsale.

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

otBackboneRouterGetDomainPrefix

otError otBackboneRouterGetDomainPrefix(
  otInstance *aInstance,
  otBorderRouterConfig *aConfig
)

Cette méthode obtient la configuration locale du préfixe de domaine.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[out] aConfig
Un pointeur vers la configuration du préfixe de domaine.
Valeurs de retour
OT_ERROR_NONE
Obtention de la configuration du préfixe de domaine avec succès.
OT_ERROR_NOT_FOUND
Aucun préfixe de domaine n'a été configuré.

otBackboneRouterGetPrimary

otError otBackboneRouterGetPrimary(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Cette fonction obtient les informations du routeur principal principal dans le réseau de threads.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[out] aConfig
Un pointeur vers où placer les informations du routeur principal principal.
Valeurs de retour
OT_ERROR_NONE
Obtention des informations sur le routeur principal principal.
OT_ERROR_NOT_FOUND
Aucun routeur de dorsale principal n'existe.

otBackboneRouterGetRegistrationJitter

uint8_t otBackboneRouterGetRegistrationJitter(
  otInstance *aInstance
)

Cette méthode renvoie la valeur de gigue d'enregistrement du routeur de base.

Détails
Retour
Valeur de gigue d'enregistrement du routeur de base.
Voir également:
otBackboneRouterSetRegistrationJitter

otBackboneRouterGetState

otBackboneRouterState otBackboneRouterGetState(
  otInstance *aInstance
)

Cette fonction obtient l'état du routeur de base.

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

otBackboneRouterMulticastListenerAdd

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

Cette méthode ajoute un écouteur de multidiffusion.

Remarque: disponible uniquement lorsque OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE est activé. Utilisé uniquement pour les tests et la certification.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aAddress
L'adresse de l'écouteur de multidiffusion.
[in] aTimeout
Délai d'expiration (en secondes) de l'écouteur de multidiffusion, ou 0 pour utiliser le délai d'expiration MLR par défaut.
Valeurs de retour
OT_ERROR_NONE
Si l'écouteur de multidiffusion a été ajouté avec succès.
OT_ERROR_INVALID_ARGS
Si l'adresse de l'écouteur de multidiffusion n'était pas valide.
OT_ERROR_NO_BUFS
Aucun espace disponible pour enregistrer l'écouteur de multidiffusion.
Voir également:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerGetNext

otBackboneRouterMulticastListenerClear

void otBackboneRouterMulticastListenerClear(
  otInstance *aInstance
)

Cette méthode efface les écouteurs de multidiffusion.

Remarque: disponible uniquement lorsque OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE est activé. Utilisé uniquement pour les tests et la certification.

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

otBackboneRouterMulticastListenerGetNext

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

Cette fonction obtient les informations suivantes sur l'écouteur de multidiffusion (à l'aide d'un itérateur).

Remarque: disponible uniquement lorsque OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE est activé. Utilisé uniquement pour les tests et la certification.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in,out] aIterator
Un pointeur vers l'itérateur. En cas de succès, l'itérateur sera mis à jour pour pointer vers le prochain écouteur de multidiffusion. 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 de multidiffusion sont placées (en cas de succès).
Valeurs de retour
OT_ERROR_NONE
aListenerInfo réussie des informations suivantes sur l'écouteur de multidiffusion ( aListenerInfo été mis à jour avec succès).
OT_ERROR_NOT_FOUND
Aucune information d'écoute de multidiffusion ultérieure n'a été trouvée.
Voir également:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerAdd

otBackboneRouterRegister

otError otBackboneRouterRegister(
  otInstance *aInstance
)

Cette fonction enregistre explicitement la configuration du Backbone Router local.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
Valeurs de retour
OT_ERROR_NO_BUFS
Espace insuffisant pour ajouter le service Backbone Router.
OT_ERROR_NONE
Mise en file d'attente réussie d'un message de demande de données serveur pour la livraison.
Voir également:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig

otBackboneRouterSetConfig

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

Cette fonction définit la configuration du routeur dorsal local.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aConfig
Un pointeur vers la configuration du Backbone Router pour prendre effet.
Valeurs de retour
OT_ERROR_NONE
Configuration mise à jour avec succès.
OT_ERROR_INVALID_ARGS
La configuration dans aConfig n'est pas valide.
Voir également:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterRegister

otBackboneRouterSetEnabled

void otBackboneRouterSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Cette fonction active ou désactive la fonctionnalité Backbone.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aEnable
TRUE pour activer la fonctionnalité Backbone, FALSE sinon.
Voir également:
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister

otBackboneRouterSetMulticastListenerCallback

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

Cette méthode définit le rappel de l'écouteur de multidiffusion de Backbone Router.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aCallback
Un pointeur vers le rappel de l'écouteur de multidiffusion.
[in] aContext
Un pointeur de contexte utilisateur.

otBackboneRouterSetRegistrationJitter

void otBackboneRouterSetRegistrationJitter(
  otInstance *aInstance,
  uint8_t aJitter
)

Cette méthode définit la valeur de gigue d'enregistrement du routeur dorsal.

Détails
Paramètres
[in] aJitter
la valeur de gigue d'enregistrement du routeur dorsale à définir.
Voir également:
otBackboneRouterGetRegistrationJitter

Macros

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT

 OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT 0

Initialiseur pour otBackboneRouterMulticastListenerIterator.