MQ_RECEIVE

Section : Manuel du programmeur Linux (3)
Mise à jour de la version anglaise : 25 février 2006
Index Menu principal

NOM

mq_receive, mq_timedreceive - Recevoir un message d'une file de messages

SYNOPSIS

#include <mqueue.h>

ssize_t mq_receive(mqd_t mqdes, char *msg_ptr,
                   size_t msg_len, unsigned *msg_prio);

#define _XOPEN_SOURCE 600
#include <time.h>
#include <mqueue.h>

ssize_t mq_timedreceive(mqd_t mqdes, char *msg_ptr,
                   size_t msg_len, unsigned *msg_prio,
                   const struct timespec *abs_timeout);

Utilisez -lrt à l'édition de liens.

DESCRIPTION

mq_receive() supprime le plus vieux message avec la plus grande priorité de la file de messages référencée par le descripteur mqdes, et le place dans le tampon pointé par msg_ptr. L'argument msg_len spécifie la taille du tampon pointé par msg_ptr ; il doit être plus grand que l'attribut mq_msgsize de la file (voir mq_getattr(3)). Si prio n'est pas NULL, le tampon vers lequel il pointe est utilisé pour renvoyer la priorité associée au message reçu.

Si la file est vide, alors, par défaut, mq_receive() bloquera jusqu'à ce qu'un message soit disponible ou que l'appel soit interrompu par un gestionnaire de signaux. Si l'attribut O_NONBLOCK est activé pour la description de la file de messages, l'appel échouera immédiatement avec l'erreur EAGAIN.

mq_timedreceive() se comporte comme mq_receive(), excepté que si la file est vide et si l'attribut O_NONBLOCK n'est pas activé pour la description de la file de messages, abs_timeout pointe vers une structure qui spécifie un plafond sur le temps pendant lequel l'appel bloquera. Le plafond est un délai absolu en secondes et nanosecondes depuis l'Époque (00H00 le 1er janvier 1970) spécifié dans la structure suivante :

struct timespec {
    time_t tv_sec;        /* secondes */
    long   tv_nsec;       /* nanosecondes */
};

Si aucun message n'est disponible et si le délai d'attente a déjà expiré pendant la durée de l'appel, mq_timedreceive() revient immédiatement.

VALEUR RENVOYÉE

Si elles réussissent, mq_receive() et mq_timedreceive() renvoient le nombre d'octets dans le message reçu ; si elles échouent, elles renvoient -1 et renseignent errno en conséquence.

ERREURS

EAGAIN: La file de message est vide et l'attribut O_NONBLOCK est positionné pour la description de la file de messages référencée par mqdes.
EBADF: Le descripteur spécifié dans mqdes n'est pas valide.
EINTR: L'appel a été interrompu par un gestionnaire de signal ; voir signal(7).
EINVAL: L'appel a bloqué et abs_timeout n'est pas valide, soit parce que tv_sec est inférieur à zéro, soit parce que tv_nsec est inférieur à zéro ou supérieur à 1000 millions.
EMSGSIZE: msg_len est plus petit que l'attribut mq_msgsize de la file de messages.
ETIMEDOUT: Le délai d'attente de l'appel a expiré avant que le message ait été transféré.

CONFORMITÉ

POSIX.1-2001.

VOIR AUSSI

mq_close(3), mq_getattr(3), mq_notify(3), mq_open(3), mq_send(3), mq_unlink(3), feature_test_macros(7), mq_overview(7), time(7)

TRADUCTION

Ce document est une traduction réalisée par Alain Portal <aportal AT univ-montp2 DOT fr> le 23 juillet 2006 et révisée le 17 juillet 2008.

L'équipe de traduction a fait le maximum pour réaliser une adaptation française de qualité. La version anglaise la plus à jour de ce document est toujours consultable via la commande : « LANG=C man 3 mq_receive ». N'hésitez pas à signaler à l'auteur ou au traducteur, selon le cas, toute erreur dans cette page de manuel.

Dernière mise à jour : 17 juillet 2008