Message

Ce module inclut des fonctions qui manipulent les tampons de message OpenThread.

Résumé

Énumérations
otMessageOrigin{
  OT_MESSAGE_ORIGIN_THREAD_NETIF = 0,
  OT_MESSAGE_ORIGIN_HOST_TRUSTED = 1,
  OT_MESSAGE_ORIGIN_HOST_UNTRUSTED = 2
} 		enum
Définit les origines du message OpenThread.
otMessagePriority{
  OT_MESSAGE_PRIORITY_LOW = 0,
  OT_MESSAGE_PRIORITY_NORMAL = 1,
  OT_MESSAGE_PRIORITY_HIGH = 2
} 		enum
Définit les niveaux de priorité des messages OpenThread.

Typedefs
otBufferInfo typedef
struct otBufferInfo
Représente les informations de tampon de message pour les différentes files d'attente utilisées par la pile OpenThread.
otMessage typedef
struct otMessage
Représentation opaque d'un tampon de message OpenThread.
otMessageOrigin typedef
Définit les origines du message OpenThread.
otMessagePriority typedef
Définit les niveaux de priorité des messages OpenThread.
otMessageQueueInfo typedef
Représente les informations sur une file d'attente de messages.
otMessageSettings typedef
Représente les paramètres d'un message.

distantes
otMessageAppend(otMessage *aMessage, const void *aBuf, uint16_t aLength)
Ajouter des octets à un message
otMessageFree(otMessage *aMessage)
void
Libérez un tampon de message alloué.
otMessageGetBufferInfo(otInstance *aInstance, otBufferInfo *aBufferInfo)
void
Permet d'obtenir les informations du tampon de message.
otMessageGetLength(const otMessage *aMessage)
uint16_t
Obtenez la longueur du message en octets.
otMessageGetOffset(const otMessage *aMessage)
uint16_t
Permet d'obtenir le décalage du message en octets.
otMessageGetOrigin(const otMessage *aMessage)
Récupère l'origine du message.
otMessageGetRss(const otMessage *aMessage)
int8_t
Renvoie le RSS (intensité du signal reçu) moyen associé au message.
otMessageIsLinkSecurityEnabled(const otMessage *aMessage)
bool
Indique si la sécurité des liens est activée pour le message.
otMessageIsLoopbackToHostAllowed(const otMessage *aMessage)
bool
Indique si le message peut être renvoyé en boucle vers l'hôte.
otMessageIsMulticastLoopEnabled(otMessage *aMessage)
bool
Indique si le message donné peut faire l'objet d'une boucle en arrière-plan dans le cas d'une adresse de destination multicast.
otMessageQueueDequeue(otMessageQueue *aQueue, otMessage *aMessage)
void
Supprime un message de la file d'attente de messages.
otMessageQueueEnqueue(otMessageQueue *aQueue, otMessage *aMessage)
void
Ajoute un message à la fin de la file d'attente de messages donnée.
otMessageQueueEnqueueAtHead(otMessageQueue *aQueue, otMessage *aMessage)
void
Ajoute un message au début ou à la fin de la file d'attente de messages donnée.
otMessageQueueGetHead(otMessageQueue *aQueue)
Renvoie un pointeur vers le message situé en tête de la file d'attente.
otMessageQueueGetNext(otMessageQueue *aQueue, const otMessage *aMessage)
Renvoie un pointeur vers le message suivant dans la file d'attente en effectuant une itération vers l'avant (de la tête à la queue).
otMessageQueueInit(otMessageQueue *aQueue)
void
Initialisez la file d'attente de messages.
otMessageRead(const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength)
uint16_t
Lire les octets d'un message.
otMessageResetBufferInfo(otInstance *aInstance)
void
Réinitialisez le compteur d'informations de la mémoire tampon de message pour suivre le nombre maximal de tampons utilisés en même temps.
otMessageSetDirectTransmission(otMessage *aMessage, bool aEnabled)
void
Définit/Force le transfert du message par transmission directe.
otMessageSetLength(otMessage *aMessage, uint16_t aLength)
Définissez la longueur du message en octets.
otMessageSetLoopbackToHostAllowed(otMessage *aMessage, bool aAllowLoopbackToHost)
void
Détermine si le message peut être renvoyé en boucle vers l'hôte.
otMessageSetMulticastLoopEnabled(otMessage *aMessage, bool aEnabled)
void
Détermine si le message donné peut être renvoyé en boucle dans le cas d'une adresse de destination multicast.
otMessageSetOffset(otMessage *aMessage, uint16_t aOffset)
void
Définissez le décalage du message en octets.
otMessageSetOrigin(otMessage *aMessage, otMessageOrigin aOrigin)
void
Définit l'origine du message.
otMessageWrite(otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength)
int
Écrivez des octets dans un message.

Structs
otBufferInfo

Représente les informations de tampon de message pour les différentes files d'attente utilisées par la pile OpenThread.

otMessageQueue

Représente une file d'attente de messages OpenThread.

otMessageQueueInfo

Représente les informations sur une file d'attente de messages.

otMessageSettings

Représente les paramètres d'un message.

Énumérations

otMessageOrigin

 otMessageOrigin

Définit les origines du message OpenThread.

Propriétés
OT_MESSAGE_ORIGIN_HOST_TRUSTED

Message provenant d'une source fiable de l'hôte.

OT_MESSAGE_ORIGIN_HOST_UNTRUSTED

Message provenant d'une source non fiable sur l'hôte.

OT_MESSAGE_ORIGIN_THREAD_NETIF

Message de Thread Netif.

otMessagePriority

 otMessagePriority

Définit les niveaux de priorité des messages OpenThread.

Propriétés
OT_MESSAGE_PRIORITY_HIGH

Niveau de priorité élevé.

OT_MESSAGE_PRIORITY_LOW

Niveau de priorité faible.

OT_MESSAGE_PRIORITY_NORMAL

Niveau de priorité normal.

Typedefs

otBufferInfo

struct otBufferInfo otBufferInfo

Représente les informations de tampon de message pour les différentes files d'attente utilisées par la pile OpenThread.

otMessage

struct otMessage otMessage

Représentation opaque d'un tampon de message OpenThread.

otMessageOrigin

enum otMessageOrigin otMessageOrigin

Définit les origines du message OpenThread.

otMessagePriority

enum otMessagePriority otMessagePriority

Définit les niveaux de priorité des messages OpenThread.

otMessageQueueInfo

struct otMessageQueueInfo otMessageQueueInfo

Représente les informations sur une file d'attente de messages.

otMessageSettings

struct otMessageSettings otMessageSettings

Représente les paramètres d'un message.

distantes

otMessageAppend

otError otMessageAppend(
  otMessage *aMessage,
  const void *aBuf,
  uint16_t aLength
)

Ajouter des octets à un message

Détails
Paramètres
[in] aMessage
Pointeur vers un tampon de message.
[in] aBuf
Pointeur vers les données à ajouter.
[in] aLength
Nombre d'octets à ajouter.
Valeurs de retour
OT_ERROR_NONE
Ajouté au message
OT_ERROR_NO_BUFS
Aucun tampon disponible pour augmenter la taille du message.
Voir aussi:
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageFree

void otMessageFree(
  otMessage *aMessage
)

Libérez un tampon de message alloué.

Détails
Paramètres
[in] aMessage
Pointeur vers un tampon de message.
Voir aussi:
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetBufferInfo

void otMessageGetBufferInfo(
  otInstance *aInstance,
  otBufferInfo *aBufferInfo
)

Permet d'obtenir les informations du tampon de message.

Détails
Paramètres
[in] aInstance
Un pointeur vers l'instance OpenThread.
[out] aBufferInfo
Pointeur où sont écrites les informations du tampon de message.

otMessageGetLength

uint16_t otMessageGetLength(
  const otMessage *aMessage
)

Obtenez la longueur du message en octets.

Détails
Paramètres
[in] aMessage
Pointeur vers un tampon de message.
Renvoie
Longueur du message en octets.
Voir aussi:
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageSetLength
otSetLengthMessage
otMessageSetLength

otMessageGetOffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

Permet d'obtenir le décalage du message en octets.

Détails
Paramètres
[in] aMessage
Pointeur vers un tampon de message.
Renvoie
Valeur du décalage du message.
Voir aussi:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetOrigin

otMessageOrigin otMessageGetOrigin(
  const otMessage *aMessage
)

Récupère l'origine du message.

Détails
Paramètres
[in] aMessage
Pointeur vers un tampon de message.
Renvoie
Origine du message.

otMessageGetRss

int8_t otMessageGetRss(
  const otMessage *aMessage
)

Renvoie le RSS (intensité du signal reçu) moyen associé au message.

Détails
Renvoie
Valeur RSS moyenne (en dBm) ou OT_RADIO_RSSI_INVALID si aucune valeur RSS moyenne n'est disponible.

otMessageIsLinkSecurityEnabled

bool otMessageIsLinkSecurityEnabled(
  const otMessage *aMessage
)

Indique si la sécurité des liens est activée pour le message.

Détails
Paramètres
[in] aMessage
Pointeur vers un tampon de message.
Valeurs de retour
TRUE
Si la sécurité des liens est activée.
FALSE
Si la sécurité des liens n'est pas activée.

otMessageIsLoopbackToHostAllowed

bool otMessageIsLoopbackToHostAllowed(
  const otMessage *aMessage
)

Indique si le message peut être renvoyé en boucle vers l'hôte.

Détails
Paramètres
[in] aMessage
Pointeur vers un tampon de message.
Valeurs de retour
TRUE
Indique si le message peut être renvoyé en boucle vers l'hôte.
FALSE
Si le message n'est pas autorisé à être renvoyé en boucle vers l'hôte.

otMessageIsMulticastLoopEnabled

bool otMessageIsMulticastLoopEnabled(
  otMessage *aMessage
)

Indique si le message donné peut faire l'objet d'une boucle en arrière-plan dans le cas d'une adresse de destination multicast.

Si aMessage est utilisé avec un otMessageInfo, le champ mMulticastLoop de la structure otMessageInfo est prioritaire et est utilisé à la place de la valeur définie sur aMessage.

Cette API est principalement destinée à être utilisée avec otIp6Send(), qui attend un message IPv6 déjà préparé.

Détails
Paramètres
[in] aMessage
Pointeur vers le message.

otMessageQueueDequeue

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Supprime un message de la file d'attente de messages.

Détails
Paramètres
[in] aQueue
Un pointeur vers la file d'attente de messages.
[in] aMessage
Message à supprimer.

otMessageQueueEnqueue

void otMessageQueueEnqueue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Ajoute un message à la fin de la file d'attente de messages donnée.

Détails
Paramètres
[in] aQueue
Un pointeur vers la file d'attente de messages.
[in] aMessage
Message à ajouter.

otMessageQueueEnqueueAtHead

void otMessageQueueEnqueueAtHead(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Ajoute un message au début ou à la fin de la file d'attente de messages donnée.

Détails
Paramètres
[in] aQueue
Un pointeur vers la file d'attente de messages.
[in] aMessage
Message à ajouter.

otMessageQueueGetHead

otMessage * otMessageQueueGetHead(
  otMessageQueue *aQueue
)

Renvoie un pointeur vers le message situé en tête de la file d'attente.

Détails
Paramètres
[in] aQueue
Pointeur vers une file d'attente de messages.
Renvoie
Pointeur vers le message en tête de la file d'attente ou valeur NULL si la file d'attente est vide.

otMessageQueueGetNext

otMessage * otMessageQueueGetNext(
  otMessageQueue *aQueue,
  const otMessage *aMessage
)

Renvoie un pointeur vers le message suivant dans la file d'attente en effectuant une itération vers l'avant (de la tête à la queue).

Détails
Paramètres
[in] aQueue
Pointeur vers une file d'attente de messages.
[in] aMessage
Pointeur vers le tampon de message actuel.
Renvoie
Pointeur vers le message suivant dans la file d'attente après aMessage ou NULL si aMessage is the tail of queue. NULL is returned ifaMessageis not in the queueaQueue.

otMessageQueueInit

void otMessageQueueInit(
  otMessageQueue *aQueue
)

Initialisez la file d'attente de messages.

DOIT être appelé une et une seule fois pour une instance otMessageQueue avant toute autre fonction otMessageQueue. Le comportement n'est pas défini si d'autres API de file d'attente sont utilisées avec un otMessageQueue avant son initialisation ou s'il est initialisé plusieurs fois.

Détails
Paramètres
[in] aQueue
Pointeur vers une file d'attente de messages.

otMessageRead

uint16_t otMessageRead(
  const otMessage *aMessage,
  uint16_t aOffset,
  void *aBuf,
  uint16_t aLength
)

Lire les octets d'un message.

Détails
Paramètres
[in] aMessage
Pointeur vers un tampon de message.
[in] aOffset
Décalage en octets.
[in] aBuf
Pointeur vers un tampon dans lequel les octets du message sont lus.
[in] aLength
Nombre d'octets à lire.
Renvoie
Nombre d'octets lus.
Voir aussi:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite

otMessageResetBufferInfo

void otMessageResetBufferInfo(
  otInstance *aInstance
)

Réinitialisez le compteur d'informations de la mémoire tampon de message pour suivre le nombre maximal de tampons utilisés en même temps.

Cela réinitialise mMaxUsedBuffers dans otBufferInfo.

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

otMessageSetDirectTransmission

void otMessageSetDirectTransmission(
  otMessage *aMessage,
  bool aEnabled
)

Définit/Force le transfert du message par transmission directe.

Le paramètre par défaut pour les nouveaux messages est false.

Détails
Paramètres
[in] aMessage
Pointeur vers un tampon de message.
[in] aEnabled
Si la valeur est true, le message est obligé d'utiliser la transmission directe. Si la valeur est false, le message suit la procédure normale.

otMessageSetLength

otError otMessageSetLength(
  otMessage *aMessage,
  uint16_t aLength
)

Définissez la longueur du message en octets.

Détails
Paramètres
[in] aMessage
Pointeur vers un tampon de message.
[in] aLength
Une longueur en octets.
Valeurs de retour
OT_ERROR_NONE
La longueur du message a bien été définie.
OT_ERROR_NO_BUFS
Aucun tampon disponible pour augmenter la taille du message.
Voir aussi:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageSetLoopbackToHostAllowed

void otMessageSetLoopbackToHostAllowed(
  otMessage *aMessage,
  bool aAllowLoopbackToHost
)

Détermine si le message peut être renvoyé en boucle vers l'hôte.

Détails
Paramètres
[in] aMessage
Pointeur vers un tampon de message.
[in] aAllowLoopbackToHost
Permet d'autoriser ou non la boucle du message à l'hôte.

otMessageSetMulticastLoopEnabled

void otMessageSetMulticastLoopEnabled(
  otMessage *aMessage,
  bool aEnabled
)

Détermine si le message donné peut être renvoyé en boucle dans le cas d'une adresse de destination multicast.

Détails
Paramètres
[in] aMessage
Pointeur vers le message.
[in] aEnabled
Valeur de configuration.

otMessageSetOffset

void otMessageSetOffset(
  otMessage *aMessage,
  uint16_t aOffset
)

Définissez le décalage du message en octets.

Détails
Paramètres
[in] aMessage
Pointeur vers un tampon de message.
[in] aOffset
Décalage en octets.
Voir aussi:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite

otMessageSetOrigin

void otMessageSetOrigin(
  otMessage *aMessage,
  otMessageOrigin aOrigin
)

Définit l'origine du message.

Détails
Paramètres
[in] aMessage
Pointeur vers un tampon de message.
[in] aOrigin
Origine du message.

otMessageWrite

int otMessageWrite(
  otMessage *aMessage,
  uint16_t aOffset,
  const void *aBuf,
  uint16_t aLength
)

Écrivez des octets dans un message.

Détails
Paramètres
[in] aMessage
Pointeur vers un tampon de message.
[in] aOffset
Décalage en octets.
[in] aBuf
Pointeur vers un tampon à partir duquel les octets du message sont écrits.
[in] aLength
Nombre d'octets à écrire.
Renvoie
Nombre d'octets écrits.
Voir aussi:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead

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 la section Ressources.