Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

IPv6

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

Synthèse

É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
Numéros de protocole Internet.

Typedefs

otBorderRoutingCounters typedef
Cette structure représente les compteurs de paquets transférés via le routage frontalier.
otIp6Address typedef
struct otIp6Address
Cette structure représente une adresse IPv6.
otIp6AddressCallback)(const otIp6AddressInfo *aAddressInfo, bool aIsAdded, void *aContext) typedef
void(*
Ce pointeur de fonction est appelé lorsqu'une adresse IPv6 interne est ajoutée ou supprimée.
otIp6AddressComponents typedef
Cette structure représente les composants d'une adresse IPv6.
otIp6AddressInfo typedef
otIp6InterfaceIdentifier typedef
Cette structure représente l'identifiant d'interface d'une adresse IPv6.
otIp6NetworkPrefix typedef
Cette structure représente le préfixe réseau d'une adresse IPv6 (64 bits les plus importants de l'adresse).
otIp6Prefix typedef
struct otIp6Prefix
Cette structure représente un préfixe IPv6.
otIp6ReceiveCallback)(otMessage *aMessage, void *aContext) typedef
void(*
Ce pointeur de fonction est appelé lorsqu'un datagramme IPv6 est reçu.
otIp6RegisterMulticastListenersCallback)(void *aContext, otError aError, uint8_t aMlrStatus, const otIp6Address *aFailedAddresses, uint8_t aFailedAddressNum) typedef
void(*
Ce pointeur de fonction est appelé avec les résultats de otIp6RegisterMulticastListeners.
otIp6SlaacPrefixFilter)(otInstance *aInstance, const otIp6Prefix *aPrefix) typedef
bool(*
Ce pointeur de fonction permet à l'utilisateur de filtrer les préfixes et de ne pas autoriser l'ajout d'une adresse SLAAC basée sur un préfixe.
otMessageInfo typedef
struct otMessageInfo
Cette structure représente les adresses de socket IPv6 locale et pair.
otNetifAddress typedef
Cette structure représente une adresse unicast d'interface réseau IPv6.
otNetifMulticastAddress typedef
Cette structure représente une adresse de multidiffusion d'interface réseau IPv6.
otPacketsAndBytes typedef
Cette structure représente les compteurs de paquets et d'octets.
otSockAddr typedef
struct otSockAddr
Cette structure représente une adresse de socket IPv6.

Variables

OT_TOOL_PACKED_END

Fonctions

otIp6AddUnicastAddress(otInstance *aInstance, const otNetifAddress *aAddress)
Ajoute une adresse d'interface réseau à l'interface Thread.
otIp6AddUnsecurePort(otInstance *aInstance, uint16_t aPort)
Cette fonction ajoute un port à la liste de ports non sécurisés autorisés.
otIp6AddressFromString(const char *aString, otIp6Address *aAddress)
Cette fonction convertit une chaîne d'adresse IPv6 lisible en représentation binaire.
otIp6AddressToString(const otIp6Address *aAddress, char *aBuffer, uint16_t aSize)
void
Cette fonction 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 des frontières.
otIp6GetMulticastAddresses(otInstance *aInstance)
Récupère la liste des adresses de multidiffusion IPv6 abonnées à l'interface Thread.
otIp6GetPrefix(const otIp6Address *aAddress, uint8_t aLength, otIp6Prefix *aPrefix)
void
Cette méthode obtient le préfixe aLength 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 *
Cette fonction renvoie un pointeur vers la liste de 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
Cette fonction indique si l'adresse IPv6 donnée est ou non l'adresse IP 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 promiscuité est activé sur l'interface Thread.
otIp6IsReceiveFilterEnabled(otInstance *aInstance)
bool
Cette fonction indique si le trafic de contrôle Thread est filtré lors de l'envoi des datagrammes IPv6 via le rappel spécifié dans otIp6SetReceiveCallback().
otIp6IsSlaacEnabled(otInstance *aInstance)
bool
Cette fonction 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 datagramme IPv6 dans le tampon de message pour l'envoi d'un message IPv6.
otIp6PrefixMatch(const otIp6Address *aFirst, const otIp6Address *aSecond)
uint8_t
Cette fonction renvoie la longueur de correspondance du préfixe (en bits) pour deux adresses IPv6.
otIp6PrefixToString(const otIp6Prefix *aPrefix, char *aBuffer, uint16_t aSize)
void
Cette fonction convertit un préfixe IPv6 donné en chaîne lisible.
otIp6ProtoToString(uint8_t aIpProto)
const char *
Cette fonction 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)
Cette fonction enregistre les écouteurs de multidiffusion sur le routeur principal.
otIp6RemoveAllUnsecurePorts(otInstance *aInstance)
void
Cette fonction 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)
Cette fonction supprime un port de la liste des ports non sécurisés autorisés.
otIp6ResetBorderRoutingCounters(otInstance *aInstance)
void
Réinitialise les compteurs de routage des frontières.
otIp6SelectSourceAddress(otInstance *aInstance, otMessageInfo *aMessageInfo)
Cette fonction effectue la sélection d'adresse source OpenThread.
otIp6Send(otInstance *aInstance, otMessage *aMessage)
Cette fonction envoie un datagramme IPv6 via l'interface Thread.
otIp6SetAddressCallback(otInstance *aInstance, otIp6AddressCallback aCallback, void *aCallbackContext)
void
Cette fonction enregistre un rappel pour informer les modifications d'adresse IPv6 interne.
otIp6SetEnabled(otInstance *aInstance, bool aEnabled)
Affiche l'interface IPv6.
otIp6SetMeshLocalIid(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
Cette fonction définit l'IDI local du maillage (à des fins de test).
otIp6SetMulticastPromiscuousEnabled(otInstance *aInstance, bool aEnabled)
void
Active ou désactive le mode promiscuité de multidiffusion sur l'interface Thread.
otIp6SetReceiveCallback(otInstance *aInstance, otIp6ReceiveCallback aCallback, void *aCallbackContext)
void
Cette fonction enregistre un rappel pour fournir les datagrammes IPv6 reçus.
otIp6SetReceiveFilterEnabled(otInstance *aInstance, bool aEnabled)
void
Cette fonction détermine si le trafic de contrôle Thread est filtré lors de l'envoi des datagrammes IPv6 via le rappel spécifié dans otIp6SetReceiveCallback().
otIp6SetSlaacEnabled(otInstance *aInstance, bool aEnabled)
void
Cette fonction active/désactive le module SLAAC.
otIp6SetSlaacPrefixFilter(otInstance *aInstance, otIp6SlaacPrefixFilter aFilter)
void
Cette fonction définit le gestionnaire de filtres du module SLAAC.
otIp6SockAddrToString(const otSockAddr *aSockAddr, char *aBuffer, uint16_t aSize)
void
Cette fonction convertit une adresse de socket IPv6 donnée en chaîne lisible.
otIp6SubscribeMulticastAddress(otInstance *aInstance, const otIp6Address *aAddress)
Achemine l'interface Thread à une adresse de multidiffusion d'interface réseau.
otIp6UnsubscribeMulticastAddress(otInstance *aInstance, const otIp6Address *aAddress)
Désactive l'interface Thread à une adresse de multidiffusion d'interface réseau.

Structs

otBorderRoutingCounters

Cette structure représente les compteurs de paquets transférés via le routage frontalier.

otIp6Address (Adresse IP6)

Cette structure représente une adresse IPv6.

otIp6AddressComponents

Cette structure représente les composants d'une adresse IPv6.

otIp6AddressInfo.

Cette structure représente les informations d'adresse IPv6.

otIp6InterfaceIdentifier

Cette structure représente l'identifiant d'interface d'une adresse IPv6.

otIp6NetworkPrefix

Cette structure représente le préfixe réseau d'une adresse IPv6 (64 bits les plus importants de l'adresse).

otIp6Prefix

Cette structure représente un préfixe IPv6.

OTMessageInfo

Cette structure représente les adresses de socket IPv6 locale et pair.

otNetifAddress (Adresse NetNetif)

Cette structure représente une adresse unicast d'interface réseau IPv6.

otNetifMulticastAddress

Cette structure représente une adresse de multidiffusion d'interface réseau IPv6.

otPacketsAndBytes

Cette structure représente les compteurs de paquets et d'octets.

otSockAddr

Cette structure représente une adresse de socket IPv6.

Union

otIp6InterfaceIdentifier::OT_Outil_PACK_CHAMP

É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 fil de discussion (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 (CE)

OT_ECN_NOT_CAPABLE

Sans ECT.

énumération anonyme

 anonymous enum

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

IPv6 : option de saut par saut

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 utilisateur.

Typedefs

otBorderRoutingCounters

struct otBorderRoutingCounters otBorderRoutingCounters

Cette structure représente les compteurs de paquets transférés via le routage frontalier.

Adresse IP6

struct otIp6Address otIp6Address

Cette structure représente une adresse IPv6.

otIp6AddressCallback

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

Ce pointeur de fonction est appelé lorsqu'une adresse IPv6 interne est ajoutée ou supprimée.

Détails
Paramètres
[in] aAddressInfo
Un pointeur vers les informations d'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

Cette structure représente les composants d'une adresse IPv6.

OTIp6AddressInfo

struct otIp6AddressInfo otIp6AddressInfo

otIp6InterfaceIdentifier

struct otIp6InterfaceIdentifier otIp6InterfaceIdentifier

Cette structure représente l'identifiant d'interface d'une adresse IPv6.

otIp6NetworkPrefix

struct otIp6NetworkPrefix otIp6NetworkPrefix

Cette structure représente le préfixe réseau d'une adresse IPv6 (64 bits les plus importants de l'adresse).

OTIp6Préfixe

struct otIp6Prefix otIp6Prefix

Cette structure représente un préfixe IPv6.

otIp6ReceiveCallback

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

Ce pointeur de fonction est appelé lorsqu'un datagramme IPv6 est reçu.

Détails
Paramètres
[in] aMessage
Pointeur vers le tampon de message contenant le datagramme IPv6 reçu. Cette fonction transfère la propriété de aMessage au destinataire du rappel. Le message doit être libéré par le destinataire du rappel après son traitement (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)

Ce pointeur de fonction est appelé avec les résultats de otIp6RegisterMulticastListeners.

Détails
Paramètres
[in] aContext
Un pointeur vers le contexte de l'utilisateur
[in] aError
OT_ERROR_NONE lors de l'envoi de MLR.req et de MLR.rsp, OT_ERROR_RESPONSE_TIMEOUT en cas d'échec de la réception de MLR.rsp, 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 également:
otIp6RegisterMulticastListeners

otIp6SlaacPrefixFilter

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

Ce pointeur de fonction permet à l'utilisateur de filtrer les 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 basée sur un préfixe. Sa valeur booléenne détermine si l'adresse est filtrée ou non.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aPrefix
Pointeur sur le préfixe pour lequel l'adresse SLAAC est sur le point d'être ajoutée.
Valeurs de retour
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.

Infos sur le message

struct otMessageInfo otMessageInfo

Cette structure représente les adresses de socket IPv6 locale et pair.

OTNetifAddress

struct otNetifAddress otNetifAddress

Cette structure représente une adresse unicast d'interface réseau IPv6.

otNetifMulticastAddress

struct otNetifMulticastAddress otNetifMulticastAddress

Cette structure représente une adresse de multidiffusion d'interface réseau IPv6.

otPacketsAndBytes

struct otPacketsAndBytes otPacketsAndBytes

Cette structure représente les compteurs de paquets et d'octets.

Add-on

struct otSockAddr otSockAddr

Cette structure représente une adresse de socket IPv6.

Variables

OT_OUTIL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otIp6InterfaceIdentifier OT_TOOL_PACKED_END

Fonctions

otIp6AddUnicastAddress

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

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

L'instance transmise aAddress est copiée par l'interface Thread. L'interface Thread n'accepte qu'un nombre fixe d'adresses unicast ajoutées en externe. Consultez les OPENTHREAD_CONFIG_IP6_MAX_EXT_UCAST_ADDRS.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aAddress
Pointeur vers une adresse d'interface réseau.
Valeurs de retour
OT_ERROR_NONE
L'adresse de l'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
)

Cette fonction ajoute un port à la liste de ports non sécurisés autorisés.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aPort
Valeur du port.
Valeurs de retour
OT_ERROR_NONE
Le transfert 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
)

Cette fonction convertit une chaîne d'adresse IPv6 lisible en représentation binaire.

Détails
Paramètres
[in] aString
Pointeur vers une chaîne terminée par NULL.
[out] aAddress
Pointeur vers une adresse IPv6.
Valeurs de retour
OT_ERROR_NONE
La chaîne a bien été analysée.
OT_ERROR_INVALID_ARGS
Échec de l'analyse de la chaîne.

otIp6AddressToString.

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

Cette fonction convertit une adresse IPv6 donnée en chaîne lisible.

La chaîne d'adresse IPv6 se présente sous la forme de 16 valeurs hexadécimales séparées par le caractère ":" : "%x:%x:%x:...:%x").

Si la chaîne obtenue ne tient pas dans aBuffer (au sein de ses aSize caractères), elle sera tronquée, mais la chaîne générée sera toujours fermée à zéro.

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). Utilisation recommandée de OT_IP6_ADDRESS_STRING_SIZE.

otIp6ArePrefixesÉgal

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 de retour
TRUE
Les deux préfixes IPv6 sont identiques.
FALSE
Les deux préfixes IPv6 ne sont pas identiques.

otIp6GetBorderRoutingCounters

const otBorderRoutingCounters * otIp6GetBorderRoutingCounters(
  otInstance *aInstance
)

Récupère les compteurs de routage des frontières.

Cette fonction nécessite l'activation de la fonctionnalité de compilation OPENTHREAD_CONFIG_IP6_BR_COUNTERS_ENABLE.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Pointeur vers les compteurs de routage des frontières.

otIp6GetMulticastAddresses

const otNetifMulticastAddress * otIp6GetMulticastAddresses(
  otInstance *aInstance
)

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

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

OTIp6GetPrefix

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

Cette méthode obtient le préfixe aLength de aAddress.

Détails
Paramètres
[in] aAddress
Pointeur vers une adresse IPv6.
[in] aLength
Longueur du préfixe en bits.
[out] aPrefix
Point de sortie pour 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
Pointeur vers une instance OpenThread.
Renvoie
Pointeur vers la première adresse de l'interface réseau.

otIp6GetUnsecurePorts

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

Cette fonction renvoie un pointeur vers la liste de ports non sécurisés.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[out] aNumEntries
Nombre d'entrées dans la liste.
Renvoie
Un pointeur vers la liste de 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 de retour
TRUE
Les deux adresses IPv6 sont identiques.
FALSE
Les deux adresses IPv6 ne sont pas les mêmes.

otIp6IsAddressUnspecified

bool otIp6IsAddressUnspecified(
  const otIp6Address *aAddress
)

Cette fonction indique si l'adresse IPv6 donnée est ou non l'adresse IP non spécifiée.

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

OTIp6IsEnabled

bool otIp6IsEnabled(
  otInstance *aInstance
)

Indique si l'interface IPv6 est opérationnelle.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Valeurs de retour
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 promiscuité est activé sur l'interface Thread.

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

otIp6IsReceiveFilterEnabled

bool otIp6IsReceiveFilterEnabled(
  otInstance *aInstance
)

Cette fonction indique si le trafic de contrôle Thread est filtré lors de l'envoi des datagrammes IPv6 via le rappel spécifié dans otIp6SetReceiveCallback().

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

otIp6IsSlaacEnabled

bool otIp6IsSlaacEnabled(
  otInstance *aInstance
)

Cette fonction indique si le module SLAAC est activé ou non.

Cette fonction nécessite l'activation de la fonctionnalité de compilation OPENTHREAD_CONFIG_IP6_SLAAC_ENABLE.

Détails
Valeurs de retour
TRUE
Le module SLAAC est activé.
FALSE
Le module SLAAC est désactivé.

OTIp6NouveauMessage

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
Pointeur vers une instance OpenThread.
[in] aSettings
Pointeur vers les paramètres du message ou NULL pour définir les paramètres par défaut.
Renvoie
Pointeur vers le tampon du message ou NULL si aucun tampon du 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 datagramme IPv6 dans le tampon de message pour l'envoi d'un message IPv6.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aData
Pointeur vers le tampon de datagramme IPv6.
[in] aDataLength
Taille du tampon de datagramme IPv6 indiquée par aData.
[in] aSettings
Pointeur vers les paramètres du message ou NULL pour définir les paramètres par défaut.
Renvoie
Pointeur vers le message ou NULL si l'en-tête IPv6 est incorrect ou si la mémoire tampon du message est insuffisante.
Voir aussi:
otMessageFree

otIp6préfixe

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

Cette fonction renvoie la longueur de correspondance du préfixe (en bits) pour deux adresses IPv6.

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

otIp6PréfixeToString

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

Cette fonction convertit un préfixe IPv6 donné en 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 (au sein de ses aSize caractères), elle sera tronquée, mais la chaîne générée sera toujours fermée à zéro.

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). Utilisation recommandée de OT_IP6_PREFIX_STRING_SIZE.

OTIp6ProtoToString.

const char * otIp6ProtoToString(
  uint8_t aIpProto
)

Cette fonction 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
)

Cette fonction enregistre les écouteurs de multidiffusion sur le routeur principal.

Remarque: cette option n'est disponible que lorsque OPENTHREAD_CONFIG_TMF_PROXY_MLR_ENABLE et OPENTHREAD_CONFIG_COMMISSIONER_ENABLE sont activés.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aAddresses
Un tableau d'adresses de multidiffusion à enregistrer.
[in] aAddressNum
Nombre d'adresses de multidiffusion à enregistrer (0 si la valeur de aAddresses est nulle).
[in] aTimeout
Un pointeur vers la valeur du délai avant expiration (en secondes) à inclure dans MLR.req. Une valeur de délai d'expiration de 0 supprime l'écouteur Multicast correspondant. Si la valeur est NULL, MLR.req n'aura pas de délai d'expiration Tlv par défaut.
[in] aCallback
Un pointeur vers la fonction de rappel.
[in] aContext
Un pointeur vers le contexte de l'utilisateur
Valeurs de retour
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'appareil n'était pas dans un état valide pour envoyer MLR.req (par exemple, le commissaire n'a pas démarré, le routeur principal est introuvable).
OT_ERROR_NO_BUFS
Si le tampon de message est insuffisant.
Voir également:
otIp6RegisterMulticastListenersCallback

otIp6RemoveAllUnsecurePorts

void otIp6RemoveAllUnsecurePorts(
  otInstance *aInstance
)

Cette fonction supprime tous les ports de la liste des ports non sécurisés autorisés.

Détails
Paramètres
[in] aInstance
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
Pointeur vers une instance OpenThread.
[in] aAddress
Pointeur vers une adresse IP.
Valeurs de retour
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
)

Cette fonction supprime un port de la liste des ports non sécurisés autorisés.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aPort
Valeur du port.
Valeurs de retour
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.

otIp6ResetBorderRoutingCounters

void otIp6ResetBorderRoutingCounters(
  otInstance *aInstance
)

Réinitialise les compteurs de routage des frontières.

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

otIp6SelectSourceAddress

otError otIp6SelectSourceAddress(
  otInstance *aInstance,
  otMessageInfo *aMessageInfo
)

Cette fonction effectue la sélection d'adresse source OpenThread.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in,out] aMessageInfo
Pointeur vers les informations du message.
Valeurs de retour
OT_ERROR_NONE
Adresse source trouvée et renseignée dans mSockAddr de aMessageInfo.
OT_ERROR_NOT_FOUND
Aucune adresse source n'a été trouvée, et aMessageInfo reste inchangé.

OTIp6Envoyer

otError otIp6Send(
  otInstance *aInstance,
  otMessage *aMessage
)

Cette fonction envoie un datagramme IPv6 via l'interface Thread.

L'appelant transfère la propriété de aMessage lors de cet appel. OpenThread libérera 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
Pointeur vers une instance OpenThread.
[in] aMessage
Pointeur vers le tampon de message contenant le datagramme IPv6.
Valeurs de retour
OT_ERROR_NONE
Le message a bien été traité.
OT_ERROR_DROP
Le message était bien formé, mais n'était pas 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
Aucun itinéraire à héberger.
OT_ERROR_INVALID_SOURCE_ADDRESS
L'adresse source n'est pas valide (une adresse Anycast ou de multidiffusion, par exemple).
OT_ERROR_PARSE
Un en-tête a été détecté lors du traitement du message.

otIp6SetAddressCallback

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

Cette fonction enregistre un rappel pour informer les modifications d'adresse IPv6 interne.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aCallback
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.

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

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aEnabled
TRUE pour activer l'IPv6, FALSE dans le cas contraire.
Valeurs de retour
OT_ERROR_NONE
L'interface IPv6 a bien été déplacée vers le haut ou vers le bas.
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
)

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

Disponible uniquement lorsque OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE est activé.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aIid
Pointeur vers l'identifiant unique local du maillage à définir.
Valeurs de retour
OT_ERROR_NONE
L'ID d'utilisateur local du réseau maillé 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 promiscuité de multidiffusion sur l'interface Thread.

Détails
Paramètres
[in] aInstance
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
)

Cette fonction enregistre un rappel pour fournir les datagrammes IPv6 reçus.

Par défaut, ce rappel ne transmet pas le trafic de contrôle Thread. Consultez la page otIp6SetReceiveFilterEnabled() pour modifier le paramètre de filtre de trafic de contrôle des fils de discussion.

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

otIp6SetReceiveFilterEnabled

void otIp6SetReceiveFilterEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Cette fonction détermine si le trafic de contrôle Thread est filtré lors de l'envoi des datagrammes IPv6 via le rappel spécifié dans otIp6SetReceiveCallback().

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

otIp6SetSlaacEnabled

void otIp6SetSlaacEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Cette fonction active/désactive le module SLAAC.

Cette fonction nécessite l'activation de la fonctionnalité de compilation OPENTHREAD_CONFIG_IP6_SLAAC_ENABLE.

Lorsque le module SLAAC est activé, des adresses SLAAC (basées sur des préfixes de maillage dans les 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
Pointeur vers une instance OpenThread.
[in] aEnabled
TRUE pour l'activer, FALSE pour la désactiver.

otIp6SetSlaacPrefixFilter

void otIp6SetSlaacPrefixFilter(
  otInstance *aInstance,
  otIp6SlaacPrefixFilter aFilter
)

Cette fonction définit le gestionnaire de filtres du module SLAAC.

Cette fonction nécessite l'activation de la fonctionnalité de compilation OPENTHREAD_CONFIG_IP6_SLAAC_ENABLE.

Le gestionnaire de filtres est appelé par le module SLAAC lorsqu'il est sur le point d'ajouter une adresse SLAAC basée sur 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 permet d'ajouter 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
Pointeur vers une instance OpenThread.
[in] aFilter
Un pointeur vers le gestionnaire de filtres de préfixe SLAAC ou sur NULL pour désactiver le filtrage.

otIp6SockAddrToString.

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

Cette fonction convertit une adresse de socket IPv6 donnée en chaîne lisible.

La chaîne d'adresse de 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 (au sein de ses aSize caractères), elle sera tronquée, mais la chaîne générée sera toujours fermée à zéro.

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). Utilisation recommandée de OT_IP6_SOCK_ADDR_STRING_SIZE.

otIp6S'abonnerMulticastAddress

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

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

L'instance aAddress transmise sera copiée par l'interface Thread. L'interface Thread n'accepte 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
Pointeur vers une instance OpenThread.
[in] aAddress
Pointeur vers une adresse IP.
Valeurs de retour
OT_ERROR_NONE
Vous vous êtes abonné à l'adresse Multicast 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.

otIp6UnsubscribeMulticastAddress

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

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

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aAddress
Pointeur vers une adresse IP.
Valeurs de retour
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_IP6_ADDRESS_SIZE

 OT_IP6_ADDRESS_SIZE 16

Taille d'une adresse IPv6 (octets)

OT_IP6_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_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 sous forme de chaîne d'un préfixe IPv6.

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 plus d'informations ou pour contribuer à notre documentation, reportez-vous à la page Ressources.