chiark / gitweb /
headers: use __inline__ instead of inline
[elogind.git] / src / systemd / sd-event.h
index 90fea4e17a23eeab0d8271e5072c741c3720dbab..fd32ac85650b9ebae99a39674e2a149e0b921fba 100644 (file)
@@ -1,5 +1,3 @@
-/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
-
 #ifndef foosdeventhfoo
 #define foosdeventhfoo
 
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 ***/
 
-#include <sys/types.h>
-#include <sys/signalfd.h>
-#include <sys/epoll.h>
 #include <inttypes.h>
 #include <signal.h>
+#include <sys/epoll.h>
+#include <sys/signalfd.h>
+#include <sys/types.h>
+
+#include "_sd-common.h"
 
 /*
   Why is this better than pure epoll?
 
-  - Supports event source priorisation
-  - Scales better with a large number of time events, since it doesn't require one timerfd each
+  - Supports event source prioritization
+  - Scales better with a large number of time events because it does not require one timerfd each
+  - Automatically tries to coalesce timer events system-wide
   - Handles signals and child PIDs
-
-  TODO:
-
-  - Detect forks and return ECHILD
-  - quit hooks
 */
 
+_SD_BEGIN_DECLARATIONS;
+
 typedef struct sd_event sd_event;
 typedef struct sd_event_source sd_event_source;
 
-typedef enum sd_event_mute {
-        SD_EVENT_MUTED = 0,
-        SD_EVENT_UNMUTED = 1,
+enum {
+        SD_EVENT_OFF = 0,
+        SD_EVENT_ON = 1,
         SD_EVENT_ONESHOT = -1
-} sd_event_mute_t;
-
-typedef int (*sd_io_handler_t)(sd_event_source *s, int fd, uint32_t revents, void *userdata);
-typedef int (*sd_time_handler_t)(sd_event_source *s, uint64_t usec, void *userdata);
-typedef int (*sd_signal_handler_t)(sd_event_source *s, const struct signalfd_siginfo *si, void *userdata);
-typedef int (*sd_child_handler_t)(sd_event_source *s, const siginfo_t *si, void *userdata);
-typedef int (*sd_defer_handler_t)(sd_event_source *s, void *userdata);
-typedef int (*sd_prepare_handler_t)(sd_event_source *s, void *userdata);
+};
+
+enum {
+        SD_EVENT_INITIAL,
+        SD_EVENT_ARMED,
+        SD_EVENT_PENDING,
+        SD_EVENT_RUNNING,
+        SD_EVENT_EXITING,
+        SD_EVENT_FINISHED,
+        SD_EVENT_PREPARING,
+};
+
+enum {
+        /* And everything in-between and outside is good too */
+        SD_EVENT_PRIORITY_IMPORTANT = -100,
+        SD_EVENT_PRIORITY_NORMAL = 0,
+        SD_EVENT_PRIORITY_IDLE = 100
+};
+
+typedef int (*sd_event_handler_t)(sd_event_source *s, void *userdata);
+typedef int (*sd_event_io_handler_t)(sd_event_source *s, int fd, uint32_t revents, void *userdata);
+typedef int (*sd_event_time_handler_t)(sd_event_source *s, uint64_t usec, void *userdata);
+typedef int (*sd_event_signal_handler_t)(sd_event_source *s, const struct signalfd_siginfo *si, void *userdata);
+typedef int (*sd_event_child_handler_t)(sd_event_source *s, const siginfo_t *si, void *userdata);
+
+int sd_event_default(sd_event **e);
 
 int sd_event_new(sd_event **e);
 sd_event* sd_event_ref(sd_event *e);
 sd_event* sd_event_unref(sd_event *e);
 
-int sd_event_add_io(sd_event *e, int fd, uint32_t events, sd_io_handler_t callback, void *userdata, sd_event_source **s);
-int sd_event_add_monotonic(sd_event *e, uint64_t usec, uint64_t accuracy, sd_time_handler_t callback, void *userdata, sd_event_source **s);
-int sd_event_add_realtime(sd_event *e, uint64_t usec, uint64_t accuracy, sd_time_handler_t callback, void *userdata, sd_event_source **s);
-int sd_event_add_signal(sd_event *e, int sig, sd_signal_handler_t callback, void *userdata, sd_event_source **s);
-int sd_event_add_child(sd_event *e, pid_t pid, int options, sd_child_handler_t callback, void *userdata, sd_event_source **s);
-int sd_event_add_defer(sd_event *e, sd_defer_handler_t callback, void *userdata, sd_event_source **s);
-
-int sd_event_run(sd_event *e, uint64_t timeout);
+int sd_event_add_io(sd_event *e, sd_event_source **s, int fd, uint32_t events, sd_event_io_handler_t callback, void *userdata);
+int sd_event_add_time(sd_event *e, sd_event_source **s, clockid_t clock, uint64_t usec, uint64_t accuracy, sd_event_time_handler_t callback, void *userdata);
+int sd_event_add_signal(sd_event *e, sd_event_source **s, int sig, sd_event_signal_handler_t callback, void *userdata);
+#if 0 /// UNNEEDED by elogind
+int sd_event_add_child(sd_event *e, sd_event_source **s, pid_t pid, int options, sd_event_child_handler_t callback, void *userdata);
+int sd_event_add_defer(sd_event *e, sd_event_source **s, sd_event_handler_t callback, void *userdata);
+#endif // 0
+int sd_event_add_post(sd_event *e, sd_event_source **s, sd_event_handler_t callback, void *userdata);
+int sd_event_add_exit(sd_event *e, sd_event_source **s, sd_event_handler_t callback, void *userdata);
+
+int sd_event_prepare(sd_event *e);
+int sd_event_wait(sd_event *e, uint64_t usec);
+int sd_event_dispatch(sd_event *e);
+int sd_event_run(sd_event *e, uint64_t usec);
+#if 0 /// UNNEEDED by elogind
 int sd_event_loop(sd_event *e);
-
-int sd_event_quit(sd_event *e);
-int sd_event_request_quit(sd_event *e);
-
-sd_event *sd_event_get(sd_event_source *s);
+#endif // 0
+int sd_event_exit(sd_event *e, int code);
+
+#if 0 /// UNNEEDED by elogind
+int sd_event_now(sd_event *e, clockid_t clock, uint64_t *usec);
+
+int sd_event_get_fd(sd_event *e);
+#endif // 0
+int sd_event_get_state(sd_event *e);
+#if 0 /// UNNEEDED by elogind
+int sd_event_get_tid(sd_event *e, pid_t *tid);
+int sd_event_get_exit_code(sd_event *e, int *code);
+#endif // 0
+int sd_event_set_watchdog(sd_event *e, int b);
+#if 0 /// UNNEEDED by elogind
+int sd_event_get_watchdog(sd_event *e);
 
 sd_event_source* sd_event_source_ref(sd_event_source *s);
+#endif // 0
 sd_event_source* sd_event_source_unref(sd_event_source *s);
 
+sd_event *sd_event_source_get_event(sd_event_source *s);
+#if 0 /// UNNEEDED by elogind
+void* sd_event_source_get_userdata(sd_event_source *s);
+void* sd_event_source_set_userdata(sd_event_source *s, void *userdata);
+#endif // 0
+
+int sd_event_source_set_description(sd_event_source *s, const char *description);
+#if 0 /// UNNEEDED by elogind
+int sd_event_source_get_description(sd_event_source *s, const char **description);
+#endif // 0
+int sd_event_source_set_prepare(sd_event_source *s, sd_event_handler_t callback);
+#if 0 /// UNNEEDED by elogind
 int sd_event_source_get_pending(sd_event_source *s);
+int sd_event_source_get_priority(sd_event_source *s, int64_t *priority);
+#endif // 0
+int sd_event_source_set_priority(sd_event_source *s, int64_t priority);
+#if 0 /// UNNEEDED by elogind
+int sd_event_source_get_enabled(sd_event_source *s, int *enabled);
+#endif // 0
+int sd_event_source_set_enabled(sd_event_source *s, int enabled);
+#if 0 /// UNNEEDED by elogind
 int sd_event_source_get_io_fd(sd_event_source *s);
+#endif // 0
+int sd_event_source_set_io_fd(sd_event_source *s, int fd);
+#if 0 /// UNNEEDED by elogind
 int sd_event_source_get_io_events(sd_event_source *s, uint32_t* events);
+#endif // 0
 int sd_event_source_set_io_events(sd_event_source *s, uint32_t events);
+#if 0 /// UNNEEDED by elogind
 int sd_event_source_get_io_revents(sd_event_source *s, uint32_t* revents);
-int sd_event_source_get_signal(sd_event_source *s);
-int sd_event_source_get_priority(sd_event_source *s, int *priority);
-int sd_event_source_set_priority(sd_event_source *s, int priority);
-int sd_event_source_get_mute(sd_event_source *s, sd_event_mute_t *m);
-int sd_event_source_set_mute(sd_event_source *s, sd_event_mute_t m);
+#endif // 0
 int sd_event_source_get_time(sd_event_source *s, uint64_t *usec);
 int sd_event_source_set_time(sd_event_source *s, uint64_t usec);
-int sd_event_source_set_time_accuracy(sd_event_source *s, uint64_t usec);
+#if 0 /// UNNEEDED by elogind
 int sd_event_source_get_time_accuracy(sd_event_source *s, uint64_t *usec);
-int sd_event_source_set_prepare(sd_event_source *s, sd_prepare_handler_t callback);
-void* sd_event_source_get_userdata(sd_event_source *s);
+int sd_event_source_set_time_accuracy(sd_event_source *s, uint64_t usec);
+int sd_event_source_get_time_clock(sd_event_source *s, clockid_t *clock);
+int sd_event_source_get_signal(sd_event_source *s);
+int sd_event_source_get_child_pid(sd_event_source *s, pid_t *pid);
+#endif // 0
+
+/* Define helpers so that __attribute__((cleanup(sd_event_unrefp))) and similar may be used. */
+_SD_DEFINE_POINTER_CLEANUP_FUNC(sd_event, sd_event_unref);
+_SD_DEFINE_POINTER_CLEANUP_FUNC(sd_event_source, sd_event_source_unref);
+
+_SD_END_DECLARATIONS;
 
 #endif