IPv6

Ce module contient des fonctions qui contrôlent la communication IPv6.

Résumé

Énumérations
anonymous enum{
  OT_ADDRESS_ORIGIN_THREAD = 0,
  OT_ADDRESS_ORIGIN_SLAAC = 1,
  OT_ADDRESS_ORIGIN_DHCPV6 = 2,
  OT_ADDRESS_ORIGIN_MANUAL = 3
} 		enum
Origines des adresses IPv6.
anonymous enum{
  OT_ECN_NOT_CAPABLE = 0x0,
  OT_ECN_CAPABLE_0 = 0x2,
  OT_ECN_CAPABLE_1 = 0x1,
  OT_ECN_MARKED = 0x3
} 		enum
États ECN, représentés dans l'en-tête IP.
anonymous enum{
  OT_IP6_PROTO_HOP_OPTS = 0,
  OT_IP6_PROTO_TCP = 6,
  OT_IP6_PROTO_UDP = 17,
  OT_IP6_PROTO_IP6 = 41,
  OT_IP6_PROTO_ROUTING = 43,
  OT_IP6_PROTO_FRAGMENT = 44,
  OT_IP6_PROTO_ICMP6 = 58,
  OT_IP6_PROTO_NONE = 59,
  OT_IP6_PROTO_DST_OPTS = 60
} 		enum
les numéros de protocole Internet.

Typedefs
otBorderRoutingCounters typedef
Représente les compteurs de paquets transférés via Routage de bordure.
otIp6Address typedef
struct otIp6Address
Représente une adresse IPv6.
otIp6AddressCallback)(const otIp6AddressInfo *aAddressInfo, bool aIsAdded, void *aContext) typedef
void(*
Le pointeur est appelé lorsqu'une adresse IPv6 interne est ajoutée ou supprimée.
otIp6AddressComponents typedef
Représente les composants d'une adresse IPv6.
otIp6AddressInfo typedef
otIp6InterfaceIdentifier typedef
Représente l'identifiant d'interface d'une adresse IPv6.
otIp6NetworkPrefix typedef
Représente le préfixe réseau d'une adresse IPv6 (64 bits les plus significatifs de l'adresse).
otIp6Prefix typedef
struct otIp6Prefix
Représente un préfixe IPv6.
otIp6ReceiveCallback)(otMessage *aMessage, void *aContext) typedef
void(*
Le pointeur est appelé lorsqu'un datagram IPv6 est reçu.
otIp6RegisterMulticastListenersCallback)(void *aContext, otError aError, uint8_t aMlrStatus, const otIp6Address *aFailedAddresses, uint8_t aFailedAddressNum) typedef
void(*
Le pointeur est appelé avec les résultats de otIp6RegisterMulticastListeners.
otIp6SlaacPrefixFilter)(otInstance *aInstance, const otIp6Prefix *aPrefix) typedef
bool(*
Le pointeur permet de filtrer des préfixes et de ne pas autoriser l'ajout d'une adresse SLAAC basée sur un préfixe.
otMessageInfo typedef
struct otMessageInfo
Représente les adresses de socket IPv6 locales et pairs.
otNetifAddress typedef
Représente une adresse IPv6 d'interface réseau IPv6.
otNetifMulticastAddress typedef
Représente une adresse de multidiffusion d'interface réseau IPv6.
otPacketsAndBytes typedef
Représente les compteurs pour les paquets et les octets.
otSockAddr typedef
struct otSockAddr
Représente une adresse de socket IPv6.

Variables
OT_TOOL_PACKED_END

Fonctions
otIp6AddUnicastAddress(otInstance *aInstance, const otNetifAddress *aAddress)
Ajout d'une adresse d'interface réseau à l'interface Thread.
otIp6AddUnsecurePort(otInstance *aInstance, uint16_t aPort)
Ajoute un port à la liste des ports non sécurisés autorisés.
otIp6AddressFromString(const char *aString, otIp6Address *aAddress)
Convertit une chaîne d'adresse IPv6 lisible en une représentation binaire.
otIp6AddressToString(const otIp6Address *aAddress, char *aBuffer, uint16_t aSize)
void
Convertit une adresse IPv6 donnée en chaîne lisible.
otIp6ArePrefixesEqual(const otIp6Prefix *aFirst, const otIp6Prefix *aSecond)
bool
Vérifiez si deux préfixes IPv6 sont identiques.
otIp6GetBorderRoutingCounters(otInstance *aInstance)
Récupère les compteurs de routage de la bordure.
otIp6GetMulticastAddresses(otInstance *aInstance)
Récupère la liste des adresses de multicast IPv6 abonnées à l'interface Thread.
otIp6GetPrefix(const otIp6Address *aAddress, uint8_t aLength, otIp6Prefix *aPrefix)
void
Récupère un préfixe avec aLength à partir de aAddress.
otIp6GetUnicastAddresses(otInstance *aInstance)
const otNetifAddress *
Récupère la liste des adresses IPv6 attribuées à l'interface Thread.
otIp6GetUnsecurePorts(otInstance *aInstance, uint8_t *aNumEntries)
const uint16_t *
Renvoie un pointeur vers la liste des ports non sécurisés.
otIp6IsAddressEqual(const otIp6Address *aFirst, const otIp6Address *aSecond)
bool
Vérifiez si deux adresses IPv6 sont identiques.
otIp6IsAddressUnspecified(const otIp6Address *aAddress)
bool
Indique si l'adresse IPv6 donnée est ou non l'adresse non spécifiée.
otIp6IsEnabled(otInstance *aInstance)
bool
Indique si l'interface IPv6 est opérationnelle.
otIp6IsMulticastPromiscuousEnabled(otInstance *aInstance)
bool
Vérifie si le mode multicast Promiscuous est activé sur l'interface Thread.
otIp6IsReceiveFilterEnabled(otInstance *aInstance)
bool
Indique si le trafic de contrôle Thread est filtré lors de la diffusion des datagrammes IPv6 via le rappel spécifié dans otIp6SetReceiveCallback().
otIp6IsSlaacEnabled(otInstance *aInstance)
bool
Indique si le module SLAAC est activé ou non.
otIp6NewMessage(otInstance *aInstance, const otMessageSettings *aSettings)
Allouez un nouveau tampon de message pour l'envoi d'un message IPv6.
otIp6NewMessageFromBuffer(otInstance *aInstance, const uint8_t *aData, uint16_t aDataLength, const otMessageSettings *aSettings)
Allouez un nouveau tampon de message et écrivez le datagram IPv6 dans le tampon de message pour l'envoi d'un message IPv6.
otIp6PrefixFromString(const char *aString, otIp6Prefix *aPrefix)
Convertit une chaîne de préfixe IPv6 lisible en une représentation binaire.
otIp6PrefixMatch(const otIp6Address *aFirst, const otIp6Address *aSecond)
uint8_t
Renvoie la longueur de correspondance du préfixe (bits) pour deux adresses IPv6.
otIp6PrefixToString(const otIp6Prefix *aPrefix, char *aBuffer, uint16_t aSize)
void
Convertit un préfixe IPv6 donné en une chaîne lisible.
otIp6ProtoToString(uint8_t aIpProto)
const char *
Convertit un numéro de protocole IP donné en chaîne lisible.
otIp6RegisterMulticastListeners(otInstance *aInstance, const otIp6Address *aAddresses, uint8_t aAddressNum, const uint32_t *aTimeout, otIp6RegisterMulticastListenersCallback aCallback, void *aContext)
Enregistre les écouteurs Multicast sur le routeur backbone principal.
otIp6RemoveAllUnsecurePorts(otInstance *aInstance)
void
Supprime tous les ports de la liste des ports non sécurisés autorisés.
otIp6RemoveUnicastAddress(otInstance *aInstance, const otIp6Address *aAddress)
Supprime une adresse d'interface réseau de l'interface Thread.
otIp6RemoveUnsecurePort(otInstance *aInstance, uint16_t aPort)
Supprime un port de la liste des ports non sécurisés autorisés.
otIp6ResetBorderRoutingCounters(otInstance *aInstance)
void
Réinitialise les compteurs d'acheminement des bordures.
otIp6SelectSourceAddress(otInstance *aInstance, otMessageInfo *aMessageInfo)
Sélectionner l'adresse source OpenThread
otIp6Send(otInstance *aInstance, otMessage *aMessage)
Envoie un datagram IPv6 via l'interface Thread.
otIp6SetAddressCallback(otInstance *aInstance, otIp6AddressCallback aCallback, void *aCallbackContext)
void
Enregistrer un rappel pour avertir les changements d'adresse IPv6 internes
otIp6SetEnabled(otInstance *aInstance, bool aEnabled)
Affiche l'interface IPv6 vers le haut ou vers le bas.
otIp6SetMeshLocalIid(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
Définit l'IDI local du maillage (à des fins de test).
otIp6SetMulticastPromiscuousEnabled(otInstance *aInstance, bool aEnabled)
void
Active ou désactive le mode multicast promiscuité sur l'interface Thread.
otIp6SetReceiveCallback(otInstance *aInstance, otIp6ReceiveCallback aCallback, void *aCallbackContext)
void
Enregistrer un rappel pour fournir les datagrammes IPv6 reçus.
otIp6SetReceiveFilterEnabled(otInstance *aInstance, bool aEnabled)
void
Détermine si le trafic de contrôle Thread est filtré lors de la diffusion des datagrammes IPv6 via le rappel spécifié dans otIp6SetReceiveCallback().
otIp6SetSlaacEnabled(otInstance *aInstance, bool aEnabled)
void
Active/désactive le module SLAAC.
otIp6SetSlaacPrefixFilter(otInstance *aInstance, otIp6SlaacPrefixFilter aFilter)
void
Définit le gestionnaire de filtres du module SLAAC.
otIp6SockAddrToString(const otSockAddr *aSockAddr, char *aBuffer, uint16_t aSize)
void
Convertit une adresse de socket IPv6 donnée en une chaîne lisible.
otIp6SubscribeMulticastAddress(otInstance *aInstance, const otIp6Address *aAddress)
Abonne l'interface Thread à une adresse de multidiffusion de l'interface réseau.
otIp6UnsubscribeMulticastAddress(otInstance *aInstance, const otIp6Address *aAddress)
Désabonnement de l'interface Thread à une adresse de multidiffusion de l'interface réseau.

Structs
otBorderRoutingCounters

Représente les compteurs de paquets transférés via Routage de bordure.

Adresse IP6

Représente une adresse IPv6.

otIp6AddressComponents

Représente les composants d'une adresse IPv6.

OTIp6AddressInfo

Représente les informations d'adresse IPv6.

otIp6InterfaceIdentifier

Représente l'identifiant d'interface d'une adresse IPv6.

otIp6NetworkPrefix :

Représente le préfixe réseau d'une adresse IPv6 (64 bits les plus significatifs de l'adresse).

OTIp6Prefix

Représente un préfixe IPv6.

MessageMessage

Représente les adresses de socket IPv6 locales et pairs.

OTNetifAddress

Représente une adresse IPv6 d'interface réseau IPv6.

otNetifMulticastAddress

Représente une adresse de multidiffusion d'interface réseau IPv6.

otPacketsAndBytes

Représente les compteurs pour les paquets et les octets.

otSockAddr.

Représente une adresse de socket IPv6.

Union
otIp6InterfaceIdentifier::OT_TOOL_PACKED_FIELD

Énumérations

énumération anonyme

 anonymous enum

Origines des adresses IPv6.

Propriétés
OT_ADDRESS_ORIGIN_DHCPV6

Adresse attribuée DHCPv6.

OT_ADDRESS_ORIGIN_MANUAL

Adresse attribuée manuellement.

OT_ADDRESS_ORIGIN_SLAAC

Adresse attribuée au contrat de niveau de service

OT_ADDRESS_ORIGIN_THREAD

Adresse attribuée au thread (ALOC, RLOC, MLEID, etc.)

énumération anonyme

 anonymous enum

États ECN, représentés dans l'en-tête IP.

Propriétés
OT_ECN_CAPABLE_0

ECT(0)

OT_ECN_CAPABLE_1

ECT(1)

OT_ECN_MARKED

Congestion rencontrée (CE)

OT_ECN_NOT_CAPABLE

Non ECT.

énumération anonyme

 anonymous enum

les numéros de protocole Internet.

Propriétés
OT_IP6_PROTO_DST_OPTS

Options de destination pour IPv6

OT_IP6_PROTO_FRAGMENT

En-tête de fragment pour IPv6.

OT_IP6_PROTO_HOP_OPTS

Option "Hop-by-Hop" IPv6.

OT_IP6_PROTO_ICMP6

ICMP pour IPv6.

OT_IP6_PROTO_IP6

Encapsulation IPv6.

OT_IP6_PROTO_NONE

Aucun en-tête suivant pour IPv6.

OT_IP6_PROTO_ROUTING

En-tête de routage pour IPv6

OT_IP6_PROTO_TCP

protocole de contrôle de la transmission

OT_IP6_PROTO_UDP

Datagram de l'utilisateur.

Typedefs

otBorderRoutingCounters

struct otBorderRoutingCounters otBorderRoutingCounters

Représente les compteurs de paquets transférés via Routage de bordure.

Adresse IP6

struct otIp6Address otIp6Address

Représente une adresse IPv6.

OTIp6AddressCall

void(* otIp6AddressCallback)(const otIp6AddressInfo *aAddressInfo, bool aIsAdded, void *aContext)

Le pointeur est appelé lorsqu'une adresse IPv6 interne est ajoutée ou supprimée.

Détails
Paramètres
[in] aAddressInfo
Un pointeur vers les informations de l'adresse IPv6.
[in] aIsAdded
TRUE si aAddress a été ajouté, FALSE si aAddress a été supprimé.
[in] aContext
Un pointeur vers un contexte spécifique à l'application.

OTIp6AddressComponents

struct otIp6AddressComponents otIp6AddressComponents

Représente les composants d'une adresse IPv6.

Informations sur l'adresse

struct otIp6AddressInfo otIp6AddressInfo

OTIp6InterfaceIdentifier

struct otIp6InterfaceIdentifier otIp6InterfaceIdentifier

Représente l'identifiant d'interface d'une adresse IPv6.

OTIp6NetworkPrefix

struct otIp6NetworkPrefix otIp6NetworkPrefix

Représente le préfixe réseau d'une adresse IPv6 (64 bits les plus significatifs de l'adresse).

Préfixe du protocole otIp6

struct otIp6Prefix otIp6Prefix

Représente un préfixe IPv6.

OTIp6ReceiveCallback

void(* otIp6ReceiveCallback)(otMessage *aMessage, void *aContext)

Le pointeur est appelé lorsqu'un datagram IPv6 est reçu.

Détails
Paramètres
[in] aMessage
Un pointeur vers le tampon du message contenant le datagramme IPv6 reçu. Cette fonction transfère la propriété de aMessage au destinataire du rappel. Le destinataire du message doit être libéré une fois qu'il a été traité (voir otMessageFree()).
[in] aContext
Un pointeur vers un contexte spécifique à l'application.

otIp6RegisterMulticastListenersCallback

void(* otIp6RegisterMulticastListenersCallback)(void *aContext, otError aError, uint8_t aMlrStatus, const otIp6Address *aFailedAddresses, uint8_t aFailedAddressNum)

Le pointeur est appelé avec les résultats de otIp6RegisterMulticastListeners.

Détails
Paramètres
[in] aContext
Un pointeur sur le contexte de l'utilisateur.
[in] aError
OT_ERROR_NONE en cas d'envoi réussi de MLR.req et de réception de MLR.rsp, OT_ERROR_RESPONSE_TIMEOUT en cas d'échec de réception de MLR.rsp, ou OT_ERROR_PARSE en cas d'échec de l'analyse de MLR.rsp.
[in] aMlrStatus
État de l'enregistrement de l'écouteur Multicast lorsque aError est OT_ERROR_NONE.
[in] aFailedAddresses
Un pointeur vers les adresses IPv6 ayant échoué lorsque aError est OT_ERROR_NONE.
[in] aFailedAddressNum
Nombre d'adresses IPv6 ayant échoué lorsque aError est OT_ERROR_NONE.
Voir aussi:
otIp6RegisterMulticastListeners

OTIp6SlaacPrefixFilter

bool(* otIp6SlaacPrefixFilter)(otInstance *aInstance, const otIp6Prefix *aPrefix)

Le pointeur permet de filtrer des préfixes et de ne pas autoriser l'ajout d'une adresse SLAAC basée sur un préfixe.

otIp6SetSlaacPrefixFilter() permet de définir le gestionnaire de filtres. Le gestionnaire de filtres est appelé par le module SLAAC lorsqu'il est sur le point d'ajouter une adresse SLAAC en fonction d'un préfixe. Sa valeur de retour booléenne détermine si l'adresse est filtrée (non ajoutée) ou non.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aPrefix
Un pointeur de préfixe pour lequel l'adresse SLAAC est sur le point d'être ajoutée.
Valeurs renvoyées
TRUE
Indique que l'adresse SLAAC basée sur le préfixe doit être filtrée et NON ajoutée.
FALSE
Indique que l'adresse SLAAC basée sur le préfixe doit être ajoutée.

OTMessageInfo

struct otMessageInfo otMessageInfo

Représente les adresses de socket IPv6 locales et pairs.

OTNetifAddress

struct otNetifAddress otNetifAddress

Représente une adresse IPv6 d'interface réseau IPv6.

OTNetifMulticastAddress

struct otNetifMulticastAddress otNetifMulticastAddress

Représente une adresse de multidiffusion d'interface réseau IPv6.

otPacketsAndBytes

struct otPacketsAndBytes otPacketsAndBytes

Représente les compteurs pour les paquets et les octets.

OTSockAddr

struct otSockAddr otSockAddr

Représente une adresse de socket IPv6.

Variables

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otIp6InterfaceIdentifier OT_TOOL_PACKED_END

Fonctions

OTIp6AddUnicastAddress

otError otIp6AddUnicastAddress(
  otInstance *aInstance,
  const otNetifAddress *aAddress
)

Ajout d'une adresse d'interface réseau à l'interface Thread.

L'instance transmise aAddress est copiée par l'interface Thread. L'interface Thread ne prend en charge qu'un nombre fixe d'adresses unicast externes. Consultez les OPENTHREAD_CONFIG_IP6_MAX_EXT_UCAST_ADDRS.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aAddress
Un pointeur vers une adresse d'interface réseau.
Valeurs renvoyées
OT_ERROR_NONE
L'adresse d'interface réseau a bien été ajoutée (ou mise à jour).
OT_ERROR_INVALID_ARGS
L'adresse IP indiquée par aAddress est une adresse interne.
OT_ERROR_NO_BUFS
L'interface réseau stocke déjà le nombre maximal d'adresses externes autorisées.

otIp6AddUnsecurePort

otError otIp6AddUnsecurePort(
  otInstance *aInstance,
  uint16_t aPort
)

Ajoute un port à la liste des ports non sécurisés autorisés.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aPort
Valeur du port.
Valeurs renvoyées
OT_ERROR_NONE
Le port a bien été ajouté à la liste des ports non sécurisés autorisés.
OT_ERROR_INVALID_ARGS
Le port n'est pas valide (la valeur 0 est réservée à un usage interne).
OT_ERROR_NO_BUFS
La liste des ports non sécurisés est pleine.

OTIp6AddressFromString

otError otIp6AddressFromString(
  const char *aString,
  otIp6Address *aAddress
)

Convertit une chaîne d'adresse IPv6 lisible en une représentation binaire.

Détails
Paramètres
[in] aString
Un pointeur vers une chaîne se terminant par NULL
[out] aAddress
Un pointeur vers une adresse IPv6.
Valeurs renvoyées
OT_ERROR_NONE
L'analyse de aString et la mise à jour de aAddress ont bien été effectuées.
OT_ERROR_PARSE
Échec de l'analyse de l'adresse aString en tant qu'adresse IPv6.

OTIp6AddressToString

void otIp6AddressToString(
  const otIp6Address *aAddress,
  char *aBuffer,
  uint16_t aSize
)

Convertit une adresse IPv6 donnée en chaîne lisible.

La chaîne d'adresse IPv6 utilise 16 valeurs hexadécimales séparées par ":" (par exemple, "%x:%x:%x:...:%x").

Si la chaîne obtenue ne tient pas dans aBuffer (dans ses caractères aSize), elle sera tronquée, mais la chaîne générée sera toujours terminée.

Détails
Paramètres
[in] aAddress
Un pointeur vers une adresse IPv6 (NE DOIT PAS être NULL).
[out] aBuffer
Un pointeur vers un tableau de caractères pour générer la chaîne (NE DOIT PAS être NULL).
[in] aSize
Taille de aBuffer (en octets). Recommandé pour utiliser OT_IP6_ADDRESS_STRING_SIZE.

otIp6ArePrefixesEqual

bool otIp6ArePrefixesEqual(
  const otIp6Prefix *aFirst,
  const otIp6Prefix *aSecond
)

Vérifiez si deux préfixes IPv6 sont identiques.

Détails
Paramètres
[in] aFirst
Un pointeur vers le premier préfixe IPv6 à comparer.
[in] aSecond
Un pointeur vers le deuxième préfixe IPv6 à comparer.
Valeurs renvoyées
TRUE
Les deux préfixes IPv6 sont identiques.
FALSE
Les deux préfixes IPv6 ne sont pas les mêmes.

otIp6GetBorderRoutingCounters

const otBorderRoutingCounters * otIp6GetBorderRoutingCounters(
  otInstance *aInstance
)

Récupère les compteurs de routage de la bordure.

La fonctionnalité de temps de compilation OPENTHREAD_CONFIG_IP6_BR_COUNTERS_ENABLE doit être activée.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
Un pointeur vers les compteurs de routage de la bordure.

OTIp6GetMulticastAddresses

const otNetifMulticastAddress * otIp6GetMulticastAddresses(
  otInstance *aInstance
)

Récupère la liste des adresses de multicast IPv6 abonnées à l'interface Thread.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
Un pointeur vers la première adresse de multidiffusion de l'interface réseau.

OTIp6GetPrefix

void otIp6GetPrefix(
  const otIp6Address *aAddress,
  uint8_t aLength,
  otIp6Prefix *aPrefix
)

Récupère un préfixe avec aLength à partir de aAddress.

Détails
Paramètres
[in] aAddress
Un pointeur vers une adresse IPv6.
[in] aLength
Longueur du préfixe en bits.
[out] aPrefix
Un pointeur pour générer le préfixe IPv6.

OTIp6GetUnicastAddresses

const otNetifAddress * otIp6GetUnicastAddresses(
  otInstance *aInstance
)

Récupère la liste des adresses IPv6 attribuées à l'interface Thread.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
Un pointeur vers la première adresse d'interface réseau.

OTIp6GetUnsecurePorts

const uint16_t * otIp6GetUnsecurePorts(
  otInstance *aInstance,
  uint8_t *aNumEntries
)

Renvoie un pointeur vers la liste des ports non sécurisés.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[out] aNumEntries
Nombre d'entrées dans la liste.
Renvoie
Un pointeur vers la liste des ports non sécurisés.

OTIp6IsAddressEqual

bool otIp6IsAddressEqual(
  const otIp6Address *aFirst,
  const otIp6Address *aSecond
)

Vérifiez si deux adresses IPv6 sont identiques.

Détails
Paramètres
[in] aFirst
Un pointeur vers la première adresse IPv6 à comparer.
[in] aSecond
Un pointeur vers la deuxième adresse IPv6 à comparer.
Valeurs renvoyées
TRUE
Les deux adresses IPv6 sont identiques.
FALSE
Les deux adresses IPv6 ne sont pas les mêmes.

otIp6IsAddressUnspecified

bool otIp6IsAddressUnspecified(
  const otIp6Address *aAddress
)

Indique si l'adresse IPv6 donnée est ou non l'adresse non spécifiée.

Détails
Paramètres
[in] aAddress
Un pointeur vers une adresse IPv6.
Valeurs renvoyées
TRUE
Si l'adresse IPv6 est l'adresse non spécifiée.
FALSE
Si l'adresse IPv6 n'est pas l'adresse non spécifiée.

OTIp6IsEnabled

bool otIp6IsEnabled(
  otInstance *aInstance
)

Indique si l'interface IPv6 est opérationnelle.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Valeurs renvoyées
TRUE
L'interface IPv6 est activée.
FALSE
L'interface IPv6 est désactivée.

otIp6IsMulticastPromiscuousEnabled

bool otIp6IsMulticastPromiscuousEnabled(
  otInstance *aInstance
)

Vérifie si le mode multicast Promiscuous est activé sur l'interface Thread.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Voir aussi:
otIp6SetMulticastPromiscuousEnabled

otIp6IsReceiveFilterEnabled

bool otIp6IsReceiveFilterEnabled(
  otInstance *aInstance
)

Indique si le trafic de contrôle Thread est filtré lors de la diffusion des datagrammes IPv6 via le rappel spécifié dans otIp6SetReceiveCallback().

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
TRUE si le trafic de contrôle des threads est filtré, FALSE dans le cas contraire.
Voir aussi:
otIp6SetReceiveCallback
otIp6SetReceiveFilterEnabled

OTIp6IsSlaacEnabled

bool otIp6IsSlaacEnabled(
  otInstance *aInstance
)

Indique si le module SLAAC est activé ou non.

La fonctionnalité de temps de compilation OPENTHREAD_CONFIG_IP6_SLAAC_ENABLE doit être activée.

Détails
Valeurs renvoyées
TRUE
Le module SLAAC est activé.
FALSE
Le module SLAAC est désactivé.

Nouveau message

otMessage * otIp6NewMessage(
  otInstance *aInstance,
  const otMessageSettings *aSettings
)

Allouez un nouveau tampon de message pour l'envoi d'un message IPv6.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aSettings
Un pointeur vers les paramètres du message ou la valeur NULL pour définir les paramètres par défaut.
Renvoie
Un pointeur vers le tampon du message ou NULL si aucun tampon de message n'est disponible ou si les paramètres ne sont pas valides.
Voir aussi:
otMessageFree

otIp6NewMessageFromBuffer

otMessage * otIp6NewMessageFromBuffer(
  otInstance *aInstance,
  const uint8_t *aData,
  uint16_t aDataLength,
  const otMessageSettings *aSettings
)

Allouez un nouveau tampon de message et écrivez le datagram IPv6 dans le tampon de message pour l'envoi d'un message IPv6.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aData
Un pointeur vers le tampon du datagramme IPv6.
[in] aDataLength
Taille du tampon de datagramme IPv6 indiquée par aData.
[in] aSettings
Un pointeur vers les paramètres du message ou la valeur NULL pour définir les paramètres par défaut.
Renvoie
Un pointeur vers le message ou la valeur NULL si l'en-tête IPv6 n'est pas au bon format ou si les tampons de message sont insuffisants.
Voir aussi:
otMessageFree

otIp6PrefixFromString

otError otIp6PrefixFromString(
  const char *aString,
  otIp6Prefix *aPrefix
)

Convertit une chaîne de préfixe IPv6 lisible en une représentation binaire.

Le paramètre aString doit être une chaîne au format "

/", où
est une adresse IPv6 et est une longueur de préfixe.

Détails
Paramètres
[in] aString
Un pointeur vers une chaîne se terminant par NULL
[out] aPrefix
Un pointeur vers un préfixe IPv6.
Valeurs renvoyées
OT_ERROR_NONE
La chaîne est analysée en tant que préfixe IPv6 et aPrefix est mis à jour.
OT_ERROR_PARSE
Échec de l'analyse de aString en tant que préfixe IPv6.

OTIp6PrefixMatch

uint8_t otIp6PrefixMatch(
  const otIp6Address *aFirst,
  const otIp6Address *aSecond
)

Renvoie la longueur de correspondance du préfixe (bits) pour deux adresses IPv6.

Détails
Paramètres
[in] aFirst
Un pointeur vers la première adresse IPv6.
[in] aSecond
Un pointeur vers la deuxième adresse IPv6.
Renvoie
Longueur de la correspondance du préfixe en bits.

OTIp6PrefixToString

void otIp6PrefixToString(
  const otIp6Prefix *aPrefix,
  char *aBuffer,
  uint16_t aSize
)

Convertit un préfixe IPv6 donné en une chaîne lisible.

La chaîne d'adresse IPv6 est au format "%x:%x:%x:...[::]/plen".

Si la chaîne obtenue ne tient pas dans aBuffer (dans ses caractères aSize), elle sera tronquée, mais la chaîne générée sera toujours terminée.

Détails
Paramètres
[in] aPrefix
Un pointeur vers un préfixe IPv6 (NE DOIT PAS être NULL).
[out] aBuffer
Un pointeur vers un tableau de caractères pour générer la chaîne (NE DOIT PAS être NULL).
[in] aSize
Taille de aBuffer (en octets). Recommandé pour utiliser OT_IP6_PREFIX_STRING_SIZE.

OTIp6ProtoToString

const char * otIp6ProtoToString(
  uint8_t aIpProto
)

Convertit un numéro de protocole IP donné en chaîne lisible.

Détails
Paramètres
[in] aIpProto
Numéro de protocole IP (énumération OT_IP6_PROTO_*).
Renvoie
Chaîne représentant aIpProto.

otIp6RegisterMulticastListeners

otError otIp6RegisterMulticastListeners(
  otInstance *aInstance,
  const otIp6Address *aAddresses,
  uint8_t aAddressNum,
  const uint32_t *aTimeout,
  otIp6RegisterMulticastListenersCallback aCallback,
  void *aContext
)

Enregistre les écouteurs Multicast sur le routeur backbone principal.

OPENTHREAD_CONFIG_TMF_PROXY_MLR_ENABLE et OPENTHREAD_CONFIG_COMMISSIONER_ENABLE doivent être activés.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aAddresses
Tableau d'adresses de multidiffusion à enregistrer.
[in] aAddressNum
Nombre d'adresses de multicast à enregistrer (0 si aAddresses est NULL).
[in] aTimeout
Un pointeur vers la valeur du délai avant expiration (en secondes) à inclure dans MLR.req. Une valeur de délai d'inactivité de 0 supprime l'écouteur Multicast correspondant. Si la valeur est NULL, MLR.req n'aura pas de délai d'inactivité TLV par défaut.
[in] aCallback
Un pointeur vers la fonction de rappel.
[in] aContext
Un pointeur sur le contexte de l'utilisateur.
Valeurs renvoyées
OT_ERROR_NONE
MLR.req a bien été envoyé. Le aCallback sera appelé si cette méthode renvoie OT_ERROR_NONE.
OT_ERROR_BUSY
Si un enregistrement précédent était en cours.
OT_ERROR_INVALID_ARGS
Si un ou plusieurs arguments ne sont pas valides.
OT_ERROR_INVALID_STATE
Si l'état de l'appareil n'est pas valide pour l'envoi de MLR.req (par exemple, "Commissaire non démarré", "Routeur backbone principal introuvable").
OT_ERROR_NO_BUFS
Si la mémoire tampon des messages est insuffisante.
Voir aussi:
otIp6RegisterMulticastListenersCallback

otIp6RemoveAllUnsecurePorts

void otIp6RemoveAllUnsecurePorts(
  otInstance *aInstance
)

Supprime tous les ports de la liste des ports non sécurisés autorisés.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.

OTIp6RemoveUnicastAddress

otError otIp6RemoveUnicastAddress(
  otInstance *aInstance,
  const otIp6Address *aAddress
)

Supprime une adresse d'interface réseau de l'interface Thread.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aAddress
Un pointeur vers une adresse IP.
Valeurs renvoyées
OT_ERROR_NONE
L'adresse de l'interface réseau a bien été supprimée.
OT_ERROR_INVALID_ARGS
L'adresse IP indiquée par aAddress est une adresse interne.
OT_ERROR_NOT_FOUND
L'adresse IP indiquée par aAddress est introuvable.

OTIp6RemoveUnsecurePort

otError otIp6RemoveUnsecurePort(
  otInstance *aInstance,
  uint16_t aPort
)

Supprime un port de la liste des ports non sécurisés autorisés.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aPort
Valeur du port.
Valeurs renvoyées
OT_ERROR_NONE
Le transfert a bien été supprimé de la liste des ports non sécurisés autorisés.
OT_ERROR_INVALID_ARGS
Le port n'est pas valide (la valeur 0 est réservée à un usage interne).
OT_ERROR_NOT_FOUND
Le port est introuvable dans la liste de ports non sécurisés.

otIp6ResetBorderRouter

void otIp6ResetBorderRoutingCounters(
  otInstance *aInstance
)

Réinitialise les compteurs d'acheminement des bordures.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.

OTIp6SelectSourceAddress

otError otIp6SelectSourceAddress(
  otInstance *aInstance,
  otMessageInfo *aMessageInfo
)

Sélectionner l'adresse source OpenThread

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in,out] aMessageInfo
Un pointeur vers les informations du message.
Valeurs renvoyées
OT_ERROR_NONE
Trouve une adresse source et est remplie dans mSockAddr de aMessageInfo.
OT_ERROR_NOT_FOUND
Aucune adresse source n'a été trouvée, et aMessageInfo n'a pas été modifié.

OTIP6Send

otError otIp6Send(
  otInstance *aInstance,
  otMessage *aMessage
)

Envoie un datagram IPv6 via l'interface Thread.

L'appelant transfère la propriété de aMessage lors de cet appel. OpenThread libère aMessage une fois le traitement terminé, y compris lorsqu'une valeur autre que OT_ERROR_NONE est renvoyée.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aMessage
Un pointeur vers le tampon du message contenant le datagramme IPv6.
Valeurs renvoyées
OT_ERROR_NONE
Le message a bien été traité.
OT_ERROR_DROP
Le message était bien formé, mais n'a pas été entièrement traité en raison des règles de traitement des paquets.
OT_ERROR_NO_BUFS
Impossible d'allouer les tampons de message nécessaires lors du traitement du datagram.
OT_ERROR_NO_ROUTE
Aucune route à héberger.
OT_ERROR_INVALID_SOURCE_ADDRESS
L'adresse source n'est pas valide, comme une adresse Anycast ou de multidiffusion.
OT_ERROR_PARSE
Un en-tête de format incorrect a été détecté lors du traitement du message.

otIp6SetAddressCallback

void otIp6SetAddressCallback(
  otInstance *aInstance,
  otIp6AddressCallback aCallback,
  void *aCallbackContext
)

Enregistrer un rappel pour avertir les changements d'adresse IPv6 internes

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aCallback
Un pointeur vers une fonction appelée lorsqu'une adresse IPv6 interne est ajoutée ou supprimée. NULL pour désactiver le rappel.
[in] aCallbackContext
Un pointeur vers un contexte spécifique à l'application.

OTIp6SetEnabled

otError otIp6SetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Affiche l'interface IPv6 vers le haut ou vers le bas.

Appelez-la pour activer ou désactiver la communication IPv6.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aEnabled
VRAI pour activer IPv6, FAUX dans le cas contraire.
Valeurs renvoyées
OT_ERROR_NONE
L'interface IPv6 a bien été relevée.
OT_ERROR_INVALID_STATE
L'interface IPv6 n'est pas disponible, car l'appareil fonctionne en mode lien brut (applicable uniquement lorsque la fonctionnalité OPENTHREAD_CONFIG_LINK_RAW_ENABLE est activée).

OTIp6SetMeshLocalIid

otError otIp6SetMeshLocalIid(
  otInstance *aInstance,
  const otIp6InterfaceIdentifier *aIid
)

Définit l'IDI local du maillage (à des fins de test).

OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE doit être activé.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aIid
Un pointeur sur l'IDI local du maillage à définir.
Valeurs renvoyées
OT_ERROR_NONE
L'identifiant local du maillage de services a bien été défini.
OT_ERROR_INVALID_STATE
Les protocoles Thread sont activés.

otIp6SetMulticastPromiscuousEnabled

void otIp6SetMulticastPromiscuousEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Active ou désactive le mode multicast promiscuité sur l'interface Thread.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aEnabled
TRUE pour activer le mode multicast Promiscuous, ou FALSE dans le cas contraire.
Voir aussi:
otIp6IsMulticastPromiscuousEnabled

OTIp6SetReceiveCallback

void otIp6SetReceiveCallback(
  otInstance *aInstance,
  otIp6ReceiveCallback aCallback,
  void *aCallbackContext
)

Enregistrer un rappel pour fournir les datagrammes IPv6 reçus.

Par défaut, ce rappel ne transmet pas le trafic de contrôle des threads. Pour modifier le paramètre de filtre de trafic de contrôle des threads, consultez otIp6SetReceiveFilterEnabled().

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aCallback
Un pointeur vers une fonction appelée lorsqu'un datagram IPv6 est reçu ou NULL pour désactiver le rappel.
[in] aCallbackContext
Un pointeur vers un contexte spécifique à l'application.
Voir également:
otIp6IsReceiveFilterEnabled
otIp6SetReceiveFilterEnabled

otIp6SetReceiveFilterEnabled

void otIp6SetReceiveFilterEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Détermine si le trafic de contrôle Thread est filtré lors de la diffusion des datagrammes IPv6 via le rappel spécifié dans otIp6SetReceiveCallback().

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aEnabled
TRUE si le trafic de contrôle des threads est filtré, FALSE dans le cas contraire.
Voir aussi:
otIp6SetReceiveCallback
otIsReceiveIp6FilterEnabled

OTIp6SetSlaacEnabled

void otIp6SetSlaacEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Active/désactive le module SLAAC.

La fonctionnalité de temps de compilation OPENTHREAD_CONFIG_IP6_SLAAC_ENABLE doit être activée.

Lorsque le module SLAAC est activé, des adresses SLAAC (basées sur les préfixes de maillage des données du réseau) sont ajoutées à l'interface. Lorsque le module SLAAC est désactivé, toute adresse SLAAC précédemment ajoutée est supprimée.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aEnabled
VRAI pour l'activer, FAUX pour le désactiver.

otIp6SetSlaacPrefixFilter

void otIp6SetSlaacPrefixFilter(
  otInstance *aInstance,
  otIp6SlaacPrefixFilter aFilter
)

Définit le gestionnaire de filtres du module SLAAC.

La fonctionnalité de temps de compilation OPENTHREAD_CONFIG_IP6_SLAAC_ENABLE doit être activée.

Le gestionnaire de filtres est appelé par le module SLAAC lorsqu'il est sur le point d'ajouter une adresse SLAAC en fonction d'un préfixe afin de décider si l'adresse doit être ajoutée ou non.

Un gestionnaire de filtres NULL désactive le filtrage et autorise l'ajout de toutes les adresses SLAAC.

Si cette fonction n'est pas appelée, le filtre par défaut utilisé par le module SLAAC est NULL (le filtrage est désactivé).

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aFilter
Un pointeur vers le gestionnaire de filtres du préfixe SLAAC ou NULL pour désactiver le filtrage.

OTIp6SockAddrToString

void otIp6SockAddrToString(
  const otSockAddr *aSockAddr,
  char *aBuffer,
  uint16_t aSize
)

Convertit une adresse de socket IPv6 donnée en une chaîne lisible.

La chaîne d'adresse du socket IPv6 est au format [address]:port, où address est affiché sous la forme de 16 valeurs hexadécimales séparées par : et port est le numéro de port au format décimal, par exemple "[%x:%x:...:%x]:%u".

Si la chaîne obtenue ne tient pas dans aBuffer (dans ses caractères aSize), elle sera tronquée, mais la chaîne générée sera toujours terminée.

Détails
Paramètres
[in] aSockAddr
Un pointeur vers une adresse de socket IPv6 (NE DOIT PAS être NULL).
[out] aBuffer
Un pointeur vers un tableau de caractères pour générer la chaîne (NE DOIT PAS être NULL).
[in] aSize
Taille de aBuffer (en octets). Recommandé pour utiliser OT_IP6_SOCK_ADDR_STRING_SIZE.

OTIp6S'abonnerMulticastAddress

otError otIp6SubscribeMulticastAddress(
  otInstance *aInstance,
  const otIp6Address *aAddress
)

Abonne l'interface Thread à une adresse de multidiffusion de l'interface réseau.

L'instance aAddress transmise sera copiée par l'interface Thread. L'interface Thread ne prend en charge qu'un nombre fixe d'adresses de multidiffusion ajoutées en externe. Consultez les OPENTHREAD_CONFIG_IP6_MAX_EXT_MCAST_ADDRS.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aAddress
Un pointeur vers une adresse IP.
Valeurs renvoyées
OT_ERROR_NONE
Vous vous êtes bien abonné à l'adresse de multidiffusion de l'interface réseau.
OT_ERROR_ALREADY
L'adresse de multidiffusion est déjà abonnée.
OT_ERROR_INVALID_ARGS
L'adresse IP indiquée par aAddress est une adresse de multidiffusion non valide.
OT_ERROR_REJECTED
L'adresse IP indiquée par aAddress est une adresse de multidiffusion interne.
OT_ERROR_NO_BUFS
L'interface réseau stocke déjà le nombre maximal d'adresses de multidiffusion externe autorisées.

otIp6Se désabonnerMulticastAddress

otError otIp6UnsubscribeMulticastAddress(
  otInstance *aInstance,
  const otIp6Address *aAddress
)

Désabonnement de l'interface Thread à une adresse de multidiffusion de l'interface réseau.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aAddress
Un pointeur vers une adresse IP.
Valeurs renvoyées
OT_ERROR_NONE
Vous vous êtes bien désabonné de l'adresse de multidiffusion de l'interface réseau.
OT_ERROR_REJECTED
L'adresse IP indiquée par aAddress est une adresse interne.
OT_ERROR_NOT_FOUND
L'adresse IP indiquée par aAddress est introuvable.

Macros

OT_IP_ADDRESS_SIZE

 OT_IP6_ADDRESS_SIZE 16

Taille d'une adresse IPv6 (octets)

OT_IP_ADDRESS_STRING_SIZE

 OT_IP6_ADDRESS_STRING_SIZE 40

Taille recommandée pour la représentation sous forme de chaîne d'une adresse IPv6.

OT_IP6_HEADER_PROTO_OFFSET

 OT_IP6_HEADER_PROTO_OFFSET 6

Décalage du champ proto dans l'en-tête IPv6 (octets)

OT_IP6_HEADER_SIZE

 OT_IP6_HEADER_SIZE 40

Taille d'un en-tête IPv6 (octets)

OT_IP6_IID_SIZE

 OT_IP6_IID_SIZE 8

Taille d'un identifiant d'interface IPv6 (octets)

OT_IP6_MAX_MLR_ADDRESSES

 OT_IP6_MAX_MLR_ADDRESSES 15

Nombre maximal d'adresses IPv6 compatibles avec l'enregistrement d'écouteurs multicast.

OT_IP6_PREFIX_BITSIZE

 OT_IP6_PREFIX_BITSIZE (OT_IP6_PREFIX_SIZE * 8)

Taille d'un préfixe IPv6 (bits)

OT_IP6_PREFIX_SIZE

 OT_IP6_PREFIX_SIZE 8

Taille d'un préfixe IPv6 (octets)

OT_IP6_PREFIX_STRING_SIZE

 OT_IP6_PREFIX_STRING_SIZE 45

Taille recommandée pour la représentation d'un préfixe IPv6 par une chaîne.

OT_IP6_SOCK_ADDR_STRING_SIZE

 OT_IP6_SOCK_ADDR_STRING_SIZE 48

Taille recommandée pour la représentation sous forme de chaîne d'une adresse de socket IPv6.

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.