src/systemd/sd-event.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #ifndef foosdeventhfoo
   4 #define foosdeventhfoo
   5
   6 /***
   7   This file is part of systemd.
   8
   9   Copyright 2013 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU Lesser General Public License as published by
  13   the Free Software Foundation; either version 2.1 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   Lesser General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 ***/
  24
  25 #include <sys/types.h>
  26 #include <sys/signalfd.h>
  27 #include <sys/epoll.h>
  28 #include <inttypes.h>
  29 #include <signal.h>
  30
  31 /*
  32   Why is this better than pure epoll?
  33
  34   - Supports event source priorisation
  35   - Scales better with a large number of time events, since it doesn't require one timerfd each
  36   - Handles signals and child PIDs
  37
  38   TODO:
  39
  40   - Detect forks and return ECHILD
  41   - Timer events with accuracy for coalescing time events
  42 */
  43
  44 typedef struct sd_event sd_event;
  45 typedef struct sd_event_source sd_event_source;
  46
  47 typedef enum sd_event_mute {
  48         SD_EVENT_MUTED = 0,
  49         SD_EVENT_UNMUTED = 1,
  50         SD_EVENT_ONESHOT = -1
  51 } sd_event_mute_t;
  52
  53 typedef int (*sd_io_handler_t)(sd_event_source *s, int fd, uint32_t revents, void *userdata);
  54 typedef int (*sd_time_handler_t)(sd_event_source *s, uint64_t usec, void *userdata);
  55 typedef int (*sd_signal_handler_t)(sd_event_source *s, const struct signalfd_siginfo *si, void *userdata);
  56 typedef int (*sd_child_handler_t)(sd_event_source *s, const siginfo_t *si, void *userdata);
  57 typedef int (*sd_defer_handler_t)(sd_event_source *s, void *userdata);
  58 typedef int (*sd_prepare_handler_t)(sd_event_source *s, void *userdata);
  59
  60 int sd_event_new(sd_event **e);
  61 sd_event* sd_event_ref(sd_event *e);
  62 sd_event* sd_event_unref(sd_event *e);
  63
  64 int sd_event_add_io(sd_event *e, int fd, uint32_t events, sd_io_handler_t callback, void *userdata, sd_event_source **s);
  65 int sd_event_add_monotonic(sd_event *e, uint64_t usec, sd_time_handler_t callback, void *userdata, sd_event_source **s);
  66 int sd_event_add_realtime(sd_event *e, uint64_t usec, sd_time_handler_t callback, void *userdata, sd_event_source **s);
  67 int sd_event_add_signal(sd_event *e, int sig, sd_signal_handler_t callback, void *userdata, sd_event_source **s);
  68 int sd_event_add_child(sd_event *e, pid_t pid, int options, sd_child_handler_t callback, void *userdata, sd_event_source **s);
  69 int sd_event_add_defer(sd_event *e, sd_defer_handler_t callback, void *userdata, sd_event_source **s);
  70
  71 int sd_event_run(sd_event *e, uint64_t timeout);
  72 int sd_event_loop(sd_event *e);
  73
  74 int sd_event_quit(sd_event *e);
  75 int sd_event_request_quit(sd_event *e);
  76
  77 sd_event *sd_event_get(sd_event_source *s);
  78
  79 sd_event_source* sd_event_source_ref(sd_event_source *s);
  80 sd_event_source* sd_event_source_unref(sd_event_source *s);
  81
  82 int sd_event_source_get_pending(sd_event_source *s);
  83 int sd_event_source_get_io_fd(sd_event_source *s);
  84 int sd_event_source_get_io_events(sd_event_source *s, uint32_t* events);
  85 int sd_event_source_set_io_events(sd_event_source *s, uint32_t events);
  86 int sd_event_source_get_io_revents(sd_event_source *s, uint32_t* revents);
  87 int sd_event_source_get_signal(sd_event_source *s);
  88 int sd_event_source_get_priority(sd_event_source *s, int *priority);
  89 int sd_event_source_set_priority(sd_event_source *s, int priority);
  90 int sd_event_source_get_mute(sd_event_source *s, sd_event_mute_t *m);
  91 int sd_event_source_set_mute(sd_event_source *s, sd_event_mute_t m);
  92 int sd_event_source_get_time(sd_event_source *s, uint64_t *usec);
  93 int sd_event_source_set_time(sd_event_source *s, uint64_t usec);
  94 int sd_event_source_set_prepare(sd_event_source *s, sd_prepare_handler_t callback);
  95 void* sd_event_source_get_userdata(sd_event_source *s);
  96
  97 #endif