d'un message ;
Ce module inclut des fonctions qui manipulent les tampons de message OpenThread.
Résumé
Énumérations |
|
---|---|
otMessagePriority{
|
enum Cette énumération définit les niveaux de priorité des messages OpenThread. |
Définitions |
|
---|---|
otBufferInfo
|
CANNOT TRANSLATEstruct otBufferInfo
Cette structure représente les informations du tampon de message pour différentes files d'attente utilisées par la pile OpenThread. |
otMessage
|
CANNOT TRANSLATEstruct otMessage
Ce type est une représentation opaque d'un tampon de message OpenThread. |
otMessagePriority
|
CANNOT TRANSLATEenum otMessagePriority
Cette énumération définit les niveaux de priorité des messages OpenThread. |
otMessageQueueInfo
|
CANNOT TRANSLATEstruct otMessageQueueInfo
Cette structure représente les informations relatives à une file d'attente de messages. |
otMessageSettings
|
CANNOT TRANSLATEstruct otMessageSettings
Cette structure représente les paramètres d'un message. |
Functions |
|
---|---|
otMessageAppend(otMessage *aMessage, const void *aBuf, uint16_t aLength)
|
ajouter des octets à un message ;
|
otMessageFree(otMessage *aMessage)
|
void
Libérez une mémoire tampon de message allouée.
|
otMessageGetBufferInfo(otInstance *aInstance, otBufferInfo *aBufferInfo)
|
void
Obtenez les informations relatives au tampon de message.
|
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 affiche le RSS (indicateur d'intensité du signal reçu) moyen associé au message.
|
otMessageIsLinkSecurityEnabled(const otMessage *aMessage)
|
bool
Cette fonction indique si la sécurité du lien est activée pour le message.
|
otMessageQueueDequeue(otMessageQueue *aQueue, otMessage *aMessage)
|
void
Cette fonction supprime un message de la file d'attente des messages donnés.
|
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 au début ou à la fin de la file d'attente de messages donnée.
|
otMessageQueueGetHead(otMessageQueue *aQueue)
|
Cette fonction renvoie un message vers le message au début de la file d'attente.
|
otMessageQueueGetNext(otMessageQueue *aQueue, const otMessage *aMessage)
|
Cette fonction renvoie un pointeur vers le message suivant de la file d'attente en itérant d'avant en fin.
|
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
|
otMessageSetDirectTransmission(otMessage *aMessage, bool aEnabled)
|
void
Cette fonction définit/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
Écrire des octets dans un message
|
Structures |
|
---|---|
otBufferInfo |
Cette structure représente les informations du tampon de message pour différentes files d'attente utilisées par la pile OpenThread. |
otMessageQueue |
Cette structure représente une file d'attente de messages OpenThread. |
otMessageQueueInfo |
Cette structure représente les informations relatives à une file d'attente de messages. |
otMessageSettings |
Cette structure représente les paramètres d'un message. |
Énumérations
Priorité des messages
otMessagePriority
Cette énumération définit les niveaux de priorité des messages OpenThread.
Properties | |
---|---|
OT_MESSAGE_PRIORITY_HIGH
|
Niveau de priorité élevé. |
OT_MESSAGE_PRIORITY_LOW
|
Niveau de priorité faible. |
OT_MESSAGE_PRIORITY_NORMAL
|
Niveau de priorité normal. |
Définitions
OTBufferInfo
struct otBufferInfo otBufferInfo
Cette structure représente les informations du tampon de message pour différentes files d'attente utilisées par la pile OpenThread.
OTMessage
struct otMessage otMessage
Ce type est une représentation opaque d'un tampon de message OpenThread.
Priorité des messages
enum otMessagePriority otMessagePriority
Cette énumération définit les niveaux de priorité des messages OpenThread.
otMessageQueueInfo
struct otMessageQueueInfo otMessageQueueInfo
Cette structure représente les informations relatives à une file d'attente de messages.
Paramètres de message
struct otMessageSettings otMessageSettings
Cette structure représente les paramètres d'un message.
Functions
otMessageAnnexe
otError otMessageAppend( otMessage *aMessage, const void *aBuf, uint16_t aLength )
ajouter des octets à un message ;
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs renvoyées |
|
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
OTMessageFree
void otMessageFree( otMessage *aMessage )
Libérez une mémoire tampon de message allouée.
Détails | |||
---|---|---|---|
Paramètres |
|
otMessageAnnexe
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageGetBufferInfo
void otMessageGetBufferInfo( otInstance *aInstance, otBufferInfo *aBufferInfo )
Obtenez les informations relatives au tampon de message.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
OTMessageGetLength
uint16_t otMessageGetLength( const otMessage *aMessage )
Obtenez la longueur du message en octets.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Longueur du message en octets.
|
otMessageFree
otMessageAnnexe
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 |
|
||
Renvoie |
Valeur de décalage du message.
|
otMessageFree
otMessageAnnexe
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageGetRs
int8_t otMessageGetRss( const otMessage *aMessage )
Cette fonction affiche le RSS (indicateur d'intensité du signal reçu) moyen associé au message.
Détails | |
---|---|
Renvoie |
Valeur RSS moyenne (en DBM) ou OT_RADIO_RSSI_INVALID si aucun flux RSS moyen n'est disponible.
|
otMessageIsLinkSecurityEnabled
bool otMessageIsLinkSecurityEnabled( const otMessage *aMessage )
Cette fonction indique si la sécurité du lien est activée pour le message.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs renvoyées |
|
otMessageQueueDequeue
void otMessageQueueDequeue( otMessageQueue *aQueue, otMessage *aMessage )
Cette fonction supprime un message de la file d'attente des messages donnés.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
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 |
|
otMessageQueueEnqueueAtHead
void otMessageQueueEnqueueAtHead( otMessageQueue *aQueue, otMessage *aMessage )
Cette fonction ajoute un message au début ou à la fin de la file d'attente de messages donnée.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otMessageQueueGetHead
otMessage * otMessageQueueGetHead( otMessageQueue *aQueue )
Cette fonction renvoie un message vers le message au début de la file d'attente.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Pointeur vers le message au début de la file d'attente ou valeur 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 de la file d'attente en itérant d'avant en fin.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Renvoie |
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 aMessageis not in the queue aQueue`. |
otMessageQueueInit
void otMessageQueueInit( otMessageQueue *aQueue )
Initialisez la file d'attente de messages.
Cette fonction DOIT être appelée 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 |
|
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 |
|
||||||||
Renvoie |
Nombre d'octets lus.
|
otMessageFree
otMessageAnnexe
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite
otMessageSetDirectTransmission
void otMessageSetDirectTransmission( otMessage *aMessage, bool aEnabled )
Cette fonction définit/force le transfert du message par transmission directe.
Le paramètre par défaut pour un nouveau message est false
.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otMessageSetLength
otError otMessageSetLength( otMessage *aMessage, uint16_t aLength )
Définissez la longueur du message en octets.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs renvoyées |
|
otMessageFree
otMessageAnnexe
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 |
|
otMessageFree
otMessageAnnexe
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite
OTMessageWrite
int otMessageWrite( otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength )
Écrire des octets dans un message
Détails | |||||||||
---|---|---|---|---|---|---|---|---|---|
Paramètres |
|
||||||||
Renvoie |
Nombre d'octets écrits.
|
otMessageFree
otMessageAnnexe
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
Resources
Les rubriques de référence de l'API OpenThread proviennent du code source, disponible sur GitHub. Pour en savoir plus ou contribuer à notre documentation, consultez la page Ressources.