ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.3
(Generate patch)

Comparing libev/ev.3 (file contents):
Revision 1.9 by root, Fri Nov 23 16:17:12 2007 UTC vs.
Revision 1.39 by root, Fri Dec 7 19:15:39 2007 UTC

… …
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title ""<STANDARD INPUT>" 1" 131.IX Title ""<STANDARD INPUT>" 1"
132.TH "<STANDARD INPUT>" 1 "2007-11-23" "perl v5.8.8" "User Contributed Perl Documentation" 132.TH "<STANDARD INPUT>" 1 "2007-12-07" "perl v5.8.8" "User Contributed Perl Documentation"
133.SH "NAME" 133.SH "NAME"
134libev \- a high performance full\-featured event loop written in C 134libev \- a high performance full\-featured event loop written in C
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137.Vb 1 137.Vb 1
138\& #include <ev.h> 138\& #include <ev.h>
139.Ve 139.Ve
140.SH "EXAMPLE PROGRAM"
141.IX Header "EXAMPLE PROGRAM"
142.Vb 1
143\& #include <ev.h>
144.Ve
145.PP
146.Vb 2
147\& ev_io stdin_watcher;
148\& ev_timer timeout_watcher;
149.Ve
150.PP
151.Vb 8
152\& /* called when data readable on stdin */
153\& static void
154\& stdin_cb (EV_P_ struct ev_io *w, int revents)
155\& {
156\& /* puts ("stdin ready"); */
157\& ev_io_stop (EV_A_ w); /* just a syntax example */
158\& ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */
159\& }
160.Ve
161.PP
162.Vb 6
163\& static void
164\& timeout_cb (EV_P_ struct ev_timer *w, int revents)
165\& {
166\& /* puts ("timeout"); */
167\& ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */
168\& }
169.Ve
170.PP
171.Vb 4
172\& int
173\& main (void)
174\& {
175\& struct ev_loop *loop = ev_default_loop (0);
176.Ve
177.PP
178.Vb 3
179\& /* initialise an io watcher, then start it */
180\& ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
181\& ev_io_start (loop, &stdin_watcher);
182.Ve
183.PP
184.Vb 3
185\& /* simple non-repeating 5.5 second timeout */
186\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
187\& ev_timer_start (loop, &timeout_watcher);
188.Ve
189.PP
190.Vb 2
191\& /* loop till timeout or data ready */
192\& ev_loop (loop, 0);
193.Ve
194.PP
195.Vb 2
196\& return 0;
197\& }
198.Ve
140.SH "DESCRIPTION" 199.SH "DESCRIPTION"
141.IX Header "DESCRIPTION" 200.IX Header "DESCRIPTION"
201The newest version of this document is also available as a html-formatted
202web page you might find easier to navigate when reading it for the first
203time: <http://cvs.schmorp.de/libev/ev.html>.
204.PP
142Libev is an event loop: you register interest in certain events (such as a 205Libev is an event loop: you register interest in certain events (such as a
143file descriptor being readable or a timeout occuring), and it will manage 206file descriptor being readable or a timeout occuring), and it will manage
144these event sources and provide your program with events. 207these event sources and provide your program with events.
145.PP 208.PP
146To do this, it must take more or less complete control over your process 209To do this, it must take more or less complete control over your process
… …
151watchers\fR, which are relatively small C structures you initialise with the 214watchers\fR, which are relatively small C structures you initialise with the
152details of the event, and then hand it over to libev by \fIstarting\fR the 215details of the event, and then hand it over to libev by \fIstarting\fR the
153watcher. 216watcher.
154.SH "FEATURES" 217.SH "FEATURES"
155.IX Header "FEATURES" 218.IX Header "FEATURES"
156Libev supports select, poll, the linux-specific epoll and the bsd-specific 219Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the
157kqueue mechanisms for file descriptor events, relative timers, absolute 220BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms
158timers with customised rescheduling, signal events, process status change 221for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface
159events (related to \s-1SIGCHLD\s0), and event watchers dealing with the event 222(for \f(CW\*(C`ev_stat\*(C'\fR), relative timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers
160loop mechanism itself (idle, prepare and check watchers). It also is quite 223with customised rescheduling (\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals
161fast (see this benchmark comparing 224(\f(CW\*(C`ev_signal\*(C'\fR), process status change events (\f(CW\*(C`ev_child\*(C'\fR), and event
162it to libevent for example). 225watchers dealing with the event loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR,
226\&\f(CW\*(C`ev_embed\*(C'\fR, \f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR watchers) as well as
227file watchers (\f(CW\*(C`ev_stat\*(C'\fR) and even limited support for fork events
228(\f(CW\*(C`ev_fork\*(C'\fR).
229.PP
230It also is quite fast (see this
231benchmark comparing it to libevent
232for example).
163.SH "CONVENTIONS" 233.SH "CONVENTIONS"
164.IX Header "CONVENTIONS" 234.IX Header "CONVENTIONS"
165Libev is very configurable. In this manual the default configuration 235Libev is very configurable. In this manual the default configuration will
166will be described, which supports multiple event loops. For more info 236be described, which supports multiple event loops. For more info about
167about various configuration options please have a look at the file 237various configuration options please have a look at \fB\s-1EMBED\s0\fR section in
168\&\fI\s-1README\s0.embed\fR in the libev distribution. If libev was configured without 238this manual. If libev was configured without support for multiple event
169support for multiple event loops, then all functions taking an initial 239loops, then all functions taking an initial argument of name \f(CW\*(C`loop\*(C'\fR
170argument of name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) 240(which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have this argument.
171will not have this argument.
172.SH "TIME REPRESENTATION" 241.SH "TIME REPRESENTATION"
173.IX Header "TIME REPRESENTATION" 242.IX Header "TIME REPRESENTATION"
174Libev represents time as a single floating point number, representing the 243Libev represents time as a single floating point number, representing the
175(fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near 244(fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near
176the beginning of 1970, details are complicated, don't ask). This type is 245the beginning of 1970, details are complicated, don't ask). This type is
… …
201Usually, it's a good idea to terminate if the major versions mismatch, 270Usually, it's a good idea to terminate if the major versions mismatch,
202as this indicates an incompatible change. Minor versions are usually 271as this indicates an incompatible change. Minor versions are usually
203compatible to older versions, so a larger minor version alone is usually 272compatible to older versions, so a larger minor version alone is usually
204not a problem. 273not a problem.
205.Sp 274.Sp
206Example: make sure we haven't accidentally been linked against the wrong 275Example: Make sure we haven't accidentally been linked against the wrong
207version: 276version.
208.Sp 277.Sp
209.Vb 3 278.Vb 3
210\& assert (("libev version mismatch", 279\& assert (("libev version mismatch",
211\& ev_version_major () == EV_VERSION_MAJOR 280\& ev_version_major () == EV_VERSION_MAJOR
212\& && ev_version_minor () >= EV_VERSION_MINOR)); 281\& && ev_version_minor () >= EV_VERSION_MINOR));
… …
231recommended for this platform. This set is often smaller than the one 300recommended for this platform. This set is often smaller than the one
232returned by \f(CW\*(C`ev_supported_backends\*(C'\fR, as for example kqueue is broken on 301returned by \f(CW\*(C`ev_supported_backends\*(C'\fR, as for example kqueue is broken on
233most BSDs and will not be autodetected unless you explicitly request it 302most BSDs and will not be autodetected unless you explicitly request it
234(assuming you know what you are doing). This is the set of backends that 303(assuming you know what you are doing). This is the set of backends that
235libev will probe for if you specify no backends explicitly. 304libev will probe for if you specify no backends explicitly.
305.IP "unsigned int ev_embeddable_backends ()" 4
306.IX Item "unsigned int ev_embeddable_backends ()"
307Returns the set of backends that are embeddable in other event loops. This
308is the theoretical, all\-platform, value. To find which backends
309might be supported on the current system, you would need to look at
310\&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for
311recommended ones.
312.Sp
313See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
236.IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4 314.IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4
237.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" 315.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))"
238Sets the allocation function to use (the prototype is similar to the 316Sets the allocation function to use (the prototype is similar \- the
239realloc C function, the semantics are identical). It is used to allocate 317semantics is identical \- to the realloc C function). It is used to
240and free memory (no surprises here). If it returns zero when memory 318allocate and free memory (no surprises here). If it returns zero when
241needs to be allocated, the library might abort or take some potentially 319memory needs to be allocated, the library might abort or take some
242destructive action. The default is your system realloc function. 320potentially destructive action. The default is your system realloc
321function.
243.Sp 322.Sp
244You could override this function in high-availability programs to, say, 323You could override this function in high-availability programs to, say,
245free some memory if it cannot allocate memory, to use a special allocator, 324free some memory if it cannot allocate memory, to use a special allocator,
246or even to sleep a while and retry until some memory is available. 325or even to sleep a while and retry until some memory is available.
247.Sp 326.Sp
248Example: replace the libev allocator with one that waits a bit and then 327Example: Replace the libev allocator with one that waits a bit and then
249retries: better than mine). 328retries).
250.Sp 329.Sp
251.Vb 6 330.Vb 6
252\& static void * 331\& static void *
253\& persistent_realloc (void *ptr, long size) 332\& persistent_realloc (void *ptr, size_t size)
254\& { 333\& {
255\& for (;;) 334\& for (;;)
256\& { 335\& {
257\& void *newptr = realloc (ptr, size); 336\& void *newptr = realloc (ptr, size);
258.Ve 337.Ve
… …
280callback is set, then libev will expect it to remedy the sitution, no 359callback is set, then libev will expect it to remedy the sitution, no
281matter what, when it returns. That is, libev will generally retry the 360matter what, when it returns. That is, libev will generally retry the
282requested operation, or, if the condition doesn't go away, do bad stuff 361requested operation, or, if the condition doesn't go away, do bad stuff
283(such as abort). 362(such as abort).
284.Sp 363.Sp
285Example: do the same thing as libev does internally: 364Example: This is basically the same thing that libev does internally, too.
286.Sp 365.Sp
287.Vb 6 366.Vb 6
288\& static void 367\& static void
289\& fatal_error (const char *msg) 368\& fatal_error (const char *msg)
290\& { 369\& {
… …
336or setgid) then libev will \fInot\fR look at the environment variable 415or setgid) then libev will \fInot\fR look at the environment variable
337\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will 416\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will
338override the flags completely if it is found in the environment. This is 417override the flags completely if it is found in the environment. This is
339useful to try out specific backends to test their performance, or to work 418useful to try out specific backends to test their performance, or to work
340around bugs. 419around bugs.
420.ie n .IP """EVFLAG_FORKCHECK""" 4
421.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4
422.IX Item "EVFLAG_FORKCHECK"
423Instead of calling \f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR manually after
424a fork, you can also make libev check for a fork in each iteration by
425enabling this flag.
426.Sp
427This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop,
428and thus this might slow down your event loop if you do a lot of loop
429iterations and little real work, but is usually not noticeable (on my
430Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence
431without a syscall and thus \fIvery\fR fast, but my Linux system also has
432\&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster).
433.Sp
434The big advantage of this flag is that you can forget about fork (and
435forget about forgetting to tell libev about forking) when you use this
436flag.
437.Sp
438This flag setting cannot be overriden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR
439environment variable.
341.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 440.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4
342.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 441.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4
343.IX Item "EVBACKEND_SELECT (value 1, portable select backend)" 442.IX Item "EVBACKEND_SELECT (value 1, portable select backend)"
344This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as 443This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as
345libev tries to roll its own fd_set with no limits on the number of fds, 444libev tries to roll its own fd_set with no limits on the number of fds,
… …
439Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is 538Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is
440always distinct from the default loop. Unlike the default loop, it cannot 539always distinct from the default loop. Unlike the default loop, it cannot
441handle signal and child watchers, and attempts to do so will be greeted by 540handle signal and child watchers, and attempts to do so will be greeted by
442undefined behaviour (or a failed assertion if assertions are enabled). 541undefined behaviour (or a failed assertion if assertions are enabled).
443.Sp 542.Sp
444Example: try to create a event loop that uses epoll and nothing else. 543Example: Try to create a event loop that uses epoll and nothing else.
445.Sp 544.Sp
446.Vb 3 545.Vb 3
447\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); 546\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
448\& if (!epoller) 547\& if (!epoller)
449\& fatal ("no epoll found here, maybe it hides under your chair"); 548\& fatal ("no epoll found here, maybe it hides under your chair");
450.Ve 549.Ve
451.IP "ev_default_destroy ()" 4 550.IP "ev_default_destroy ()" 4
452.IX Item "ev_default_destroy ()" 551.IX Item "ev_default_destroy ()"
453Destroys the default loop again (frees all memory and kernel state 552Destroys the default loop again (frees all memory and kernel state
454etc.). This stops all registered event watchers (by not touching them in 553etc.). None of the active event watchers will be stopped in the normal
455any way whatsoever, although you cannot rely on this :). 554sense, so e.g. \f(CW\*(C`ev_is_active\*(C'\fR might still return true. It is your
555responsibility to either stop all watchers cleanly yoursef \fIbefore\fR
556calling this function, or cope with the fact afterwards (which is usually
557the easiest thing, youc na just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them
558for example).
456.IP "ev_loop_destroy (loop)" 4 559.IP "ev_loop_destroy (loop)" 4
457.IX Item "ev_loop_destroy (loop)" 560.IX Item "ev_loop_destroy (loop)"
458Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an 561Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an
459earlier call to \f(CW\*(C`ev_loop_new\*(C'\fR. 562earlier call to \f(CW\*(C`ev_loop_new\*(C'\fR.
460.IP "ev_default_fork ()" 4 563.IP "ev_default_fork ()" 4
… …
482.IP "ev_loop_fork (loop)" 4 585.IP "ev_loop_fork (loop)" 4
483.IX Item "ev_loop_fork (loop)" 586.IX Item "ev_loop_fork (loop)"
484Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by 587Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by
485\&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop 588\&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop
486after fork, and how you do this is entirely your own problem. 589after fork, and how you do this is entirely your own problem.
590.IP "unsigned int ev_loop_count (loop)" 4
591.IX Item "unsigned int ev_loop_count (loop)"
592Returns the count of loop iterations for the loop, which is identical to
593the number of times libev did poll for new events. It starts at \f(CW0\fR and
594happily wraps around with enough iterations.
595.Sp
596This value can sometimes be useful as a generation counter of sorts (it
597\&\*(L"ticks\*(R" the number of loop iterations), as it roughly corresponds with
598\&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls.
487.IP "unsigned int ev_backend (loop)" 4 599.IP "unsigned int ev_backend (loop)" 4
488.IX Item "unsigned int ev_backend (loop)" 600.IX Item "unsigned int ev_backend (loop)"
489Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in 601Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in
490use. 602use.
491.IP "ev_tstamp ev_now (loop)" 4 603.IP "ev_tstamp ev_now (loop)" 4
… …
543\& be handled here by queueing them when their watcher gets executed. 655\& be handled here by queueing them when their watcher gets executed.
544\& - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK 656\& - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
545\& were used, return, otherwise continue with step *. 657\& were used, return, otherwise continue with step *.
546.Ve 658.Ve
547.Sp 659.Sp
548Example: queue some jobs and then loop until no events are outsanding 660Example: Queue some jobs and then loop until no events are outsanding
549anymore. 661anymore.
550.Sp 662.Sp
551.Vb 4 663.Vb 4
552\& ... queue jobs here, make sure they register event watchers as long 664\& ... queue jobs here, make sure they register event watchers as long
553\& ... as they still have work to do (even an idle watcher will do..) 665\& ... as they still have work to do (even an idle watcher will do..)
… …
575visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from exiting if 687visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from exiting if
576no event watchers registered by it are active. It is also an excellent 688no event watchers registered by it are active. It is also an excellent
577way to do this for generic recurring timers or from within third-party 689way to do this for generic recurring timers or from within third-party
578libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR. 690libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR.
579.Sp 691.Sp
580Example: create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR 692Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR
581running when nothing else is active. 693running when nothing else is active.
582.Sp 694.Sp
583.Vb 4 695.Vb 4
584\& struct dv_signal exitsig; 696\& struct ev_signal exitsig;
585\& ev_signal_init (&exitsig, sig_cb, SIGINT); 697\& ev_signal_init (&exitsig, sig_cb, SIGINT);
586\& ev_signal_start (myloop, &exitsig); 698\& ev_signal_start (loop, &exitsig);
587\& evf_unref (myloop); 699\& evf_unref (loop);
588.Ve 700.Ve
589.Sp 701.Sp
590Example: for some weird reason, unregister the above signal handler again. 702Example: For some weird reason, unregister the above signal handler again.
591.Sp 703.Sp
592.Vb 2 704.Vb 2
593\& ev_ref (myloop); 705\& ev_ref (loop);
594\& ev_signal_stop (myloop, &exitsig); 706\& ev_signal_stop (loop, &exitsig);
595.Ve 707.Ve
596.SH "ANATOMY OF A WATCHER" 708.SH "ANATOMY OF A WATCHER"
597.IX Header "ANATOMY OF A WATCHER" 709.IX Header "ANATOMY OF A WATCHER"
598A watcher is a structure that you create and register to record your 710A watcher is a structure that you create and register to record your
599interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to 711interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to
… …
636*)\*(C'\fR), and you can stop watching for events at any time by calling the 748*)\*(C'\fR), and you can stop watching for events at any time by calling the
637corresponding stop function (\f(CW\*(C`ev_<type>_stop (loop, watcher *)\*(C'\fR. 749corresponding stop function (\f(CW\*(C`ev_<type>_stop (loop, watcher *)\*(C'\fR.
638.PP 750.PP
639As long as your watcher is active (has been started but not stopped) you 751As long as your watcher is active (has been started but not stopped) you
640must not touch the values stored in it. Most specifically you must never 752must not touch the values stored in it. Most specifically you must never
641reinitialise it or call its set macro. 753reinitialise it or call its \f(CW\*(C`set\*(C'\fR macro.
642.PP
643You can check whether an event is active by calling the \f(CW\*(C`ev_is_active
644(watcher *)\*(C'\fR macro. To see whether an event is outstanding (but the
645callback for it has not been called yet) you can use the \f(CW\*(C`ev_is_pending
646(watcher *)\*(C'\fR macro.
647.PP 754.PP
648Each and every callback receives the event loop pointer as first, the 755Each and every callback receives the event loop pointer as first, the
649registered watcher structure as second, and a bitset of received events as 756registered watcher structure as second, and a bitset of received events as
650third argument. 757third argument.
651.PP 758.PP
… …
676The signal specified in the \f(CW\*(C`ev_signal\*(C'\fR watcher has been received by a thread. 783The signal specified in the \f(CW\*(C`ev_signal\*(C'\fR watcher has been received by a thread.
677.ie n .IP """EV_CHILD""" 4 784.ie n .IP """EV_CHILD""" 4
678.el .IP "\f(CWEV_CHILD\fR" 4 785.el .IP "\f(CWEV_CHILD\fR" 4
679.IX Item "EV_CHILD" 786.IX Item "EV_CHILD"
680The pid specified in the \f(CW\*(C`ev_child\*(C'\fR watcher has received a status change. 787The pid specified in the \f(CW\*(C`ev_child\*(C'\fR watcher has received a status change.
788.ie n .IP """EV_STAT""" 4
789.el .IP "\f(CWEV_STAT\fR" 4
790.IX Item "EV_STAT"
791The path specified in the \f(CW\*(C`ev_stat\*(C'\fR watcher changed its attributes somehow.
681.ie n .IP """EV_IDLE""" 4 792.ie n .IP """EV_IDLE""" 4
682.el .IP "\f(CWEV_IDLE\fR" 4 793.el .IP "\f(CWEV_IDLE\fR" 4
683.IX Item "EV_IDLE" 794.IX Item "EV_IDLE"
684The \f(CW\*(C`ev_idle\*(C'\fR watcher has determined that you have nothing better to do. 795The \f(CW\*(C`ev_idle\*(C'\fR watcher has determined that you have nothing better to do.
685.ie n .IP """EV_PREPARE""" 4 796.ie n .IP """EV_PREPARE""" 4
… …
695\&\f(CW\*(C`ev_loop\*(C'\fR has gathered them, but before it invokes any callbacks for any 806\&\f(CW\*(C`ev_loop\*(C'\fR has gathered them, but before it invokes any callbacks for any
696received events. Callbacks of both watcher types can start and stop as 807received events. Callbacks of both watcher types can start and stop as
697many watchers as they want, and all of them will be taken into account 808many watchers as they want, and all of them will be taken into account
698(for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep 809(for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep
699\&\f(CW\*(C`ev_loop\*(C'\fR from blocking). 810\&\f(CW\*(C`ev_loop\*(C'\fR from blocking).
811.ie n .IP """EV_EMBED""" 4
812.el .IP "\f(CWEV_EMBED\fR" 4
813.IX Item "EV_EMBED"
814The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention.
815.ie n .IP """EV_FORK""" 4
816.el .IP "\f(CWEV_FORK\fR" 4
817.IX Item "EV_FORK"
818The event loop has been resumed in the child process after fork (see
819\&\f(CW\*(C`ev_fork\*(C'\fR).
700.ie n .IP """EV_ERROR""" 4 820.ie n .IP """EV_ERROR""" 4
701.el .IP "\f(CWEV_ERROR\fR" 4 821.el .IP "\f(CWEV_ERROR\fR" 4
702.IX Item "EV_ERROR" 822.IX Item "EV_ERROR"
703An unspecified error has occured, the watcher has been stopped. This might 823An unspecified error has occured, the watcher has been stopped. This might
704happen because the watcher could not be properly started because libev 824happen because the watcher could not be properly started because libev
… …
709Libev will usually signal a few \*(L"dummy\*(R" events together with an error, 829Libev will usually signal a few \*(L"dummy\*(R" events together with an error,
710for example it might indicate that a fd is readable or writable, and if 830for example it might indicate that a fd is readable or writable, and if
711your callbacks is well-written it can just attempt the operation and cope 831your callbacks is well-written it can just attempt the operation and cope
712with the error from \fIread()\fR or \fIwrite()\fR. This will not work in multithreaded 832with the error from \fIread()\fR or \fIwrite()\fR. This will not work in multithreaded
713programs, though, so beware. 833programs, though, so beware.
834.Sh "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0"
835.IX Subsection "GENERIC WATCHER FUNCTIONS"
836In the following description, \f(CW\*(C`TYPE\*(C'\fR stands for the watcher type,
837e.g. \f(CW\*(C`timer\*(C'\fR for \f(CW\*(C`ev_timer\*(C'\fR watchers and \f(CW\*(C`io\*(C'\fR for \f(CW\*(C`ev_io\*(C'\fR watchers.
838.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4
839.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4
840.IX Item "ev_init (ev_TYPE *watcher, callback)"
841This macro initialises the generic portion of a watcher. The contents
842of the watcher object can be arbitrary (so \f(CW\*(C`malloc\*(C'\fR will do). Only
843the generic parts of the watcher are initialised, you \fIneed\fR to call
844the type-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR macro afterwards to initialise the
845type-specific parts. For each type there is also a \f(CW\*(C`ev_TYPE_init\*(C'\fR macro
846which rolls both calls into one.
847.Sp
848You can reinitialise a watcher at any time as long as it has been stopped
849(or never started) and there are no pending events outstanding.
850.Sp
851The callback is always of type \f(CW\*(C`void (*)(ev_loop *loop, ev_TYPE *watcher,
852int revents)\*(C'\fR.
853.ie n .IP """ev_TYPE_set"" (ev_TYPE *, [args])" 4
854.el .IP "\f(CWev_TYPE_set\fR (ev_TYPE *, [args])" 4
855.IX Item "ev_TYPE_set (ev_TYPE *, [args])"
856This macro initialises the type-specific parts of a watcher. You need to
857call \f(CW\*(C`ev_init\*(C'\fR at least once before you call this macro, but you can
858call \f(CW\*(C`ev_TYPE_set\*(C'\fR any number of times. You must not, however, call this
859macro on a watcher that is active (it can be pending, however, which is a
860difference to the \f(CW\*(C`ev_init\*(C'\fR macro).
861.Sp
862Although some watcher types do not have type-specific arguments
863(e.g. \f(CW\*(C`ev_prepare\*(C'\fR) you still need to call its \f(CW\*(C`set\*(C'\fR macro.
864.ie n .IP """ev_TYPE_init"" (ev_TYPE *watcher, callback, [args])" 4
865.el .IP "\f(CWev_TYPE_init\fR (ev_TYPE *watcher, callback, [args])" 4
866.IX Item "ev_TYPE_init (ev_TYPE *watcher, callback, [args])"
867This convinience macro rolls both \f(CW\*(C`ev_init\*(C'\fR and \f(CW\*(C`ev_TYPE_set\*(C'\fR macro
868calls into a single call. This is the most convinient method to initialise
869a watcher. The same limitations apply, of course.
870.ie n .IP """ev_TYPE_start"" (loop *, ev_TYPE *watcher)" 4
871.el .IP "\f(CWev_TYPE_start\fR (loop *, ev_TYPE *watcher)" 4
872.IX Item "ev_TYPE_start (loop *, ev_TYPE *watcher)"
873Starts (activates) the given watcher. Only active watchers will receive
874events. If the watcher is already active nothing will happen.
875.ie n .IP """ev_TYPE_stop"" (loop *, ev_TYPE *watcher)" 4
876.el .IP "\f(CWev_TYPE_stop\fR (loop *, ev_TYPE *watcher)" 4
877.IX Item "ev_TYPE_stop (loop *, ev_TYPE *watcher)"
878Stops the given watcher again (if active) and clears the pending
879status. It is possible that stopped watchers are pending (for example,
880non-repeating timers are being stopped when they become pending), but
881\&\f(CW\*(C`ev_TYPE_stop\*(C'\fR ensures that the watcher is neither active nor pending. If
882you want to free or reuse the memory used by the watcher it is therefore a
883good idea to always call its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function.
884.IP "bool ev_is_active (ev_TYPE *watcher)" 4
885.IX Item "bool ev_is_active (ev_TYPE *watcher)"
886Returns a true value iff the watcher is active (i.e. it has been started
887and not yet been stopped). As long as a watcher is active you must not modify
888it.
889.IP "bool ev_is_pending (ev_TYPE *watcher)" 4
890.IX Item "bool ev_is_pending (ev_TYPE *watcher)"
891Returns a true value iff the watcher is pending, (i.e. it has outstanding
892events but its callback has not yet been invoked). As long as a watcher
893is pending (but not active) you must not call an init function on it (but
894\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe) and you must make sure the watcher is available to
895libev (e.g. you cnanot \f(CW\*(C`free ()\*(C'\fR it).
896.IP "callback ev_cb (ev_TYPE *watcher)" 4
897.IX Item "callback ev_cb (ev_TYPE *watcher)"
898Returns the callback currently set on the watcher.
899.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4
900.IX Item "ev_cb_set (ev_TYPE *watcher, callback)"
901Change the callback. You can change the callback at virtually any time
902(modulo threads).
903.IP "ev_set_priority (ev_TYPE *watcher, priority)" 4
904.IX Item "ev_set_priority (ev_TYPE *watcher, priority)"
905.PD 0
906.IP "int ev_priority (ev_TYPE *watcher)" 4
907.IX Item "int ev_priority (ev_TYPE *watcher)"
908.PD
909Set and query the priority of the watcher. The priority is a small
910integer between \f(CW\*(C`EV_MAXPRI\*(C'\fR (default: \f(CW2\fR) and \f(CW\*(C`EV_MINPRI\*(C'\fR
911(default: \f(CW\*(C`\-2\*(C'\fR). Pending watchers with higher priority will be invoked
912before watchers with lower priority, but priority will not keep watchers
913from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers).
914.Sp
915This means that priorities are \fIonly\fR used for ordering callback
916invocation after new events have been received. This is useful, for
917example, to reduce latency after idling, or more often, to bind two
918watchers on the same event and make sure one is called first.
919.Sp
920If you need to suppress invocation when higher priority events are pending
921you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality.
922.Sp
923The default priority used by watchers when no priority has been set is
924always \f(CW0\fR, which is supposed to not be too high and not be too low :).
925.Sp
926Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is
927fine, as long as you do not mind that the priority value you query might
928or might not have been adjusted to be within valid range.
714.Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" 929.Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0"
715.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" 930.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER"
716Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change 931Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change
717and read at any time, libev will completely ignore it. This can be used 932and read at any time, libev will completely ignore it. This can be used
718to associate arbitrary data with your watcher. If you need more data and 933to associate arbitrary data with your watcher. If you need more data and
… …
739\& struct my_io *w = (struct my_io *)w_; 954\& struct my_io *w = (struct my_io *)w_;
740\& ... 955\& ...
741\& } 956\& }
742.Ve 957.Ve
743.PP 958.PP
744More interesting and less C\-conformant ways of catsing your callback type 959More interesting and less C\-conformant ways of casting your callback type
745have been omitted.... 960instead have been omitted.
961.PP
962Another common scenario is having some data structure with multiple
963watchers:
964.PP
965.Vb 6
966\& struct my_biggy
967\& {
968\& int some_data;
969\& ev_timer t1;
970\& ev_timer t2;
971\& }
972.Ve
973.PP
974In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more complicated,
975you need to use \f(CW\*(C`offsetof\*(C'\fR:
976.PP
977.Vb 1
978\& #include <stddef.h>
979.Ve
980.PP
981.Vb 6
982\& static void
983\& t1_cb (EV_P_ struct ev_timer *w, int revents)
984\& {
985\& struct my_biggy big = (struct my_biggy *
986\& (((char *)w) - offsetof (struct my_biggy, t1));
987\& }
988.Ve
989.PP
990.Vb 6
991\& static void
992\& t2_cb (EV_P_ struct ev_timer *w, int revents)
993\& {
994\& struct my_biggy big = (struct my_biggy *
995\& (((char *)w) - offsetof (struct my_biggy, t2));
996\& }
997.Ve
746.SH "WATCHER TYPES" 998.SH "WATCHER TYPES"
747.IX Header "WATCHER TYPES" 999.IX Header "WATCHER TYPES"
748This section describes each watcher in detail, but will not repeat 1000This section describes each watcher in detail, but will not repeat
749information given in the last section. 1001information given in the last section. Any initialisation/set macros,
1002functions and members specific to the watcher type are explained.
1003.PP
1004Members are additionally marked with either \fI[read\-only]\fR, meaning that,
1005while the watcher is active, you can look at the member and expect some
1006sensible content, but you must not modify it (you can modify it while the
1007watcher is stopped to your hearts content), or \fI[read\-write]\fR, which
1008means you can expect it to have some sensible content while the watcher
1009is active, but you can also modify it. Modifying it may not do something
1010sensible or take immediate effect (or do anything at all), but libev will
1011not crash or malfunction in any way.
750.ie n .Sh """ev_io"" \- is this file descriptor readable or writable" 1012.ie n .Sh """ev_io"" \- is this file descriptor readable or writable?"
751.el .Sh "\f(CWev_io\fP \- is this file descriptor readable or writable" 1013.el .Sh "\f(CWev_io\fP \- is this file descriptor readable or writable?"
752.IX Subsection "ev_io - is this file descriptor readable or writable" 1014.IX Subsection "ev_io - is this file descriptor readable or writable?"
753I/O watchers check whether a file descriptor is readable or writable 1015I/O watchers check whether a file descriptor is readable or writable
754in each iteration of the event loop (This behaviour is called 1016in each iteration of the event loop, or, more precisely, when reading
755level-triggering because you keep receiving events as long as the 1017would not block the process and writing would at least be able to write
756condition persists. Remember you can stop the watcher if you don't want to 1018some data. This behaviour is called level-triggering because you keep
757act on the event and neither want to receive future events). 1019receiving events as long as the condition persists. Remember you can stop
1020the watcher if you don't want to act on the event and neither want to
1021receive future events.
758.PP 1022.PP
759In general you can register as many read and/or write event watchers per 1023In general you can register as many read and/or write event watchers per
760fd as you want (as long as you don't confuse yourself). Setting all file 1024fd as you want (as long as you don't confuse yourself). Setting all file
761descriptors to non-blocking mode is also usually a good idea (but not 1025descriptors to non-blocking mode is also usually a good idea (but not
762required if you know what you are doing). 1026required if you know what you are doing).
763.PP 1027.PP
764You have to be careful with dup'ed file descriptors, though. Some backends 1028You have to be careful with dup'ed file descriptors, though. Some backends
765(the linux epoll backend is a notable example) cannot handle dup'ed file 1029(the linux epoll backend is a notable example) cannot handle dup'ed file
766descriptors correctly if you register interest in two or more fds pointing 1030descriptors correctly if you register interest in two or more fds pointing
767to the same underlying file/socket etc. description (that is, they share 1031to the same underlying file/socket/etc. description (that is, they share
768the same underlying \*(L"file open\*(R"). 1032the same underlying \*(L"file open\*(R").
769.PP 1033.PP
770If you must do this, then force the use of a known-to-be-good backend 1034If you must do this, then force the use of a known-to-be-good backend
771(at the time of this writing, this includes only \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and 1035(at the time of this writing, this includes only \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and
772\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR). 1036\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR).
1037.PP
1038Another thing you have to watch out for is that it is quite easy to
1039receive \*(L"spurious\*(R" readyness notifications, that is your callback might
1040be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block
1041because there is no data. Not only are some backends known to create a
1042lot of those (for example solaris ports), it is very easy to get into
1043this situation even with a relatively standard program structure. Thus
1044it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning
1045\&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives.
1046.PP
1047If you cannot run the fd in non-blocking mode (for example you should not
1048play around with an Xlib connection), then you have to seperately re-test
1049whether a file descriptor is really ready with a known-to-be good interface
1050such as poll (fortunately in our Xlib example, Xlib already does this on
1051its own, so its quite safe to use).
773.IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 1052.IP "ev_io_init (ev_io *, callback, int fd, int events)" 4
774.IX Item "ev_io_init (ev_io *, callback, int fd, int events)" 1053.IX Item "ev_io_init (ev_io *, callback, int fd, int events)"
775.PD 0 1054.PD 0
776.IP "ev_io_set (ev_io *, int fd, int events)" 4 1055.IP "ev_io_set (ev_io *, int fd, int events)" 4
777.IX Item "ev_io_set (ev_io *, int fd, int events)" 1056.IX Item "ev_io_set (ev_io *, int fd, int events)"
778.PD 1057.PD
779Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The fd is the file descriptor to rceeive 1058Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to
780events for and events is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or \f(CW\*(C`EV_READ | 1059rceeive events for and events is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or
781EV_WRITE\*(C'\fR to receive the given events. 1060\&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR to receive the given events.
782.Sp 1061.IP "int fd [read\-only]" 4
783Please note that most of the more scalable backend mechanisms (for example 1062.IX Item "int fd [read-only]"
784epoll and solaris ports) can result in spurious readyness notifications 1063The file descriptor being watched.
785for file descriptors, so you practically need to use non-blocking I/O (and 1064.IP "int events [read\-only]" 4
786treat callback invocation as hint only), or retest separately with a safe 1065.IX Item "int events [read-only]"
787interface before doing I/O (XLib can do this), or force the use of either 1066The events being watched.
788\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR, which don't suffer from this
789problem. Also note that it is quite easy to have your callback invoked
790when the readyness condition is no longer valid even when employing
791typical ways of handling events, so its a good idea to use non-blocking
792I/O unconditionally.
793.PP 1067.PP
794Example: call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well 1068Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well
795readable, but only once. Since it is likely line\-buffered, you could 1069readable, but only once. Since it is likely line\-buffered, you could
796attempt to read a whole line in the callback: 1070attempt to read a whole line in the callback.
797.PP 1071.PP
798.Vb 6 1072.Vb 6
799\& static void 1073\& static void
800\& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1074\& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)
801\& { 1075\& {
… …
810\& struct ev_io stdin_readable; 1084\& struct ev_io stdin_readable;
811\& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); 1085\& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
812\& ev_io_start (loop, &stdin_readable); 1086\& ev_io_start (loop, &stdin_readable);
813\& ev_loop (loop, 0); 1087\& ev_loop (loop, 0);
814.Ve 1088.Ve
815.ie n .Sh """ev_timer"" \- relative and optionally recurring timeouts" 1089.ie n .Sh """ev_timer"" \- relative and optionally repeating timeouts"
816.el .Sh "\f(CWev_timer\fP \- relative and optionally recurring timeouts" 1090.el .Sh "\f(CWev_timer\fP \- relative and optionally repeating timeouts"
817.IX Subsection "ev_timer - relative and optionally recurring timeouts" 1091.IX Subsection "ev_timer - relative and optionally repeating timeouts"
818Timer watchers are simple relative timers that generate an event after a 1092Timer watchers are simple relative timers that generate an event after a
819given time, and optionally repeating in regular intervals after that. 1093given time, and optionally repeating in regular intervals after that.
820.PP 1094.PP
821The timers are based on real time, that is, if you register an event that 1095The timers are based on real time, that is, if you register an event that
822times out after an hour and you reset your system clock to last years 1096times out after an hour and you reset your system clock to last years
… …
856.IP "ev_timer_again (loop)" 4 1130.IP "ev_timer_again (loop)" 4
857.IX Item "ev_timer_again (loop)" 1131.IX Item "ev_timer_again (loop)"
858This will act as if the timer timed out and restart it again if it is 1132This will act as if the timer timed out and restart it again if it is
859repeating. The exact semantics are: 1133repeating. The exact semantics are:
860.Sp 1134.Sp
1135If the timer is pending, its pending status is cleared.
1136.Sp
861If the timer is started but nonrepeating, stop it. 1137If the timer is started but nonrepeating, stop it (as if it timed out).
862.Sp 1138.Sp
863If the timer is repeating, either start it if necessary (with the repeat 1139If the timer is repeating, either start it if necessary (with the
864value), or reset the running timer to the repeat value. 1140\&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value.
865.Sp 1141.Sp
866This sounds a bit complicated, but here is a useful and typical 1142This sounds a bit complicated, but here is a useful and typical
867example: Imagine you have a tcp connection and you want a so-called idle 1143example: Imagine you have a tcp connection and you want a so-called idle
868timeout, that is, you want to be called when there have been, say, 60 1144timeout, that is, you want to be called when there have been, say, 60
869seconds of inactivity on the socket. The easiest way to do this is to 1145seconds of inactivity on the socket. The easiest way to do this is to
870configure an \f(CW\*(C`ev_timer\*(C'\fR with after=repeat=60 and calling ev_timer_again each 1146configure an \f(CW\*(C`ev_timer\*(C'\fR with a \f(CW\*(C`repeat\*(C'\fR value of \f(CW60\fR and then call
871time you successfully read or write some data. If you go into an idle 1147\&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If
872state where you do not expect data to travel on the socket, you can stop 1148you go into an idle state where you do not expect data to travel on the
873the timer, and again will automatically restart it if need be. 1149socket, you can \f(CW\*(C`ev_timer_stop\*(C'\fR the timer, and \f(CW\*(C`ev_timer_again\*(C'\fR will
1150automatically restart it if need be.
1151.Sp
1152That means you can ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR
1153altogether and only ever use the \f(CW\*(C`repeat\*(C'\fR value and \f(CW\*(C`ev_timer_again\*(C'\fR:
1154.Sp
1155.Vb 8
1156\& ev_timer_init (timer, callback, 0., 5.);
1157\& ev_timer_again (loop, timer);
1158\& ...
1159\& timer->again = 17.;
1160\& ev_timer_again (loop, timer);
1161\& ...
1162\& timer->again = 10.;
1163\& ev_timer_again (loop, timer);
1164.Ve
1165.Sp
1166This is more slightly efficient then stopping/starting the timer each time
1167you want to modify its timeout value.
1168.IP "ev_tstamp repeat [read\-write]" 4
1169.IX Item "ev_tstamp repeat [read-write]"
1170The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out
1171or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any),
1172which is also when any modifications are taken into account.
874.PP 1173.PP
875Example: create a timer that fires after 60 seconds. 1174Example: Create a timer that fires after 60 seconds.
876.PP 1175.PP
877.Vb 5 1176.Vb 5
878\& static void 1177\& static void
879\& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1178\& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
880\& { 1179\& {
… …
886\& struct ev_timer mytimer; 1185\& struct ev_timer mytimer;
887\& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); 1186\& ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
888\& ev_timer_start (loop, &mytimer); 1187\& ev_timer_start (loop, &mytimer);
889.Ve 1188.Ve
890.PP 1189.PP
891Example: create a timeout timer that times out after 10 seconds of 1190Example: Create a timeout timer that times out after 10 seconds of
892inactivity. 1191inactivity.
893.PP 1192.PP
894.Vb 5 1193.Vb 5
895\& static void 1194\& static void
896\& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1195\& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
… …
909.Vb 3 1208.Vb 3
910\& // and in some piece of code that gets executed on any "activity": 1209\& // and in some piece of code that gets executed on any "activity":
911\& // reset the timeout to start ticking again at 10 seconds 1210\& // reset the timeout to start ticking again at 10 seconds
912\& ev_timer_again (&mytimer); 1211\& ev_timer_again (&mytimer);
913.Ve 1212.Ve
914.ie n .Sh """ev_periodic"" \- to cron or not to cron" 1213.ie n .Sh """ev_periodic"" \- to cron or not to cron?"
915.el .Sh "\f(CWev_periodic\fP \- to cron or not to cron" 1214.el .Sh "\f(CWev_periodic\fP \- to cron or not to cron?"
916.IX Subsection "ev_periodic - to cron or not to cron" 1215.IX Subsection "ev_periodic - to cron or not to cron?"
917Periodic watchers are also timers of a kind, but they are very versatile 1216Periodic watchers are also timers of a kind, but they are very versatile
918(and unfortunately a bit complex). 1217(and unfortunately a bit complex).
919.PP 1218.PP
920Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time) 1219Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time)
921but on wallclock time (absolute time). You can tell a periodic watcher 1220but on wallclock time (absolute time). You can tell a periodic watcher
922to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a 1221to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a
923periodic watcher to trigger in 10 seconds (by specifiying e.g. c<ev_now () 1222periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now ()
924+ 10.>) and then reset your system clock to the last year, then it will 1223+ 10.\*(C'\fR) and then reset your system clock to the last year, then it will
925take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger 1224take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger
926roughly 10 seconds later and of course not if you reset your system time 1225roughly 10 seconds later and of course not if you reset your system time
927again). 1226again).
928.PP 1227.PP
929They can also be used to implement vastly more complex timers, such as 1228They can also be used to implement vastly more complex timers, such as
… …
1010.IX Item "ev_periodic_again (loop, ev_periodic *)" 1309.IX Item "ev_periodic_again (loop, ev_periodic *)"
1011Simply stops and restarts the periodic watcher again. This is only useful 1310Simply stops and restarts the periodic watcher again. This is only useful
1012when you changed some parameters or the reschedule callback would return 1311when you changed some parameters or the reschedule callback would return
1013a different time than the last time it was called (e.g. in a crond like 1312a different time than the last time it was called (e.g. in a crond like
1014program when the crontabs have changed). 1313program when the crontabs have changed).
1314.IP "ev_tstamp interval [read\-write]" 4
1315.IX Item "ev_tstamp interval [read-write]"
1316The current interval value. Can be modified any time, but changes only
1317take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being
1318called.
1319.IP "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read\-write]" 4
1320.IX Item "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]"
1321The current reschedule callback, or \f(CW0\fR, if this functionality is
1322switched off. Can be changed any time, but changes only take effect when
1323the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called.
1015.PP 1324.PP
1016Example: call a callback every hour, or, more precisely, whenever the 1325Example: Call a callback every hour, or, more precisely, whenever the
1017system clock is divisible by 3600. The callback invocation times have 1326system clock is divisible by 3600. The callback invocation times have
1018potentially a lot of jittering, but good long-term stability. 1327potentially a lot of jittering, but good long-term stability.
1019.PP 1328.PP
1020.Vb 5 1329.Vb 5
1021\& static void 1330\& static void
… …
1029\& struct ev_periodic hourly_tick; 1338\& struct ev_periodic hourly_tick;
1030\& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); 1339\& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1031\& ev_periodic_start (loop, &hourly_tick); 1340\& ev_periodic_start (loop, &hourly_tick);
1032.Ve 1341.Ve
1033.PP 1342.PP
1034Example: the same as above, but use a reschedule callback to do it: 1343Example: The same as above, but use a reschedule callback to do it:
1035.PP 1344.PP
1036.Vb 1 1345.Vb 1
1037\& #include <math.h> 1346\& #include <math.h>
1038.Ve 1347.Ve
1039.PP 1348.PP
… …
1047.PP 1356.PP
1048.Vb 1 1357.Vb 1
1049\& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); 1358\& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1050.Ve 1359.Ve
1051.PP 1360.PP
1052Example: call a callback every hour, starting now: 1361Example: Call a callback every hour, starting now:
1053.PP 1362.PP
1054.Vb 4 1363.Vb 4
1055\& struct ev_periodic hourly_tick; 1364\& struct ev_periodic hourly_tick;
1056\& ev_periodic_init (&hourly_tick, clock_cb, 1365\& ev_periodic_init (&hourly_tick, clock_cb,
1057\& fmod (ev_now (loop), 3600.), 3600., 0); 1366\& fmod (ev_now (loop), 3600.), 3600., 0);
1058\& ev_periodic_start (loop, &hourly_tick); 1367\& ev_periodic_start (loop, &hourly_tick);
1059.Ve 1368.Ve
1060.ie n .Sh """ev_signal"" \- signal me when a signal gets signalled" 1369.ie n .Sh """ev_signal"" \- signal me when a signal gets signalled!"
1061.el .Sh "\f(CWev_signal\fP \- signal me when a signal gets signalled" 1370.el .Sh "\f(CWev_signal\fP \- signal me when a signal gets signalled!"
1062.IX Subsection "ev_signal - signal me when a signal gets signalled" 1371.IX Subsection "ev_signal - signal me when a signal gets signalled!"
1063Signal watchers will trigger an event when the process receives a specific 1372Signal watchers will trigger an event when the process receives a specific
1064signal one or more times. Even though signals are very asynchronous, libev 1373signal one or more times. Even though signals are very asynchronous, libev
1065will try it's best to deliver signals synchronously, i.e. as part of the 1374will try it's best to deliver signals synchronously, i.e. as part of the
1066normal event processing, like any other event. 1375normal event processing, like any other event.
1067.PP 1376.PP
… …
1077.IP "ev_signal_set (ev_signal *, int signum)" 4 1386.IP "ev_signal_set (ev_signal *, int signum)" 4
1078.IX Item "ev_signal_set (ev_signal *, int signum)" 1387.IX Item "ev_signal_set (ev_signal *, int signum)"
1079.PD 1388.PD
1080Configures the watcher to trigger on the given signal number (usually one 1389Configures the watcher to trigger on the given signal number (usually one
1081of the \f(CW\*(C`SIGxxx\*(C'\fR constants). 1390of the \f(CW\*(C`SIGxxx\*(C'\fR constants).
1391.IP "int signum [read\-only]" 4
1392.IX Item "int signum [read-only]"
1393The signal the watcher watches out for.
1082.ie n .Sh """ev_child"" \- wait for pid status changes" 1394.ie n .Sh """ev_child"" \- watch out for process status changes"
1083.el .Sh "\f(CWev_child\fP \- wait for pid status changes" 1395.el .Sh "\f(CWev_child\fP \- watch out for process status changes"
1084.IX Subsection "ev_child - wait for pid status changes" 1396.IX Subsection "ev_child - watch out for process status changes"
1085Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to 1397Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to
1086some child status changes (most typically when a child of yours dies). 1398some child status changes (most typically when a child of yours dies).
1087.IP "ev_child_init (ev_child *, callback, int pid)" 4 1399.IP "ev_child_init (ev_child *, callback, int pid)" 4
1088.IX Item "ev_child_init (ev_child *, callback, int pid)" 1400.IX Item "ev_child_init (ev_child *, callback, int pid)"
1089.PD 0 1401.PD 0
… …
1094\&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look 1406\&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look
1095at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see 1407at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see
1096the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems 1408the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems
1097\&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the 1409\&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the
1098process causing the status change. 1410process causing the status change.
1411.IP "int pid [read\-only]" 4
1412.IX Item "int pid [read-only]"
1413The process id this watcher watches out for, or \f(CW0\fR, meaning any process id.
1414.IP "int rpid [read\-write]" 4
1415.IX Item "int rpid [read-write]"
1416The process id that detected a status change.
1417.IP "int rstatus [read\-write]" 4
1418.IX Item "int rstatus [read-write]"
1419The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems
1420\&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details).
1099.PP 1421.PP
1100Example: try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0. 1422Example: Try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0.
1101.PP 1423.PP
1102.Vb 5 1424.Vb 5
1103\& static void 1425\& static void
1104\& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) 1426\& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1105\& { 1427\& {
… …
1110.Vb 3 1432.Vb 3
1111\& struct ev_signal signal_watcher; 1433\& struct ev_signal signal_watcher;
1112\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT); 1434\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1113\& ev_signal_start (loop, &sigint_cb); 1435\& ev_signal_start (loop, &sigint_cb);
1114.Ve 1436.Ve
1437.ie n .Sh """ev_stat"" \- did the file attributes just change?"
1438.el .Sh "\f(CWev_stat\fP \- did the file attributes just change?"
1439.IX Subsection "ev_stat - did the file attributes just change?"
1440This watches a filesystem path for attribute changes. That is, it calls
1441\&\f(CW\*(C`stat\*(C'\fR regularly (or when the \s-1OS\s0 says it changed) and sees if it changed
1442compared to the last time, invoking the callback if it did.
1443.PP
1444The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does
1445not exist\*(R" is a status change like any other. The condition \*(L"path does
1446not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is
1447otherwise always forced to be at least one) and all the other fields of
1448the stat buffer having unspecified contents.
1449.PP
1450The path \fIshould\fR be absolute and \fImust not\fR end in a slash. If it is
1451relative and your working directory changes, the behaviour is undefined.
1452.PP
1453Since there is no standard to do this, the portable implementation simply
1454calls \f(CW\*(C`stat (2)\*(C'\fR regularly on the path to see if it changed somehow. You
1455can specify a recommended polling interval for this case. If you specify
1456a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable,
1457unspecified default\fR value will be used (which you can expect to be around
1458five seconds, although this might change dynamically). Libev will also
1459impose a minimum interval which is currently around \f(CW0.1\fR, but thats
1460usually overkill.
1461.PP
1462This watcher type is not meant for massive numbers of stat watchers,
1463as even with OS-supported change notifications, this can be
1464resource\-intensive.
1465.PP
1466At the time of this writing, only the Linux inotify interface is
1467implemented (implementing kqueue support is left as an exercise for the
1468reader). Inotify will be used to give hints only and should not change the
1469semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs
1470to fall back to regular polling again even with inotify, but changes are
1471usually detected immediately, and if the file exists there will be no
1472polling.
1473.IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4
1474.IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)"
1475.PD 0
1476.IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4
1477.IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)"
1478.PD
1479Configures the watcher to wait for status changes of the given
1480\&\f(CW\*(C`path\*(C'\fR. The \f(CW\*(C`interval\*(C'\fR is a hint on how quickly a change is expected to
1481be detected and should normally be specified as \f(CW0\fR to let libev choose
1482a suitable value. The memory pointed to by \f(CW\*(C`path\*(C'\fR must point to the same
1483path for as long as the watcher is active.
1484.Sp
1485The callback will be receive \f(CW\*(C`EV_STAT\*(C'\fR when a change was detected,
1486relative to the attributes at the time the watcher was started (or the
1487last change was detected).
1488.IP "ev_stat_stat (ev_stat *)" 4
1489.IX Item "ev_stat_stat (ev_stat *)"
1490Updates the stat buffer immediately with new values. If you change the
1491watched path in your callback, you could call this fucntion to avoid
1492detecting this change (while introducing a race condition). Can also be
1493useful simply to find out the new values.
1494.IP "ev_statdata attr [read\-only]" 4
1495.IX Item "ev_statdata attr [read-only]"
1496The most-recently detected attributes of the file. Although the type is of
1497\&\f(CW\*(C`ev_statdata\*(C'\fR, this is usually the (or one of the) \f(CW\*(C`struct stat\*(C'\fR types
1498suitable for your system. If the \f(CW\*(C`st_nlink\*(C'\fR member is \f(CW0\fR, then there
1499was some error while \f(CW\*(C`stat\*(C'\fRing the file.
1500.IP "ev_statdata prev [read\-only]" 4
1501.IX Item "ev_statdata prev [read-only]"
1502The previous attributes of the file. The callback gets invoked whenever
1503\&\f(CW\*(C`prev\*(C'\fR != \f(CW\*(C`attr\*(C'\fR.
1504.IP "ev_tstamp interval [read\-only]" 4
1505.IX Item "ev_tstamp interval [read-only]"
1506The specified interval.
1507.IP "const char *path [read\-only]" 4
1508.IX Item "const char *path [read-only]"
1509The filesystem path that is being watched.
1510.PP
1511Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes.
1512.PP
1513.Vb 15
1514\& static void
1515\& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1516\& {
1517\& /* /etc/passwd changed in some way */
1518\& if (w->attr.st_nlink)
1519\& {
1520\& printf ("passwd current size %ld\en", (long)w->attr.st_size);
1521\& printf ("passwd current atime %ld\en", (long)w->attr.st_mtime);
1522\& printf ("passwd current mtime %ld\en", (long)w->attr.st_mtime);
1523\& }
1524\& else
1525\& /* you shalt not abuse printf for puts */
1526\& puts ("wow, /etc/passwd is not there, expect problems. "
1527\& "if this is windows, they already arrived\en");
1528\& }
1529.Ve
1530.PP
1531.Vb 2
1532\& ...
1533\& ev_stat passwd;
1534.Ve
1535.PP
1536.Vb 2
1537\& ev_stat_init (&passwd, passwd_cb, "/etc/passwd");
1538\& ev_stat_start (loop, &passwd);
1539.Ve
1115.ie n .Sh """ev_idle"" \- when you've got nothing better to do" 1540.ie n .Sh """ev_idle"" \- when you've got nothing better to do..."
1116.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do" 1541.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..."
1117.IX Subsection "ev_idle - when you've got nothing better to do" 1542.IX Subsection "ev_idle - when you've got nothing better to do..."
1118Idle watchers trigger events when there are no other events are pending 1543Idle watchers trigger events when no other events of the same or higher
1119(prepare, check and other idle watchers do not count). That is, as long 1544priority are pending (prepare, check and other idle watchers do not
1120as your process is busy handling sockets or timeouts (or even signals, 1545count).
1121imagine) it will not be triggered. But when your process is idle all idle 1546.PP
1122watchers are being called again and again, once per event loop iteration \- 1547That is, as long as your process is busy handling sockets or timeouts
1548(or even signals, imagine) of the same or higher priority it will not be
1549triggered. But when your process is idle (or only lower-priority watchers
1550are pending), the idle watchers are being called once per event loop
1123until stopped, that is, or your process receives more events and becomes 1551iteration \- until stopped, that is, or your process receives more events
1124busy. 1552and becomes busy again with higher priority stuff.
1125.PP 1553.PP
1126The most noteworthy effect is that as long as any idle watchers are 1554The most noteworthy effect is that as long as any idle watchers are
1127active, the process will not block when waiting for new events. 1555active, the process will not block when waiting for new events.
1128.PP 1556.PP
1129Apart from keeping your process non-blocking (which is a useful 1557Apart from keeping your process non-blocking (which is a useful
… …
1134.IX Item "ev_idle_init (ev_signal *, callback)" 1562.IX Item "ev_idle_init (ev_signal *, callback)"
1135Initialises and configures the idle watcher \- it has no parameters of any 1563Initialises and configures the idle watcher \- it has no parameters of any
1136kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, 1564kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless,
1137believe me. 1565believe me.
1138.PP 1566.PP
1139Example: dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR, start it, and in the 1567Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the
1140callback, free it. Alos, use no error checking, as usual. 1568callback, free it. Also, use no error checking, as usual.
1141.PP 1569.PP
1142.Vb 7 1570.Vb 7
1143\& static void 1571\& static void
1144\& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) 1572\& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1145\& { 1573\& {
… …
1152.Vb 3 1580.Vb 3
1153\& struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); 1581\& struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));
1154\& ev_idle_init (idle_watcher, idle_cb); 1582\& ev_idle_init (idle_watcher, idle_cb);
1155\& ev_idle_start (loop, idle_cb); 1583\& ev_idle_start (loop, idle_cb);
1156.Ve 1584.Ve
1157.ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop" 1585.ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop!"
1158.el .Sh "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop" 1586.el .Sh "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!"
1159.IX Subsection "ev_prepare and ev_check - customise your event loop" 1587.IX Subsection "ev_prepare and ev_check - customise your event loop!"
1160Prepare and check watchers are usually (but not always) used in tandem: 1588Prepare and check watchers are usually (but not always) used in tandem:
1161prepare watchers get invoked before the process blocks and check watchers 1589prepare watchers get invoked before the process blocks and check watchers
1162afterwards. 1590afterwards.
1163.PP 1591.PP
1592You \fImust not\fR call \f(CW\*(C`ev_loop\*(C'\fR or similar functions that enter
1593the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR
1594watchers. Other loops than the current one are fine, however. The
1595rationale behind this is that you do not need to check for recursion in
1596those watchers, i.e. the sequence will always be \f(CW\*(C`ev_prepare\*(C'\fR, blocking,
1597\&\f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each kind they will always be
1598called in pairs bracketing the blocking call.
1599.PP
1164Their main purpose is to integrate other event mechanisms into libev. This 1600Their main purpose is to integrate other event mechanisms into libev and
1165could be used, for example, to track variable changes, implement your own 1601their use is somewhat advanced. This could be used, for example, to track
1166watchers, integrate net-snmp or a coroutine library and lots more. 1602variable changes, implement your own watchers, integrate net-snmp or a
1603coroutine library and lots more. They are also occasionally useful if
1604you cache some data and want to flush it before blocking (for example,
1605in X programs you might want to do an \f(CW\*(C`XFlush ()\*(C'\fR in an \f(CW\*(C`ev_prepare\*(C'\fR
1606watcher).
1167.PP 1607.PP
1168This is done by examining in each prepare call which file descriptors need 1608This is done by examining in each prepare call which file descriptors need
1169to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers for 1609to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers for
1170them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many libraries 1610them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many libraries
1171provide just this functionality). Then, in the check watcher you check for 1611provide just this functionality). Then, in the check watcher you check for
… …
1190.PD 1630.PD
1191Initialises and configures the prepare or check watcher \- they have no 1631Initialises and configures the prepare or check watcher \- they have no
1192parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR 1632parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR
1193macros, but using them is utterly, utterly and completely pointless. 1633macros, but using them is utterly, utterly and completely pointless.
1194.PP 1634.PP
1195Example: *TODO*. 1635Example: To include a library such as adns, you would add \s-1IO\s0 watchers
1636and a timeout watcher in a prepare handler, as required by libadns, and
1637in a check watcher, destroy them and call into libadns. What follows is
1638pseudo-code only of course:
1639.PP
1640.Vb 2
1641\& static ev_io iow [nfd];
1642\& static ev_timer tw;
1643.Ve
1644.PP
1645.Vb 9
1646\& static void
1647\& io_cb (ev_loop *loop, ev_io *w, int revents)
1648\& {
1649\& // set the relevant poll flags
1650\& // could also call adns_processreadable etc. here
1651\& struct pollfd *fd = (struct pollfd *)w->data;
1652\& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1653\& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1654\& }
1655.Ve
1656.PP
1657.Vb 8
1658\& // create io watchers for each fd and a timer before blocking
1659\& static void
1660\& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
1661\& {
1662\& int timeout = 3600000;
1663\& struct pollfd fds [nfd];
1664\& // actual code will need to loop here and realloc etc.
1665\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1666.Ve
1667.PP
1668.Vb 3
1669\& /* the callback is illegal, but won't be called as we stop during check */
1670\& ev_timer_init (&tw, 0, timeout * 1e-3);
1671\& ev_timer_start (loop, &tw);
1672.Ve
1673.PP
1674.Vb 6
1675\& // create on ev_io per pollfd
1676\& for (int i = 0; i < nfd; ++i)
1677\& {
1678\& ev_io_init (iow + i, io_cb, fds [i].fd,
1679\& ((fds [i].events & POLLIN ? EV_READ : 0)
1680\& | (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1681.Ve
1682.PP
1683.Vb 5
1684\& fds [i].revents = 0;
1685\& iow [i].data = fds + i;
1686\& ev_io_start (loop, iow + i);
1687\& }
1688\& }
1689.Ve
1690.PP
1691.Vb 5
1692\& // stop all watchers after blocking
1693\& static void
1694\& adns_check_cb (ev_loop *loop, ev_check *w, int revents)
1695\& {
1696\& ev_timer_stop (loop, &tw);
1697.Ve
1698.PP
1699.Vb 2
1700\& for (int i = 0; i < nfd; ++i)
1701\& ev_io_stop (loop, iow + i);
1702.Ve
1703.PP
1704.Vb 2
1705\& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
1706\& }
1707.Ve
1708.ie n .Sh """ev_embed"" \- when one backend isn't enough..."
1709.el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..."
1710.IX Subsection "ev_embed - when one backend isn't enough..."
1711This is a rather advanced watcher type that lets you embed one event loop
1712into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded
1713loop, other types of watchers might be handled in a delayed or incorrect
1714fashion and must not be used).
1715.PP
1716There are primarily two reasons you would want that: work around bugs and
1717prioritise I/O.
1718.PP
1719As an example for a bug workaround, the kqueue backend might only support
1720sockets on some platform, so it is unusable as generic backend, but you
1721still want to make use of it because you have many sockets and it scales
1722so nicely. In this case, you would create a kqueue-based loop and embed it
1723into your default loop (which might use e.g. poll). Overall operation will
1724be a bit slower because first libev has to poll and then call kevent, but
1725at least you can use both at what they are best.
1726.PP
1727As for prioritising I/O: rarely you have the case where some fds have
1728to be watched and handled very quickly (with low latency), and even
1729priorities and idle watchers might have too much overhead. In this case
1730you would put all the high priority stuff in one loop and all the rest in
1731a second one, and embed the second one in the first.
1732.PP
1733As long as the watcher is active, the callback will be invoked every time
1734there might be events pending in the embedded loop. The callback must then
1735call \f(CW\*(C`ev_embed_sweep (mainloop, watcher)\*(C'\fR to make a single sweep and invoke
1736their callbacks (you could also start an idle watcher to give the embedded
1737loop strictly lower priority for example). You can also set the callback
1738to \f(CW0\fR, in which case the embed watcher will automatically execute the
1739embedded loop sweep.
1740.PP
1741As long as the watcher is started it will automatically handle events. The
1742callback will be invoked whenever some events have been handled. You can
1743set the callback to \f(CW0\fR to avoid having to specify one if you are not
1744interested in that.
1745.PP
1746Also, there have not currently been made special provisions for forking:
1747when you fork, you not only have to call \f(CW\*(C`ev_loop_fork\*(C'\fR on both loops,
1748but you will also have to stop and restart any \f(CW\*(C`ev_embed\*(C'\fR watchers
1749yourself.
1750.PP
1751Unfortunately, not all backends are embeddable, only the ones returned by
1752\&\f(CW\*(C`ev_embeddable_backends\*(C'\fR are, which, unfortunately, does not include any
1753portable one.
1754.PP
1755So when you want to use this feature you will always have to be prepared
1756that you cannot get an embeddable loop. The recommended way to get around
1757this is to have a separate variables for your embeddable loop, try to
1758create it, and if that fails, use the normal loop for everything:
1759.PP
1760.Vb 3
1761\& struct ev_loop *loop_hi = ev_default_init (0);
1762\& struct ev_loop *loop_lo = 0;
1763\& struct ev_embed embed;
1764.Ve
1765.PP
1766.Vb 5
1767\& // see if there is a chance of getting one that works
1768\& // (remember that a flags value of 0 means autodetection)
1769\& loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
1770\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
1771\& : 0;
1772.Ve
1773.PP
1774.Vb 8
1775\& // if we got one, then embed it, otherwise default to loop_hi
1776\& if (loop_lo)
1777\& {
1778\& ev_embed_init (&embed, 0, loop_lo);
1779\& ev_embed_start (loop_hi, &embed);
1780\& }
1781\& else
1782\& loop_lo = loop_hi;
1783.Ve
1784.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4
1785.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)"
1786.PD 0
1787.IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4
1788.IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)"
1789.PD
1790Configures the watcher to embed the given loop, which must be
1791embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be
1792invoked automatically, otherwise it is the responsibility of the callback
1793to invoke it (it will continue to be called until the sweep has been done,
1794if you do not want thta, you need to temporarily stop the embed watcher).
1795.IP "ev_embed_sweep (loop, ev_embed *)" 4
1796.IX Item "ev_embed_sweep (loop, ev_embed *)"
1797Make a single, non-blocking sweep over the embedded loop. This works
1798similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most
1799apropriate way for embedded loops.
1800.IP "struct ev_loop *loop [read\-only]" 4
1801.IX Item "struct ev_loop *loop [read-only]"
1802The embedded event loop.
1803.ie n .Sh """ev_fork"" \- the audacity to resume the event loop after a fork"
1804.el .Sh "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork"
1805.IX Subsection "ev_fork - the audacity to resume the event loop after a fork"
1806Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because
1807whoever is a good citizen cared to tell libev about it by calling
1808\&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the
1809event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called,
1810and only in the child after the fork. If whoever good citizen calling
1811\&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork
1812handlers will be invoked, too, of course.
1813.IP "ev_fork_init (ev_signal *, callback)" 4
1814.IX Item "ev_fork_init (ev_signal *, callback)"
1815Initialises and configures the fork watcher \- it has no parameters of any
1816kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless,
1817believe me.
1196.SH "OTHER FUNCTIONS" 1818.SH "OTHER FUNCTIONS"
1197.IX Header "OTHER FUNCTIONS" 1819.IX Header "OTHER FUNCTIONS"
1198There are some other functions of possible interest. Described. Here. Now. 1820There are some other functions of possible interest. Described. Here. Now.
1199.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 1821.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4
1200.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 1822.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)"
… …
1229.Ve 1851.Ve
1230.Sp 1852.Sp
1231.Vb 1 1853.Vb 1
1232\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 1854\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
1233.Ve 1855.Ve
1234.IP "ev_feed_event (loop, watcher, int events)" 4 1856.IP "ev_feed_event (ev_loop *, watcher *, int revents)" 4
1235.IX Item "ev_feed_event (loop, watcher, int events)" 1857.IX Item "ev_feed_event (ev_loop *, watcher *, int revents)"
1236Feeds the given event set into the event loop, as if the specified event 1858Feeds the given event set into the event loop, as if the specified event
1237had happened for the specified watcher (which must be a pointer to an 1859had happened for the specified watcher (which must be a pointer to an
1238initialised but not necessarily started event watcher). 1860initialised but not necessarily started event watcher).
1239.IP "ev_feed_fd_event (loop, int fd, int revents)" 4 1861.IP "ev_feed_fd_event (ev_loop *, int fd, int revents)" 4
1240.IX Item "ev_feed_fd_event (loop, int fd, int revents)" 1862.IX Item "ev_feed_fd_event (ev_loop *, int fd, int revents)"
1241Feed an event on the given fd, as if a file descriptor backend detected 1863Feed an event on the given fd, as if a file descriptor backend detected
1242the given events it. 1864the given events it.
1243.IP "ev_feed_signal_event (loop, int signum)" 4 1865.IP "ev_feed_signal_event (ev_loop *loop, int signum)" 4
1244.IX Item "ev_feed_signal_event (loop, int signum)" 1866.IX Item "ev_feed_signal_event (ev_loop *loop, int signum)"
1245Feed an event as if the given signal occured (loop must be the default loop!). 1867Feed an event as if the given signal occured (\f(CW\*(C`loop\*(C'\fR must be the default
1868loop!).
1246.SH "LIBEVENT EMULATION" 1869.SH "LIBEVENT EMULATION"
1247.IX Header "LIBEVENT EMULATION" 1870.IX Header "LIBEVENT EMULATION"
1248Libev offers a compatibility emulation layer for libevent. It cannot 1871Libev offers a compatibility emulation layer for libevent. It cannot
1249emulate the internals of libevent, so here are some usage hints: 1872emulate the internals of libevent, so here are some usage hints:
1250.IP "* Use it by including <event.h>, as usual." 4 1873.IP "* Use it by including <event.h>, as usual." 4
… …
1261.IP "* The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need to use the libev header file and library." 4 1884.IP "* The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need to use the libev header file and library." 4
1262.IX Item "The libev emulation is not ABI compatible to libevent, you need to use the libev header file and library." 1885.IX Item "The libev emulation is not ABI compatible to libevent, you need to use the libev header file and library."
1263.PD 1886.PD
1264.SH "\*(C+ SUPPORT" 1887.SH "\*(C+ SUPPORT"
1265.IX Header " SUPPORT" 1888.IX Header " SUPPORT"
1266\&\s-1TBD\s0. 1889Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow
1890you to use some convinience methods to start/stop watchers and also change
1891the callback model to a model using method callbacks on objects.
1892.PP
1893To use it,
1894.PP
1895.Vb 1
1896\& #include <ev++.h>
1897.Ve
1898.PP
1899(it is not installed by default). This automatically includes \fIev.h\fR
1900and puts all of its definitions (many of them macros) into the global
1901namespace. All \*(C+ specific things are put into the \f(CW\*(C`ev\*(C'\fR namespace.
1902.PP
1903It should support all the same embedding options as \fIev.h\fR, most notably
1904\&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR.
1905.PP
1906Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace:
1907.ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4
1908.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4
1909.IX Item "ev::READ, ev::WRITE etc."
1910These are just enum values with the same values as the \f(CW\*(C`EV_READ\*(C'\fR etc.
1911macros from \fIev.h\fR.
1912.ie n .IP """ev::tstamp""\fR, \f(CW""ev::now""" 4
1913.el .IP "\f(CWev::tstamp\fR, \f(CWev::now\fR" 4
1914.IX Item "ev::tstamp, ev::now"
1915Aliases to the same types/functions as with the \f(CW\*(C`ev_\*(C'\fR prefix.
1916.ie n .IP """ev::io""\fR, \f(CW""ev::timer""\fR, \f(CW""ev::periodic""\fR, \f(CW""ev::idle""\fR, \f(CW""ev::sig"" etc." 4
1917.el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4
1918.IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc."
1919For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of
1920the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR
1921which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro
1922defines by many implementations.
1923.Sp
1924All of those classes have these methods:
1925.RS 4
1926.IP "ev::TYPE::TYPE (object *, object::method *)" 4
1927.IX Item "ev::TYPE::TYPE (object *, object::method *)"
1928.PD 0
1929.IP "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" 4
1930.IX Item "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)"
1931.IP "ev::TYPE::~TYPE" 4
1932.IX Item "ev::TYPE::~TYPE"
1933.PD
1934The constructor takes a pointer to an object and a method pointer to
1935the event handler callback to call in this class. The constructor calls
1936\&\f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the \f(CW\*(C`set\*(C'\fR method
1937before starting it. If you do not specify a loop then the constructor
1938automatically associates the default loop with this watcher.
1939.Sp
1940The destructor automatically stops the watcher if it is active.
1941.IP "w\->set (struct ev_loop *)" 4
1942.IX Item "w->set (struct ev_loop *)"
1943Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only
1944do this when the watcher is inactive (and not pending either).
1945.IP "w\->set ([args])" 4
1946.IX Item "w->set ([args])"
1947Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be
1948called at least once. Unlike the C counterpart, an active watcher gets
1949automatically stopped and restarted.
1950.IP "w\->start ()" 4
1951.IX Item "w->start ()"
1952Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument as the
1953constructor already takes the loop.
1954.IP "w\->stop ()" 4
1955.IX Item "w->stop ()"
1956Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument.
1957.ie n .IP "w\->again () ""ev::timer""\fR, \f(CW""ev::periodic"" only" 4
1958.el .IP "w\->again () \f(CWev::timer\fR, \f(CWev::periodic\fR only" 4
1959.IX Item "w->again () ev::timer, ev::periodic only"
1960For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding
1961\&\f(CW\*(C`ev_TYPE_again\*(C'\fR function.
1962.ie n .IP "w\->sweep () ""ev::embed"" only" 4
1963.el .IP "w\->sweep () \f(CWev::embed\fR only" 4
1964.IX Item "w->sweep () ev::embed only"
1965Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR.
1966.ie n .IP "w\->update () ""ev::stat"" only" 4
1967.el .IP "w\->update () \f(CWev::stat\fR only" 4
1968.IX Item "w->update () ev::stat only"
1969Invokes \f(CW\*(C`ev_stat_stat\*(C'\fR.
1970.RE
1971.RS 4
1972.RE
1973.PP
1974Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in
1975the constructor.
1976.PP
1977.Vb 4
1978\& class myclass
1979\& {
1980\& ev_io io; void io_cb (ev::io &w, int revents);
1981\& ev_idle idle void idle_cb (ev::idle &w, int revents);
1982.Ve
1983.PP
1984.Vb 2
1985\& myclass ();
1986\& }
1987.Ve
1988.PP
1989.Vb 6
1990\& myclass::myclass (int fd)
1991\& : io (this, &myclass::io_cb),
1992\& idle (this, &myclass::idle_cb)
1993\& {
1994\& io.start (fd, ev::READ);
1995\& }
1996.Ve
1997.SH "MACRO MAGIC"
1998.IX Header "MACRO MAGIC"
1999Libev can be compiled with a variety of options, the most fundemantal is
2000\&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) functions and
2001callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument.
2002.PP
2003To make it easier to write programs that cope with either variant, the
2004following macros are defined:
2005.ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4
2006.el .IP "\f(CWEV_A\fR, \f(CWEV_A_\fR" 4
2007.IX Item "EV_A, EV_A_"
2008This provides the loop \fIargument\fR for functions, if one is required (\*(L"ev
2009loop argument\*(R"). The \f(CW\*(C`EV_A\*(C'\fR form is used when this is the sole argument,
2010\&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example:
2011.Sp
2012.Vb 3
2013\& ev_unref (EV_A);
2014\& ev_timer_add (EV_A_ watcher);
2015\& ev_loop (EV_A_ 0);
2016.Ve
2017.Sp
2018It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope,
2019which is often provided by the following macro.
2020.ie n .IP """EV_P""\fR, \f(CW""EV_P_""" 4
2021.el .IP "\f(CWEV_P\fR, \f(CWEV_P_\fR" 4
2022.IX Item "EV_P, EV_P_"
2023This provides the loop \fIparameter\fR for functions, if one is required (\*(L"ev
2024loop parameter\*(R"). The \f(CW\*(C`EV_P\*(C'\fR form is used when this is the sole parameter,
2025\&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example:
2026.Sp
2027.Vb 2
2028\& // this is how ev_unref is being declared
2029\& static void ev_unref (EV_P);
2030.Ve
2031.Sp
2032.Vb 2
2033\& // this is how you can declare your typical callback
2034\& static void cb (EV_P_ ev_timer *w, int revents)
2035.Ve
2036.Sp
2037It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite
2038suitable for use with \f(CW\*(C`EV_A\*(C'\fR.
2039.ie n .IP """EV_DEFAULT""\fR, \f(CW""EV_DEFAULT_""" 4
2040.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4
2041.IX Item "EV_DEFAULT, EV_DEFAULT_"
2042Similar to the other two macros, this gives you the value of the default
2043loop, if multiple loops are supported (\*(L"ev loop default\*(R").
2044.PP
2045Example: Declare and initialise a check watcher, utilising the above
2046macros so it will work regardless of whether multiple loops are supported
2047or not.
2048.PP
2049.Vb 5
2050\& static void
2051\& check_cb (EV_P_ ev_timer *w, int revents)
2052\& {
2053\& ev_check_stop (EV_A_ w);
2054\& }
2055.Ve
2056.PP
2057.Vb 4
2058\& ev_check check;
2059\& ev_check_init (&check, check_cb);
2060\& ev_check_start (EV_DEFAULT_ &check);
2061\& ev_loop (EV_DEFAULT_ 0);
2062.Ve
2063.SH "EMBEDDING"
2064.IX Header "EMBEDDING"
2065Libev can (and often is) directly embedded into host
2066applications. Examples of applications that embed it include the Deliantra
2067Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe)
2068and rxvt\-unicode.
2069.PP
2070The goal is to enable you to just copy the neecssary files into your
2071source directory without having to change even a single line in them, so
2072you can easily upgrade by simply copying (or having a checked-out copy of
2073libev somewhere in your source tree).
2074.Sh "\s-1FILESETS\s0"
2075.IX Subsection "FILESETS"
2076Depending on what features you need you need to include one or more sets of files
2077in your app.
2078.PP
2079\fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR
2080.IX Subsection "CORE EVENT LOOP"
2081.PP
2082To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual
2083configuration (no autoconf):
2084.PP
2085.Vb 2
2086\& #define EV_STANDALONE 1
2087\& #include "ev.c"
2088.Ve
2089.PP
2090This will automatically include \fIev.h\fR, too, and should be done in a
2091single C source file only to provide the function implementations. To use
2092it, do the same for \fIev.h\fR in all files wishing to use this \s-1API\s0 (best
2093done by writing a wrapper around \fIev.h\fR that you can include instead and
2094where you can put other configuration options):
2095.PP
2096.Vb 2
2097\& #define EV_STANDALONE 1
2098\& #include "ev.h"
2099.Ve
2100.PP
2101Both header files and implementation files can be compiled with a \*(C+
2102compiler (at least, thats a stated goal, and breakage will be treated
2103as a bug).
2104.PP
2105You need the following files in your source tree, or in a directory
2106in your include path (e.g. in libev/ when using \-Ilibev):
2107.PP
2108.Vb 4
2109\& ev.h
2110\& ev.c
2111\& ev_vars.h
2112\& ev_wrap.h
2113.Ve
2114.PP
2115.Vb 1
2116\& ev_win32.c required on win32 platforms only
2117.Ve
2118.PP
2119.Vb 5
2120\& ev_select.c only when select backend is enabled (which is enabled by default)
2121\& ev_poll.c only when poll backend is enabled (disabled by default)
2122\& ev_epoll.c only when the epoll backend is enabled (disabled by default)
2123\& ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
2124\& ev_port.c only when the solaris port backend is enabled (disabled by default)
2125.Ve
2126.PP
2127\&\fIev.c\fR includes the backend files directly when enabled, so you only need
2128to compile this single file.
2129.PP
2130\fI\s-1LIBEVENT\s0 \s-1COMPATIBILITY\s0 \s-1API\s0\fR
2131.IX Subsection "LIBEVENT COMPATIBILITY API"
2132.PP
2133To include the libevent compatibility \s-1API\s0, also include:
2134.PP
2135.Vb 1
2136\& #include "event.c"
2137.Ve
2138.PP
2139in the file including \fIev.c\fR, and:
2140.PP
2141.Vb 1
2142\& #include "event.h"
2143.Ve
2144.PP
2145in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR.
2146.PP
2147You need the following additional files for this:
2148.PP
2149.Vb 2
2150\& event.h
2151\& event.c
2152.Ve
2153.PP
2154\fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR
2155.IX Subsection "AUTOCONF SUPPORT"
2156.PP
2157Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your config in
2158whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your
2159\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then
2160include \fIconfig.h\fR and configure itself accordingly.
2161.PP
2162For this of course you need the m4 file:
2163.PP
2164.Vb 1
2165\& libev.m4
2166.Ve
2167.Sh "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0"
2168.IX Subsection "PREPROCESSOR SYMBOLS/MACROS"
2169Libev can be configured via a variety of preprocessor symbols you have to define
2170before including any of its files. The default is not to build for multiplicity
2171and only include the select backend.
2172.IP "\s-1EV_STANDALONE\s0" 4
2173.IX Item "EV_STANDALONE"
2174Must always be \f(CW1\fR if you do not use autoconf configuration, which
2175keeps libev from including \fIconfig.h\fR, and it also defines dummy
2176implementations for some libevent functions (such as logging, which is not
2177supported). It will also not define any of the structs usually found in
2178\&\fIevent.h\fR that are not directly supported by the libev core alone.
2179.IP "\s-1EV_USE_MONOTONIC\s0" 4
2180.IX Item "EV_USE_MONOTONIC"
2181If defined to be \f(CW1\fR, libev will try to detect the availability of the
2182monotonic clock option at both compiletime and runtime. Otherwise no use
2183of the monotonic clock option will be attempted. If you enable this, you
2184usually have to link against librt or something similar. Enabling it when
2185the functionality isn't available is safe, though, althoguh you have
2186to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR
2187function is hiding in (often \fI\-lrt\fR).
2188.IP "\s-1EV_USE_REALTIME\s0" 4
2189.IX Item "EV_USE_REALTIME"
2190If defined to be \f(CW1\fR, libev will try to detect the availability of the
2191realtime clock option at compiletime (and assume its availability at
2192runtime if successful). Otherwise no use of the realtime clock option will
2193be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR by \f(CW\*(C`clock_get
2194(CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect correctness. See tzhe note about libraries
2195in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though.
2196.IP "\s-1EV_USE_SELECT\s0" 4
2197.IX Item "EV_USE_SELECT"
2198If undefined or defined to be \f(CW1\fR, libev will compile in support for the
2199\&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at autodetection will be done: if no
2200other method takes over, select will be it. Otherwise the select backend
2201will not be compiled in.
2202.IP "\s-1EV_SELECT_USE_FD_SET\s0" 4
2203.IX Item "EV_SELECT_USE_FD_SET"
2204If defined to \f(CW1\fR, then the select backend will use the system \f(CW\*(C`fd_set\*(C'\fR
2205structure. This is useful if libev doesn't compile due to a missing
2206\&\f(CW\*(C`NFDBITS\*(C'\fR or \f(CW\*(C`fd_mask\*(C'\fR definition or it misguesses the bitset layout on
2207exotic systems. This usually limits the range of file descriptors to some
2208low limit such as 1024 or might have other limitations (winsocket only
2209allows 64 sockets). The \f(CW\*(C`FD_SETSIZE\*(C'\fR macro, set before compilation, might
2210influence the size of the \f(CW\*(C`fd_set\*(C'\fR used.
2211.IP "\s-1EV_SELECT_IS_WINSOCKET\s0" 4
2212.IX Item "EV_SELECT_IS_WINSOCKET"
2213When defined to \f(CW1\fR, the select backend will assume that
2214select/socket/connect etc. don't understand file descriptors but
2215wants osf handles on win32 (this is the case when the select to
2216be used is the winsock select). This means that it will call
2217\&\f(CW\*(C`_get_osfhandle\*(C'\fR on the fd to convert it to an \s-1OS\s0 handle. Otherwise,
2218it is assumed that all these functions actually work on fds, even
2219on win32. Should not be defined on non\-win32 platforms.
2220.IP "\s-1EV_USE_POLL\s0" 4
2221.IX Item "EV_USE_POLL"
2222If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2)
2223backend. Otherwise it will be enabled on non\-win32 platforms. It
2224takes precedence over select.
2225.IP "\s-1EV_USE_EPOLL\s0" 4
2226.IX Item "EV_USE_EPOLL"
2227If defined to be \f(CW1\fR, libev will compile in support for the Linux
2228\&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime,
2229otherwise another method will be used as fallback. This is the
2230preferred backend for GNU/Linux systems.
2231.IP "\s-1EV_USE_KQUEUE\s0" 4
2232.IX Item "EV_USE_KQUEUE"
2233If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style
2234\&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime,
2235otherwise another method will be used as fallback. This is the preferred
2236backend for \s-1BSD\s0 and BSD-like systems, although on most BSDs kqueue only
2237supports some types of fds correctly (the only platform we found that
2238supports ptys for example was NetBSD), so kqueue might be compiled in, but
2239not be used unless explicitly requested. The best way to use it is to find
2240out whether kqueue supports your type of fd properly and use an embedded
2241kqueue loop.
2242.IP "\s-1EV_USE_PORT\s0" 4
2243.IX Item "EV_USE_PORT"
2244If defined to be \f(CW1\fR, libev will compile in support for the Solaris
224510 port style backend. Its availability will be detected at runtime,
2246otherwise another method will be used as fallback. This is the preferred
2247backend for Solaris 10 systems.
2248.IP "\s-1EV_USE_DEVPOLL\s0" 4
2249.IX Item "EV_USE_DEVPOLL"
2250reserved for future expansion, works like the \s-1USE\s0 symbols above.
2251.IP "\s-1EV_USE_INOTIFY\s0" 4
2252.IX Item "EV_USE_INOTIFY"
2253If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify
2254interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will
2255be detected at runtime.
2256.IP "\s-1EV_H\s0" 4
2257.IX Item "EV_H"
2258The name of the \fIev.h\fR header file used to include it. The default if
2259undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This
2260can be used to virtually rename the \fIev.h\fR header file in case of conflicts.
2261.IP "\s-1EV_CONFIG_H\s0" 4
2262.IX Item "EV_CONFIG_H"
2263If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override
2264\&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to
2265\&\f(CW\*(C`EV_H\*(C'\fR, above.
2266.IP "\s-1EV_EVENT_H\s0" 4
2267.IX Item "EV_EVENT_H"
2268Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea
2269of how the \fIevent.h\fR header can be found.
2270.IP "\s-1EV_PROTOTYPES\s0" 4
2271.IX Item "EV_PROTOTYPES"
2272If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function
2273prototypes, but still define all the structs and other symbols. This is
2274occasionally useful if you want to provide your own wrapper functions
2275around libev functions.
2276.IP "\s-1EV_MULTIPLICITY\s0" 4
2277.IX Item "EV_MULTIPLICITY"
2278If undefined or defined to \f(CW1\fR, then all event-loop-specific functions
2279will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create
2280additional independent event loops. Otherwise there will be no support
2281for multiple event loops and there is no first event loop pointer
2282argument. Instead, all functions act on the single default loop.
2283.IP "\s-1EV_MINPRI\s0" 4
2284.IX Item "EV_MINPRI"
2285.PD 0
2286.IP "\s-1EV_MAXPRI\s0" 4
2287.IX Item "EV_MAXPRI"
2288.PD
2289The range of allowed priorities. \f(CW\*(C`EV_MINPRI\*(C'\fR must be smaller or equal to
2290\&\f(CW\*(C`EV_MAXPRI\*(C'\fR, but otherwise there are no non-obvious limitations. You can
2291provide for more priorities by overriding those symbols (usually defined
2292to be \f(CW\*(C`\-2\*(C'\fR and \f(CW2\fR, respectively).
2293.Sp
2294When doing priority-based operations, libev usually has to linearly search
2295all the priorities, so having many of them (hundreds) uses a lot of space
2296and time, so using the defaults of five priorities (\-2 .. +2) is usually
2297fine.
2298.Sp
2299If your embedding app does not need any priorities, defining these both to
2300\&\f(CW0\fR will save some memory and cpu.
2301.IP "\s-1EV_PERIODIC_ENABLE\s0" 4
2302.IX Item "EV_PERIODIC_ENABLE"
2303If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If
2304defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of
2305code.
2306.IP "\s-1EV_IDLE_ENABLE\s0" 4
2307.IX Item "EV_IDLE_ENABLE"
2308If undefined or defined to be \f(CW1\fR, then idle watchers are supported. If
2309defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of
2310code.
2311.IP "\s-1EV_EMBED_ENABLE\s0" 4
2312.IX Item "EV_EMBED_ENABLE"
2313If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If
2314defined to be \f(CW0\fR, then they are not.
2315.IP "\s-1EV_STAT_ENABLE\s0" 4
2316.IX Item "EV_STAT_ENABLE"
2317If undefined or defined to be \f(CW1\fR, then stat watchers are supported. If
2318defined to be \f(CW0\fR, then they are not.
2319.IP "\s-1EV_FORK_ENABLE\s0" 4
2320.IX Item "EV_FORK_ENABLE"
2321If undefined or defined to be \f(CW1\fR, then fork watchers are supported. If
2322defined to be \f(CW0\fR, then they are not.
2323.IP "\s-1EV_MINIMAL\s0" 4
2324.IX Item "EV_MINIMAL"
2325If you need to shave off some kilobytes of code at the expense of some
2326speed, define this symbol to \f(CW1\fR. Currently only used for gcc to override
2327some inlining decisions, saves roughly 30% codesize of amd64.
2328.IP "\s-1EV_PID_HASHSIZE\s0" 4
2329.IX Item "EV_PID_HASHSIZE"
2330\&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by
2331pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more
2332than enough. If you need to manage thousands of children you might want to
2333increase this value (\fImust\fR be a power of two).
2334.IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4
2335.IX Item "EV_INOTIFY_HASHSIZE"
2336\&\f(CW\*(C`ev_staz\*(C'\fR watchers use a small hash table to distribute workload by
2337inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR),
2338usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR
2339watchers you might want to increase this value (\fImust\fR be a power of
2340two).
2341.IP "\s-1EV_COMMON\s0" 4
2342.IX Item "EV_COMMON"
2343By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining
2344this macro to a something else you can include more and other types of
2345members. You have to define it each time you include one of the files,
2346though, and it must be identical each time.
2347.Sp
2348For example, the perl \s-1EV\s0 module uses something like this:
2349.Sp
2350.Vb 3
2351\& #define EV_COMMON \e
2352\& SV *self; /* contains this struct */ \e
2353\& SV *cb_sv, *fh /* note no trailing ";" */
2354.Ve
2355.IP "\s-1EV_CB_DECLARE\s0 (type)" 4
2356.IX Item "EV_CB_DECLARE (type)"
2357.PD 0
2358.IP "\s-1EV_CB_INVOKE\s0 (watcher, revents)" 4
2359.IX Item "EV_CB_INVOKE (watcher, revents)"
2360.IP "ev_set_cb (ev, cb)" 4
2361.IX Item "ev_set_cb (ev, cb)"
2362.PD
2363Can be used to change the callback member declaration in each watcher,
2364and the way callbacks are invoked and set. Must expand to a struct member
2365definition and a statement, respectively. See the \fIev.v\fR header file for
2366their default definitions. One possible use for overriding these is to
2367avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use
2368method calls instead of plain function calls in \*(C+.
2369.Sh "\s-1EXAMPLES\s0"
2370.IX Subsection "EXAMPLES"
2371For a real-world example of a program the includes libev
2372verbatim, you can have a look at the \s-1EV\s0 perl module
2373(<http://software.schmorp.de/pkg/EV.html>). It has the libev files in
2374the \fIlibev/\fR subdirectory and includes them in the \fI\s-1EV/EVAPI\s0.h\fR (public
2375interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file
2376will be compiled. It is pretty complex because it provides its own header
2377file.
2378.Sp
2379The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file
2380that everybody includes and which overrides some configure choices:
2381.Sp
2382.Vb 9
2383\& #define EV_MINIMAL 1
2384\& #define EV_USE_POLL 0
2385\& #define EV_MULTIPLICITY 0
2386\& #define EV_PERIODIC_ENABLE 0
2387\& #define EV_STAT_ENABLE 0
2388\& #define EV_FORK_ENABLE 0
2389\& #define EV_CONFIG_H <config.h>
2390\& #define EV_MINPRI 0
2391\& #define EV_MAXPRI 0
2392.Ve
2393.Sp
2394.Vb 1
2395\& #include "ev++.h"
2396.Ve
2397.Sp
2398And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled:
2399.Sp
2400.Vb 2
2401\& #include "ev_cpp.h"
2402\& #include "ev.c"
2403.Ve
2404.SH "COMPLEXITIES"
2405.IX Header "COMPLEXITIES"
2406In this section the complexities of (many of) the algorithms used inside
2407libev will be explained. For complexity discussions about backends see the
2408documentation for \f(CW\*(C`ev_default_init\*(C'\fR.
2409.RS 4
2410.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4
2411.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)"
2412This means that, when you have a watcher that triggers in one hour and
2413there are 100 watchers that would trigger before that then inserting will
2414have to skip those 100 watchers.
2415.IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4
2416.IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)"
2417That means that for changing a timer costs less than removing/adding them
2418as only the relative motion in the event queue has to be paid for.
2419.IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4
2420.IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)"
2421These just add the watcher into an array or at the head of a list. If
2422the array needs to be extended libev needs to realloc and move the whole
2423array, but this happen asymptotically less and less with more watchers,
2424thus amortised O(1).
2425.IP "Stopping check/prepare/idle watchers: O(1)" 4
2426.IX Item "Stopping check/prepare/idle watchers: O(1)"
2427.PD 0
2428.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4
2429.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))"
2430.PD
2431These watchers are stored in lists then need to be walked to find the
2432correct watcher to remove. The lists are usually short (you don't usually
2433have many watchers waiting for the same fd or signal).
2434.IP "Finding the next timer per loop iteration: O(1)" 4
2435.IX Item "Finding the next timer per loop iteration: O(1)"
2436.PD 0
2437.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4
2438.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)"
2439.PD
2440A change means an I/O watcher gets started or stopped, which requires
2441libev to recalculate its status (and possibly tell the kernel).
2442.IP "Activating one watcher: O(1)" 4
2443.IX Item "Activating one watcher: O(1)"
2444.PD 0
2445.IP "Priority handling: O(number_of_priorities)" 4
2446.IX Item "Priority handling: O(number_of_priorities)"
2447.PD
2448Priorities are implemented by allocating some space for each
2449priority. When doing priority-based operations, libev usually has to
2450linearly search all the priorities.
2451.RE
2452.RS 4
1267.SH "AUTHOR" 2453.SH "AUTHOR"
1268.IX Header "AUTHOR" 2454.IX Header "AUTHOR"
1269Marc Lehmann <libev@schmorp.de>. 2455Marc Lehmann <libev@schmorp.de>.

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines