epoll_ctl − Interface de contrôle pour un descripteur epoll.

#include <sys/epoll.h>

int epoll_ctl(int epfd, int op, int fd, struct epoll_event *event)

Contrôle le descripteur epoll epfd, en demandant que l’opération op soit réalisée sur le descripteur cible fd. La structure event décrit l’objet lié au descripteur de fichier fd. La structure epoll_event est définie ainsi :

    typedef union epoll_data {
        void *ptr;
        int fd;
        __uint32_t u32;
        __uint64_t u64;
    } epoll_data_t;

   struct epoll_event {
        __uint32_t events;    /* Evénement epoll      */
        epoll_data_t data;    /* Variable utilisateur */
    };

Le membre events est un masque de bits composés à partir des événéments disponibles suivants :

EPOLLIN

Le descripteur associé est disponible pour un appel read(2).

EPOLLOUT

Le descripteur associé est disponible pour un appel write(2).

EPOLLRDHUP

Le pair de la socket stream a fermé la connexion, ou a été mis hors service en cours d’écriture sur la connexion. (Cet attribut est particulièrement utile pour écrire du code simple afin de détecter la mise hors service du pair lors de l’utilisation de la surveillance « Edge Triggered ».)

EPOLLPRI

Il y a des données urgentes disponibles pour un appel read(2).

EPOLLERR

Une erreur s’est produite sur le descripteur associé. epoll_wait(2) attendra toujours cet événement ; il n’est pas nécessaire de le mettre dans events.

EPOLLHUP

Une déconnexion s’est produite sur le descripteur associé.

EPOLLET

Fixer le comportement en détection de changement d’état sur le descripteur. Par défaut epoll fonctionne en détection de niveau. Voir epoll(7) pour plus de détails sur les comportements en détection de niveau et de changements d’état.

EPOLLONESHOT (depuis le noyau 2.6.2)

Fixer le comportement coup unique (Ndt : one-shot) pour le descripteur de fichier associé. Cela signifie qu’après qu’un événement n’ait été retiré avec epoll_wait(2), le descripteur de fichier est désactivé de manière interne et aucun autre événement ne sera rapporté par l’interface epoll. L’utilisateur doit appeler epoll_ctl(2) avec EPOLL_CTL_MOD pour réactiver le descripteur de fichier avec le nouveau masque d’événement.

L’interface epoll supporte tous les descripteurs de fichiers supportés par poll(2). Les valeurs valides pour le paramètre op sont :

EPOLL_CTL_ADD

Ajouter le descripteur de fichier fd dans le descripteur epoll epfd et associe l’événement event avec le fichier représenté par fd.

EPOLL_CTL_MOD

Change l’événement event associé au descripteur de fichier fd.

EPOLL_CTL_DEL

Supprime le descripteur de fichier fd dans le descripteur epoll epfd. L’événement event est ignoré et peut être NULL (mais voir la section BOGUES plus loin).

Lorsqu’il réussit, l’appel epoll_ctl(2) renvoie zéro. Si une erreur se produit, epoll_ctl(2) renvoie −1 et errno contient le code approprié.

EBADF

epfd ou fd n’est pas un descripteur valide.

EEXIST

op était EPOLL_CTL_ADD, et le descripteur de fichier fd fourni est déjà dans epfd.

EINVAL

epfd n’est pas un descripteur epoll, ou fd est le même que epfd, ou l’opération demandée op n’est pas supportée par cette interface.

ENOENT

op était EPOLL_CTL_MOD ou EPOLL_CTL_DEL, et fd n’est pas dans epfd.

ENOMEM

Pas assez de mémoire dans le noyau pour traiter l’opération op.

EPERM

Le fichier cible fd ne supporte pas epoll.

epoll_ctl(2) est une nouvelle API introduite dans Linux 2.5.44. Son interface est stabilisée depuis le 2.5.66.

Dans les noyaux précédents la version 2.6.9, l’opération EPOLL_CTL_DEL réclamait un pointeur non nul pour event, même si cet argument était ignoré Depuis le noyau 2.6.9, event peut être NULL lorsqu’on utilise EPOLL_CTL_DEL.

epoll_create(2), epoll_wait(2), poll(2), epoll(7)

Ce document est une traduction réalisée par Christophe Blaess <http://www.blaess.fr/christophe/> le 25 juillet 2003 et révisée le 12 août 2006.

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=en man 2 epoll_ctl ». N’hésitez pas à signaler à l’auteur ou au traducteur, selon le cas, toute erreur dans cette page de manuel.