SYNOPSIS

#define _GNU_SOURCE
#include <sys/socket.h>
int recvmmsg(int sockfd, struct mmsghdr *msgvec, unsigned int vlen,
unsigned int flags, struct timespec *timeout);

DESCRIPTION

L'appel système recvmmsg() est une extension de recvmsg(2) qui permet à l'appelant de recevoir plusieurs messages d'une socket en utilisant un seul appel système. (Cela améliore les performances pour certaines applications.) Une autre propriété de ce cette extension de recvmsg(2) est la gestion d'une temporisation pour l'opération de réception.

Le paramètre sockfd est le descripteur de fichier de la socket émettrice.

L'argument msgvec est un pointeur vers un tableau de structures mmsghdr. La taille de ce tableau est précisée dans vlen.

La structure mmsghdr est définie dans <sys/socket.h> comme ceci :

struct mmsghdr {
    struct msghdr msg_hdr;  /* En-tête du message  */
    unsigned int  msg_len;  /* Nombre d'octets reçus pour l'en-tête */
};

Le champ msg_hdr est une structure msghdr, conformément à recvmsg(2). Le champ msg_len est le nombre d'octets retourné par le message dans l'entrée. Ce champ a la même valeur que la valeur de retour de la simple commande recvmsg(2) sur l'en-tête.

L'argument flags contient le OU binaire de la collection des attributs. Les attributs sont ceux documentés pour recvmsg(2), plus :

MSG_WAITFORONE (depuis Linux 2.6.34)

Activer MSG_DONTWAIT après le premier message reçu.

L'argument timeout est un pointeur vers une struct timespec (consultez clock_gettime(2)) définissant la temporisation (en secondes et nanosecondes) pour l'opération de réception. (Cet intervalle sera arrondi à la granularité de l'horloge système, et peut être légèrement modifié à cause des délais d'ordonnancement du noyau.) Si timeout est le pointeur nul, l'opération se bloque indéfiniment.

Un appel bloquant recvmmsg() bloque jusqu'à la réception de vlsen messages ou l'expiration de la temporisation. Un appel non bloquant lit autant de messages que disponibles (jusqu'à la limite indiquée par vlen) et retourne immédiatement.

Au retour de recvmmsg(), les éléments successifs de msgvec sont mis à jour pour contenir l'information concernant chaque message reçu : les champs secondaires de msg_hdr sont mis à jour conformément à recmsg(2). La valeur de retour de l'appel indique le nombre d'éléments de msgvec mis à jour.

VALEUR RENVOYÉE

En cas du succès, recvmmsg() retourne le nombre de messages reçus dans msgvec ; Dans le cas contraire, il renvoie -1 et remplit errno avec le code d'erreur.

VERSIONS

L'appel système recvmmsg() a été ajouté dans Linux 2.6.33. La prise en charge dans la glibc a été ajoutée dans la version 2.12.

CONFORMITÉ

recvmmsg() est spécifique à Linux.

EXEMPLE

Le programme suivant utilise recvmmsg() pour recevoir plusieurs messages sur une socket et les stocker dans plusieurs tampons. L'appel termine si tous les tampons sont remplis ou si le délai indiqué est dépassé.

Le morceau de code suivant engendre périodiquement des datagrammes UDP contenant un nombre aléatoire :

$ while true; do echo $RANDOM > /dev/udp/127.0.0.1/1234; 
sleep 0.25; done

Ces datagrammes sont lus par le programme ci-dessous, qui peut par exemple afficher la sortie suivante :

$ ./a.out
5 messages reçus
1 11782
2 11345
3 304
4 13514
5 28421

Source du programme

#define _GNU_SOURCE
#include <netinet/ip.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/socket.h>
int
main(void)
{
#define VLEN 10
#define BUFSIZE 200
#define TIMEOUT 1
    int sockfd, retval, i;
    struct sockaddr_in sa;
    struct mmsghdr msgs[VLEN];
    struct iovec iovecs[VLEN];
    char bufs[VLEN][BUFSIZE+1];
    struct timespec timeout;
    sockfd = socket(AF_INET, SOCK_DGRAM, 0);
    if (sockfd == -1) {
        perror("socket()");
        exit(EXIT_FAILURE);
    }
    sa.sin_family = AF_INET;
    sa.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
    sa.sin_port = htons(1234);
    if (bind(sockfd, (struct sockaddr *) &sa, sizeof(sa)) == -1) {
        perror("bind()");
        exit(EXIT_FAILURE);
    }
    memset(msgs, 0, sizeof(msgs));
    for (i = 0; i < VLEN; i++) {
        iovecs[i].iov_base = bufs[i];
        iovecs[i].iov_len = BUFSIZE;
        msgs[i].msg_hdr.msg_iov = &iovecs[i];
        msgs[i].msg_hdr.msg_iovlen = 1;
    }
    timeout.tv_sec = TIMEOUT;
    timeout.tv_nsec = 0;
    resultat = recvmmsg(sockfd, msgs, VLEN, 0, &timeout);
    if (resultat == -1) {
        perror("recvmmsg()");
        exit(EXIT_FAILURE);
    }
    printf("%d messages reçus\n", resultat);
    for (i = 0; i < resultat; i++) {
        bufs[i][msgs[i].msg_len] = 0;
        printf("%d %s", i+1, bufs[i]);
    }
    exit(EXIT_SUCCESS);
}

COLOPHON

Cette page fait partie de la publication 3.65 du projet man-pages Linux. Une description du projet et des instructions pour signaler des anomalies peuvent être trouvées à l'adresse http://www.kernel.org/doc/man-pages/.

TRADUCTION

Depuis 2010, cette traduction est maintenue à l'aide de l'outil po4a <http://po4a.alioth.debian.org/> par l'équipe de traduction francophone au sein du projet perkamon <http://perkamon.alioth.debian.org/>.

Veuillez signaler toute erreur de traduction en écrivant à <[email protected]> ou par un rapport de bogue sur le paquet manpages-fr.

Vous pouvez toujours avoir accès à la version anglaise de ce document en utilisant la commande « man -L C <section> <page_de_man> ».