Agent Border

Ce module inclut des fonctions pour le rôle d'agent de bordure Thread.

Résumé

Énumérations
otBorderAgentState{
  OT_BORDER_AGENT_STATE_STOPPED = 0,
  OT_BORDER_AGENT_STATE_STARTED = 1,
  OT_BORDER_AGENT_STATE_ACTIVE = 2
} 		enum
Définit l'état de l'agent Border.

Typedefs
otBorderAgentId typedef
Représente un ID d'agent Border.
otBorderAgentState typedef
Définit l'état de l'agent Border.

Variables
OT_TOOL_PACKED_END

Fonctions
otBorderAgentGetId(otInstance *aInstance, otBorderAgentId *aId)
Récupère l'ID Border Agent ID généré de manière aléatoire.
otBorderAgentGetState(otInstance *aInstance)
Récupère le otBorderAgentState du rôle "Thread Border Agent".
otBorderAgentGetUdpPort(otInstance *aInstance)
uint16_t
Récupère le port UDP du service de l'agent de bordure Thread.
otBorderAgentSetId(otInstance *aInstance, const otBorderAgentId *aId)
Définit l'ID Border Agent.

Structs
otBorderAgentId

Représente un ID d'agent Border.

Énumérations

otBorderAgentState

 otBorderAgentState

Définit l'état de l'agent Border.

Propriétés
OT_BORDER_AGENT_STATE_ACTIVE

L'agent de bordure est connecté au commissaire externe.

OT_BORDER_AGENT_STATE_STARTED

L'agent Border est démarré.

OT_BORDER_AGENT_STATE_STOPPED

Le rôle de l'agent Border est désactivé.

Typedefs

otBorderAgentId

struct otBorderAgentId otBorderAgentId

Représente un ID d'agent Border.

otBorderAgentState

enum otBorderAgentState otBorderAgentState

Définit l'état de l'agent Border.

Variables

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otBorderAgentId OT_TOOL_PACKED_END

Fonctions

otBorderAgentGetId

otError otBorderAgentGetId(
  otInstance *aInstance,
  otBorderAgentId *aId
)

Récupère l'ID Border Agent ID généré de manière aléatoire.

L'ID est enregistré dans le stockage persistant et survit aux redémarrages. En règle générale, l'ID doit être publié dans le service mDNS de MeshCoP en tant que valeur TXT id pour que le client puisse identifier cet appareil de routeur/agent de bordure.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[out] aId
Un pointeur à mettre en mémoire tampon pour recevoir l'ID.
Valeurs renvoyées
OT_ERROR_NONE
S'il a bien été récupéré.
...
Si vous ne parvenez pas à récupérer l'ID Border Agent.
Voir aussi:
otBorderAgentSetId

otBorderAgentGetState

otBorderAgentState otBorderAgentGetState(
  otInstance *aInstance
)

Récupère le otBorderAgentState du rôle "Thread Border Agent".

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
otBorderAgentState actuel de l'agent Border.

otBorderAgentGetUdpPort

uint16_t otBorderAgentGetUdpPort(
  otInstance *aInstance
)

Récupère le port UDP du service de l'agent de bordure Thread.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
Port UDP de l'agent Border.

otBorderAgentSetId

otError otBorderAgentSetId(
  otInstance *aInstance,
  const otBorderAgentId *aId
)

Définit l'ID Border Agent.

L'ID de l'agent Border sera enregistré dans le stockage persistant et après les redémarrages. Vous devez le définir une seule fois après le rétablissement de la configuration d'usine. Si l'ID n'a jamais été défini en appelant cette fonction, un ID aléatoire est généré et renvoyé lorsque otBorderAgentGetId est appelé.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[out] aId
Un pointeur vers l'ID de l'agent Border.
Valeurs renvoyées
OT_ERROR_NONE
Si vous avez réussi à définir l'ID de l'agent Border.
...
Si vous n'avez pas défini l'ID de l'agent Border.
Voir aussi:
otBorderAgentGetId

Macros

OT_BORDER_AGENT_ID_LENGTH

 OT_BORDER_AGENT_ID_LENGTH (16)

Longueur de l'ID Border Agent/Router en octets.

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.