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

Message

Ce module comprend des fonctions qui manipulent les tampons de messages OpenThread.

Sommaire

Énumérations

otMessagePriority {
OT_MESSAGE_PRIORITY_LOW = 0,
OT_MESSAGE_PRIORITY_NORMAL = 1,
OT_MESSAGE_PRIORITY_HIGH = 2
}		 énumération
Cette énumération définit les niveaux de priorité des messages OpenThread.

Typedefs

otBufferInfo typedef
struct otBufferInfo
Cette structure représente les informations du tampon de message.
otMessage typedef
struct otMessage
Cette structure pointe vers un tampon de messages OpenThread.
otMessagePriority typedef
Cette énumération définit les niveaux de priorité des messages OpenThread.
otMessageSettings typedef
Cette structure représente les paramètres d'un message.

Les fonctions

otMessageAppend ( otMessage *aMessage, const void *aBuf, uint16_t aLength)
Ajoutez des octets à un message.
otMessageFree ( otMessage *aMessage)
void
Libérez un tampon de messages alloué.
otMessageGetBufferInfo ( otInstance *aInstance, otBufferInfo *aBufferInfo)
void
Obtenez les informations du tampon de messages.
otMessageGetLength (const otMessage *aMessage)
uint16_t
Obtenez la longueur du message en octets.
otMessageGetOffset (const otMessage *aMessage)
uint16_t
Obtenez le décalage du message en octets.
otMessageGetRss (const otMessage *aMessage)
int8_t
Cette fonction renvoie le RSS moyen (force du signal reçu) associé au message.
otMessageIsLinkSecurityEnabled (const otMessage *aMessage)
bool
Cette fonction indique si la sécurité de liaison est activée ou non pour le message.
otMessageQueueDequeue ( otMessageQueue *aQueue, otMessage *aMessage)
void
Cette fonction supprime un message de la file d'attente de messages donnée.
otMessageQueueEnqueue ( otMessageQueue *aQueue, otMessage *aMessage)
void
Cette fonction ajoute un message à la fin de la file d'attente de messages donnée.
otMessageQueueEnqueueAtHead ( otMessageQueue *aQueue, otMessage *aMessage)
void
Cette fonction ajoute un message en tête / avant de la file d'attente de messages donnée.
otMessageQueueGetHead ( otMessageQueue *aQueue)
Cette fonction renvoie un pointeur vers le message en tête de la file d'attente.
otMessageQueueGetNext ( otMessageQueue *aQueue, const otMessage *aMessage)
Cette fonction 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 des messages.
otMessageRead (const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength)
uint16_t
Lire les octets d'un message.
otMessageSetDirectTransmission ( otMessage *aMessage, bool aEnabled)
void
Cette fonction active / force le transfert du message par transmission directe.
otMessageSetLength ( otMessage *aMessage, uint16_t aLength)
Définissez la longueur du message en octets.
otMessageSetOffset ( otMessage *aMessage, uint16_t aOffset)
void
Définissez le décalage du message en octets.
otMessageWrite ( otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength)
int
Écrivez des octets dans un message.

Structs

otBufferInfo

Cette structure représente les informations du tampon de message.

otMessage

Cette structure pointe vers un tampon de messages OpenThread.

otMessageQueue

Cette structure représente une file d'attente de messages OpenThread.

otMessageSettings

Cette structure représente les paramètres d'un message.

énumérations

otMessagePriority

 otMessagePriority

Cette énumération 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

Cette structure représente les informations du tampon de message.

otMessage

struct otMessage otMessage

Cette structure pointe vers un tampon de messages OpenThread.

otMessagePriority

enum otMessagePriority otMessagePriority

Cette énumération définit les niveaux de priorité des messages OpenThread.

otMessageSettings

struct otMessageSettings otMessageSettings

Cette structure représente les paramètres d'un message.

Les fonctions

otMessageAppend

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

Ajoutez des octets à un message.

Détails
Paramètres
[in] aMessage
Un pointeur vers un tampon de messages.
[in] aBuf
Un pointeur vers les données à ajouter.
[in] aLength
Nombre d'octets à ajouter.
Valeurs de retour
OT_ERROR_NONE
Ajouté avec succès au message
OT_ERROR_NO_BUFS
Aucun tampon disponible pour agrandir le message.
Voir également:
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageFree

void otMessageFree(
  otMessage *aMessage
)

Libérez un tampon de messages alloué.

Détails
Paramètres
[in] aMessage
Un pointeur vers un tampon de messages.
Voir également:
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetBufferInfo

void otMessageGetBufferInfo(
  otInstance *aInstance,
  otBufferInfo *aBufferInfo
)

Obtenez les informations du tampon de messages.

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

otMessageGetLength

uint16_t otMessageGetLength(
  const otMessage *aMessage
)

Obtenez la longueur du message en octets.

Détails
Paramètres
[in] aMessage
Un pointeur vers un tampon de messages.
Retour
La longueur du message en octets.
Voir également:
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetLength

otMessageGetOffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

Obtenez le décalage du message en octets.

Détails
Paramètres
[in] aMessage
Un pointeur vers un tampon de messages.
Retour
La valeur de décalage du message.
Voir également:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetRss

int8_t otMessageGetRss(
  const otMessage *aMessage
)

Cette fonction renvoie le RSS moyen (force du signal reçu) associé au message.

Détails
Retour
Valeur RSS moyenne (en dBm) ou OT_RADIO_RSSI_INVALID si aucun RSS moyen n'est disponible.

otMessageIsLinkSecurityEnabled

bool otMessageIsLinkSecurityEnabled(
  const otMessage *aMessage
)

Cette fonction indique si la sécurité de liaison est activée ou non pour le message.

Détails
Paramètres
[in] aMessage
Un pointeur vers un tampon de messages.
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.

otMessageQueueDequeue

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Cette fonction supprime un message de la file d'attente de messages donnée.

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

otMessageQueueEnqueue

void otMessageQueueEnqueue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Cette fonction 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 des messages.
[in] aMessage
Le message à ajouter.

otMessageQueueEnqueueAtHead

void otMessageQueueEnqueueAtHead(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Cette fonction ajoute un message en tête / avant de la file d'attente de messages donnée.

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

otMessageQueueGetHead

otMessage * otMessageQueueGetHead(
  otMessageQueue *aQueue
)

Cette fonction renvoie un pointeur vers le message en tête de la file d'attente.

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

otMessageQueueGetNext

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

Cette fonction 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
Un pointeur vers une file d'attente de messages.
[in] aMessage
Un pointeur vers le tampon de messages actuel.
Retour
Un 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 if aMessage is not in the queue aQueue`.

otMessageQueueInit

void otMessageQueueInit(
  otMessageQueue *aQueue
)

Initialisez la file d'attente des messages.

Cette fonction DOIT être appelée 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é plus d'une fois.

Détails
Paramètres
[in] aQueue
Un 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
Un pointeur vers un tampon de messages.
[in] aOffset
Un décalage en octets.
[in] aBuf
Un pointeur vers un tampon dans lequel les octets de message sont lus.
[in] aLength
Nombre d'octets à lire.
Retour
Le nombre d'octets lus.
Voir également:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite

otMessageSetDirectTransmission

void otMessageSetDirectTransmission(
  otMessage *aMessage,
  bool aEnabled
)

Cette fonction active / force le transfert du message par transmission directe.

Le paramètre par défaut pour un nouveau message est false .

Détails
Paramètres
[in] aMessage
Un pointeur vers un tampon de messages.
[in] aEnabled
Si true , le message est obligé d'utiliser la transmission directe. Si 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
Un pointeur vers un tampon de messages.
[in] aLength
Une longueur en octets.
Valeurs de retour
OT_ERROR_NONE
Définissez avec succès la longueur du message.
OT_ERROR_NO_BUFS
Aucun tampon disponible pour agrandir le message.
Voir également:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageSetOffset

void otMessageSetOffset(
  otMessage *aMessage,
  uint16_t aOffset
)

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

Détails
Paramètres
[in] aMessage
Un pointeur vers un tampon de messages.
[in] aOffset
Un décalage en octets.
Voir également:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite

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
Un pointeur vers un tampon de messages.
[in] aOffset
Un décalage en octets.
[in] aBuf
Pointeur vers un tampon à partir duquel les octets de message sont écrits.
[in] aLength
Nombre d'octets à écrire.
Retour
Le nombre d'octets écrits.
Voir également:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead