X-Git-Url: https://git.llucax.com/software/libev.git/blobdiff_plain/b263424bde37eea20a5dee6eb7d42ee411878218..48151275f9dd2099bb2e98f47a341678182d9230:/ev.h?ds=inline diff --git a/ev.h b/ev.h index a1d8891..c49a4dd 100644 --- a/ev.h +++ b/ev.h @@ -1,18 +1,80 @@ +/* + * Copyright (c) 2007 Marc Alexander Lehmann + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * * Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following + * disclaimer in the documentation and/or other materials provided + * with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + #ifndef EV_H #define EV_H +#ifdef __cplusplus +extern "C" { +#endif + typedef double ev_tstamp; +/* these priorities are inclusive, higher priorities will be called earlier */ +#ifndef EV_MINPRI +# define EV_MINPRI -2 +#endif +#ifndef EV_MAXPRI +# define EV_MAXPRI +2 +#endif + +#ifndef EV_MULTIPLICITY +# define EV_MULTIPLICITY 1 +#endif + +/* support multiple event loops? */ +#if EV_MULTIPLICITY +struct ev_loop; +# define EV_P struct ev_loop *loop +# define EV_P_ EV_P, +# define EV_A loop +# define EV_A_ EV_A, +#else +# define EV_P void +# define EV_P_ +# define EV_A +# define EV_A_ +#endif + /* eventmask, revents, events... */ -#define EV_UNDEF -1 /* guaranteed to be invalid */ -#define EV_NONE 0x00 -#define EV_READ 0x01 -#define EV_WRITE 0x02 -#define EV_TIMEOUT 0x04 -#define EV_SIGNAL 0x08 -#define EV_IDLE 0x10 -#define EV_CHECK 0x20 -#define EV_ERROR (0x3f|0x80) +#define EV_UNDEF -1 /* guaranteed to be invalid */ +#define EV_NONE 0x00 +#define EV_READ 0x01 +#define EV_WRITE 0x02 +#define EV_TIMEOUT 0x000100 +#define EV_PERIODIC 0x000200 +#define EV_SIGNAL 0x000400 +#define EV_IDLE 0x000800 +#define EV_CHECK 0x001000 +#define EV_PREPARE 0x002000 +#define EV_CHILD 0x004000 +#define EV_ERROR 0x800000 /* sent when an error occurs */ /* can be used to add custom fields to all watchers */ #ifndef EV_COMMON @@ -22,6 +84,9 @@ typedef double ev_tstamp; # define EV_PROTOTYPES 1 #endif +#define EV_VERSION_MAJOR 1 +#define EV_VERSION_MINOR 1 + /* * struct member types: * private: you can look at them, but not change them, and they might not mean anything to you. @@ -33,12 +98,13 @@ typedef double ev_tstamp; #define EV_WATCHER(type) \ int active; /* private */ \ int pending; /* private */ \ + int priority; /* private */ \ EV_COMMON; /* rw */ \ - void (*cb)(struct type *, int revents); /* rw */ /* gets invoked with an eventmask */ + void (*cb)(EV_P_ struct type *, int revents) /* private */ /* gets invoked with an eventmask */ #define EV_WATCHER_LIST(type) \ EV_WATCHER (type); \ - struct type *next /* private */ + struct ev_watcher_list *next /* private */ #define EV_WATCHER_TIME(type) \ EV_WATCHER (type); \ @@ -60,6 +126,7 @@ struct ev_watcher_time { }; /* invoked after a specific time, repeatable (based on monotonic clock) */ +/* revent EV_TIMEOUT */ struct ev_timer { EV_WATCHER_TIME (ev_timer); @@ -68,14 +135,17 @@ struct ev_timer }; /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ +/* revent EV_PERIODIC */ struct ev_periodic { EV_WATCHER_TIME (ev_periodic); ev_tstamp interval; /* rw */ + ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */ }; /* invoked when fd is either EV_READable or EV_WRITEable */ +/* revent EV_READ, EV_WRITE */ struct ev_io { EV_WATCHER_LIST (ev_io); @@ -85,6 +155,7 @@ struct ev_io }; /* invoked when the given signal has been received */ +/* revent EV_SIGNAL */ struct ev_signal { EV_WATCHER_LIST (ev_signal); @@ -93,85 +164,206 @@ struct ev_signal }; /* invoked when the nothing else needs to be done, keeps the process from blocking */ +/* revent EV_IDLE */ struct ev_idle { EV_WATCHER (ev_idle); }; -/* invoked for each run of the mainloop, just before the next blocking vall is initiated */ +/* invoked for each run of the mainloop, just before the blocking call */ +/* you can still change events in any way you like */ +/* revent EV_PREPARE */ +struct ev_prepare +{ + EV_WATCHER (ev_prepare); +}; + +/* invoked for each run of the mainloop, just after the blocking call */ +/* revent EV_CHECK */ struct ev_check { EV_WATCHER (ev_check); }; -#define EVMETHOD_NONE 0 -#define EVMETHOD_SELECT 1 -#define EVMETHOD_EPOLL 2 -#if EV_PROTOTYPES -extern int ev_method; -int ev_init (int flags); /* returns ev_method */ +/* invoked when sigchld is received and waitpid indicates the givne pid */ +/* revent EV_CHILD */ +/* does not support priorities */ +struct ev_child +{ + EV_WATCHER_LIST (ev_child); + + int pid; /* ro */ + int rpid; /* rw, holds the received pid */ + int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */ +}; -/* these three calls are suitable for plugging into pthread_atfork */ -void ev_prefork (void); -void ev_postfork_parent (void); -void ev_postfork_child (void); +/* the presence of this union forces similar struct layout */ +union ev_any_watcher +{ + struct ev_watcher w; + struct ev_watcher_list wl; + struct ev_io io; + struct ev_timer timer; + struct ev_periodic periodic; + struct ev_signal signal; + struct ev_idle idle; + struct ev_child child; + struct ev_prepare prepare; + struct ev_check check; +}; + +#define EVMETHOD_AUTO 0 /* consults environment */ +#define EVMETHOD_SELECT 1 +#define EVMETHOD_POLL 2 +#define EVMETHOD_EPOLL 4 +#define EVMETHOD_KQUEUE 8 +#define EVMETHOD_DEVPOLL 16 /* NYI */ +#define EVMETHOD_PORT 32 /* NYI */ +#define EVMETHOD_WIN32 64 /* NYI */ +#define EVMETHOD_ANY ~0 /* any method, do not consult env */ + +#if EV_PROTOTYPES +int ev_version_major (void); +int ev_version_minor (void); -extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */ ev_tstamp ev_time (void); + +/* Sets the allocation function to use, works like realloc. + * It is used to allocate and free memory. + * If it returns zero when memory needs to be allocated, the library might abort + * or take some potentially destructive action. + * The default is your system realloc function. + */ +void ev_set_allocator (void *(*cb)(void *ptr, long size)); + +/* set the callback function to call on a + * retryable syscall error + * (such as failed select, poll, epoll_wait) + */ +void ev_set_syserr_cb (void (*cb)(const char *msg)); + +# if EV_MULTIPLICITY +/* the default loop is the only one that handles signals and child watchers */ +/* you can call this as often as you like */ +struct ev_loop *ev_default_loop (int methods); /* returns default loop */ + +/* create and destroy alternative loops that don't handle signals */ +struct ev_loop *ev_loop_new (int methods); +void ev_loop_destroy (EV_P); +void ev_loop_fork (EV_P); +# else +int ev_default_loop (int methods); /* returns true when successful */ +# endif + +void ev_default_destroy (void); /* destroy the default loop */ +/* this needs to be called after fork, to duplicate the default loop */ +/* if you create alternative loops you have to call ev_loop_fork on them */ +/* you can call it in either the parent or the child */ +/* you can actually call it at any time, anywhere :) */ +void ev_default_fork (void); + +int ev_method (EV_P); #endif #define EVLOOP_NONBLOCK 1 /* do not block/wait */ #define EVLOOP_ONESHOT 2 /* block *once* only */ +#define EVUNLOOP_ONCE 1 /* unloop once */ +#define EVUNLOOP_ALL 2 /* unloop all loops */ + #if EV_PROTOTYPES -void ev_loop (int flags); -extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */ +void ev_loop (EV_P_ int flags); +void ev_unloop (EV_P_ int how); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */ + +ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ + +/* + * ref/unref can be used to add or remove a refcount on the mainloop. every watcher + * keeps one reference. if you have a long-runing watcher you never unregister that + * should not keep ev_loop from running, unref() after starting, and ref() before stopping. + */ +void ev_ref (EV_P); +void ev_unref (EV_P); /* convinience function, wait for a single event, without registering an event watcher */ /* if timeout is < 0, do wait indefinitely */ -void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); +void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); #endif /* these may evaluate ev multiple times, and the other arguments at most once */ -/* either use evw_init + evXXX_set, or the evXXX_init macro, below, to first initialise a watcher */ -#define evw_init(ev,cb_) do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0) - -#define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) -#define evtimer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) -#define evperiodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0) -#define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) -#define evcheck_set(ev) /* nop, yes, this is a serious in-joke */ -#define evidle_set(ev) /* nop, yes, this is a serious in-joke */ - -#define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0) -#define evtimer_init(ev,cb,after,repeat) do { evw_init ((ev), (cb)); evtimer_set ((ev),(after),(repeat)); } while (0) -#define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_set ((ev),(at),(interval)); } while (0) -#define evsignal_init(ev,cb,signum) do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0) -#define evcheck_init(ev,cb) do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0) -#define evidle_init(ev,cb) do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0) - -#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ +/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ +#define ev_watcher_init(ev,cb_) do { \ + ((struct ev_watcher *)(void *)(ev))->active = \ + ((struct ev_watcher *)(void *)(ev))->pending = \ + ((struct ev_watcher *)(void *)(ev))->priority = 0; \ + (ev)->cb = (cb_); \ +} while (0) + +#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) +#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) +#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) +#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) +#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ +#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ +#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ +#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) + +#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) +#define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) +#define ev_periodic_init(ev,cb,at,ival,res) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) +#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) +#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) +#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) +#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0) +#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) + +#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ +#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ + +#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */ +#define ev_cb(ev) (ev)->cb /* rw */ +#define ev_set_priority(ev,pri) ev_priority (ev) = (pri) +#define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) /* stopping (enabling, adding) a watcher does nothing if it is already running */ /* stopping (disabling, deleting) a watcher does nothing unless its already running */ #if EV_PROTOTYPES -void evio_start (struct ev_io *w); -void evio_stop (struct ev_io *w); -void evtimer_start (struct ev_timer *w); -void evtimer_stop (struct ev_timer *w); -void evtimer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ +/* feeds an event into a watcher as if the event actually occured */ +/* accepts any ev_watcher type */ +void ev_feed_event (EV_P_ void *w, int revents); + +void ev_io_start (EV_P_ struct ev_io *w); +void ev_io_stop (EV_P_ struct ev_io *w); -void evperiodic_start (struct ev_periodic *w); -void evperiodic_stop (struct ev_periodic *w); +void ev_timer_start (EV_P_ struct ev_timer *w); +void ev_timer_stop (EV_P_ struct ev_timer *w); +/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ +void ev_timer_again (EV_P_ struct ev_timer *w); -void evsignal_start (struct ev_signal *w); -void evsignal_stop (struct ev_signal *w); +void ev_periodic_start (EV_P_ struct ev_periodic *w); +void ev_periodic_stop (EV_P_ struct ev_periodic *w); +void ev_periodic_again (EV_P_ struct ev_periodic *w); -void evidle_start (struct ev_idle *w); -void evidle_stop (struct ev_idle *w); +void ev_idle_start (EV_P_ struct ev_idle *w); +void ev_idle_stop (EV_P_ struct ev_idle *w); + +void ev_prepare_start (EV_P_ struct ev_prepare *w); +void ev_prepare_stop (EV_P_ struct ev_prepare *w); + +void ev_check_start (EV_P_ struct ev_check *w); +void ev_check_stop (EV_P_ struct ev_check *w); + +/* only supported in the default loop */ +void ev_signal_start (EV_P_ struct ev_signal *w); +void ev_signal_stop (EV_P_ struct ev_signal *w); + +/* only supported in the default loop */ +void ev_child_start (EV_P_ struct ev_child *w); +void ev_child_stop (EV_P_ struct ev_child *w); +#endif -void evcheck_start (struct ev_check *w); -void evcheck_stop (struct ev_check *w); +#ifdef __cplusplus +} #endif #endif