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

Comparing libev/ev.3 (file contents):
Revision 1.63 by root, Wed Apr 2 15:23:11 2008 UTC vs.
Revision 1.70 by root, Sun Jul 6 03:36:51 2008 UTC

129. ds Ae AE 129. ds Ae AE
130.\} 130.\}
131.rm #[ #] #H #V #F C 131.rm #[ #] #H #V #F C
132.\" ======================================================================== 132.\" ========================================================================
133.\" 133.\"
134.IX Title "EV 1" 134.IX Title "LIBEV 3"
135.TH EV 1 "2008-04-02" "perl v5.10.0" "User Contributed Perl Documentation" 135.TH LIBEV 3 "2008-07-05" "libev-3.43" "libev - high performance full featured event loop"
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes 136.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents. 137.\" way too many mistakes in technical documents.
138.if n .ad l 138.if n .ad l
139.nh 139.nh
140.SH "NAME" 140.SH "NAME"
141libev \- a high performance full\-featured event loop written in C 141libev \- a high performance full\-featured event loop written in C
142.SH "SYNOPSIS" 142.SH "SYNOPSIS"
143.IX Header "SYNOPSIS" 143.IX Header "SYNOPSIS"
144.Vb 1 144.Vb 1
145\& #include <ev.h> 145\& #include <ev.h>
146.Ve 146.Ve
147.Sh "\s-1EXAMPLE\s0 \s-1PROGRAM\s0" 147.Sh "\s-1EXAMPLE\s0 \s-1PROGRAM\s0"
148.IX Subsection "EXAMPLE PROGRAM" 148.IX Subsection "EXAMPLE PROGRAM"
149.Vb 2 149.Vb 2
150\& // a single header file is required 150\& // a single header file is required
151\& #include <ev.h> 151\& #include <ev.h>
152\& 152\&
153\& // every watcher type has its own typedef\*(Aqd struct 153\& // every watcher type has its own typedef\*(Aqd struct
154\& // with the name ev_<type> 154\& // with the name ev_<type>
155\& ev_io stdin_watcher; 155\& ev_io stdin_watcher;
156\& ev_timer timeout_watcher; 156\& ev_timer timeout_watcher;
157\& 157\&
158\& // all watcher callbacks have a similar signature 158\& // all watcher callbacks have a similar signature
159\& // this callback is called when data is readable on stdin 159\& // this callback is called when data is readable on stdin
160\& static void 160\& static void
161\& stdin_cb (EV_P_ struct ev_io *w, int revents) 161\& stdin_cb (EV_P_ struct ev_io *w, int revents)
162\& { 162\& {
163\& puts ("stdin ready"); 163\& puts ("stdin ready");
164\& // for one\-shot events, one must manually stop the watcher 164\& // for one\-shot events, one must manually stop the watcher
165\& // with its corresponding stop function. 165\& // with its corresponding stop function.
166\& ev_io_stop (EV_A_ w); 166\& ev_io_stop (EV_A_ w);
167\& 167\&
168\& // this causes all nested ev_loop\*(Aqs to stop iterating 168\& // this causes all nested ev_loop\*(Aqs to stop iterating
169\& ev_unloop (EV_A_ EVUNLOOP_ALL); 169\& ev_unloop (EV_A_ EVUNLOOP_ALL);
170\& } 170\& }
171\& 171\&
172\& // another callback, this time for a time\-out 172\& // another callback, this time for a time\-out
173\& static void 173\& static void
174\& timeout_cb (EV_P_ struct ev_timer *w, int revents) 174\& timeout_cb (EV_P_ struct ev_timer *w, int revents)
175\& { 175\& {
176\& puts ("timeout"); 176\& puts ("timeout");
177\& // this causes the innermost ev_loop to stop iterating 177\& // this causes the innermost ev_loop to stop iterating
178\& ev_unloop (EV_A_ EVUNLOOP_ONE); 178\& ev_unloop (EV_A_ EVUNLOOP_ONE);
179\& } 179\& }
180\& 180\&
181\& int 181\& int
182\& main (void) 182\& main (void)
183\& { 183\& {
184\& // use the default event loop unless you have special needs 184\& // use the default event loop unless you have special needs
185\& struct ev_loop *loop = ev_default_loop (0); 185\& struct ev_loop *loop = ev_default_loop (0);
186\& 186\&
187\& // initialise an io watcher, then start it 187\& // initialise an io watcher, then start it
188\& // this one will watch for stdin to become readable 188\& // this one will watch for stdin to become readable
189\& ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); 189\& ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
190\& ev_io_start (loop, &stdin_watcher); 190\& ev_io_start (loop, &stdin_watcher);
191\& 191\&
192\& // initialise a timer watcher, then start it 192\& // initialise a timer watcher, then start it
193\& // simple non\-repeating 5.5 second timeout 193\& // simple non\-repeating 5.5 second timeout
194\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); 194\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
195\& ev_timer_start (loop, &timeout_watcher); 195\& ev_timer_start (loop, &timeout_watcher);
196\& 196\&
197\& // now wait for events to arrive 197\& // now wait for events to arrive
198\& ev_loop (loop, 0); 198\& ev_loop (loop, 0);
199\& 199\&
200\& // unloop was called, so exit 200\& // unloop was called, so exit
201\& return 0; 201\& return 0;
202\& } 202\& }
203.Ve 203.Ve
204.SH "DESCRIPTION" 204.SH "DESCRIPTION"
205.IX Header "DESCRIPTION" 205.IX Header "DESCRIPTION"
206The newest version of this document is also available as an html-formatted 206The newest version of this document is also available as an html-formatted
207web page you might find easier to navigate when reading it for the first 207web page you might find easier to navigate when reading it for the first
208time: <http://cvs.schmorp.de/libev/ev.html>. 208time: <http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>.
209.PP 209.PP
210Libev is an event loop: you register interest in certain events (such as a 210Libev is an event loop: you register interest in certain events (such as a
211file descriptor being readable or a timeout occurring), and it will manage 211file descriptor being readable or a timeout occurring), and it will manage
212these event sources and provide your program with events. 212these event sources and provide your program with events.
213.PP 213.PP
249Libev represents time as a single floating point number, representing the 249Libev represents time as a single floating point number, representing the
250(fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near 250(fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near
251the beginning of 1970, details are complicated, don't ask). This type is 251the beginning of 1970, details are complicated, don't ask). This type is
252called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually aliases 252called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually aliases
253to the \f(CW\*(C`double\*(C'\fR type in C, and when you need to do any calculations on 253to the \f(CW\*(C`double\*(C'\fR type in C, and when you need to do any calculations on
254it, you should treat it as some floatingpoint value. Unlike the name 254it, you should treat it as some floating point value. Unlike the name
255component \f(CW\*(C`stamp\*(C'\fR might indicate, it is also used for time differences 255component \f(CW\*(C`stamp\*(C'\fR might indicate, it is also used for time differences
256throughout libev. 256throughout libev.
257.SH "ERROR HANDLING"
258.IX Header "ERROR HANDLING"
259Libev knows three classes of errors: operating system errors, usage errors
260and internal errors (bugs).
261.PP
262When libev catches an operating system error it cannot handle (for example
263a system call indicating a condition libev cannot fix), it calls the callback
264set via \f(CW\*(C`ev_set_syserr_cb\*(C'\fR, which is supposed to fix the problem or
265abort. The default is to print a diagnostic message and to call \f(CW\*(C`abort
266()\*(C'\fR.
267.PP
268When libev detects a usage error such as a negative timer interval, then
269it will print a diagnostic message and abort (via the \f(CW\*(C`assert\*(C'\fR mechanism,
270so \f(CW\*(C`NDEBUG\*(C'\fR will disable this checking): these are programming errors in
271the libev caller and need to be fixed there.
272.PP
273Libev also has a few internal error-checking \f(CW\*(C`assert\*(C'\fRions, and also has
274extensive consistency checking code. These do not trigger under normal
275circumstances, as they indicate either a bug in libev or worse.
257.SH "GLOBAL FUNCTIONS" 276.SH "GLOBAL FUNCTIONS"
258.IX Header "GLOBAL FUNCTIONS" 277.IX Header "GLOBAL FUNCTIONS"
259These functions can be called anytime, even before initialising the 278These functions can be called anytime, even before initialising the
260library in any way. 279library in any way.
261.IP "ev_tstamp ev_time ()" 4 280.IP "ev_tstamp ev_time ()" 4
265you actually want to know. 284you actually want to know.
266.IP "ev_sleep (ev_tstamp interval)" 4 285.IP "ev_sleep (ev_tstamp interval)" 4
267.IX Item "ev_sleep (ev_tstamp interval)" 286.IX Item "ev_sleep (ev_tstamp interval)"
268Sleep for the given interval: The current thread will be blocked until 287Sleep for the given interval: The current thread will be blocked until
269either it is interrupted or the given time interval has passed. Basically 288either it is interrupted or the given time interval has passed. Basically
270this is a subsecond-resolution \f(CW\*(C`sleep ()\*(C'\fR. 289this is a sub-second-resolution \f(CW\*(C`sleep ()\*(C'\fR.
271.IP "int ev_version_major ()" 4 290.IP "int ev_version_major ()" 4
272.IX Item "int ev_version_major ()" 291.IX Item "int ev_version_major ()"
273.PD 0 292.PD 0
274.IP "int ev_version_minor ()" 4 293.IP "int ev_version_minor ()" 4
275.IX Item "int ev_version_minor ()" 294.IX Item "int ev_version_minor ()"
290.Sp 309.Sp
291Example: Make sure we haven't accidentally been linked against the wrong 310Example: Make sure we haven't accidentally been linked against the wrong
292version. 311version.
293.Sp 312.Sp
294.Vb 3 313.Vb 3
295\& assert (("libev version mismatch", 314\& assert (("libev version mismatch",
296\& ev_version_major () == EV_VERSION_MAJOR 315\& ev_version_major () == EV_VERSION_MAJOR
297\& && ev_version_minor () >= EV_VERSION_MINOR)); 316\& && ev_version_minor () >= EV_VERSION_MINOR));
298.Ve 317.Ve
299.IP "unsigned int ev_supported_backends ()" 4 318.IP "unsigned int ev_supported_backends ()" 4
300.IX Item "unsigned int ev_supported_backends ()" 319.IX Item "unsigned int ev_supported_backends ()"
301Return the set of all backends (i.e. their corresponding \f(CW\*(C`EV_BACKEND_*\*(C'\fR 320Return the set of all backends (i.e. their corresponding \f(CW\*(C`EV_BACKEND_*\*(C'\fR
302value) compiled into this binary of libev (independent of their 321value) compiled into this binary of libev (independent of their
305.Sp 324.Sp
306Example: make sure we have the epoll method, because yeah this is cool and 325Example: make sure we have the epoll method, because yeah this is cool and
307a must have and can we have a torrent of it please!!!11 326a must have and can we have a torrent of it please!!!11
308.Sp 327.Sp
309.Vb 2 328.Vb 2
310\& assert (("sorry, no epoll, no sex", 329\& assert (("sorry, no epoll, no sex",
311\& ev_supported_backends () & EVBACKEND_EPOLL)); 330\& ev_supported_backends () & EVBACKEND_EPOLL));
312.Ve 331.Ve
313.IP "unsigned int ev_recommended_backends ()" 4 332.IP "unsigned int ev_recommended_backends ()" 4
314.IX Item "unsigned int ev_recommended_backends ()" 333.IX Item "unsigned int ev_recommended_backends ()"
315Return the set of all backends compiled into this binary of libev and also 334Return the set of all backends compiled into this binary of libev and also
316recommended for this platform. This set is often smaller than the one 335recommended for this platform. This set is often smaller than the one
317returned by \f(CW\*(C`ev_supported_backends\*(C'\fR, as for example kqueue is broken on 336returned by \f(CW\*(C`ev_supported_backends\*(C'\fR, as for example kqueue is broken on
318most BSDs and will not be autodetected unless you explicitly request it 337most BSDs and will not be auto-detected unless you explicitly request it
319(assuming you know what you are doing). This is the set of backends that 338(assuming you know what you are doing). This is the set of backends that
320libev will probe for if you specify no backends explicitly. 339libev will probe for if you specify no backends explicitly.
321.IP "unsigned int ev_embeddable_backends ()" 4 340.IP "unsigned int ev_embeddable_backends ()" 4
322.IX Item "unsigned int ev_embeddable_backends ()" 341.IX Item "unsigned int ev_embeddable_backends ()"
323Returns the set of backends that are embeddable in other event loops. This 342Returns the set of backends that are embeddable in other event loops. This
328.Sp 347.Sp
329See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. 348See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
330.IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4 349.IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4
331.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" 350.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))"
332Sets the allocation function to use (the prototype is similar \- the 351Sets the allocation function to use (the prototype is similar \- the
333semantics is identical \- to the realloc C function). It is used to 352semantics are identical to the \f(CW\*(C`realloc\*(C'\fR C89/SuS/POSIX function). It is
334allocate and free memory (no surprises here). If it returns zero when 353used to allocate and free memory (no surprises here). If it returns zero
335memory needs to be allocated, the library might abort or take some 354when memory needs to be allocated (\f(CW\*(C`size != 0\*(C'\fR), the library might abort
336potentially destructive action. The default is your system realloc 355or take some potentially destructive action.
337function. 356.Sp
357Since some systems (at least OpenBSD and Darwin) fail to implement
358correct \f(CW\*(C`realloc\*(C'\fR semantics, libev will use a wrapper around the system
359\&\f(CW\*(C`realloc\*(C'\fR and \f(CW\*(C`free\*(C'\fR functions by default.
338.Sp 360.Sp
339You could override this function in high-availability programs to, say, 361You could override this function in high-availability programs to, say,
340free some memory if it cannot allocate memory, to use a special allocator, 362free some memory if it cannot allocate memory, to use a special allocator,
341or even to sleep a while and retry until some memory is available. 363or even to sleep a while and retry until some memory is available.
342.Sp 364.Sp
343Example: Replace the libev allocator with one that waits a bit and then 365Example: Replace the libev allocator with one that waits a bit and then
344retries). 366retries (example requires a standards-compliant \f(CW\*(C`realloc\*(C'\fR).
345.Sp 367.Sp
346.Vb 6 368.Vb 6
347\& static void * 369\& static void *
348\& persistent_realloc (void *ptr, size_t size) 370\& persistent_realloc (void *ptr, size_t size)
349\& { 371\& {
361\& ... 383\& ...
362\& ev_set_allocator (persistent_realloc); 384\& ev_set_allocator (persistent_realloc);
363.Ve 385.Ve
364.IP "ev_set_syserr_cb (void (*cb)(const char *msg));" 4 386.IP "ev_set_syserr_cb (void (*cb)(const char *msg));" 4
365.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg));" 387.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg));"
366Set the callback function to call on a retryable syscall error (such 388Set the callback function to call on a retryable system call error (such
367as failed select, poll, epoll_wait). The message is a printable string 389as failed select, poll, epoll_wait). The message is a printable string
368indicating the system call or subsystem causing the problem. If this 390indicating the system call or subsystem causing the problem. If this
369callback is set, then libev will expect it to remedy the sitution, no 391callback is set, then libev will expect it to remedy the situation, no
370matter what, when it returns. That is, libev will generally retry the 392matter what, when it returns. That is, libev will generally retry the
371requested operation, or, if the condition doesn't go away, do bad stuff 393requested operation, or, if the condition doesn't go away, do bad stuff
372(such as abort). 394(such as abort).
373.Sp 395.Sp
374Example: This is basically the same thing that libev does internally, too. 396Example: This is basically the same thing that libev does internally, too.
387.SH "FUNCTIONS CONTROLLING THE EVENT LOOP" 409.SH "FUNCTIONS CONTROLLING THE EVENT LOOP"
388.IX Header "FUNCTIONS CONTROLLING THE EVENT LOOP" 410.IX Header "FUNCTIONS CONTROLLING THE EVENT LOOP"
389An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR. The library knows two 411An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR. The library knows two
390types of such loops, the \fIdefault\fR loop, which supports signals and child 412types of such loops, the \fIdefault\fR loop, which supports signals and child
391events, and dynamically created loops which do not. 413events, and dynamically created loops which do not.
392.PP
393If you use threads, a common model is to run the default event loop
394in your main thread (or in a separate thread) and for each thread you
395create, you also create another event loop. Libev itself does no locking
396whatsoever, so if you mix calls to the same event loop in different
397threads, make sure you lock (this is usually a bad idea, though, even if
398done correctly, because it's hideous and inefficient).
399.IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4 414.IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4
400.IX Item "struct ev_loop *ev_default_loop (unsigned int flags)" 415.IX Item "struct ev_loop *ev_default_loop (unsigned int flags)"
401This will initialise the default event loop if it hasn't been initialised 416This will initialise the default event loop if it hasn't been initialised
402yet and return it. If the default loop could not be initialised, returns 417yet and return it. If the default loop could not be initialised, returns
403false. If it already was initialised it simply returns it (and ignores the 418false. If it already was initialised it simply returns it (and ignores the
410from multiple threads, you have to lock (note also that this is unlikely, 425from multiple threads, you have to lock (note also that this is unlikely,
411as loops cannot bes hared easily between threads anyway). 426as loops cannot bes hared easily between threads anyway).
412.Sp 427.Sp
413The default loop is the only loop that can handle \f(CW\*(C`ev_signal\*(C'\fR and 428The default loop is the only loop that can handle \f(CW\*(C`ev_signal\*(C'\fR and
414\&\f(CW\*(C`ev_child\*(C'\fR watchers, and to do this, it always registers a handler 429\&\f(CW\*(C`ev_child\*(C'\fR watchers, and to do this, it always registers a handler
415for \f(CW\*(C`SIGCHLD\*(C'\fR. If this is a problem for your app you can either 430for \f(CW\*(C`SIGCHLD\*(C'\fR. If this is a problem for your application you can either
416create a dynamic loop with \f(CW\*(C`ev_loop_new\*(C'\fR that doesn't do that, or you 431create a dynamic loop with \f(CW\*(C`ev_loop_new\*(C'\fR that doesn't do that, or you
417can simply overwrite the \f(CW\*(C`SIGCHLD\*(C'\fR signal handler \fIafter\fR calling 432can simply overwrite the \f(CW\*(C`SIGCHLD\*(C'\fR signal handler \fIafter\fR calling
418\&\f(CW\*(C`ev_default_init\*(C'\fR. 433\&\f(CW\*(C`ev_default_init\*(C'\fR.
419.Sp 434.Sp
420The flags argument can be used to specify special behaviour or specific 435The flags argument can be used to specify special behaviour or specific
428The default flags value. Use this if you have no clue (it's the right 443The default flags value. Use this if you have no clue (it's the right
429thing, believe me). 444thing, believe me).
430.ie n .IP """EVFLAG_NOENV""" 4 445.ie n .IP """EVFLAG_NOENV""" 4
431.el .IP "\f(CWEVFLAG_NOENV\fR" 4 446.el .IP "\f(CWEVFLAG_NOENV\fR" 4
432.IX Item "EVFLAG_NOENV" 447.IX Item "EVFLAG_NOENV"
433If this flag bit is ored into the flag value (or the program runs setuid 448If this flag bit is or'ed into the flag value (or the program runs setuid
434or setgid) then libev will \fInot\fR look at the environment variable 449or setgid) then libev will \fInot\fR look at the environment variable
435\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will 450\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will
436override the flags completely if it is found in the environment. This is 451override the flags completely if it is found in the environment. This is
437useful to try out specific backends to test their performance, or to work 452useful to try out specific backends to test their performance, or to work
438around bugs. 453around bugs.
445.Sp 460.Sp
446This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, 461This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop,
447and thus this might slow down your event loop if you do a lot of loop 462and thus this might slow down your event loop if you do a lot of loop
448iterations and little real work, but is usually not noticeable (on my 463iterations and little real work, but is usually not noticeable (on my
449GNU/Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence 464GNU/Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence
450without a syscall and thus \fIvery\fR fast, but my GNU/Linux system also has 465without a system call and thus \fIvery\fR fast, but my GNU/Linux system also has
451\&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). 466\&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster).
452.Sp 467.Sp
453The big advantage of this flag is that you can forget about fork (and 468The big advantage of this flag is that you can forget about fork (and
454forget about forgetting to tell libev about forking) when you use this 469forget about forgetting to tell libev about forking) when you use this
455flag. 470flag.
456.Sp 471.Sp
457This flag setting cannot be overriden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR 472This flag setting cannot be overridden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR
458environment variable. 473environment variable.
459.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 474.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4
460.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 475.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4
461.IX Item "EVBACKEND_SELECT (value 1, portable select backend)" 476.IX Item "EVBACKEND_SELECT (value 1, portable select backend)"
462This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as 477This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as
464but if that fails, expect a fairly low limit on the number of fds when 479but if that fails, expect a fairly low limit on the number of fds when
465using this backend. It doesn't scale too well (O(highest_fd)), but its 480using this backend. It doesn't scale too well (O(highest_fd)), but its
466usually the fastest backend for a low number of (low-numbered :) fds. 481usually the fastest backend for a low number of (low-numbered :) fds.
467.Sp 482.Sp
468To get good performance out of this backend you need a high amount of 483To get good performance out of this backend you need a high amount of
469parallelity (most of the file descriptors should be busy). If you are 484parallelism (most of the file descriptors should be busy). If you are
470writing a server, you should \f(CW\*(C`accept ()\*(C'\fR in a loop to accept as many 485writing a server, you should \f(CW\*(C`accept ()\*(C'\fR in a loop to accept as many
471connections as possible during one iteration. You might also want to have 486connections as possible during one iteration. You might also want to have
472a look at \f(CW\*(C`ev_set_io_collect_interval ()\*(C'\fR to increase the amount of 487a look at \f(CW\*(C`ev_set_io_collect_interval ()\*(C'\fR to increase the amount of
473readyness notifications you get per iteration. 488readiness notifications you get per iteration.
474.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4 489.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4
475.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4 490.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4
476.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)" 491.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)"
477And this is your standard \fIpoll\fR\|(2) backend. It's more complicated 492And this is your standard \fIpoll\fR\|(2) backend. It's more complicated
478than select, but handles sparse fds better and has no artificial 493than select, but handles sparse fds better and has no artificial
486For few fds, this backend is a bit little slower than poll and select, 501For few fds, this backend is a bit little slower than poll and select,
487but it scales phenomenally better. While poll and select usually scale 502but it scales phenomenally better. While poll and select usually scale
488like O(total_fds) where n is the total number of fds (or the highest fd), 503like O(total_fds) where n is the total number of fds (or the highest fd),
489epoll scales either O(1) or O(active_fds). The epoll design has a number 504epoll scales either O(1) or O(active_fds). The epoll design has a number
490of shortcomings, such as silently dropping events in some hard-to-detect 505of shortcomings, such as silently dropping events in some hard-to-detect
491cases and rewiring a syscall per fd change, no fork support and bad 506cases and requiring a system call per fd change, no fork support and bad
492support for dup. 507support for dup.
493.Sp 508.Sp
494While stopping, setting and starting an I/O watcher in the same iteration 509While stopping, setting and starting an I/O watcher in the same iteration
495will result in some caching, there is still a syscall per such incident 510will result in some caching, there is still a system call per such incident
496(because the fd could point to a different file description now), so its 511(because the fd could point to a different file description now), so its
497best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors might not work 512best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors might not work
498very well if you register events for both fds. 513very well if you register events for both fds.
499.Sp 514.Sp
500Please note that epoll sometimes generates spurious notifications, so you 515Please note that epoll sometimes generates spurious notifications, so you
503.Sp 518.Sp
504Best performance from this backend is achieved by not unregistering all 519Best performance from this backend is achieved by not unregistering all
505watchers for a file descriptor until it has been closed, if possible, i.e. 520watchers for a file descriptor until it has been closed, if possible, i.e.
506keep at least one watcher active per fd at all times. 521keep at least one watcher active per fd at all times.
507.Sp 522.Sp
508While nominally embeddeble in other event loops, this feature is broken in 523While nominally embeddable in other event loops, this feature is broken in
509all kernel versions tested so far. 524all kernel versions tested so far.
510.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 525.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4
511.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4 526.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4
512.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" 527.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)"
513Kqueue deserves special mention, as at the time of this writing, it 528Kqueue deserves special mention, as at the time of this writing, it
514was broken on all BSDs except NetBSD (usually it doesn't work reliably 529was broken on all BSDs except NetBSD (usually it doesn't work reliably
515with anything but sockets and pipes, except on Darwin, where of course 530with anything but sockets and pipes, except on Darwin, where of course
516it's completely useless). For this reason it's not being \*(L"autodetected\*(R" 531it's completely useless). For this reason it's not being \*(L"auto-detected\*(R"
517unless you explicitly specify it explicitly in the flags (i.e. using 532unless you explicitly specify it explicitly in the flags (i.e. using
518\&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR) or libev was compiled on a known-to-be-good (\-enough) 533\&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR) or libev was compiled on a known-to-be-good (\-enough)
519system like NetBSD. 534system like NetBSD.
520.Sp 535.Sp
521You still can embed kqueue into a normal poll or select backend and use it 536You still can embed kqueue into a normal poll or select backend and use it
523the target platform). See \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. 538the target platform). See \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
524.Sp 539.Sp
525It scales in the same way as the epoll backend, but the interface to the 540It scales in the same way as the epoll backend, but the interface to the
526kernel is more efficient (which says nothing about its actual speed, of 541kernel is more efficient (which says nothing about its actual speed, of
527course). While stopping, setting and starting an I/O watcher does never 542course). While stopping, setting and starting an I/O watcher does never
528cause an extra syscall as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to 543cause an extra system call as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to
529two event changes per incident, support for \f(CW\*(C`fork ()\*(C'\fR is very bad and it 544two event changes per incident, support for \f(CW\*(C`fork ()\*(C'\fR is very bad and it
530drops fds silently in similarly hard-to-detect cases. 545drops fds silently in similarly hard-to-detect cases.
531.Sp 546.Sp
532This backend usually performs well under most conditions. 547This backend usually performs well under most conditions.
533.Sp 548.Sp
548.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 563.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4
549.IX Item "EVBACKEND_PORT (value 32, Solaris 10)" 564.IX Item "EVBACKEND_PORT (value 32, Solaris 10)"
550This uses the Solaris 10 event port mechanism. As with everything on Solaris, 565This uses the Solaris 10 event port mechanism. As with everything on Solaris,
551it's really slow, but it still scales very well (O(active_fds)). 566it's really slow, but it still scales very well (O(active_fds)).
552.Sp 567.Sp
553Please note that solaris event ports can deliver a lot of spurious 568Please note that Solaris event ports can deliver a lot of spurious
554notifications, so you need to use non-blocking I/O or other means to avoid 569notifications, so you need to use non-blocking I/O or other means to avoid
555blocking when no data (or space) is available. 570blocking when no data (or space) is available.
556.Sp 571.Sp
557While this backend scales well, it requires one system call per active 572While this backend scales well, it requires one system call per active
558file descriptor per loop iteration. For small and medium numbers of file 573file descriptor per loop iteration. For small and medium numbers of file
559descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend 574descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend
560might perform better. 575might perform better.
561.Sp 576.Sp
562On the positive side, ignoring the spurious readyness notifications, this 577On the positive side, ignoring the spurious readiness notifications, this
563backend actually performed to specification in all tests and is fully 578backend actually performed to specification in all tests and is fully
564embeddable, which is a rare feat among the OS-specific backends. 579embeddable, which is a rare feat among the OS-specific backends.
565.ie n .IP """EVBACKEND_ALL""" 4 580.ie n .IP """EVBACKEND_ALL""" 4
566.el .IP "\f(CWEVBACKEND_ALL\fR" 4 581.el .IP "\f(CWEVBACKEND_ALL\fR" 4
567.IX Item "EVBACKEND_ALL" 582.IX Item "EVBACKEND_ALL"
571.Sp 586.Sp
572It is definitely not recommended to use this flag. 587It is definitely not recommended to use this flag.
573.RE 588.RE
574.RS 4 589.RS 4
575.Sp 590.Sp
576If one or more of these are ored into the flags value, then only these 591If one or more of these are or'ed into the flags value, then only these
577backends will be tried (in the reverse order as listed here). If none are 592backends will be tried (in the reverse order as listed here). If none are
578specified, all backends in \f(CW\*(C`ev_recommended_backends ()\*(C'\fR will be tried. 593specified, all backends in \f(CW\*(C`ev_recommended_backends ()\*(C'\fR will be tried.
579.Sp 594.Sp
580The most typical usage is like this: 595The most typical usage is like this:
581.Sp 596.Sp
582.Vb 2 597.Vb 2
583\& if (!ev_default_loop (0)) 598\& if (!ev_default_loop (0))
584\& fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); 599\& fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
585.Ve 600.Ve
586.Sp 601.Sp
587Restrict libev to the select and poll backends, and do not allow 602Restrict libev to the select and poll backends, and do not allow
588environment settings to be taken into account: 603environment settings to be taken into account:
589.Sp 604.Sp
590.Vb 1 605.Vb 1
591\& ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV); 606\& ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
592.Ve 607.Ve
593.Sp 608.Sp
594Use whatever libev has to offer, but make sure that kqueue is used if 609Use whatever libev has to offer, but make sure that kqueue is used if
595available (warning, breaks stuff, best use only with your own private 610available (warning, breaks stuff, best use only with your own private
596event loop and only if you know the \s-1OS\s0 supports your types of fds): 611event loop and only if you know the \s-1OS\s0 supports your types of fds):
597.Sp 612.Sp
598.Vb 1 613.Vb 1
599\& ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); 614\& ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
600.Ve 615.Ve
601.RE 616.RE
602.IP "struct ev_loop *ev_loop_new (unsigned int flags)" 4 617.IP "struct ev_loop *ev_loop_new (unsigned int flags)" 4
603.IX Item "struct ev_loop *ev_loop_new (unsigned int flags)" 618.IX Item "struct ev_loop *ev_loop_new (unsigned int flags)"
604Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is 619Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is
611default loop in the \*(L"main\*(R" or \*(L"initial\*(R" thread. 626default loop in the \*(L"main\*(R" or \*(L"initial\*(R" thread.
612.Sp 627.Sp
613Example: Try to create a event loop that uses epoll and nothing else. 628Example: Try to create a event loop that uses epoll and nothing else.
614.Sp 629.Sp
615.Vb 3 630.Vb 3
616\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); 631\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
617\& if (!epoller) 632\& if (!epoller)
618\& fatal ("no epoll found here, maybe it hides under your chair"); 633\& fatal ("no epoll found here, maybe it hides under your chair");
619.Ve 634.Ve
620.IP "ev_default_destroy ()" 4 635.IP "ev_default_destroy ()" 4
621.IX Item "ev_default_destroy ()" 636.IX Item "ev_default_destroy ()"
622Destroys the default loop again (frees all memory and kernel state 637Destroys the default loop again (frees all memory and kernel state
623etc.). None of the active event watchers will be stopped in the normal 638etc.). None of the active event watchers will be stopped in the normal
624sense, so e.g. \f(CW\*(C`ev_is_active\*(C'\fR might still return true. It is your 639sense, so e.g. \f(CW\*(C`ev_is_active\*(C'\fR might still return true. It is your
625responsibility to either stop all watchers cleanly yoursef \fIbefore\fR 640responsibility to either stop all watchers cleanly yourself \fIbefore\fR
626calling this function, or cope with the fact afterwards (which is usually 641calling this function, or cope with the fact afterwards (which is usually
627the easiest thing, you can just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them 642the easiest thing, you can just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them
628for example). 643for example).
629.Sp 644.Sp
630Note that certain global state, such as signal state, will not be freed by 645Note that certain global state, such as signal state, will not be freed by
705A flags value of \f(CW\*(C`EVLOOP_NONBLOCK\*(C'\fR will look for new events, will handle 720A flags value of \f(CW\*(C`EVLOOP_NONBLOCK\*(C'\fR will look for new events, will handle
706those events and any outstanding ones, but will not block your process in 721those events and any outstanding ones, but will not block your process in
707case there are no events and will return after one iteration of the loop. 722case there are no events and will return after one iteration of the loop.
708.Sp 723.Sp
709A flags value of \f(CW\*(C`EVLOOP_ONESHOT\*(C'\fR will look for new events (waiting if 724A flags value of \f(CW\*(C`EVLOOP_ONESHOT\*(C'\fR will look for new events (waiting if
710neccessary) and will handle those and any outstanding ones. It will block 725necessary) and will handle those and any outstanding ones. It will block
711your process until at least one new event arrives, and will return after 726your process until at least one new event arrives, and will return after
712one iteration of the loop. This is useful if you are waiting for some 727one iteration of the loop. This is useful if you are waiting for some
713external event in conjunction with something not expressible using other 728external event in conjunction with something not expressible using other
714libev watchers. However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is 729libev watchers. However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is
715usually a better approach for this kind of thing. 730usually a better approach for this kind of thing.
781.Sp 796.Sp
782Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR 797Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR
783running when nothing else is active. 798running when nothing else is active.
784.Sp 799.Sp
785.Vb 4 800.Vb 4
786\& struct ev_signal exitsig; 801\& struct ev_signal exitsig;
787\& ev_signal_init (&exitsig, sig_cb, SIGINT); 802\& ev_signal_init (&exitsig, sig_cb, SIGINT);
788\& ev_signal_start (loop, &exitsig); 803\& ev_signal_start (loop, &exitsig);
789\& evf_unref (loop); 804\& evf_unref (loop);
790.Ve 805.Ve
791.Sp 806.Sp
792Example: For some weird reason, unregister the above signal handler again. 807Example: For some weird reason, unregister the above signal handler again.
793.Sp 808.Sp
794.Vb 2 809.Vb 2
795\& ev_ref (loop); 810\& ev_ref (loop);
796\& ev_signal_stop (loop, &exitsig); 811\& ev_signal_stop (loop, &exitsig);
797.Ve 812.Ve
798.IP "ev_set_io_collect_interval (loop, ev_tstamp interval)" 4 813.IP "ev_set_io_collect_interval (loop, ev_tstamp interval)" 4
799.IX Item "ev_set_io_collect_interval (loop, ev_tstamp interval)" 814.IX Item "ev_set_io_collect_interval (loop, ev_tstamp interval)"
800.PD 0 815.PD 0
801.IP "ev_set_timeout_collect_interval (loop, ev_tstamp interval)" 4 816.IP "ev_set_timeout_collect_interval (loop, ev_tstamp interval)" 4
825to spend more time collecting timeouts, at the expense of increased 840to spend more time collecting timeouts, at the expense of increased
826latency (the watcher callback will be called later). \f(CW\*(C`ev_io\*(C'\fR watchers 841latency (the watcher callback will be called later). \f(CW\*(C`ev_io\*(C'\fR watchers
827will not be affected. Setting this to a non-null value will not introduce 842will not be affected. Setting this to a non-null value will not introduce
828any overhead in libev. 843any overhead in libev.
829.Sp 844.Sp
830Many (busy) programs can usually benefit by setting the io collect 845Many (busy) programs can usually benefit by setting the I/O collect
831interval to a value near \f(CW0.1\fR or so, which is often enough for 846interval to a value near \f(CW0.1\fR or so, which is often enough for
832interactive servers (of course not for games), likewise for timeouts. It 847interactive servers (of course not for games), likewise for timeouts. It
833usually doesn't make much sense to set it to a lower value than \f(CW0.01\fR, 848usually doesn't make much sense to set it to a lower value than \f(CW0.01\fR,
834as this approsaches the timing granularity of most systems. 849as this approaches the timing granularity of most systems.
850.IP "ev_loop_verify (loop)" 4
851.IX Item "ev_loop_verify (loop)"
852This function only does something when \f(CW\*(C`EV_VERIFY\*(C'\fR support has been
853compiled in. It tries to go through all internal structures and checks
854them for validity. If anything is found to be inconsistent, it will print
855an error message to standard error and call \f(CW\*(C`abort ()\*(C'\fR.
856.Sp
857This can be used to catch bugs inside libev itself: under normal
858circumstances, this function will never abort as of course libev keeps its
859data structures consistent.
835.SH "ANATOMY OF A WATCHER" 860.SH "ANATOMY OF A WATCHER"
836.IX Header "ANATOMY OF A WATCHER" 861.IX Header "ANATOMY OF A WATCHER"
837A watcher is a structure that you create and register to record your 862A watcher is a structure that you create and register to record your
838interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to 863interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to
839become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher for that: 864become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher for that:
840.PP 865.PP
841.Vb 5 866.Vb 5
842\& static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) 867\& static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)
843\& { 868\& {
844\& ev_io_stop (w); 869\& ev_io_stop (w);
845\& ev_unloop (loop, EVUNLOOP_ALL); 870\& ev_unloop (loop, EVUNLOOP_ALL);
846\& } 871\& }
847\& 872\&
848\& struct ev_loop *loop = ev_default_loop (0); 873\& struct ev_loop *loop = ev_default_loop (0);
849\& struct ev_io stdin_watcher; 874\& struct ev_io stdin_watcher;
850\& ev_init (&stdin_watcher, my_cb); 875\& ev_init (&stdin_watcher, my_cb);
851\& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ); 876\& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
852\& ev_io_start (loop, &stdin_watcher); 877\& ev_io_start (loop, &stdin_watcher);
853\& ev_loop (loop, 0); 878\& ev_loop (loop, 0);
854.Ve 879.Ve
855.PP 880.PP
856As you can see, you are responsible for allocating the memory for your 881As you can see, you are responsible for allocating the memory for your
857watcher structures (and it is usually a bad idea to do this on the stack, 882watcher structures (and it is usually a bad idea to do this on the stack,
858although this can sometimes be quite valid). 883although this can sometimes be quite valid).
859.PP 884.PP
860Each watcher structure must be initialised by a call to \f(CW\*(C`ev_init 885Each watcher structure must be initialised by a call to \f(CW\*(C`ev_init
861(watcher *, callback)\*(C'\fR, which expects a callback to be provided. This 886(watcher *, callback)\*(C'\fR, which expects a callback to be provided. This
862callback gets invoked each time the event occurs (or, in the case of io 887callback gets invoked each time the event occurs (or, in the case of I/O
863watchers, each time the event loop detects that the file descriptor given 888watchers, each time the event loop detects that the file descriptor given
864is readable and/or writable). 889is readable and/or writable).
865.PP 890.PP
866Each watcher type has its own \f(CW\*(C`ev_<type>_set (watcher *, ...)\*(C'\fR macro 891Each watcher type has its own \f(CW\*(C`ev_<type>_set (watcher *, ...)\*(C'\fR macro
867with arguments specific to this watcher type. There is also a macro 892with arguments specific to this watcher type. There is also a macro
947.IX Item "EV_ASYNC" 972.IX Item "EV_ASYNC"
948The given async watcher has been asynchronously notified (see \f(CW\*(C`ev_async\*(C'\fR). 973The given async watcher has been asynchronously notified (see \f(CW\*(C`ev_async\*(C'\fR).
949.ie n .IP """EV_ERROR""" 4 974.ie n .IP """EV_ERROR""" 4
950.el .IP "\f(CWEV_ERROR\fR" 4 975.el .IP "\f(CWEV_ERROR\fR" 4
951.IX Item "EV_ERROR" 976.IX Item "EV_ERROR"
952An unspecified error has occured, the watcher has been stopped. This might 977An unspecified error has occurred, the watcher has been stopped. This might
953happen because the watcher could not be properly started because libev 978happen because the watcher could not be properly started because libev
954ran out of memory, a file descriptor was found to be closed or any other 979ran out of memory, a file descriptor was found to be closed or any other
955problem. You best act on it by reporting the problem and somehow coping 980problem. You best act on it by reporting the problem and somehow coping
956with the watcher being stopped. 981with the watcher being stopped.
957.Sp 982.Sp
958Libev will usually signal a few \*(L"dummy\*(R" events together with an error, 983Libev will usually signal a few \*(L"dummy\*(R" events together with an error,
959for example it might indicate that a fd is readable or writable, and if 984for example it might indicate that a fd is readable or writable, and if
960your callbacks is well-written it can just attempt the operation and cope 985your callbacks is well-written it can just attempt the operation and cope
961with the error from \fIread()\fR or \fIwrite()\fR. This will not work in multithreaded 986with the error from \fIread()\fR or \fIwrite()\fR. This will not work in multi-threaded
962programs, though, so beware. 987programs, though, so beware.
963.Sh "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0" 988.Sh "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0"
964.IX Subsection "GENERIC WATCHER FUNCTIONS" 989.IX Subsection "GENERIC WATCHER FUNCTIONS"
965In the following description, \f(CW\*(C`TYPE\*(C'\fR stands for the watcher type, 990In the following description, \f(CW\*(C`TYPE\*(C'\fR stands for the watcher type,
966e.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. 991e.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.
991Although some watcher types do not have type-specific arguments 1016Although some watcher types do not have type-specific arguments
992(e.g. \f(CW\*(C`ev_prepare\*(C'\fR) you still need to call its \f(CW\*(C`set\*(C'\fR macro. 1017(e.g. \f(CW\*(C`ev_prepare\*(C'\fR) you still need to call its \f(CW\*(C`set\*(C'\fR macro.
993.ie n .IP """ev_TYPE_init"" (ev_TYPE *watcher, callback, [args])" 4 1018.ie n .IP """ev_TYPE_init"" (ev_TYPE *watcher, callback, [args])" 4
994.el .IP "\f(CWev_TYPE_init\fR (ev_TYPE *watcher, callback, [args])" 4 1019.el .IP "\f(CWev_TYPE_init\fR (ev_TYPE *watcher, callback, [args])" 4
995.IX Item "ev_TYPE_init (ev_TYPE *watcher, callback, [args])" 1020.IX Item "ev_TYPE_init (ev_TYPE *watcher, callback, [args])"
996This convinience macro rolls both \f(CW\*(C`ev_init\*(C'\fR and \f(CW\*(C`ev_TYPE_set\*(C'\fR macro 1021This convenience macro rolls both \f(CW\*(C`ev_init\*(C'\fR and \f(CW\*(C`ev_TYPE_set\*(C'\fR macro
997calls into a single call. This is the most convinient method to initialise 1022calls into a single call. This is the most convenient method to initialise
998a watcher. The same limitations apply, of course. 1023a watcher. The same limitations apply, of course.
999.ie n .IP """ev_TYPE_start"" (loop *, ev_TYPE *watcher)" 4 1024.ie n .IP """ev_TYPE_start"" (loop *, ev_TYPE *watcher)" 4
1000.el .IP "\f(CWev_TYPE_start\fR (loop *, ev_TYPE *watcher)" 4 1025.el .IP "\f(CWev_TYPE_start\fR (loop *, ev_TYPE *watcher)" 4
1001.IX Item "ev_TYPE_start (loop *, ev_TYPE *watcher)" 1026.IX Item "ev_TYPE_start (loop *, ev_TYPE *watcher)"
1002Starts (activates) the given watcher. Only active watchers will receive 1027Starts (activates) the given watcher. Only active watchers will receive
1077don't want to allocate memory and store a pointer to it in that data 1102don't want to allocate memory and store a pointer to it in that data
1078member, you can also \*(L"subclass\*(R" the watcher type and provide your own 1103member, you can also \*(L"subclass\*(R" the watcher type and provide your own
1079data: 1104data:
1080.PP 1105.PP
1081.Vb 7 1106.Vb 7
1082\& struct my_io 1107\& struct my_io
1083\& { 1108\& {
1084\& struct ev_io io; 1109\& struct ev_io io;
1085\& int otherfd; 1110\& int otherfd;
1086\& void *somedata; 1111\& void *somedata;
1087\& struct whatever *mostinteresting; 1112\& struct whatever *mostinteresting;
1088\& } 1113\& }
1089.Ve 1114.Ve
1090.PP 1115.PP
1091And since your callback will be called with a pointer to the watcher, you 1116And since your callback will be called with a pointer to the watcher, you
1092can cast it back to your own type: 1117can cast it back to your own type:
1093.PP 1118.PP
1094.Vb 5 1119.Vb 5
1095\& static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents) 1120\& static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents)
1096\& { 1121\& {
1097\& struct my_io *w = (struct my_io *)w_; 1122\& struct my_io *w = (struct my_io *)w_;
1098\& ... 1123\& ...
1099\& } 1124\& }
1100.Ve 1125.Ve
1101.PP 1126.PP
1102More interesting and less C\-conformant ways of casting your callback type 1127More interesting and less C\-conformant ways of casting your callback type
1103instead have been omitted. 1128instead have been omitted.
1104.PP 1129.PP
1105Another common scenario is having some data structure with multiple 1130Another common scenario is having some data structure with multiple
1106watchers: 1131watchers:
1107.PP 1132.PP
1108.Vb 6 1133.Vb 6
1109\& struct my_biggy 1134\& struct my_biggy
1110\& { 1135\& {
1111\& int some_data; 1136\& int some_data;
1112\& ev_timer t1; 1137\& ev_timer t1;
1113\& ev_timer t2; 1138\& ev_timer t2;
1114\& } 1139\& }
1115.Ve 1140.Ve
1116.PP 1141.PP
1117In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more complicated, 1142In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more complicated,
1118you need to use \f(CW\*(C`offsetof\*(C'\fR: 1143you need to use \f(CW\*(C`offsetof\*(C'\fR:
1119.PP 1144.PP
1120.Vb 1 1145.Vb 1
1121\& #include <stddef.h> 1146\& #include <stddef.h>
1122\& 1147\&
1123\& static void 1148\& static void
1124\& t1_cb (EV_P_ struct ev_timer *w, int revents) 1149\& t1_cb (EV_P_ struct ev_timer *w, int revents)
1125\& { 1150\& {
1126\& struct my_biggy big = (struct my_biggy * 1151\& struct my_biggy big = (struct my_biggy *
1127\& (((char *)w) \- offsetof (struct my_biggy, t1)); 1152\& (((char *)w) \- offsetof (struct my_biggy, t1));
1128\& } 1153\& }
1129\& 1154\&
1130\& static void 1155\& static void
1131\& t2_cb (EV_P_ struct ev_timer *w, int revents) 1156\& t2_cb (EV_P_ struct ev_timer *w, int revents)
1132\& { 1157\& {
1133\& struct my_biggy big = (struct my_biggy * 1158\& struct my_biggy big = (struct my_biggy *
1134\& (((char *)w) \- offsetof (struct my_biggy, t2)); 1159\& (((char *)w) \- offsetof (struct my_biggy, t2));
1135\& } 1160\& }
1136.Ve 1161.Ve
1137.SH "WATCHER TYPES" 1162.SH "WATCHER TYPES"
1138.IX Header "WATCHER TYPES" 1163.IX Header "WATCHER TYPES"
1139This section describes each watcher in detail, but will not repeat 1164This section describes each watcher in detail, but will not repeat
1140information given in the last section. Any initialisation/set macros, 1165information given in the last section. Any initialisation/set macros,
1167If you must do this, then force the use of a known-to-be-good backend 1192If you must do this, then force the use of a known-to-be-good backend
1168(at the time of this writing, this includes only \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and 1193(at the time of this writing, this includes only \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and
1169\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR). 1194\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR).
1170.PP 1195.PP
1171Another thing you have to watch out for is that it is quite easy to 1196Another thing you have to watch out for is that it is quite easy to
1172receive \*(L"spurious\*(R" readyness notifications, that is your callback might 1197receive \*(L"spurious\*(R" readiness notifications, that is your callback might
1173be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block 1198be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block
1174because there is no data. Not only are some backends known to create a 1199because there is no data. Not only are some backends known to create a
1175lot of those (for example solaris ports), it is very easy to get into 1200lot of those (for example Solaris ports), it is very easy to get into
1176this situation even with a relatively standard program structure. Thus 1201this situation even with a relatively standard program structure. Thus
1177it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning 1202it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning
1178\&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives. 1203\&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives.
1179.PP 1204.PP
1180If you cannot run the fd in non-blocking mode (for example you should not 1205If you cannot run the fd in non-blocking mode (for example you should not
1181play around with an Xlib connection), then you have to seperately re-test 1206play around with an Xlib connection), then you have to separately re-test
1182whether a file descriptor is really ready with a known-to-be good interface 1207whether a file descriptor is really ready with a known-to-be good interface
1183such as poll (fortunately in our Xlib example, Xlib already does this on 1208such as poll (fortunately in our Xlib example, Xlib already does this on
1184its own, so its quite safe to use). 1209its own, so its quite safe to use).
1185.PP 1210.PP
1186\fIThe special problem of disappearing file descriptors\fR 1211\fIThe special problem of disappearing file descriptors\fR
1249.PD 0 1274.PD 0
1250.IP "ev_io_set (ev_io *, int fd, int events)" 4 1275.IP "ev_io_set (ev_io *, int fd, int events)" 4
1251.IX Item "ev_io_set (ev_io *, int fd, int events)" 1276.IX Item "ev_io_set (ev_io *, int fd, int events)"
1252.PD 1277.PD
1253Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to 1278Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to
1254rceeive events for and events is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or 1279receive events for and events is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or
1255\&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR to receive the given events. 1280\&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR to receive the given events.
1256.IP "int fd [read\-only]" 4 1281.IP "int fd [read\-only]" 4
1257.IX Item "int fd [read-only]" 1282.IX Item "int fd [read-only]"
1258The file descriptor being watched. 1283The file descriptor being watched.
1259.IP "int events [read\-only]" 4 1284.IP "int events [read\-only]" 4
1266Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well 1291Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well
1267readable, but only once. Since it is likely line-buffered, you could 1292readable, but only once. Since it is likely line-buffered, you could
1268attempt to read a whole line in the callback. 1293attempt to read a whole line in the callback.
1269.PP 1294.PP
1270.Vb 6 1295.Vb 6
1271\& static void 1296\& static void
1272\& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1297\& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)
1273\& { 1298\& {
1274\& ev_io_stop (loop, w); 1299\& ev_io_stop (loop, w);
1275\& .. read from stdin here (or from w\->fd) and haqndle any I/O errors 1300\& .. read from stdin here (or from w\->fd) and haqndle any I/O errors
1276\& } 1301\& }
1277\& 1302\&
1278\& ... 1303\& ...
1279\& struct ev_loop *loop = ev_default_init (0); 1304\& struct ev_loop *loop = ev_default_init (0);
1280\& struct ev_io stdin_readable; 1305\& struct ev_io stdin_readable;
1281\& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); 1306\& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1282\& ev_io_start (loop, &stdin_readable); 1307\& ev_io_start (loop, &stdin_readable);
1283\& ev_loop (loop, 0); 1308\& ev_loop (loop, 0);
1284.Ve 1309.Ve
1285.ie n .Sh """ev_timer"" \- relative and optionally repeating timeouts" 1310.ie n .Sh """ev_timer"" \- relative and optionally repeating timeouts"
1286.el .Sh "\f(CWev_timer\fP \- relative and optionally repeating timeouts" 1311.el .Sh "\f(CWev_timer\fP \- relative and optionally repeating timeouts"
1287.IX Subsection "ev_timer - relative and optionally repeating timeouts" 1312.IX Subsection "ev_timer - relative and optionally repeating timeouts"
1288Timer watchers are simple relative timers that generate an event after a 1313Timer watchers are simple relative timers that generate an event after a
1289given time, and optionally repeating in regular intervals after that. 1314given time, and optionally repeating in regular intervals after that.
1290.PP 1315.PP
1291The timers are based on real time, that is, if you register an event that 1316The timers are based on real time, that is, if you register an event that
1292times out after an hour and you reset your system clock to last years 1317times out after an hour and you reset your system clock to January last
1293time, it will still time out after (roughly) and hour. \*(L"Roughly\*(R" because 1318year, it will still time out after (roughly) and hour. \*(L"Roughly\*(R" because
1294detecting time jumps is hard, and some inaccuracies are unavoidable (the 1319detecting time jumps is hard, and some inaccuracies are unavoidable (the
1295monotonic clock option helps a lot here). 1320monotonic clock option helps a lot here).
1296.PP 1321.PP
1297The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR 1322The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR
1298time. This is usually the right thing as this timestamp refers to the time 1323time. This is usually the right thing as this timestamp refers to the time
1302.PP 1327.PP
1303.Vb 1 1328.Vb 1
1304\& ev_timer_set (&timer, after + ev_now () \- ev_time (), 0.); 1329\& ev_timer_set (&timer, after + ev_now () \- ev_time (), 0.);
1305.Ve 1330.Ve
1306.PP 1331.PP
1307The callback is guarenteed to be invoked only when its timeout has passed, 1332The callback is guaranteed to be invoked only after its timeout has passed,
1308but if multiple timers become ready during the same loop iteration then 1333but if multiple timers become ready during the same loop iteration then
1309order of execution is undefined. 1334order of execution is undefined.
1310.PP 1335.PP
1311\fIWatcher-Specific Functions and Data Members\fR 1336\fIWatcher-Specific Functions and Data Members\fR
1312.IX Subsection "Watcher-Specific Functions and Data Members" 1337.IX Subsection "Watcher-Specific Functions and Data Members"
1314.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 1339.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)"
1315.PD 0 1340.PD 0
1316.IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 1341.IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4
1317.IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 1342.IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)"
1318.PD 1343.PD
1319Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds. If \f(CW\*(C`repeat\*(C'\fR is 1344Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds. If \f(CW\*(C`repeat\*(C'\fR
1320\&\f(CW0.\fR, then it will automatically be stopped. If it is positive, then the 1345is \f(CW0.\fR, then it will automatically be stopped once the timeout is
1321timer will automatically be configured to trigger again \f(CW\*(C`repeat\*(C'\fR seconds 1346reached. If it is positive, then the timer will automatically be
1322later, again, and again, until stopped manually. 1347configured to trigger again \f(CW\*(C`repeat\*(C'\fR seconds later, again, and again,
1348until stopped manually.
1323.Sp 1349.Sp
1324The timer itself will do a best-effort at avoiding drift, that is, if you 1350The timer itself will do a best-effort at avoiding drift, that is, if
1325configure a timer to trigger every 10 seconds, then it will trigger at 1351you configure a timer to trigger every 10 seconds, then it will normally
1326exactly 10 second intervals. If, however, your program cannot keep up with 1352trigger at exactly 10 second intervals. If, however, your program cannot
1327the timer (because it takes longer than those 10 seconds to do stuff) the 1353keep up with the timer (because it takes longer than those 10 seconds to
1328timer will not fire more than once per event loop iteration. 1354do stuff) the timer will not fire more than once per event loop iteration.
1329.IP "ev_timer_again (loop, ev_timer *)" 4 1355.IP "ev_timer_again (loop, ev_timer *)" 4
1330.IX Item "ev_timer_again (loop, ev_timer *)" 1356.IX Item "ev_timer_again (loop, ev_timer *)"
1331This will act as if the timer timed out and restart it again if it is 1357This will act as if the timer timed out and restart it again if it is
1332repeating. The exact semantics are: 1358repeating. The exact semantics are:
1333.Sp 1359.Sp
1334If the timer is pending, its pending status is cleared. 1360If the timer is pending, its pending status is cleared.
1335.Sp 1361.Sp
1336If the timer is started but nonrepeating, stop it (as if it timed out). 1362If the timer is started but non-repeating, stop it (as if it timed out).
1337.Sp 1363.Sp
1338If the timer is repeating, either start it if necessary (with the 1364If the timer is repeating, either start it if necessary (with the
1339\&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value. 1365\&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value.
1340.Sp 1366.Sp
1341This sounds a bit complicated, but here is a useful and typical 1367This sounds a bit complicated, but here is a useful and typical
1342example: Imagine you have a tcp connection and you want a so-called idle 1368example: Imagine you have a \s-1TCP\s0 connection and you want a so-called idle
1343timeout, that is, you want to be called when there have been, say, 60 1369timeout, that is, you want to be called when there have been, say, 60
1344seconds of inactivity on the socket. The easiest way to do this is to 1370seconds of inactivity on the socket. The easiest way to do this is to
1345configure an \f(CW\*(C`ev_timer\*(C'\fR with a \f(CW\*(C`repeat\*(C'\fR value of \f(CW60\fR and then call 1371configure an \f(CW\*(C`ev_timer\*(C'\fR with a \f(CW\*(C`repeat\*(C'\fR value of \f(CW60\fR and then call
1346\&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If 1372\&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If
1347you go into an idle state where you do not expect data to travel on the 1373you go into an idle state where you do not expect data to travel on the
1374.IX Subsection "Examples" 1400.IX Subsection "Examples"
1375.PP 1401.PP
1376Example: Create a timer that fires after 60 seconds. 1402Example: Create a timer that fires after 60 seconds.
1377.PP 1403.PP
1378.Vb 5 1404.Vb 5
1379\& static void 1405\& static void
1380\& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1406\& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
1381\& { 1407\& {
1382\& .. one minute over, w is actually stopped right here 1408\& .. one minute over, w is actually stopped right here
1383\& } 1409\& }
1384\& 1410\&
1385\& struct ev_timer mytimer; 1411\& struct ev_timer mytimer;
1386\& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); 1412\& ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
1387\& ev_timer_start (loop, &mytimer); 1413\& ev_timer_start (loop, &mytimer);
1388.Ve 1414.Ve
1389.PP 1415.PP
1390Example: Create a timeout timer that times out after 10 seconds of 1416Example: Create a timeout timer that times out after 10 seconds of
1391inactivity. 1417inactivity.
1392.PP 1418.PP
1393.Vb 5 1419.Vb 5
1394\& static void 1420\& static void
1395\& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1421\& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
1396\& { 1422\& {
1397\& .. ten seconds without any activity 1423\& .. ten seconds without any activity
1398\& } 1424\& }
1399\& 1425\&
1400\& struct ev_timer mytimer; 1426\& struct ev_timer mytimer;
1401\& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */ 1427\& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1402\& ev_timer_again (&mytimer); /* start timer */ 1428\& ev_timer_again (&mytimer); /* start timer */
1403\& ev_loop (loop, 0); 1429\& ev_loop (loop, 0);
1404\& 1430\&
1405\& // and in some piece of code that gets executed on any "activity": 1431\& // and in some piece of code that gets executed on any "activity":
1406\& // reset the timeout to start ticking again at 10 seconds 1432\& // reset the timeout to start ticking again at 10 seconds
1407\& ev_timer_again (&mytimer); 1433\& ev_timer_again (&mytimer);
1408.Ve 1434.Ve
1409.ie n .Sh """ev_periodic"" \- to cron or not to cron?" 1435.ie n .Sh """ev_periodic"" \- to cron or not to cron?"
1410.el .Sh "\f(CWev_periodic\fP \- to cron or not to cron?" 1436.el .Sh "\f(CWev_periodic\fP \- to cron or not to cron?"
1411.IX Subsection "ev_periodic - to cron or not to cron?" 1437.IX Subsection "ev_periodic - to cron or not to cron?"
1412Periodic watchers are also timers of a kind, but they are very versatile 1438Periodic watchers are also timers of a kind, but they are very versatile
1413(and unfortunately a bit complex). 1439(and unfortunately a bit complex).
1414.PP 1440.PP
1415Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time) 1441Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time)
1416but on wallclock time (absolute time). You can tell a periodic watcher 1442but on wall clock time (absolute time). You can tell a periodic watcher
1417to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a 1443to trigger after some specific point in time. For example, if you tell a
1418periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now () 1444periodic watcher to trigger in 10 seconds (by specifying e.g. \f(CW\*(C`ev_now ()
1419+ 10.\*(C'\fR) and then reset your system clock to the last year, then it will 1445+ 10.\*(C'\fR, that is, an absolute time not a delay) and then reset your system
1446clock to January of the previous year, then it will take more than year
1420take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger 1447to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would still trigger
1421roughly 10 seconds later). 1448roughly 10 seconds later as it uses a relative timeout).
1422.PP 1449.PP
1423They can also be used to implement vastly more complex timers, such as 1450\&\f(CW\*(C`ev_periodic\*(C'\fRs can also be used to implement vastly more complex timers,
1424triggering an event on each midnight, local time or other, complicated, 1451such as triggering an event on each \*(L"midnight, local time\*(R", or other
1425rules. 1452complicated, rules.
1426.PP 1453.PP
1427As with timers, the callback is guarenteed to be invoked only when the 1454As with timers, the callback is guaranteed to be invoked only when the
1428time (\f(CW\*(C`at\*(C'\fR) has been passed, but if multiple periodic timers become ready 1455time (\f(CW\*(C`at\*(C'\fR) has passed, but if multiple periodic timers become ready
1429during the same loop iteration then order of execution is undefined. 1456during the same loop iteration then order of execution is undefined.
1430.PP 1457.PP
1431\fIWatcher-Specific Functions and Data Members\fR 1458\fIWatcher-Specific Functions and Data Members\fR
1432.IX Subsection "Watcher-Specific Functions and Data Members" 1459.IX Subsection "Watcher-Specific Functions and Data Members"
1433.IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 1460.IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4
1440operation, and we will explain them from simplest to complex: 1467operation, and we will explain them from simplest to complex:
1441.RS 4 1468.RS 4
1442.IP "\(bu" 4 1469.IP "\(bu" 4
1443absolute timer (at = time, interval = reschedule_cb = 0) 1470absolute timer (at = time, interval = reschedule_cb = 0)
1444.Sp 1471.Sp
1445In this configuration the watcher triggers an event at the wallclock time 1472In this configuration the watcher triggers an event after the wall clock
1446\&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs, 1473time \f(CW\*(C`at\*(C'\fR has passed and doesn't repeat. It will not adjust when a time
1447that is, if it is to be run at January 1st 2011 then it will run when the 1474jump occurs, that is, if it is to be run at January 1st 2011 then it will
1448system time reaches or surpasses this time. 1475run when the system time reaches or surpasses this time.
1449.IP "\(bu" 4 1476.IP "\(bu" 4
1450repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) 1477repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1451.Sp 1478.Sp
1452In this mode the watcher will always be scheduled to time out at the next 1479In this mode the watcher will always be scheduled to time out at the next
1453\&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N, which can also be negative) 1480\&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N, which can also be negative)
1454and then repeat, regardless of any time jumps. 1481and then repeat, regardless of any time jumps.
1455.Sp 1482.Sp
1456This can be used to create timers that do not drift with respect to system 1483This can be used to create timers that do not drift with respect to system
1457time: 1484time, for example, here is a \f(CW\*(C`ev_periodic\*(C'\fR that triggers each hour, on
1485the hour:
1458.Sp 1486.Sp
1459.Vb 1 1487.Vb 1
1460\& ev_periodic_set (&periodic, 0., 3600., 0); 1488\& ev_periodic_set (&periodic, 0., 3600., 0);
1461.Ve 1489.Ve
1462.Sp 1490.Sp
1463This doesn't mean there will always be 3600 seconds in between triggers, 1491This doesn't mean there will always be 3600 seconds in between triggers,
1464but only that the the callback will be called when the system time shows a 1492but only that the callback will be called when the system time shows a
1465full hour (\s-1UTC\s0), or more correctly, when the system time is evenly divisible 1493full hour (\s-1UTC\s0), or more correctly, when the system time is evenly divisible
1466by 3600. 1494by 3600.
1467.Sp 1495.Sp
1468Another way to think about it (for the mathematically inclined) is that 1496Another way to think about it (for the mathematically inclined) is that
1469\&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible 1497\&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible
1470time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. 1498time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps.
1471.Sp 1499.Sp
1472For numerical stability it is preferable that the \f(CW\*(C`at\*(C'\fR value is near 1500For numerical stability it is preferable that the \f(CW\*(C`at\*(C'\fR value is near
1473\&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for 1501\&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for
1474this value. 1502this value, and in fact is often specified as zero.
1503.Sp
1504Note also that there is an upper limit to how often a timer can fire (\s-1CPU\s0
1505speed for example), so if \f(CW\*(C`interval\*(C'\fR is very small then timing stability
1506will of course deteriorate. Libev itself tries to be exact to be about one
1507millisecond (if the \s-1OS\s0 supports it and the machine is fast enough).
1475.IP "\(bu" 4 1508.IP "\(bu" 4
1476manual reschedule mode (at and interval ignored, reschedule_cb = callback) 1509manual reschedule mode (at and interval ignored, reschedule_cb = callback)
1477.Sp 1510.Sp
1478In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being 1511In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being
1479ignored. Instead, each time the periodic watcher gets scheduled, the 1512ignored. Instead, each time the periodic watcher gets scheduled, the
1480reschedule callback will be called with the watcher as first, and the 1513reschedule callback will be called with the watcher as first, and the
1481current time as second argument. 1514current time as second argument.
1482.Sp 1515.Sp
1483\&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, 1516\&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher,
1484ever, or make any event loop modifications\fR. If you need to stop it, 1517ever, or make \s-1ANY\s0 event loop modifications whatsoever\fR.
1485return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop it afterwards (e.g. by 1518.Sp
1519If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop
1486starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is legal). 1520it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the
1521only event loop modification you are allowed to do).
1487.Sp 1522.Sp
1488Its prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic *w, 1523The callback prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic
1489ev_tstamp now)\*(C'\fR, e.g.: 1524*w, ev_tstamp now)\*(C'\fR, e.g.:
1490.Sp 1525.Sp
1491.Vb 4 1526.Vb 4
1492\& static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) 1527\& static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
1493\& { 1528\& {
1494\& return now + 60.; 1529\& return now + 60.;
1498It must return the next time to trigger, based on the passed time value 1533It must return the next time to trigger, based on the passed time value
1499(that is, the lowest time value larger than to the second argument). It 1534(that is, the lowest time value larger than to the second argument). It
1500will usually be called just before the callback will be triggered, but 1535will usually be called just before the callback will be triggered, but
1501might be called at other times, too. 1536might be called at other times, too.
1502.Sp 1537.Sp
1503\&\s-1NOTE:\s0 \fIThis callback must always return a time that is later than the 1538\&\s-1NOTE:\s0 \fIThis callback must always return a time that is higher than or
1504passed \f(CI\*(C`now\*(C'\fI value\fR. Not even \f(CW\*(C`now\*(C'\fR itself will do, it \fImust\fR be larger. 1539equal to the passed \f(CI\*(C`now\*(C'\fI value\fR.
1505.Sp 1540.Sp
1506This can be used to create very complex timers, such as a timer that 1541This can be used to create very complex timers, such as a timer that
1507triggers on each midnight, local time. To do this, you would calculate the 1542triggers on \*(L"next midnight, local time\*(R". To do this, you would calculate the
1508next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for this. How 1543next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for this. How
1509you do this is, again, up to you (but it is not trivial, which is the main 1544you do this is, again, up to you (but it is not trivial, which is the main
1510reason I omitted it as an example). 1545reason I omitted it as an example).
1511.RE 1546.RE
1512.RS 4 1547.RS 4
1515.IX Item "ev_periodic_again (loop, ev_periodic *)" 1550.IX Item "ev_periodic_again (loop, ev_periodic *)"
1516Simply stops and restarts the periodic watcher again. This is only useful 1551Simply stops and restarts the periodic watcher again. This is only useful
1517when you changed some parameters or the reschedule callback would return 1552when you changed some parameters or the reschedule callback would return
1518a different time than the last time it was called (e.g. in a crond like 1553a different time than the last time it was called (e.g. in a crond like
1519program when the crontabs have changed). 1554program when the crontabs have changed).
1555.IP "ev_tstamp ev_periodic_at (ev_periodic *)" 4
1556.IX Item "ev_tstamp ev_periodic_at (ev_periodic *)"
1557When active, returns the absolute time that the watcher is supposed to
1558trigger next.
1520.IP "ev_tstamp offset [read\-write]" 4 1559.IP "ev_tstamp offset [read\-write]" 4
1521.IX Item "ev_tstamp offset [read-write]" 1560.IX Item "ev_tstamp offset [read-write]"
1522When repeating, this contains the offset value, otherwise this is the 1561When repeating, this contains the offset value, otherwise this is the
1523absolute point in time (the \f(CW\*(C`at\*(C'\fR value passed to \f(CW\*(C`ev_periodic_set\*(C'\fR). 1562absolute point in time (the \f(CW\*(C`at\*(C'\fR value passed to \f(CW\*(C`ev_periodic_set\*(C'\fR).
1524.Sp 1563.Sp
1532.IP "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read\-write]" 4 1571.IP "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read\-write]" 4
1533.IX Item "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]" 1572.IX Item "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]"
1534The current reschedule callback, or \f(CW0\fR, if this functionality is 1573The current reschedule callback, or \f(CW0\fR, if this functionality is
1535switched off. Can be changed any time, but changes only take effect when 1574switched off. Can be changed any time, but changes only take effect when
1536the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. 1575the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called.
1537.IP "ev_tstamp at [read\-only]" 4
1538.IX Item "ev_tstamp at [read-only]"
1539When active, contains the absolute time that the watcher is supposed to
1540trigger next.
1541.PP 1576.PP
1542\fIExamples\fR 1577\fIExamples\fR
1543.IX Subsection "Examples" 1578.IX Subsection "Examples"
1544.PP 1579.PP
1545Example: Call a callback every hour, or, more precisely, whenever the 1580Example: Call a callback every hour, or, more precisely, whenever the
1546system clock is divisible by 3600. The callback invocation times have 1581system clock is divisible by 3600. The callback invocation times have
1547potentially a lot of jittering, but good long-term stability. 1582potentially a lot of jitter, but good long-term stability.
1548.PP 1583.PP
1549.Vb 5 1584.Vb 5
1550\& static void 1585\& static void
1551\& clock_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1586\& clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)
1552\& { 1587\& {
1553\& ... its now a full hour (UTC, or TAI or whatever your clock follows) 1588\& ... its now a full hour (UTC, or TAI or whatever your clock follows)
1554\& } 1589\& }
1555\& 1590\&
1556\& struct ev_periodic hourly_tick; 1591\& struct ev_periodic hourly_tick;
1557\& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); 1592\& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1558\& ev_periodic_start (loop, &hourly_tick); 1593\& ev_periodic_start (loop, &hourly_tick);
1559.Ve 1594.Ve
1560.PP 1595.PP
1561Example: The same as above, but use a reschedule callback to do it: 1596Example: The same as above, but use a reschedule callback to do it:
1562.PP 1597.PP
1563.Vb 1 1598.Vb 1
1564\& #include <math.h> 1599\& #include <math.h>
1565\& 1600\&
1566\& static ev_tstamp 1601\& static ev_tstamp
1567\& my_scheduler_cb (struct ev_periodic *w, ev_tstamp now) 1602\& my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
1568\& { 1603\& {
1569\& return fmod (now, 3600.) + 3600.; 1604\& return fmod (now, 3600.) + 3600.;
1570\& } 1605\& }
1571\& 1606\&
1572\& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); 1607\& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1573.Ve 1608.Ve
1574.PP 1609.PP
1575Example: Call a callback every hour, starting now: 1610Example: Call a callback every hour, starting now:
1576.PP 1611.PP
1577.Vb 4 1612.Vb 4
1578\& struct ev_periodic hourly_tick; 1613\& struct ev_periodic hourly_tick;
1579\& ev_periodic_init (&hourly_tick, clock_cb, 1614\& ev_periodic_init (&hourly_tick, clock_cb,
1580\& fmod (ev_now (loop), 3600.), 3600., 0); 1615\& fmod (ev_now (loop), 3600.), 3600., 0);
1581\& ev_periodic_start (loop, &hourly_tick); 1616\& ev_periodic_start (loop, &hourly_tick);
1582.Ve 1617.Ve
1583.ie n .Sh """ev_signal"" \- signal me when a signal gets signalled!" 1618.ie n .Sh """ev_signal"" \- signal me when a signal gets signalled!"
1584.el .Sh "\f(CWev_signal\fP \- signal me when a signal gets signalled!" 1619.el .Sh "\f(CWev_signal\fP \- signal me when a signal gets signalled!"
1585.IX Subsection "ev_signal - signal me when a signal gets signalled!" 1620.IX Subsection "ev_signal - signal me when a signal gets signalled!"
1586Signal watchers will trigger an event when the process receives a specific 1621Signal watchers will trigger an event when the process receives a specific
1594as you don't register any with libev). Similarly, when the last signal 1629as you don't register any with libev). Similarly, when the last signal
1595watcher for a signal is stopped libev will reset the signal handler to 1630watcher for a signal is stopped libev will reset the signal handler to
1596\&\s-1SIG_DFL\s0 (regardless of what it was set to before). 1631\&\s-1SIG_DFL\s0 (regardless of what it was set to before).
1597.PP 1632.PP
1598If possible and supported, libev will install its handlers with 1633If possible and supported, libev will install its handlers with
1599\&\f(CW\*(C`SA_RESTART\*(C'\fR behaviour enabled, so syscalls should not be unduly 1634\&\f(CW\*(C`SA_RESTART\*(C'\fR behaviour enabled, so system calls should not be unduly
1600interrupted. If you have a problem with syscalls getting interrupted by 1635interrupted. If you have a problem with system calls getting interrupted by
1601signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher and unblock 1636signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher and unblock
1602them in an \f(CW\*(C`ev_prepare\*(C'\fR watcher. 1637them in an \f(CW\*(C`ev_prepare\*(C'\fR watcher.
1603.PP 1638.PP
1604\fIWatcher-Specific Functions and Data Members\fR 1639\fIWatcher-Specific Functions and Data Members\fR
1605.IX Subsection "Watcher-Specific Functions and Data Members" 1640.IX Subsection "Watcher-Specific Functions and Data Members"
1619.IX Subsection "Examples" 1654.IX Subsection "Examples"
1620.PP 1655.PP
1621Example: Try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0. 1656Example: Try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0.
1622.PP 1657.PP
1623.Vb 5 1658.Vb 5
1624\& static void 1659\& static void
1625\& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) 1660\& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1626\& { 1661\& {
1627\& ev_unloop (loop, EVUNLOOP_ALL); 1662\& ev_unloop (loop, EVUNLOOP_ALL);
1628\& } 1663\& }
1629\& 1664\&
1630\& struct ev_signal signal_watcher; 1665\& struct ev_signal signal_watcher;
1631\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT); 1666\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1632\& ev_signal_start (loop, &sigint_cb); 1667\& ev_signal_start (loop, &sigint_cb);
1633.Ve 1668.Ve
1634.ie n .Sh """ev_child"" \- watch out for process status changes" 1669.ie n .Sh """ev_child"" \- watch out for process status changes"
1635.el .Sh "\f(CWev_child\fP \- watch out for process status changes" 1670.el .Sh "\f(CWev_child\fP \- watch out for process status changes"
1636.IX Subsection "ev_child - watch out for process status changes" 1671.IX Subsection "ev_child - watch out for process status changes"
1637Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to 1672Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to
1639is permissible to install a child watcher \fIafter\fR the child has been 1674is permissible to install a child watcher \fIafter\fR the child has been
1640forked (which implies it might have already exited), as long as the event 1675forked (which implies it might have already exited), as long as the event
1641loop isn't entered (or is continued from a watcher). 1676loop isn't entered (or is continued from a watcher).
1642.PP 1677.PP
1643Only the default event loop is capable of handling signals, and therefore 1678Only the default event loop is capable of handling signals, and therefore
1644you can only rgeister child watchers in the default event loop. 1679you can only register child watchers in the default event loop.
1645.PP 1680.PP
1646\fIProcess Interaction\fR 1681\fIProcess Interaction\fR
1647.IX Subsection "Process Interaction" 1682.IX Subsection "Process Interaction"
1648.PP 1683.PP
1649Libev grabs \f(CW\*(C`SIGCHLD\*(C'\fR as soon as the default event loop is 1684Libev grabs \f(CW\*(C`SIGCHLD\*(C'\fR as soon as the default event loop is
1650initialised. This is necessary to guarantee proper behaviour even if 1685initialised. This is necessary to guarantee proper behaviour even if
1651the first child watcher is started after the child exits. The occurance 1686the first child watcher is started after the child exits. The occurrence
1652of \f(CW\*(C`SIGCHLD\*(C'\fR is recorded asynchronously, but child reaping is done 1687of \f(CW\*(C`SIGCHLD\*(C'\fR is recorded asynchronously, but child reaping is done
1653synchronously as part of the event loop processing. Libev always reaps all 1688synchronously as part of the event loop processing. Libev always reaps all
1654children, even ones not watched. 1689children, even ones not watched.
1655.PP 1690.PP
1656\fIOverriding the Built-In Processing\fR 1691\fIOverriding the Built-In Processing\fR
1696.PP 1731.PP
1697Example: \f(CW\*(C`fork()\*(C'\fR a new process and install a child handler to wait for 1732Example: \f(CW\*(C`fork()\*(C'\fR a new process and install a child handler to wait for
1698its completion. 1733its completion.
1699.PP 1734.PP
1700.Vb 1 1735.Vb 1
1701\& ev_child cw; 1736\& ev_child cw;
1702\& 1737\&
1703\& static void 1738\& static void
1704\& child_cb (EV_P_ struct ev_child *w, int revents) 1739\& child_cb (EV_P_ struct ev_child *w, int revents)
1705\& { 1740\& {
1706\& ev_child_stop (EV_A_ w); 1741\& ev_child_stop (EV_A_ w);
1707\& printf ("process %d exited with status %x\en", w\->rpid, w\->rstatus); 1742\& printf ("process %d exited with status %x\en", w\->rpid, w\->rstatus);
1708\& } 1743\& }
1709\& 1744\&
1710\& pid_t pid = fork (); 1745\& pid_t pid = fork ();
1711\& 1746\&
1712\& if (pid < 0) 1747\& if (pid < 0)
1713\& // error 1748\& // error
1714\& else if (pid == 0) 1749\& else if (pid == 0)
1715\& { 1750\& {
1716\& // the forked child executes here 1751\& // the forked child executes here
1717\& exit (1); 1752\& exit (1);
1718\& } 1753\& }
1719\& else 1754\& else
1720\& { 1755\& {
1721\& ev_child_init (&cw, child_cb, pid, 0); 1756\& ev_child_init (&cw, child_cb, pid, 0);
1722\& ev_child_start (EV_DEFAULT_ &cw); 1757\& ev_child_start (EV_DEFAULT_ &cw);
1723\& } 1758\& }
1724.Ve 1759.Ve
1725.ie n .Sh """ev_stat"" \- did the file attributes just change?" 1760.ie n .Sh """ev_stat"" \- did the file attributes just change?"
1726.el .Sh "\f(CWev_stat\fP \- did the file attributes just change?" 1761.el .Sh "\f(CWev_stat\fP \- did the file attributes just change?"
1727.IX Subsection "ev_stat - did the file attributes just change?" 1762.IX Subsection "ev_stat - did the file attributes just change?"
1728This watches a filesystem path for attribute changes. That is, it calls 1763This watches a file system path for attribute changes. That is, it calls
1729\&\f(CW\*(C`stat\*(C'\fR regularly (or when the \s-1OS\s0 says it changed) and sees if it changed 1764\&\f(CW\*(C`stat\*(C'\fR regularly (or when the \s-1OS\s0 says it changed) and sees if it changed
1730compared to the last time, invoking the callback if it did. 1765compared to the last time, invoking the callback if it did.
1731.PP 1766.PP
1732The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does 1767The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does
1733not exist\*(R" is a status change like any other. The condition \*(L"path does 1768not exist\*(R" is a status change like any other. The condition \*(L"path does
1751as even with OS-supported change notifications, this can be 1786as even with OS-supported change notifications, this can be
1752resource-intensive. 1787resource-intensive.
1753.PP 1788.PP
1754At the time of this writing, only the Linux inotify interface is 1789At the time of this writing, only the Linux inotify interface is
1755implemented (implementing kqueue support is left as an exercise for the 1790implemented (implementing kqueue support is left as an exercise for the
1791reader, note, however, that the author sees no way of implementing ev_stat
1756reader). Inotify will be used to give hints only and should not change the 1792semantics with kqueue). Inotify will be used to give hints only and should
1757semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs 1793not change the semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev
1758to fall back to regular polling again even with inotify, but changes are 1794sometimes needs to fall back to regular polling again even with inotify,
1759usually detected immediately, and if the file exists there will be no 1795but changes are usually detected immediately, and if the file exists there
1760polling. 1796will be no polling.
1761.PP 1797.PP
1762\fI\s-1ABI\s0 Issues (Largefile Support)\fR 1798\fI\s-1ABI\s0 Issues (Largefile Support)\fR
1763.IX Subsection "ABI Issues (Largefile Support)" 1799.IX Subsection "ABI Issues (Largefile Support)"
1764.PP 1800.PP
1765Libev by default (unless the user overrides this) uses the default 1801Libev by default (unless the user overrides this) uses the default
1766compilation environment, which means that on systems with optionally 1802compilation environment, which means that on systems with large file
1767disabled large file support, you get the 32 bit version of the stat 1803support disabled by default, you get the 32 bit version of the stat
1768structure. When using the library from programs that change the \s-1ABI\s0 to 1804structure. When using the library from programs that change the \s-1ABI\s0 to
1769use 64 bit file offsets the programs will fail. In that case you have to 1805use 64 bit file offsets the programs will fail. In that case you have to
1770compile libev with the same flags to get binary compatibility. This is 1806compile libev with the same flags to get binary compatibility. This is
1771obviously the case with any flags that change the \s-1ABI\s0, but the problem is 1807obviously the case with any flags that change the \s-1ABI\s0, but the problem is
1772most noticably with ev_stat and largefile support. 1808most noticeably disabled with ev_stat and large file support.
1809.PP
1810The solution for this is to lobby your distribution maker to make large
1811file interfaces available by default (as e.g. FreeBSD does) and not
1812optional. Libev cannot simply switch on large file support because it has
1813to exchange stat structures with application programs compiled using the
1814default compilation environment.
1773.PP 1815.PP
1774\fIInotify\fR 1816\fIInotify\fR
1775.IX Subsection "Inotify" 1817.IX Subsection "Inotify"
1776.PP 1818.PP
1777When \f(CW\*(C`inotify (7)\*(C'\fR support has been compiled into libev (generally only 1819When \f(CW\*(C`inotify (7)\*(C'\fR support has been compiled into libev (generally only
1778available on Linux) and present at runtime, it will be used to speed up 1820available on Linux) and present at runtime, it will be used to speed up
1779change detection where possible. The inotify descriptor will be created lazily 1821change detection where possible. The inotify descriptor will be created lazily
1780when the first \f(CW\*(C`ev_stat\*(C'\fR watcher is being started. 1822when the first \f(CW\*(C`ev_stat\*(C'\fR watcher is being started.
1781.PP 1823.PP
1782Inotify presense does not change the semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers 1824Inotify presence does not change the semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers
1783except that changes might be detected earlier, and in some cases, to avoid 1825except that changes might be detected earlier, and in some cases, to avoid
1784making regular \f(CW\*(C`stat\*(C'\fR calls. Even in the presense of inotify support 1826making regular \f(CW\*(C`stat\*(C'\fR calls. Even in the presence of inotify support
1785there are many cases where libev has to resort to regular \f(CW\*(C`stat\*(C'\fR polling. 1827there are many cases where libev has to resort to regular \f(CW\*(C`stat\*(C'\fR polling.
1786.PP 1828.PP
1787(There is no support for kqueue, as apparently it cannot be used to 1829(There is no support for kqueue, as apparently it cannot be used to
1788implement this functionality, due to the requirement of having a file 1830implement this functionality, due to the requirement of having a file
1789descriptor open on the object at all times). 1831descriptor open on the object at all times).
1790.PP 1832.PP
1791\fIThe special problem of stat time resolution\fR 1833\fIThe special problem of stat time resolution\fR
1792.IX Subsection "The special problem of stat time resolution" 1834.IX Subsection "The special problem of stat time resolution"
1793.PP 1835.PP
1794The \f(CW\*(C`stat ()\*(C'\fR syscall only supports full-second resolution portably, and 1836The \f(CW\*(C`stat ()\*(C'\fR system call only supports full-second resolution portably, and
1795even on systems where the resolution is higher, many filesystems still 1837even on systems where the resolution is higher, many file systems still
1796only support whole seconds. 1838only support whole seconds.
1797.PP 1839.PP
1798That means that, if the time is the only thing that changes, you might 1840That means that, if the time is the only thing that changes, you can
1799miss updates: on the first update, \f(CW\*(C`ev_stat\*(C'\fR detects a change and calls 1841easily miss updates: on the first update, \f(CW\*(C`ev_stat\*(C'\fR detects a change and
1800your callback, which does something. When there is another update within 1842calls your callback, which does something. When there is another update
1801the same second, \f(CW\*(C`ev_stat\*(C'\fR will be unable to detect it. 1843within the same second, \f(CW\*(C`ev_stat\*(C'\fR will be unable to detect it as the stat
1844data does not change.
1802.PP 1845.PP
1803The solution to this is to delay acting on a change for a second (or till 1846The solution to this is to delay acting on a change for slightly more
1804the next second boundary), using a roughly one-second delay \f(CW\*(C`ev_timer\*(C'\fR 1847than a second (or till slightly after the next full second boundary), using
1805(\f(CW\*(C`ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)\*(C'\fR). The \f(CW.01\fR 1848a roughly one-second-delay \f(CW\*(C`ev_timer\*(C'\fR (e.g. \f(CW\*(C`ev_timer_set (w, 0., 1.02);
1806is added to work around small timing inconsistencies of some operating 1849ev_timer_again (loop, w)\*(C'\fR).
1807systems. 1850.PP
1851The \f(CW.02\fR offset is added to work around small timing inconsistencies
1852of some operating systems (where the second counter of the current time
1853might be be delayed. One such system is the Linux kernel, where a call to
1854\&\f(CW\*(C`gettimeofday\*(C'\fR might return a timestamp with a full second later than
1855a subsequent \f(CW\*(C`time\*(C'\fR call \- if the equivalent of \f(CW\*(C`time ()\*(C'\fR is used to
1856update file times then there will be a small window where the kernel uses
1857the previous second to update file times but libev might already execute
1858the timer callback).
1808.PP 1859.PP
1809\fIWatcher-Specific Functions and Data Members\fR 1860\fIWatcher-Specific Functions and Data Members\fR
1810.IX Subsection "Watcher-Specific Functions and Data Members" 1861.IX Subsection "Watcher-Specific Functions and Data Members"
1811.IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 1862.IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4
1812.IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 1863.IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)"
1818\&\f(CW\*(C`path\*(C'\fR. The \f(CW\*(C`interval\*(C'\fR is a hint on how quickly a change is expected to 1869\&\f(CW\*(C`path\*(C'\fR. The \f(CW\*(C`interval\*(C'\fR is a hint on how quickly a change is expected to
1819be detected and should normally be specified as \f(CW0\fR to let libev choose 1870be detected and should normally be specified as \f(CW0\fR to let libev choose
1820a suitable value. The memory pointed to by \f(CW\*(C`path\*(C'\fR must point to the same 1871a suitable value. The memory pointed to by \f(CW\*(C`path\*(C'\fR must point to the same
1821path for as long as the watcher is active. 1872path for as long as the watcher is active.
1822.Sp 1873.Sp
1823The callback will be receive \f(CW\*(C`EV_STAT\*(C'\fR when a change was detected, 1874The callback will receive \f(CW\*(C`EV_STAT\*(C'\fR when a change was detected, relative
1824relative to the attributes at the time the watcher was started (or the 1875to the attributes at the time the watcher was started (or the last change
1825last change was detected). 1876was detected).
1826.IP "ev_stat_stat (loop, ev_stat *)" 4 1877.IP "ev_stat_stat (loop, ev_stat *)" 4
1827.IX Item "ev_stat_stat (loop, ev_stat *)" 1878.IX Item "ev_stat_stat (loop, ev_stat *)"
1828Updates the stat buffer immediately with new values. If you change the 1879Updates the stat buffer immediately with new values. If you change the
1829watched path in your callback, you could call this fucntion to avoid 1880watched path in your callback, you could call this function to avoid
1830detecting this change (while introducing a race condition). Can also be 1881detecting this change (while introducing a race condition if you are not
1831useful simply to find out the new values. 1882the only one changing the path). Can also be useful simply to find out the
1883new values.
1832.IP "ev_statdata attr [read\-only]" 4 1884.IP "ev_statdata attr [read\-only]" 4
1833.IX Item "ev_statdata attr [read-only]" 1885.IX Item "ev_statdata attr [read-only]"
1834The most-recently detected attributes of the file. Although the type is of 1886The most-recently detected attributes of the file. Although the type is
1835\&\f(CW\*(C`ev_statdata\*(C'\fR, this is usually the (or one of the) \f(CW\*(C`struct stat\*(C'\fR types 1887\&\f(CW\*(C`ev_statdata\*(C'\fR, this is usually the (or one of the) \f(CW\*(C`struct stat\*(C'\fR types
1888suitable for your system, but you can only rely on the POSIX-standardised
1836suitable for your system. If the \f(CW\*(C`st_nlink\*(C'\fR member is \f(CW0\fR, then there 1889members to be present. If the \f(CW\*(C`st_nlink\*(C'\fR member is \f(CW0\fR, then there was
1837was some error while \f(CW\*(C`stat\*(C'\fRing the file. 1890some error while \f(CW\*(C`stat\*(C'\fRing the file.
1838.IP "ev_statdata prev [read\-only]" 4 1891.IP "ev_statdata prev [read\-only]" 4
1839.IX Item "ev_statdata prev [read-only]" 1892.IX Item "ev_statdata prev [read-only]"
1840The previous attributes of the file. The callback gets invoked whenever 1893The previous attributes of the file. The callback gets invoked whenever
1841\&\f(CW\*(C`prev\*(C'\fR != \f(CW\*(C`attr\*(C'\fR. 1894\&\f(CW\*(C`prev\*(C'\fR != \f(CW\*(C`attr\*(C'\fR, or, more precisely, one or more of these members
1895differ: \f(CW\*(C`st_dev\*(C'\fR, \f(CW\*(C`st_ino\*(C'\fR, \f(CW\*(C`st_mode\*(C'\fR, \f(CW\*(C`st_nlink\*(C'\fR, \f(CW\*(C`st_uid\*(C'\fR,
1896\&\f(CW\*(C`st_gid\*(C'\fR, \f(CW\*(C`st_rdev\*(C'\fR, \f(CW\*(C`st_size\*(C'\fR, \f(CW\*(C`st_atime\*(C'\fR, \f(CW\*(C`st_mtime\*(C'\fR, \f(CW\*(C`st_ctime\*(C'\fR.
1842.IP "ev_tstamp interval [read\-only]" 4 1897.IP "ev_tstamp interval [read\-only]" 4
1843.IX Item "ev_tstamp interval [read-only]" 1898.IX Item "ev_tstamp interval [read-only]"
1844The specified interval. 1899The specified interval.
1845.IP "const char *path [read\-only]" 4 1900.IP "const char *path [read\-only]" 4
1846.IX Item "const char *path [read-only]" 1901.IX Item "const char *path [read-only]"
1847The filesystem path that is being watched. 1902The file system path that is being watched.
1848.PP 1903.PP
1849\fIExamples\fR 1904\fIExamples\fR
1850.IX Subsection "Examples" 1905.IX Subsection "Examples"
1851.PP 1906.PP
1852Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes. 1907Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes.
1853.PP 1908.PP
1854.Vb 10 1909.Vb 10
1855\& static void 1910\& static void
1856\& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) 1911\& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1857\& { 1912\& {
1858\& /* /etc/passwd changed in some way */ 1913\& /* /etc/passwd changed in some way */
1859\& if (w\->attr.st_nlink) 1914\& if (w\->attr.st_nlink)
1860\& { 1915\& {
1861\& printf ("passwd current size %ld\en", (long)w\->attr.st_size); 1916\& printf ("passwd current size %ld\en", (long)w\->attr.st_size);
1862\& printf ("passwd current atime %ld\en", (long)w\->attr.st_mtime); 1917\& printf ("passwd current atime %ld\en", (long)w\->attr.st_mtime);
1863\& printf ("passwd current mtime %ld\en", (long)w\->attr.st_mtime); 1918\& printf ("passwd current mtime %ld\en", (long)w\->attr.st_mtime);
1864\& } 1919\& }
1865\& else 1920\& else
1866\& /* you shalt not abuse printf for puts */ 1921\& /* you shalt not abuse printf for puts */
1867\& puts ("wow, /etc/passwd is not there, expect problems. " 1922\& puts ("wow, /etc/passwd is not there, expect problems. "
1868\& "if this is windows, they already arrived\en"); 1923\& "if this is windows, they already arrived\en");
1869\& } 1924\& }
1870\& 1925\&
1871\& ... 1926\& ...
1872\& ev_stat passwd; 1927\& ev_stat passwd;
1873\& 1928\&
1874\& ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.); 1929\& ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
1875\& ev_stat_start (loop, &passwd); 1930\& ev_stat_start (loop, &passwd);
1876.Ve 1931.Ve
1877.PP 1932.PP
1878Example: Like above, but additionally use a one-second delay so we do not 1933Example: Like above, but additionally use a one-second delay so we do not
1879miss updates (however, frequent updates will delay processing, too, so 1934miss updates (however, frequent updates will delay processing, too, so
1880one might do the work both on \f(CW\*(C`ev_stat\*(C'\fR callback invocation \fIand\fR on 1935one might do the work both on \f(CW\*(C`ev_stat\*(C'\fR callback invocation \fIand\fR on
1881\&\f(CW\*(C`ev_timer\*(C'\fR callback invocation). 1936\&\f(CW\*(C`ev_timer\*(C'\fR callback invocation).
1882.PP 1937.PP
1883.Vb 2 1938.Vb 2
1884\& static ev_stat passwd; 1939\& static ev_stat passwd;
1885\& static ev_timer timer; 1940\& static ev_timer timer;
1886\& 1941\&
1887\& static void 1942\& static void
1888\& timer_cb (EV_P_ ev_timer *w, int revents) 1943\& timer_cb (EV_P_ ev_timer *w, int revents)
1889\& { 1944\& {
1890\& ev_timer_stop (EV_A_ w); 1945\& ev_timer_stop (EV_A_ w);
1891\& 1946\&
1892\& /* now it\*(Aqs one second after the most recent passwd change */ 1947\& /* now it\*(Aqs one second after the most recent passwd change */
1893\& } 1948\& }
1894\& 1949\&
1895\& static void 1950\& static void
1896\& stat_cb (EV_P_ ev_stat *w, int revents) 1951\& stat_cb (EV_P_ ev_stat *w, int revents)
1897\& { 1952\& {
1898\& /* reset the one\-second timer */ 1953\& /* reset the one\-second timer */
1899\& ev_timer_again (EV_A_ &timer); 1954\& ev_timer_again (EV_A_ &timer);
1900\& } 1955\& }
1901\& 1956\&
1902\& ... 1957\& ...
1903\& ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.); 1958\& ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1904\& ev_stat_start (loop, &passwd); 1959\& ev_stat_start (loop, &passwd);
1905\& ev_timer_init (&timer, timer_cb, 0., 1.01); 1960\& ev_timer_init (&timer, timer_cb, 0., 1.02);
1906.Ve 1961.Ve
1907.ie n .Sh """ev_idle"" \- when you've got nothing better to do..." 1962.ie n .Sh """ev_idle"" \- when you've got nothing better to do..."
1908.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." 1963.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..."
1909.IX Subsection "ev_idle - when you've got nothing better to do..." 1964.IX Subsection "ev_idle - when you've got nothing better to do..."
1910Idle watchers trigger events when no other events of the same or higher 1965Idle watchers trigger events when no other events of the same or higher
1939.PP 1994.PP
1940Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the 1995Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the
1941callback, free it. Also, use no error checking, as usual. 1996callback, free it. Also, use no error checking, as usual.
1942.PP 1997.PP
1943.Vb 7 1998.Vb 7
1944\& static void 1999\& static void
1945\& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) 2000\& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1946\& { 2001\& {
1947\& free (w); 2002\& free (w);
1948\& // now do something you wanted to do when the program has 2003\& // now do something you wanted to do when the program has
1949\& // no longer anything immediate to do. 2004\& // no longer anything immediate to do.
1950\& } 2005\& }
1951\& 2006\&
1952\& struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); 2007\& struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));
1953\& ev_idle_init (idle_watcher, idle_cb); 2008\& ev_idle_init (idle_watcher, idle_cb);
1954\& ev_idle_start (loop, idle_cb); 2009\& ev_idle_start (loop, idle_cb);
1955.Ve 2010.Ve
1956.ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop!" 2011.ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop!"
1957.el .Sh "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!" 2012.el .Sh "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!"
1958.IX Subsection "ev_prepare and ev_check - customise your event loop!" 2013.IX Subsection "ev_prepare and ev_check - customise your event loop!"
1959Prepare and check watchers are usually (but not always) used in tandem: 2014Prepare and check watchers are usually (but not always) used in tandem:
1978.PP 2033.PP
1979This is done by examining in each prepare call which file descriptors need 2034This is done by examining in each prepare call which file descriptors need
1980to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers for 2035to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers for
1981them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many libraries 2036them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many libraries
1982provide just this functionality). Then, in the check watcher you check for 2037provide just this functionality). Then, in the check watcher you check for
1983any events that occured (by checking the pending status of all watchers 2038any events that occurred (by checking the pending status of all watchers
1984and stopping them) and call back into the library. The I/O and timer 2039and stopping them) and call back into the library. The I/O and timer
1985callbacks will never actually be called (but must be valid nevertheless, 2040callbacks will never actually be called (but must be valid nevertheless,
1986because you never know, you know?). 2041because you never know, you know?).
1987.PP 2042.PP
1988As another example, the Perl Coro module uses these hooks to integrate 2043As another example, the Perl Coro module uses these hooks to integrate
1996.PP 2051.PP
1997It is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) 2052It is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR)
1998priority, to ensure that they are being run before any other watchers 2053priority, to ensure that they are being run before any other watchers
1999after the poll. Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, 2054after the poll. Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers,
2000too) should not activate (\*(L"feed\*(R") events into libev. While libev fully 2055too) should not activate (\*(L"feed\*(R") events into libev. While libev fully
2001supports this, they will be called before other \f(CW\*(C`ev_check\*(C'\fR watchers 2056supports this, they might get executed before other \f(CW\*(C`ev_check\*(C'\fR watchers
2002did their job. As \f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other 2057did their job. As \f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other
2003(non-libev) event loops those other event loops might be in an unusable 2058(non-libev) event loops those other event loops might be in an unusable
2004state until their \f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to 2059state until their \f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to
2005coexist peacefully with others). 2060coexist peacefully with others).
2006.PP 2061.PP
2020.IX Subsection "Examples" 2075.IX Subsection "Examples"
2021.PP 2076.PP
2022There are a number of principal ways to embed other event loops or modules 2077There are a number of principal ways to embed other event loops or modules
2023into libev. Here are some ideas on how to include libadns into libev 2078into libev. Here are some ideas on how to include libadns into libev
2024(there is a Perl module named \f(CW\*(C`EV::ADNS\*(C'\fR that does this, which you could 2079(there is a Perl module named \f(CW\*(C`EV::ADNS\*(C'\fR that does this, which you could
2025use for an actually working example. Another Perl module named \f(CW\*(C`EV::Glib\*(C'\fR 2080use as a working example. Another Perl module named \f(CW\*(C`EV::Glib\*(C'\fR embeds a
2026embeds a Glib main context into libev, and finally, \f(CW\*(C`Glib::EV\*(C'\fR embeds \s-1EV\s0 2081Glib main context into libev, and finally, \f(CW\*(C`Glib::EV\*(C'\fR embeds \s-1EV\s0 into the
2027into the Glib event loop). 2082Glib event loop).
2028.PP 2083.PP
2029Method 1: Add \s-1IO\s0 watchers and a timeout watcher in a prepare handler, 2084Method 1: Add \s-1IO\s0 watchers and a timeout watcher in a prepare handler,
2030and in a check watcher, destroy them and call into libadns. What follows 2085and in a check watcher, destroy them and call into libadns. What follows
2031is pseudo-code only of course. This requires you to either use a low 2086is pseudo-code only of course. This requires you to either use a low
2032priority for the check watcher or use \f(CW\*(C`ev_clear_pending\*(C'\fR explicitly, as 2087priority for the check watcher or use \f(CW\*(C`ev_clear_pending\*(C'\fR explicitly, as
2033the callbacks for the IO/timeout watchers might not have been called yet. 2088the callbacks for the IO/timeout watchers might not have been called yet.
2034.PP 2089.PP
2035.Vb 2 2090.Vb 2
2036\& static ev_io iow [nfd]; 2091\& static ev_io iow [nfd];
2037\& static ev_timer tw; 2092\& static ev_timer tw;
2038\& 2093\&
2039\& static void 2094\& static void
2040\& io_cb (ev_loop *loop, ev_io *w, int revents) 2095\& io_cb (ev_loop *loop, ev_io *w, int revents)
2041\& { 2096\& {
2042\& } 2097\& }
2043\& 2098\&
2044\& // create io watchers for each fd and a timer before blocking 2099\& // create io watchers for each fd and a timer before blocking
2045\& static void 2100\& static void
2046\& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) 2101\& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
2047\& { 2102\& {
2048\& int timeout = 3600000; 2103\& int timeout = 3600000;
2049\& struct pollfd fds [nfd]; 2104\& struct pollfd fds [nfd];
2050\& // actual code will need to loop here and realloc etc. 2105\& // actual code will need to loop here and realloc etc.
2051\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); 2106\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
2052\& 2107\&
2053\& /* the callback is illegal, but won\*(Aqt be called as we stop during check */ 2108\& /* the callback is illegal, but won\*(Aqt be called as we stop during check */
2054\& ev_timer_init (&tw, 0, timeout * 1e\-3); 2109\& ev_timer_init (&tw, 0, timeout * 1e\-3);
2055\& ev_timer_start (loop, &tw); 2110\& ev_timer_start (loop, &tw);
2056\& 2111\&
2057\& // create one ev_io per pollfd 2112\& // create one ev_io per pollfd
2058\& for (int i = 0; i < nfd; ++i) 2113\& for (int i = 0; i < nfd; ++i)
2059\& { 2114\& {
2060\& ev_io_init (iow + i, io_cb, fds [i].fd, 2115\& ev_io_init (iow + i, io_cb, fds [i].fd,
2061\& ((fds [i].events & POLLIN ? EV_READ : 0) 2116\& ((fds [i].events & POLLIN ? EV_READ : 0)
2062\& | (fds [i].events & POLLOUT ? EV_WRITE : 0))); 2117\& | (fds [i].events & POLLOUT ? EV_WRITE : 0)));
2063\& 2118\&
2064\& fds [i].revents = 0; 2119\& fds [i].revents = 0;
2065\& ev_io_start (loop, iow + i); 2120\& ev_io_start (loop, iow + i);
2066\& } 2121\& }
2067\& } 2122\& }
2068\& 2123\&
2069\& // stop all watchers after blocking 2124\& // stop all watchers after blocking
2070\& static void 2125\& static void
2071\& adns_check_cb (ev_loop *loop, ev_check *w, int revents) 2126\& adns_check_cb (ev_loop *loop, ev_check *w, int revents)
2072\& { 2127\& {
2073\& ev_timer_stop (loop, &tw); 2128\& ev_timer_stop (loop, &tw);
2074\& 2129\&
2075\& for (int i = 0; i < nfd; ++i) 2130\& for (int i = 0; i < nfd; ++i)
2076\& { 2131\& {
2077\& // set the relevant poll flags 2132\& // set the relevant poll flags
2078\& // could also call adns_processreadable etc. here 2133\& // could also call adns_processreadable etc. here
2079\& struct pollfd *fd = fds + i; 2134\& struct pollfd *fd = fds + i;
2080\& int revents = ev_clear_pending (iow + i); 2135\& int revents = ev_clear_pending (iow + i);
2081\& if (revents & EV_READ ) fd\->revents |= fd\->events & POLLIN; 2136\& if (revents & EV_READ ) fd\->revents |= fd\->events & POLLIN;
2082\& if (revents & EV_WRITE) fd\->revents |= fd\->events & POLLOUT; 2137\& if (revents & EV_WRITE) fd\->revents |= fd\->events & POLLOUT;
2083\& 2138\&
2084\& // now stop the watcher 2139\& // now stop the watcher
2085\& ev_io_stop (loop, iow + i); 2140\& ev_io_stop (loop, iow + i);
2086\& } 2141\& }
2087\& 2142\&
2088\& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); 2143\& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
2089\& } 2144\& }
2090.Ve 2145.Ve
2091.PP 2146.PP
2092Method 2: This would be just like method 1, but you run \f(CW\*(C`adns_afterpoll\*(C'\fR 2147Method 2: This would be just like method 1, but you run \f(CW\*(C`adns_afterpoll\*(C'\fR
2093in the prepare watcher and would dispose of the check watcher. 2148in the prepare watcher and would dispose of the check watcher.
2094.PP 2149.PP
2095Method 3: If the module to be embedded supports explicit event 2150Method 3: If the module to be embedded supports explicit event
2096notification (adns does), you can also make use of the actual watcher 2151notification (libadns does), you can also make use of the actual watcher
2097callbacks, and only destroy/create the watchers in the prepare watcher. 2152callbacks, and only destroy/create the watchers in the prepare watcher.
2098.PP 2153.PP
2099.Vb 5 2154.Vb 5
2100\& static void 2155\& static void
2101\& timer_cb (EV_P_ ev_timer *w, int revents) 2156\& timer_cb (EV_P_ ev_timer *w, int revents)
2102\& { 2157\& {
2103\& adns_state ads = (adns_state)w\->data; 2158\& adns_state ads = (adns_state)w\->data;
2104\& update_now (EV_A); 2159\& update_now (EV_A);
2105\& 2160\&
2106\& adns_processtimeouts (ads, &tv_now); 2161\& adns_processtimeouts (ads, &tv_now);
2107\& } 2162\& }
2108\& 2163\&
2109\& static void 2164\& static void
2110\& io_cb (EV_P_ ev_io *w, int revents) 2165\& io_cb (EV_P_ ev_io *w, int revents)
2111\& { 2166\& {
2112\& adns_state ads = (adns_state)w\->data; 2167\& adns_state ads = (adns_state)w\->data;
2113\& update_now (EV_A); 2168\& update_now (EV_A);
2114\& 2169\&
2115\& if (revents & EV_READ ) adns_processreadable (ads, w\->fd, &tv_now); 2170\& if (revents & EV_READ ) adns_processreadable (ads, w\->fd, &tv_now);
2116\& if (revents & EV_WRITE) adns_processwriteable (ads, w\->fd, &tv_now); 2171\& if (revents & EV_WRITE) adns_processwriteable (ads, w\->fd, &tv_now);
2117\& } 2172\& }
2118\& 2173\&
2119\& // do not ever call adns_afterpoll 2174\& // do not ever call adns_afterpoll
2120.Ve 2175.Ve
2121.PP 2176.PP
2122Method 4: Do not use a prepare or check watcher because the module you 2177Method 4: Do not use a prepare or check watcher because the module you
2123want to embed is too inflexible to support it. Instead, youc na override 2178want to embed is too inflexible to support it. Instead, you can override
2124their poll function. The drawback with this solution is that the main 2179their poll function. The drawback with this solution is that the main
2125loop is now no longer controllable by \s-1EV\s0. The \f(CW\*(C`Glib::EV\*(C'\fR module does 2180loop is now no longer controllable by \s-1EV\s0. The \f(CW\*(C`Glib::EV\*(C'\fR module does
2126this. 2181this.
2127.PP 2182.PP
2128.Vb 4 2183.Vb 4
2129\& static gint 2184\& static gint
2130\& event_poll_func (GPollFD *fds, guint nfds, gint timeout) 2185\& event_poll_func (GPollFD *fds, guint nfds, gint timeout)
2131\& { 2186\& {
2132\& int got_events = 0; 2187\& int got_events = 0;
2133\& 2188\&
2134\& for (n = 0; n < nfds; ++n) 2189\& for (n = 0; n < nfds; ++n)
2135\& // create/start io watcher that sets the relevant bits in fds[n] and increment got_events 2190\& // create/start io watcher that sets the relevant bits in fds[n] and increment got_events
2136\& 2191\&
2137\& if (timeout >= 0) 2192\& if (timeout >= 0)
2138\& // create/start timer 2193\& // create/start timer
2139\& 2194\&
2140\& // poll 2195\& // poll
2141\& ev_loop (EV_A_ 0); 2196\& ev_loop (EV_A_ 0);
2142\& 2197\&
2143\& // stop timer again 2198\& // stop timer again
2144\& if (timeout >= 0) 2199\& if (timeout >= 0)
2145\& ev_timer_stop (EV_A_ &to); 2200\& ev_timer_stop (EV_A_ &to);
2146\& 2201\&
2147\& // stop io watchers again \- their callbacks should have set 2202\& // stop io watchers again \- their callbacks should have set
2148\& for (n = 0; n < nfds; ++n) 2203\& for (n = 0; n < nfds; ++n)
2149\& ev_io_stop (EV_A_ iow [n]); 2204\& ev_io_stop (EV_A_ iow [n]);
2150\& 2205\&
2151\& return got_events; 2206\& return got_events;
2152\& } 2207\& }
2153.Ve 2208.Ve
2154.ie n .Sh """ev_embed"" \- when one backend isn't enough..." 2209.ie n .Sh """ev_embed"" \- when one backend isn't enough..."
2155.el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." 2210.el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..."
2156.IX Subsection "ev_embed - when one backend isn't enough..." 2211.IX Subsection "ev_embed - when one backend isn't enough..."
2157This is a rather advanced watcher type that lets you embed one event loop 2212This is a rather advanced watcher type that lets you embed one event loop
2213.PD 2268.PD
2214Configures the watcher to embed the given loop, which must be 2269Configures the watcher to embed the given loop, which must be
2215embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be 2270embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be
2216invoked automatically, otherwise it is the responsibility of the callback 2271invoked automatically, otherwise it is the responsibility of the callback
2217to invoke it (it will continue to be called until the sweep has been done, 2272to invoke it (it will continue to be called until the sweep has been done,
2218if you do not want thta, you need to temporarily stop the embed watcher). 2273if you do not want that, you need to temporarily stop the embed watcher).
2219.IP "ev_embed_sweep (loop, ev_embed *)" 4 2274.IP "ev_embed_sweep (loop, ev_embed *)" 4
2220.IX Item "ev_embed_sweep (loop, ev_embed *)" 2275.IX Item "ev_embed_sweep (loop, ev_embed *)"
2221Make a single, non-blocking sweep over the embedded loop. This works 2276Make a single, non-blocking sweep over the embedded loop. This works
2222similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most 2277similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most
2223apropriate way for embedded loops. 2278appropriate way for embedded loops.
2224.IP "struct ev_loop *other [read\-only]" 4 2279.IP "struct ev_loop *other [read\-only]" 4
2225.IX Item "struct ev_loop *other [read-only]" 2280.IX Item "struct ev_loop *other [read-only]"
2226The embedded event loop. 2281The embedded event loop.
2227.PP 2282.PP
2228\fIExamples\fR 2283\fIExamples\fR
2229.IX Subsection "Examples" 2284.IX Subsection "Examples"
2230.PP 2285.PP
2231Example: Try to get an embeddable event loop and embed it into the default 2286Example: Try to get an embeddable event loop and embed it into the default
2232event loop. If that is not possible, use the default loop. The default 2287event loop. If that is not possible, use the default loop. The default
2233loop is stored in \f(CW\*(C`loop_hi\*(C'\fR, while the mebeddable loop is stored in 2288loop is stored in \f(CW\*(C`loop_hi\*(C'\fR, while the embeddable loop is stored in
2234\&\f(CW\*(C`loop_lo\*(C'\fR (which is \f(CW\*(C`loop_hi\*(C'\fR in the acse no embeddable loop can be 2289\&\f(CW\*(C`loop_lo\*(C'\fR (which is \f(CW\*(C`loop_hi\*(C'\fR in the case no embeddable loop can be
2235used). 2290used).
2236.PP 2291.PP
2237.Vb 3 2292.Vb 3
2238\& struct ev_loop *loop_hi = ev_default_init (0); 2293\& struct ev_loop *loop_hi = ev_default_init (0);
2239\& struct ev_loop *loop_lo = 0; 2294\& struct ev_loop *loop_lo = 0;
2240\& struct ev_embed embed; 2295\& struct ev_embed embed;
2241\& 2296\&
2242\& // see if there is a chance of getting one that works 2297\& // see if there is a chance of getting one that works
2243\& // (remember that a flags value of 0 means autodetection) 2298\& // (remember that a flags value of 0 means autodetection)
2244\& loop_lo = ev_embeddable_backends () & ev_recommended_backends () 2299\& loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
2245\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 2300\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
2246\& : 0; 2301\& : 0;
2247\& 2302\&
2248\& // if we got one, then embed it, otherwise default to loop_hi 2303\& // if we got one, then embed it, otherwise default to loop_hi
2249\& if (loop_lo) 2304\& if (loop_lo)
2250\& { 2305\& {
2251\& ev_embed_init (&embed, 0, loop_lo); 2306\& ev_embed_init (&embed, 0, loop_lo);
2252\& ev_embed_start (loop_hi, &embed); 2307\& ev_embed_start (loop_hi, &embed);
2253\& } 2308\& }
2254\& else 2309\& else
2255\& loop_lo = loop_hi; 2310\& loop_lo = loop_hi;
2256.Ve 2311.Ve
2257.PP 2312.PP
2258Example: Check if kqueue is available but not recommended and create 2313Example: Check if kqueue is available but not recommended and create
2259a kqueue backend for use with sockets (which usually work with any 2314a kqueue backend for use with sockets (which usually work with any
2260kqueue implementation). Store the kqueue/socket\-only event loop in 2315kqueue implementation). Store the kqueue/socket\-only event loop in
2261\&\f(CW\*(C`loop_socket\*(C'\fR. (One might optionally use \f(CW\*(C`EVFLAG_NOENV\*(C'\fR, too). 2316\&\f(CW\*(C`loop_socket\*(C'\fR. (One might optionally use \f(CW\*(C`EVFLAG_NOENV\*(C'\fR, too).
2262.PP 2317.PP
2263.Vb 3 2318.Vb 3
2264\& struct ev_loop *loop = ev_default_init (0); 2319\& struct ev_loop *loop = ev_default_init (0);
2265\& struct ev_loop *loop_socket = 0; 2320\& struct ev_loop *loop_socket = 0;
2266\& struct ev_embed embed; 2321\& struct ev_embed embed;
2267\& 2322\&
2268\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 2323\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2269\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 2324\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2270\& { 2325\& {
2271\& ev_embed_init (&embed, 0, loop_socket); 2326\& ev_embed_init (&embed, 0, loop_socket);
2272\& ev_embed_start (loop, &embed); 2327\& ev_embed_start (loop, &embed);
2273\& } 2328\& }
2274\& 2329\&
2275\& if (!loop_socket) 2330\& if (!loop_socket)
2276\& loop_socket = loop; 2331\& loop_socket = loop;
2277\& 2332\&
2278\& // now use loop_socket for all sockets, and loop for everything else 2333\& // now use loop_socket for all sockets, and loop for everything else
2279.Ve 2334.Ve
2280.ie n .Sh """ev_fork"" \- the audacity to resume the event loop after a fork" 2335.ie n .Sh """ev_fork"" \- the audacity to resume the event loop after a fork"
2281.el .Sh "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork" 2336.el .Sh "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork"
2282.IX Subsection "ev_fork - the audacity to resume the event loop after a fork" 2337.IX Subsection "ev_fork - the audacity to resume the event loop after a fork"
2283Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because 2338Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because
2329queue: 2384queue:
2330.IP "queueing from a signal handler context" 4 2385.IP "queueing from a signal handler context" 4
2331.IX Item "queueing from a signal handler context" 2386.IX Item "queueing from a signal handler context"
2332To implement race-free queueing, you simply add to the queue in the signal 2387To implement race-free queueing, you simply add to the queue in the signal
2333handler but you block the signal handler in the watcher callback. Here is an example that does that for 2388handler but you block the signal handler in the watcher callback. Here is an example that does that for
2334some fictitiuous \s-1SIGUSR1\s0 handler: 2389some fictitious \s-1SIGUSR1\s0 handler:
2335.Sp 2390.Sp
2336.Vb 1 2391.Vb 1
2337\& static ev_async mysig; 2392\& static ev_async mysig;
2338\& 2393\&
2339\& static void 2394\& static void
2410.IP "ev_async_send (loop, ev_async *)" 4 2465.IP "ev_async_send (loop, ev_async *)" 4
2411.IX Item "ev_async_send (loop, ev_async *)" 2466.IX Item "ev_async_send (loop, ev_async *)"
2412Sends/signals/activates the given \f(CW\*(C`ev_async\*(C'\fR watcher, that is, feeds 2467Sends/signals/activates the given \f(CW\*(C`ev_async\*(C'\fR watcher, that is, feeds
2413an \f(CW\*(C`EV_ASYNC\*(C'\fR event on the watcher into the event loop. Unlike 2468an \f(CW\*(C`EV_ASYNC\*(C'\fR event on the watcher into the event loop. Unlike
2414\&\f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do in other threads, signal or 2469\&\f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do in other threads, signal or
2415similar contexts (see the dicusssion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the embedding 2470similar contexts (see the discussion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the embedding
2416section below on what exactly this means). 2471section below on what exactly this means).
2417.Sp 2472.Sp
2418This call incurs the overhead of a syscall only once per loop iteration, 2473This call incurs the overhead of a system call only once per loop iteration,
2419so while the overhead might be noticable, it doesn't apply to repeated 2474so while the overhead might be noticeable, it doesn't apply to repeated
2420calls to \f(CW\*(C`ev_async_send\*(C'\fR. 2475calls to \f(CW\*(C`ev_async_send\*(C'\fR.
2421.IP "bool = ev_async_pending (ev_async *)" 4 2476.IP "bool = ev_async_pending (ev_async *)" 4
2422.IX Item "bool = ev_async_pending (ev_async *)" 2477.IX Item "bool = ev_async_pending (ev_async *)"
2423Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the 2478Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the
2424watcher but the event has not yet been processed (or even noted) by the 2479watcher but the event has not yet been processed (or even noted) by the
2425event loop. 2480event loop.
2426.Sp 2481.Sp
2427\&\f(CW\*(C`ev_async_send\*(C'\fR sets a flag in the watcher and wakes up the loop. When 2482\&\f(CW\*(C`ev_async_send\*(C'\fR sets a flag in the watcher and wakes up the loop. When
2428the loop iterates next and checks for the watcher to have become active, 2483the loop iterates next and checks for the watcher to have become active,
2429it will reset the flag again. \f(CW\*(C`ev_async_pending\*(C'\fR can be used to very 2484it will reset the flag again. \f(CW\*(C`ev_async_pending\*(C'\fR can be used to very
2430quickly check wether invoking the loop might be a good idea. 2485quickly check whether invoking the loop might be a good idea.
2431.Sp 2486.Sp
2432Not that this does \fInot\fR check wether the watcher itself is pending, only 2487Not that this does \fInot\fR check whether the watcher itself is pending, only
2433wether it has been requested to make this watcher pending. 2488whether it has been requested to make this watcher pending.
2434.SH "OTHER FUNCTIONS" 2489.SH "OTHER FUNCTIONS"
2435.IX Header "OTHER FUNCTIONS" 2490.IX Header "OTHER FUNCTIONS"
2436There are some other functions of possible interest. Described. Here. Now. 2491There are some other functions of possible interest. Described. Here. Now.
2437.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 2492.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4
2438.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 2493.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)"
2442or timeout without having to allocate/configure/start/stop/free one or 2497or timeout without having to allocate/configure/start/stop/free one or
2443more watchers yourself. 2498more watchers yourself.
2444.Sp 2499.Sp
2445If \f(CW\*(C`fd\*(C'\fR is less than 0, then no I/O watcher will be started and events 2500If \f(CW\*(C`fd\*(C'\fR is less than 0, then no I/O watcher will be started and events
2446is being ignored. Otherwise, an \f(CW\*(C`ev_io\*(C'\fR watcher for the given \f(CW\*(C`fd\*(C'\fR and 2501is being ignored. Otherwise, an \f(CW\*(C`ev_io\*(C'\fR watcher for the given \f(CW\*(C`fd\*(C'\fR and
2447\&\f(CW\*(C`events\*(C'\fR set will be craeted and started. 2502\&\f(CW\*(C`events\*(C'\fR set will be created and started.
2448.Sp 2503.Sp
2449If \f(CW\*(C`timeout\*(C'\fR is less than 0, then no timeout watcher will be 2504If \f(CW\*(C`timeout\*(C'\fR is less than 0, then no timeout watcher will be
2450started. Otherwise an \f(CW\*(C`ev_timer\*(C'\fR watcher with after = \f(CW\*(C`timeout\*(C'\fR (and 2505started. Otherwise an \f(CW\*(C`ev_timer\*(C'\fR watcher with after = \f(CW\*(C`timeout\*(C'\fR (and
2451repeat = 0) will be started. While \f(CW0\fR is a valid timeout, it is of 2506repeat = 0) will be started. While \f(CW0\fR is a valid timeout, it is of
2452dubious value. 2507dubious value.
2455passed an \f(CW\*(C`revents\*(C'\fR set like normal event callbacks (a combination of 2510passed an \f(CW\*(C`revents\*(C'\fR set like normal event callbacks (a combination of
2456\&\f(CW\*(C`EV_ERROR\*(C'\fR, \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or \f(CW\*(C`EV_TIMEOUT\*(C'\fR) and the \f(CW\*(C`arg\*(C'\fR 2511\&\f(CW\*(C`EV_ERROR\*(C'\fR, \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or \f(CW\*(C`EV_TIMEOUT\*(C'\fR) and the \f(CW\*(C`arg\*(C'\fR
2457value passed to \f(CW\*(C`ev_once\*(C'\fR: 2512value passed to \f(CW\*(C`ev_once\*(C'\fR:
2458.Sp 2513.Sp
2459.Vb 7 2514.Vb 7
2460\& static void stdin_ready (int revents, void *arg) 2515\& static void stdin_ready (int revents, void *arg)
2461\& { 2516\& {
2462\& if (revents & EV_TIMEOUT) 2517\& if (revents & EV_TIMEOUT)
2463\& /* doh, nothing entered */; 2518\& /* doh, nothing entered */;
2464\& else if (revents & EV_READ) 2519\& else if (revents & EV_READ)
2465\& /* stdin might have data for us, joy! */; 2520\& /* stdin might have data for us, joy! */;
2466\& } 2521\& }
2467\& 2522\&
2468\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 2523\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2469.Ve 2524.Ve
2470.IP "ev_feed_event (ev_loop *, watcher *, int revents)" 4 2525.IP "ev_feed_event (ev_loop *, watcher *, int revents)" 4
2471.IX Item "ev_feed_event (ev_loop *, watcher *, int revents)" 2526.IX Item "ev_feed_event (ev_loop *, watcher *, int revents)"
2472Feeds the given event set into the event loop, as if the specified event 2527Feeds the given event set into the event loop, as if the specified event
2473had happened for the specified watcher (which must be a pointer to an 2528had happened for the specified watcher (which must be a pointer to an
2476.IX Item "ev_feed_fd_event (ev_loop *, int fd, int revents)" 2531.IX Item "ev_feed_fd_event (ev_loop *, int fd, int revents)"
2477Feed an event on the given fd, as if a file descriptor backend detected 2532Feed an event on the given fd, as if a file descriptor backend detected
2478the given events it. 2533the given events it.
2479.IP "ev_feed_signal_event (ev_loop *loop, int signum)" 4 2534.IP "ev_feed_signal_event (ev_loop *loop, int signum)" 4
2480.IX Item "ev_feed_signal_event (ev_loop *loop, int signum)" 2535.IX Item "ev_feed_signal_event (ev_loop *loop, int signum)"
2481Feed an event as if the given signal occured (\f(CW\*(C`loop\*(C'\fR must be the default 2536Feed an event as if the given signal occurred (\f(CW\*(C`loop\*(C'\fR must be the default
2482loop!). 2537loop!).
2483.SH "LIBEVENT EMULATION" 2538.SH "LIBEVENT EMULATION"
2484.IX Header "LIBEVENT EMULATION" 2539.IX Header "LIBEVENT EMULATION"
2485Libev offers a compatibility emulation layer for libevent. It cannot 2540Libev offers a compatibility emulation layer for libevent. It cannot
2486emulate the internals of libevent, so here are some usage hints: 2541emulate the internals of libevent, so here are some usage hints:
2496.IP "\(bu" 4 2551.IP "\(bu" 4
2497Priorities are not currently supported. Initialising priorities 2552Priorities are not currently supported. Initialising priorities
2498will fail and all watchers will have the same priority, even though there 2553will fail and all watchers will have the same priority, even though there
2499is an ev_pri field. 2554is an ev_pri field.
2500.IP "\(bu" 4 2555.IP "\(bu" 4
2556In libevent, the last base created gets the signals, in libev, the
2557first base created (== the default loop) gets the signals.
2558.IP "\(bu" 4
2501Other members are not supported. 2559Other members are not supported.
2502.IP "\(bu" 4 2560.IP "\(bu" 4
2503The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need 2561The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need
2504to use the libev header file and library. 2562to use the libev header file and library.
2505.SH "\*(C+ SUPPORT" 2563.SH "\*(C+ SUPPORT"
2506.IX Header " SUPPORT" 2564.IX Header " SUPPORT"
2507Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow 2565Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow
2508you to use some convinience methods to start/stop watchers and also change 2566you to use some convenience methods to start/stop watchers and also change
2509the callback model to a model using method callbacks on objects. 2567the callback model to a model using method callbacks on objects.
2510.PP 2568.PP
2511To use it, 2569To use it,
2512.PP 2570.PP
2513.Vb 1 2571.Vb 1
2514\& #include <ev++.h> 2572\& #include <ev++.h>
2515.Ve 2573.Ve
2516.PP 2574.PP
2517This automatically includes \fIev.h\fR and puts all of its definitions (many 2575This automatically includes \fIev.h\fR and puts all of its definitions (many
2518of them macros) into the global namespace. All \*(C+ specific things are 2576of them macros) into the global namespace. All \*(C+ specific things are
2519put into the \f(CW\*(C`ev\*(C'\fR namespace. It should support all the same embedding 2577put into the \f(CW\*(C`ev\*(C'\fR namespace. It should support all the same embedding
2585thunking function, making it as fast as a direct C callback. 2643thunking function, making it as fast as a direct C callback.
2586.Sp 2644.Sp
2587Example: simple class declaration and watcher initialisation 2645Example: simple class declaration and watcher initialisation
2588.Sp 2646.Sp
2589.Vb 4 2647.Vb 4
2590\& struct myclass 2648\& struct myclass
2591\& { 2649\& {
2592\& void io_cb (ev::io &w, int revents) { } 2650\& void io_cb (ev::io &w, int revents) { }
2593\& } 2651\& }
2594\& 2652\&
2595\& myclass obj; 2653\& myclass obj;
2596\& ev::io iow; 2654\& ev::io iow;
2597\& iow.set <myclass, &myclass::io_cb> (&obj); 2655\& iow.set <myclass, &myclass::io_cb> (&obj);
2598.Ve 2656.Ve
2599.IP "w\->set<function> (void *data = 0)" 4 2657.IP "w\->set<function> (void *data = 0)" 4
2600.IX Item "w->set<function> (void *data = 0)" 2658.IX Item "w->set<function> (void *data = 0)"
2601Also sets a callback, but uses a static method or plain function as 2659Also sets a callback, but uses a static method or plain function as
2602callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's 2660callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's
2607See the method\-\f(CW\*(C`set\*(C'\fR above for more details. 2665See the method\-\f(CW\*(C`set\*(C'\fR above for more details.
2608.Sp 2666.Sp
2609Example: 2667Example:
2610.Sp 2668.Sp
2611.Vb 2 2669.Vb 2
2612\& static void io_cb (ev::io &w, int revents) { } 2670\& static void io_cb (ev::io &w, int revents) { }
2613\& iow.set <io_cb> (); 2671\& iow.set <io_cb> ();
2614.Ve 2672.Ve
2615.IP "w\->set (struct ev_loop *)" 4 2673.IP "w\->set (struct ev_loop *)" 4
2616.IX Item "w->set (struct ev_loop *)" 2674.IX Item "w->set (struct ev_loop *)"
2617Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only 2675Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only
2618do this when the watcher is inactive (and not pending either). 2676do this when the watcher is inactive (and not pending either).
2619.IP "w\->set ([args])" 4 2677.IP "w\->set ([arguments])" 4
2620.IX Item "w->set ([args])" 2678.IX Item "w->set ([arguments])"
2621Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be 2679Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same arguments. Must be
2622called at least once. Unlike the C counterpart, an active watcher gets 2680called at least once. Unlike the C counterpart, an active watcher gets
2623automatically stopped and restarted when reconfiguring it with this 2681automatically stopped and restarted when reconfiguring it with this
2624method. 2682method.
2625.IP "w\->start ()" 4 2683.IP "w\->start ()" 4
2626.IX Item "w->start ()" 2684.IX Item "w->start ()"
2648.PP 2706.PP
2649Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in 2707Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in
2650the constructor. 2708the constructor.
2651.PP 2709.PP
2652.Vb 4 2710.Vb 4
2653\& class myclass 2711\& class myclass
2654\& { 2712\& {
2655\& ev::io io; void io_cb (ev::io &w, int revents); 2713\& ev::io io; void io_cb (ev::io &w, int revents);
2656\& ev:idle idle void idle_cb (ev::idle &w, int revents); 2714\& ev:idle idle void idle_cb (ev::idle &w, int revents);
2657\& 2715\&
2658\& myclass (int fd) 2716\& myclass (int fd)
2659\& { 2717\& {
2660\& io .set <myclass, &myclass::io_cb > (this); 2718\& io .set <myclass, &myclass::io_cb > (this);
2661\& idle.set <myclass, &myclass::idle_cb> (this); 2719\& idle.set <myclass, &myclass::idle_cb> (this);
2662\& 2720\&
2663\& io.start (fd, ev::READ); 2721\& io.start (fd, ev::READ);
2664\& } 2722\& }
2665\& }; 2723\& };
2666.Ve 2724.Ve
2667.SH "OTHER LANGUAGE BINDINGS" 2725.SH "OTHER LANGUAGE BINDINGS"
2668.IX Header "OTHER LANGUAGE BINDINGS" 2726.IX Header "OTHER LANGUAGE BINDINGS"
2669Libev does not offer other language bindings itself, but bindings for a 2727Libev does not offer other language bindings itself, but bindings for a
2670numbe rof languages exist in the form of third-party packages. If you know 2728number of languages exist in the form of third-party packages. If you know
2671any interesting language binding in addition to the ones listed here, drop 2729any interesting language binding in addition to the ones listed here, drop
2672me a note. 2730me a note.
2673.IP "Perl" 4 2731.IP "Perl" 4
2674.IX Item "Perl" 2732.IX Item "Perl"
2675The \s-1EV\s0 module implements the full libev \s-1API\s0 and is actually used to test 2733The \s-1EV\s0 module implements the full libev \s-1API\s0 and is actually used to test
2676libev. \s-1EV\s0 is developed together with libev. Apart from the \s-1EV\s0 core module, 2734libev. \s-1EV\s0 is developed together with libev. Apart from the \s-1EV\s0 core module,
2677there are additional modules that implement libev-compatible interfaces 2735there are additional modules that implement libev-compatible interfaces
2678to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR), \f(CW\*(C`Net::SNMP\*(C'\fR (\f(CW\*(C`Net::SNMP::EV\*(C'\fR) and the 2736to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR), \f(CW\*(C`Net::SNMP\*(C'\fR (\f(CW\*(C`Net::SNMP::EV\*(C'\fR) and the
2679\&\f(CW\*(C`libglib\*(C'\fR event core (\f(CW\*(C`Glib::EV\*(C'\fR and \f(CW\*(C`EV::Glib\*(C'\fR). 2737\&\f(CW\*(C`libglib\*(C'\fR event core (\f(CW\*(C`Glib::EV\*(C'\fR and \f(CW\*(C`EV::Glib\*(C'\fR).
2680.Sp 2738.Sp
2681It can be found and installed via \s-1CPAN\s0, its homepage is found at 2739It can be found and installed via \s-1CPAN\s0, its homepage is at
2682<http://software.schmorp.de/pkg/EV>. 2740<http://software.schmorp.de/pkg/EV>.
2741.IP "Python" 4
2742.IX Item "Python"
2743Python bindings can be found at <http://code.google.com/p/pyev/>. It
2744seems to be quite complete and well-documented. Note, however, that the
2745patch they require for libev is outright dangerous as it breaks the \s-1ABI\s0
2746for everybody else, and therefore, should never be applied in an installed
2747libev (if python requires an incompatible \s-1ABI\s0 then it needs to embed
2748libev).
2683.IP "Ruby" 4 2749.IP "Ruby" 4
2684.IX Item "Ruby" 2750.IX Item "Ruby"
2685Tony Arcieri has written a ruby extension that offers access to a subset 2751Tony Arcieri has written a ruby extension that offers access to a subset
2686of the libev \s-1API\s0 and adds filehandle abstractions, asynchronous \s-1DNS\s0 and 2752of the libev \s-1API\s0 and adds file handle abstractions, asynchronous \s-1DNS\s0 and
2687more on top of it. It can be found via gem servers. Its homepage is at 2753more on top of it. It can be found via gem servers. Its homepage is at
2688<http://rev.rubyforge.org/>. 2754<http://rev.rubyforge.org/>.
2689.IP "D" 4 2755.IP "D" 4
2690.IX Item "D" 2756.IX Item "D"
2691Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to 2757Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to
2692be found at <http://git.llucax.com.ar/?p=software/ev.d.git;a=summary>. 2758be found at <http://git.llucax.com.ar/?p=software/ev.d.git;a=summary>.
2693.SH "MACRO MAGIC" 2759.SH "MACRO MAGIC"
2694.IX Header "MACRO MAGIC" 2760.IX Header "MACRO MAGIC"
2695Libev can be compiled with a variety of options, the most fundamantal 2761Libev can be compiled with a variety of options, the most fundamental
2696of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) 2762of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most)
2697functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. 2763functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument.
2698.PP 2764.PP
2699To make it easier to write programs that cope with either variant, the 2765To make it easier to write programs that cope with either variant, the
2700following macros are defined: 2766following macros are defined:
2704This provides the loop \fIargument\fR for functions, if one is required (\*(L"ev 2770This provides the loop \fIargument\fR for functions, if one is required (\*(L"ev
2705loop argument\*(R"). The \f(CW\*(C`EV_A\*(C'\fR form is used when this is the sole argument, 2771loop argument\*(R"). The \f(CW\*(C`EV_A\*(C'\fR form is used when this is the sole argument,
2706\&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example: 2772\&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example:
2707.Sp 2773.Sp
2708.Vb 3 2774.Vb 3
2709\& ev_unref (EV_A); 2775\& ev_unref (EV_A);
2710\& ev_timer_add (EV_A_ watcher); 2776\& ev_timer_add (EV_A_ watcher);
2711\& ev_loop (EV_A_ 0); 2777\& ev_loop (EV_A_ 0);
2712.Ve 2778.Ve
2713.Sp 2779.Sp
2714It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope, 2780It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope,
2715which is often provided by the following macro. 2781which is often provided by the following macro.
2716.ie n .IP """EV_P""\fR, \f(CW""EV_P_""" 4 2782.ie n .IP """EV_P""\fR, \f(CW""EV_P_""" 4
2719This provides the loop \fIparameter\fR for functions, if one is required (\*(L"ev 2785This provides the loop \fIparameter\fR for functions, if one is required (\*(L"ev
2720loop parameter\*(R"). The \f(CW\*(C`EV_P\*(C'\fR form is used when this is the sole parameter, 2786loop parameter\*(R"). The \f(CW\*(C`EV_P\*(C'\fR form is used when this is the sole parameter,
2721\&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example: 2787\&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example:
2722.Sp 2788.Sp
2723.Vb 2 2789.Vb 2
2724\& // this is how ev_unref is being declared 2790\& // this is how ev_unref is being declared
2725\& static void ev_unref (EV_P); 2791\& static void ev_unref (EV_P);
2726\& 2792\&
2727\& // this is how you can declare your typical callback 2793\& // this is how you can declare your typical callback
2728\& static void cb (EV_P_ ev_timer *w, int revents) 2794\& static void cb (EV_P_ ev_timer *w, int revents)
2729.Ve 2795.Ve
2730.Sp 2796.Sp
2731It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite 2797It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite
2732suitable for use with \f(CW\*(C`EV_A\*(C'\fR. 2798suitable for use with \f(CW\*(C`EV_A\*(C'\fR.
2733.ie n .IP """EV_DEFAULT""\fR, \f(CW""EV_DEFAULT_""" 4 2799.ie n .IP """EV_DEFAULT""\fR, \f(CW""EV_DEFAULT_""" 4
2734.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 2800.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4
2735.IX Item "EV_DEFAULT, EV_DEFAULT_" 2801.IX Item "EV_DEFAULT, EV_DEFAULT_"
2736Similar to the other two macros, this gives you the value of the default 2802Similar to the other two macros, this gives you the value of the default
2737loop, if multiple loops are supported (\*(L"ev loop default\*(R"). 2803loop, if multiple loops are supported (\*(L"ev loop default\*(R").
2804.ie n .IP """EV_DEFAULT_UC""\fR, \f(CW""EV_DEFAULT_UC_""" 4
2805.el .IP "\f(CWEV_DEFAULT_UC\fR, \f(CWEV_DEFAULT_UC_\fR" 4
2806.IX Item "EV_DEFAULT_UC, EV_DEFAULT_UC_"
2807Usage identical to \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR, but requires that the
2808default loop has been initialised (\f(CW\*(C`UC\*(C'\fR == unchecked). Their behaviour
2809is undefined when the default loop has not been initialised by a previous
2810execution of \f(CW\*(C`EV_DEFAULT\*(C'\fR, \f(CW\*(C`EV_DEFAULT_\*(C'\fR or \f(CW\*(C`ev_default_init (...)\*(C'\fR.
2811.Sp
2812It is often prudent to use \f(CW\*(C`EV_DEFAULT\*(C'\fR when initialising the first
2813watcher in a function but use \f(CW\*(C`EV_DEFAULT_UC\*(C'\fR afterwards.
2738.PP 2814.PP
2739Example: Declare and initialise a check watcher, utilising the above 2815Example: Declare and initialise a check watcher, utilising the above
2740macros so it will work regardless of whether multiple loops are supported 2816macros so it will work regardless of whether multiple loops are supported
2741or not. 2817or not.
2742.PP 2818.PP
2743.Vb 5 2819.Vb 5
2744\& static void 2820\& static void
2745\& check_cb (EV_P_ ev_timer *w, int revents) 2821\& check_cb (EV_P_ ev_timer *w, int revents)
2746\& { 2822\& {
2747\& ev_check_stop (EV_A_ w); 2823\& ev_check_stop (EV_A_ w);
2748\& } 2824\& }
2749\& 2825\&
2750\& ev_check check; 2826\& ev_check check;
2751\& ev_check_init (&check, check_cb); 2827\& ev_check_init (&check, check_cb);
2752\& ev_check_start (EV_DEFAULT_ &check); 2828\& ev_check_start (EV_DEFAULT_ &check);
2753\& ev_loop (EV_DEFAULT_ 0); 2829\& ev_loop (EV_DEFAULT_ 0);
2754.Ve 2830.Ve
2755.SH "EMBEDDING" 2831.SH "EMBEDDING"
2756.IX Header "EMBEDDING" 2832.IX Header "EMBEDDING"
2757Libev can (and often is) directly embedded into host 2833Libev can (and often is) directly embedded into host
2758applications. Examples of applications that embed it include the Deliantra 2834applications. Examples of applications that embed it include the Deliantra
2764you can easily upgrade by simply copying (or having a checked-out copy of 2840you can easily upgrade by simply copying (or having a checked-out copy of
2765libev somewhere in your source tree). 2841libev somewhere in your source tree).
2766.Sh "\s-1FILESETS\s0" 2842.Sh "\s-1FILESETS\s0"
2767.IX Subsection "FILESETS" 2843.IX Subsection "FILESETS"
2768Depending on what features you need you need to include one or more sets of files 2844Depending on what features you need you need to include one or more sets of files
2769in your app. 2845in your application.
2770.PP 2846.PP
2771\fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR 2847\fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR
2772.IX Subsection "CORE EVENT LOOP" 2848.IX Subsection "CORE EVENT LOOP"
2773.PP 2849.PP
2774To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual 2850To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual
2775configuration (no autoconf): 2851configuration (no autoconf):
2776.PP 2852.PP
2777.Vb 2 2853.Vb 2
2778\& #define EV_STANDALONE 1 2854\& #define EV_STANDALONE 1
2779\& #include "ev.c" 2855\& #include "ev.c"
2780.Ve 2856.Ve
2781.PP 2857.PP
2782This will automatically include \fIev.h\fR, too, and should be done in a 2858This will automatically include \fIev.h\fR, too, and should be done in a
2783single C source file only to provide the function implementations. To use 2859single C source file only to provide the function implementations. To use
2784it, do the same for \fIev.h\fR in all files wishing to use this \s-1API\s0 (best 2860it, do the same for \fIev.h\fR in all files wishing to use this \s-1API\s0 (best
2785done by writing a wrapper around \fIev.h\fR that you can include instead and 2861done by writing a wrapper around \fIev.h\fR that you can include instead and
2786where you can put other configuration options): 2862where you can put other configuration options):
2787.PP 2863.PP
2788.Vb 2 2864.Vb 2
2789\& #define EV_STANDALONE 1 2865\& #define EV_STANDALONE 1
2790\& #include "ev.h" 2866\& #include "ev.h"
2791.Ve 2867.Ve
2792.PP 2868.PP
2793Both header files and implementation files can be compiled with a \*(C+ 2869Both header files and implementation files can be compiled with a \*(C+
2794compiler (at least, thats a stated goal, and breakage will be treated 2870compiler (at least, thats a stated goal, and breakage will be treated
2795as a bug). 2871as a bug).
2796.PP 2872.PP
2797You need the following files in your source tree, or in a directory 2873You need the following files in your source tree, or in a directory
2798in your include path (e.g. in libev/ when using \-Ilibev): 2874in your include path (e.g. in libev/ when using \-Ilibev):
2799.PP 2875.PP
2800.Vb 4 2876.Vb 4
2801\& ev.h 2877\& ev.h
2802\& ev.c 2878\& ev.c
2803\& ev_vars.h 2879\& ev_vars.h
2804\& ev_wrap.h 2880\& ev_wrap.h
2805\& 2881\&
2806\& ev_win32.c required on win32 platforms only 2882\& ev_win32.c required on win32 platforms only
2807\& 2883\&
2808\& ev_select.c only when select backend is enabled (which is enabled by default) 2884\& ev_select.c only when select backend is enabled (which is enabled by default)
2809\& ev_poll.c only when poll backend is enabled (disabled by default) 2885\& ev_poll.c only when poll backend is enabled (disabled by default)
2810\& ev_epoll.c only when the epoll backend is enabled (disabled by default) 2886\& ev_epoll.c only when the epoll backend is enabled (disabled by default)
2811\& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 2887\& ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
2812\& ev_port.c only when the solaris port backend is enabled (disabled by default) 2888\& ev_port.c only when the solaris port backend is enabled (disabled by default)
2813.Ve 2889.Ve
2814.PP 2890.PP
2815\&\fIev.c\fR includes the backend files directly when enabled, so you only need 2891\&\fIev.c\fR includes the backend files directly when enabled, so you only need
2816to compile this single file. 2892to compile this single file.
2817.PP 2893.PP
2819.IX Subsection "LIBEVENT COMPATIBILITY API" 2895.IX Subsection "LIBEVENT COMPATIBILITY API"
2820.PP 2896.PP
2821To include the libevent compatibility \s-1API\s0, also include: 2897To include the libevent compatibility \s-1API\s0, also include:
2822.PP 2898.PP
2823.Vb 1 2899.Vb 1
2824\& #include "event.c" 2900\& #include "event.c"
2825.Ve 2901.Ve
2826.PP 2902.PP
2827in the file including \fIev.c\fR, and: 2903in the file including \fIev.c\fR, and:
2828.PP 2904.PP
2829.Vb 1 2905.Vb 1
2830\& #include "event.h" 2906\& #include "event.h"
2831.Ve 2907.Ve
2832.PP 2908.PP
2833in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR. 2909in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR.
2834.PP 2910.PP
2835You need the following additional files for this: 2911You need the following additional files for this:
2836.PP 2912.PP
2837.Vb 2 2913.Vb 2
2838\& event.h 2914\& event.h
2839\& event.c 2915\& event.c
2840.Ve 2916.Ve
2841.PP 2917.PP
2842\fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR 2918\fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR
2843.IX Subsection "AUTOCONF SUPPORT" 2919.IX Subsection "AUTOCONF SUPPORT"
2844.PP 2920.PP
2845Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your config in 2921Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your configuration in
2846whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your 2922whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your
2847\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then 2923\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then
2848include \fIconfig.h\fR and configure itself accordingly. 2924include \fIconfig.h\fR and configure itself accordingly.
2849.PP 2925.PP
2850For this of course you need the m4 file: 2926For this of course you need the m4 file:
2851.PP 2927.PP
2852.Vb 1 2928.Vb 1
2853\& libev.m4 2929\& libev.m4
2854.Ve 2930.Ve
2855.Sh "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" 2931.Sh "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0"
2856.IX Subsection "PREPROCESSOR SYMBOLS/MACROS" 2932.IX Subsection "PREPROCESSOR SYMBOLS/MACROS"
2857Libev can be configured via a variety of preprocessor symbols you have to define 2933Libev can be configured via a variety of preprocessor symbols you have to
2858before including any of its files. The default is not to build for multiplicity 2934define before including any of its files. The default in the absence of
2859and only include the select backend. 2935autoconf is noted for every option.
2860.IP "\s-1EV_STANDALONE\s0" 4 2936.IP "\s-1EV_STANDALONE\s0" 4
2861.IX Item "EV_STANDALONE" 2937.IX Item "EV_STANDALONE"
2862Must always be \f(CW1\fR if you do not use autoconf configuration, which 2938Must always be \f(CW1\fR if you do not use autoconf configuration, which
2863keeps libev from including \fIconfig.h\fR, and it also defines dummy 2939keeps libev from including \fIconfig.h\fR, and it also defines dummy
2864implementations for some libevent functions (such as logging, which is not 2940implementations for some libevent functions (such as logging, which is not
2865supported). It will also not define any of the structs usually found in 2941supported). It will also not define any of the structs usually found in
2866\&\fIevent.h\fR that are not directly supported by the libev core alone. 2942\&\fIevent.h\fR that are not directly supported by the libev core alone.
2867.IP "\s-1EV_USE_MONOTONIC\s0" 4 2943.IP "\s-1EV_USE_MONOTONIC\s0" 4
2868.IX Item "EV_USE_MONOTONIC" 2944.IX Item "EV_USE_MONOTONIC"
2869If defined to be \f(CW1\fR, libev will try to detect the availability of the 2945If defined to be \f(CW1\fR, libev will try to detect the availability of the
2870monotonic clock option at both compiletime and runtime. Otherwise no use 2946monotonic clock option at both compile time and runtime. Otherwise no use
2871of the monotonic clock option will be attempted. If you enable this, you 2947of the monotonic clock option will be attempted. If you enable this, you
2872usually have to link against librt or something similar. Enabling it when 2948usually have to link against librt or something similar. Enabling it when
2873the functionality isn't available is safe, though, although you have 2949the functionality isn't available is safe, though, although you have
2874to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR 2950to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR
2875function is hiding in (often \fI\-lrt\fR). 2951function is hiding in (often \fI\-lrt\fR).
2876.IP "\s-1EV_USE_REALTIME\s0" 4 2952.IP "\s-1EV_USE_REALTIME\s0" 4
2877.IX Item "EV_USE_REALTIME" 2953.IX Item "EV_USE_REALTIME"
2878If defined to be \f(CW1\fR, libev will try to detect the availability of the 2954If defined to be \f(CW1\fR, libev will try to detect the availability of the
2879realtime clock option at compiletime (and assume its availability at 2955real-time clock option at compile time (and assume its availability at
2880runtime if successful). Otherwise no use of the realtime clock option will 2956runtime if successful). Otherwise no use of the real-time clock option will
2881be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR by \f(CW\*(C`clock_get 2957be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR by \f(CW\*(C`clock_get
2882(CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect correctness. See the 2958(CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect correctness. See the
2883note about libraries in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. 2959note about libraries in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though.
2884.IP "\s-1EV_USE_NANOSLEEP\s0" 4 2960.IP "\s-1EV_USE_NANOSLEEP\s0" 4
2885.IX Item "EV_USE_NANOSLEEP" 2961.IX Item "EV_USE_NANOSLEEP"
2886If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available 2962If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available
2887and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR. 2963and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR.
2964.IP "\s-1EV_USE_EVENTFD\s0" 4
2965.IX Item "EV_USE_EVENTFD"
2966If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is
2967available and will probe for kernel support at runtime. This will improve
2968\&\f(CW\*(C`ev_signal\*(C'\fR and \f(CW\*(C`ev_async\*(C'\fR performance and reduce resource consumption.
2969If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
29702.7 or newer, otherwise disabled.
2888.IP "\s-1EV_USE_SELECT\s0" 4 2971.IP "\s-1EV_USE_SELECT\s0" 4
2889.IX Item "EV_USE_SELECT" 2972.IX Item "EV_USE_SELECT"
2890If undefined or defined to be \f(CW1\fR, libev will compile in support for the 2973If undefined or defined to be \f(CW1\fR, libev will compile in support for the
2891\&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at autodetection will be done: if no 2974\&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at auto-detection will be done: if no
2892other method takes over, select will be it. Otherwise the select backend 2975other method takes over, select will be it. Otherwise the select backend
2893will not be compiled in. 2976will not be compiled in.
2894.IP "\s-1EV_SELECT_USE_FD_SET\s0" 4 2977.IP "\s-1EV_SELECT_USE_FD_SET\s0" 4
2895.IX Item "EV_SELECT_USE_FD_SET" 2978.IX Item "EV_SELECT_USE_FD_SET"
2896If defined to \f(CW1\fR, then the select backend will use the system \f(CW\*(C`fd_set\*(C'\fR 2979If defined to \f(CW1\fR, then the select backend will use the system \f(CW\*(C`fd_set\*(C'\fR
2897structure. This is useful if libev doesn't compile due to a missing 2980structure. This is useful if libev doesn't compile due to a missing
2898\&\f(CW\*(C`NFDBITS\*(C'\fR or \f(CW\*(C`fd_mask\*(C'\fR definition or it misguesses the bitset layout on 2981\&\f(CW\*(C`NFDBITS\*(C'\fR or \f(CW\*(C`fd_mask\*(C'\fR definition or it mis-guesses the bitset layout on
2899exotic systems. This usually limits the range of file descriptors to some 2982exotic systems. This usually limits the range of file descriptors to some
2900low limit such as 1024 or might have other limitations (winsocket only 2983low limit such as 1024 or might have other limitations (winsocket only
2901allows 64 sockets). The \f(CW\*(C`FD_SETSIZE\*(C'\fR macro, set before compilation, might 2984allows 64 sockets). The \f(CW\*(C`FD_SETSIZE\*(C'\fR macro, set before compilation, might
2902influence the size of the \f(CW\*(C`fd_set\*(C'\fR used. 2985influence the size of the \f(CW\*(C`fd_set\*(C'\fR used.
2903.IP "\s-1EV_SELECT_IS_WINSOCKET\s0" 4 2986.IP "\s-1EV_SELECT_IS_WINSOCKET\s0" 4
2923takes precedence over select. 3006takes precedence over select.
2924.IP "\s-1EV_USE_EPOLL\s0" 4 3007.IP "\s-1EV_USE_EPOLL\s0" 4
2925.IX Item "EV_USE_EPOLL" 3008.IX Item "EV_USE_EPOLL"
2926If defined to be \f(CW1\fR, libev will compile in support for the Linux 3009If defined to be \f(CW1\fR, libev will compile in support for the Linux
2927\&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime, 3010\&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime,
2928otherwise another method will be used as fallback. This is the 3011otherwise another method will be used as fallback. This is the preferred
2929preferred backend for GNU/Linux systems. 3012backend for GNU/Linux systems. If undefined, it will be enabled if the
3013headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
2930.IP "\s-1EV_USE_KQUEUE\s0" 4 3014.IP "\s-1EV_USE_KQUEUE\s0" 4
2931.IX Item "EV_USE_KQUEUE" 3015.IX Item "EV_USE_KQUEUE"
2932If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style 3016If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style
2933\&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime, 3017\&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime,
2934otherwise another method will be used as fallback. This is the preferred 3018otherwise another method will be used as fallback. This is the preferred
294410 port style backend. Its availability will be detected at runtime, 302810 port style backend. Its availability will be detected at runtime,
2945otherwise another method will be used as fallback. This is the preferred 3029otherwise another method will be used as fallback. This is the preferred
2946backend for Solaris 10 systems. 3030backend for Solaris 10 systems.
2947.IP "\s-1EV_USE_DEVPOLL\s0" 4 3031.IP "\s-1EV_USE_DEVPOLL\s0" 4
2948.IX Item "EV_USE_DEVPOLL" 3032.IX Item "EV_USE_DEVPOLL"
2949reserved for future expansion, works like the \s-1USE\s0 symbols above. 3033Reserved for future expansion, works like the \s-1USE\s0 symbols above.
2950.IP "\s-1EV_USE_INOTIFY\s0" 4 3034.IP "\s-1EV_USE_INOTIFY\s0" 4
2951.IX Item "EV_USE_INOTIFY" 3035.IX Item "EV_USE_INOTIFY"
2952If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify 3036If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify
2953interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will 3037interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will
2954be detected at runtime. 3038be detected at runtime. If undefined, it will be enabled if the headers
3039indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
2955.IP "\s-1EV_ATOMIC_T\s0" 4 3040.IP "\s-1EV_ATOMIC_T\s0" 4
2956.IX Item "EV_ATOMIC_T" 3041.IX Item "EV_ATOMIC_T"
2957Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose 3042Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose
2958access is atomic with respect to other threads or signal contexts. No such 3043access is atomic with respect to other threads or signal contexts. No such
2959type is easily found in the C language, so you can provide your own type 3044type is easily found in the C language, so you can provide your own type
2960that you know is safe for your purposes. It is used both for signal handler \*(L"locking\*(R" 3045that you know is safe for your purposes. It is used both for signal handler \*(L"locking\*(R"
2961as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR watchers. 3046as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR watchers.
2962.Sp 3047.Sp
2963In the absense of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR 3048In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR
2964(from \fIsignal.h\fR), which is usually good enough on most platforms. 3049(from \fIsignal.h\fR), which is usually good enough on most platforms.
2965.IP "\s-1EV_H\s0" 4 3050.IP "\s-1EV_H\s0" 4
2966.IX Item "EV_H" 3051.IX Item "EV_H"
2967The name of the \fIev.h\fR header file used to include it. The default if 3052The name of the \fIev.h\fR header file used to include it. The default if
2968undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be 3053undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be
3003When doing priority-based operations, libev usually has to linearly search 3088When doing priority-based operations, libev usually has to linearly search
3004all the priorities, so having many of them (hundreds) uses a lot of space 3089all the priorities, so having many of them (hundreds) uses a lot of space
3005and time, so using the defaults of five priorities (\-2 .. +2) is usually 3090and time, so using the defaults of five priorities (\-2 .. +2) is usually
3006fine. 3091fine.
3007.Sp 3092.Sp
3008If your embedding app does not need any priorities, defining these both to 3093If your embedding application does not need any priorities, defining these both to
3009\&\f(CW0\fR will save some memory and cpu. 3094\&\f(CW0\fR will save some memory and \s-1CPU\s0.
3010.IP "\s-1EV_PERIODIC_ENABLE\s0" 4 3095.IP "\s-1EV_PERIODIC_ENABLE\s0" 4
3011.IX Item "EV_PERIODIC_ENABLE" 3096.IX Item "EV_PERIODIC_ENABLE"
3012If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If 3097If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If
3013defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of 3098defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of
3014code. 3099code.
3034If undefined or defined to be \f(CW1\fR, then async watchers are supported. If 3119If undefined or defined to be \f(CW1\fR, then async watchers are supported. If
3035defined to be \f(CW0\fR, then they are not. 3120defined to be \f(CW0\fR, then they are not.
3036.IP "\s-1EV_MINIMAL\s0" 4 3121.IP "\s-1EV_MINIMAL\s0" 4
3037.IX Item "EV_MINIMAL" 3122.IX Item "EV_MINIMAL"
3038If you need to shave off some kilobytes of code at the expense of some 3123If you need to shave off some kilobytes of code at the expense of some
3039speed, define this symbol to \f(CW1\fR. Currently only used for gcc to override 3124speed, define this symbol to \f(CW1\fR. Currently this is used to override some
3040some inlining decisions, saves roughly 30% codesize of amd64. 3125inlining decisions, saves roughly 30% code size on amd64. It also selects a
3126much smaller 2\-heap for timer management over the default 4\-heap.
3041.IP "\s-1EV_PID_HASHSIZE\s0" 4 3127.IP "\s-1EV_PID_HASHSIZE\s0" 4
3042.IX Item "EV_PID_HASHSIZE" 3128.IX Item "EV_PID_HASHSIZE"
3043\&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by 3129\&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by
3044pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more 3130pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more
3045than enough. If you need to manage thousands of children you might want to 3131than enough. If you need to manage thousands of children you might want to
3049\&\f(CW\*(C`ev_stat\*(C'\fR watchers use a small hash table to distribute workload by 3135\&\f(CW\*(C`ev_stat\*(C'\fR watchers use a small hash table to distribute workload by
3050inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), 3136inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR),
3051usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR 3137usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR
3052watchers you might want to increase this value (\fImust\fR be a power of 3138watchers you might want to increase this value (\fImust\fR be a power of
3053two). 3139two).
3140.IP "\s-1EV_USE_4HEAP\s0" 4
3141.IX Item "EV_USE_4HEAP"
3142Heaps are not very cache-efficient. To improve the cache-efficiency of the
3143timer and periodics heap, libev uses a 4\-heap when this symbol is defined
3144to \f(CW1\fR. The 4\-heap uses more complicated (longer) code but has
3145noticeably faster performance with many (thousands) of watchers.
3146.Sp
3147The default is \f(CW1\fR unless \f(CW\*(C`EV_MINIMAL\*(C'\fR is set in which case it is \f(CW0\fR
3148(disabled).
3149.IP "\s-1EV_HEAP_CACHE_AT\s0" 4
3150.IX Item "EV_HEAP_CACHE_AT"
3151Heaps are not very cache-efficient. To improve the cache-efficiency of the
3152timer and periodics heap, libev can cache the timestamp (\fIat\fR) within
3153the heap structure (selected by defining \f(CW\*(C`EV_HEAP_CACHE_AT\*(C'\fR to \f(CW1\fR),
3154which uses 8\-12 bytes more per watcher and a few hundred bytes more code,
3155but avoids random read accesses on heap changes. This improves performance
3156noticeably with with many (hundreds) of watchers.
3157.Sp
3158The default is \f(CW1\fR unless \f(CW\*(C`EV_MINIMAL\*(C'\fR is set in which case it is \f(CW0\fR
3159(disabled).
3160.IP "\s-1EV_VERIFY\s0" 4
3161.IX Item "EV_VERIFY"
3162Controls how much internal verification (see \f(CW\*(C`ev_loop_verify ()\*(C'\fR) will
3163be done: If set to \f(CW0\fR, no internal verification code will be compiled
3164in. If set to \f(CW1\fR, then verification code will be compiled in, but not
3165called. If set to \f(CW2\fR, then the internal verification code will be
3166called once per loop, which can slow down libev. If set to \f(CW3\fR, then the
3167verification code will be called very frequently, which will slow down
3168libev considerably.
3169.Sp
3170The default is \f(CW1\fR, unless \f(CW\*(C`EV_MINIMAL\*(C'\fR is set, in which case it will be
3171\&\f(CW0.\fR
3054.IP "\s-1EV_COMMON\s0" 4 3172.IP "\s-1EV_COMMON\s0" 4
3055.IX Item "EV_COMMON" 3173.IX Item "EV_COMMON"
3056By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining 3174By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining
3057this macro to a something else you can include more and other types of 3175this macro to a something else you can include more and other types of
3058members. You have to define it each time you include one of the files, 3176members. You have to define it each time you include one of the files,
3059though, and it must be identical each time. 3177though, and it must be identical each time.
3060.Sp 3178.Sp
3061For example, the perl \s-1EV\s0 module uses something like this: 3179For example, the perl \s-1EV\s0 module uses something like this:
3062.Sp 3180.Sp
3063.Vb 3 3181.Vb 3
3064\& #define EV_COMMON \e 3182\& #define EV_COMMON \e
3065\& SV *self; /* contains this struct */ \e 3183\& SV *self; /* contains this struct */ \e
3066\& SV *cb_sv, *fh /* note no trailing ";" */ 3184\& SV *cb_sv, *fh /* note no trailing ";" */
3067.Ve 3185.Ve
3068.IP "\s-1EV_CB_DECLARE\s0 (type)" 4 3186.IP "\s-1EV_CB_DECLARE\s0 (type)" 4
3069.IX Item "EV_CB_DECLARE (type)" 3187.IX Item "EV_CB_DECLARE (type)"
3070.PD 0 3188.PD 0
3071.IP "\s-1EV_CB_INVOKE\s0 (watcher, revents)" 4 3189.IP "\s-1EV_CB_INVOKE\s0 (watcher, revents)" 4
3079their default definitions. One possible use for overriding these is to 3197their default definitions. One possible use for overriding these is to
3080avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use 3198avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use
3081method calls instead of plain function calls in \*(C+. 3199method calls instead of plain function calls in \*(C+.
3082.Sh "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0" 3200.Sh "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0"
3083.IX Subsection "EXPORTED API SYMBOLS" 3201.IX Subsection "EXPORTED API SYMBOLS"
3084If you need to re-export the \s-1API\s0 (e.g. via a dll) and you need a list of 3202If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of
3085exported symbols, you can use the provided \fISymbol.*\fR files which list 3203exported symbols, you can use the provided \fISymbol.*\fR files which list
3086all public symbols, one per line: 3204all public symbols, one per line:
3087.PP 3205.PP
3088.Vb 2 3206.Vb 2
3089\& Symbols.ev for libev proper 3207\& Symbols.ev for libev proper
3090\& Symbols.event for the libevent emulation 3208\& Symbols.event for the libevent emulation
3091.Ve 3209.Ve
3092.PP 3210.PP
3093This can also be used to rename all public symbols to avoid clashes with 3211This can also be used to rename all public symbols to avoid clashes with
3094multiple versions of libev linked together (which is obviously bad in 3212multiple versions of libev linked together (which is obviously bad in
3095itself, but sometimes it is inconvinient to avoid this). 3213itself, but sometimes it is inconvenient to avoid this).
3096.PP 3214.PP
3097A sed command like this will create wrapper \f(CW\*(C`#define\*(C'\fR's that you need to 3215A sed command like this will create wrapper \f(CW\*(C`#define\*(C'\fR's that you need to
3098include before including \fIev.h\fR: 3216include before including \fIev.h\fR:
3099.PP 3217.PP
3100.Vb 1 3218.Vb 1
3121.PP 3239.PP
3122The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file 3240The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file
3123that everybody includes and which overrides some configure choices: 3241that everybody includes and which overrides some configure choices:
3124.PP 3242.PP
3125.Vb 9 3243.Vb 9
3126\& #define EV_MINIMAL 1 3244\& #define EV_MINIMAL 1
3127\& #define EV_USE_POLL 0 3245\& #define EV_USE_POLL 0
3128\& #define EV_MULTIPLICITY 0 3246\& #define EV_MULTIPLICITY 0
3129\& #define EV_PERIODIC_ENABLE 0 3247\& #define EV_PERIODIC_ENABLE 0
3130\& #define EV_STAT_ENABLE 0 3248\& #define EV_STAT_ENABLE 0
3131\& #define EV_FORK_ENABLE 0 3249\& #define EV_FORK_ENABLE 0
3132\& #define EV_CONFIG_H <config.h> 3250\& #define EV_CONFIG_H <config.h>
3133\& #define EV_MINPRI 0 3251\& #define EV_MINPRI 0
3134\& #define EV_MAXPRI 0 3252\& #define EV_MAXPRI 0
3135\& 3253\&
3136\& #include "ev++.h" 3254\& #include "ev++.h"
3137.Ve 3255.Ve
3138.PP 3256.PP
3139And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled: 3257And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled:
3140.PP 3258.PP
3141.Vb 2 3259.Vb 2
3142\& #include "ev_cpp.h" 3260\& #include "ev_cpp.h"
3143\& #include "ev.c" 3261\& #include "ev.c"
3144.Ve 3262.Ve
3263.SH "THREADS AND COROUTINES"
3264.IX Header "THREADS AND COROUTINES"
3265.Sh "\s-1THREADS\s0"
3266.IX Subsection "THREADS"
3267Libev itself is completely thread-safe, but it uses no locking. This
3268means that you can use as many loops as you want in parallel, as long as
3269only one thread ever calls into one libev function with the same loop
3270parameter.
3271.PP
3272Or put differently: calls with different loop parameters can be done in
3273parallel from multiple threads, calls with the same loop parameter must be
3274done serially (but can be done from different threads, as long as only one
3275thread ever is inside a call at any point in time, e.g. by using a mutex
3276per loop).
3277.PP
3278If you want to know which design (one loop, locking, or multiple loops
3279without or something else still) is best for your problem, then I cannot
3280help you. I can give some generic advice however:
3281.IP "\(bu" 4
3282most applications have a main thread: use the default libev loop
3283in that thread, or create a separate thread running only the default loop.
3284.Sp
3285This helps integrating other libraries or software modules that use libev
3286themselves and don't care/know about threading.
3287.IP "\(bu" 4
3288one loop per thread is usually a good model.
3289.Sp
3290Doing this is almost never wrong, sometimes a better-performance model
3291exists, but it is always a good start.
3292.IP "\(bu" 4
3293other models exist, such as the leader/follower pattern, where one
3294loop is handed through multiple threads in a kind of round-robin fashion.
3295.Sp
3296Choosing a model is hard \- look around, learn, know that usually you can do
3297better than you currently do :\-)
3298.IP "\(bu" 4
3299often you need to talk to some other thread which blocks in the
3300event loop \- \f(CW\*(C`ev_async\*(C'\fR watchers can be used to wake them up from other
3301threads safely (or from signal contexts...).
3302.Sh "\s-1COROUTINES\s0"
3303.IX Subsection "COROUTINES"
3304Libev is much more accommodating to coroutines (\*(L"cooperative threads\*(R"):
3305libev fully supports nesting calls to it's functions from different
3306coroutines (e.g. you can call \f(CW\*(C`ev_loop\*(C'\fR on the same loop from two
3307different coroutines and switch freely between both coroutines running the
3308loop, as long as you don't confuse yourself). The only exception is that
3309you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks.
3310.PP
3311Care has been invested into making sure that libev does not keep local
3312state inside \f(CW\*(C`ev_loop\*(C'\fR, and other calls do not usually allow coroutine
3313switches.
3145.SH "COMPLEXITIES" 3314.SH "COMPLEXITIES"
3146.IX Header "COMPLEXITIES" 3315.IX Header "COMPLEXITIES"
3147In this section the complexities of (many of) the algorithms used inside 3316In this section the complexities of (many of) the algorithms used inside
3148libev will be explained. For complexity discussions about backends see the 3317libev will be explained. For complexity discussions about backends see the
3149documentation for \f(CW\*(C`ev_default_init\*(C'\fR. 3318documentation for \f(CW\*(C`ev_default_init\*(C'\fR.
3174These watchers are stored in lists then need to be walked to find the 3343These watchers are stored in lists then need to be walked to find the
3175correct watcher to remove. The lists are usually short (you don't usually 3344correct watcher to remove. The lists are usually short (you don't usually
3176have many watchers waiting for the same fd or signal). 3345have many watchers waiting for the same fd or signal).
3177.IP "Finding the next timer in each loop iteration: O(1)" 4 3346.IP "Finding the next timer in each loop iteration: O(1)" 4
3178.IX Item "Finding the next timer in each loop iteration: O(1)" 3347.IX Item "Finding the next timer in each loop iteration: O(1)"
3179By virtue of using a binary heap, the next timer is always found at the 3348By virtue of using a binary or 4\-heap, the next timer is always found at a
3180beginning of the storage array. 3349fixed position in the storage array.
3181.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 3350.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4
3182.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 3351.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)"
3183A change means an I/O watcher gets started or stopped, which requires 3352A change means an I/O watcher gets started or stopped, which requires
3184libev to recalculate its status (and possibly tell the kernel, depending 3353libev to recalculate its status (and possibly tell the kernel, depending
3185on backend and wether \f(CW\*(C`ev_io_set\*(C'\fR was used). 3354on backend and whether \f(CW\*(C`ev_io_set\*(C'\fR was used).
3186.IP "Activating one watcher (putting it into the pending state): O(1)" 4 3355.IP "Activating one watcher (putting it into the pending state): O(1)" 4
3187.IX Item "Activating one watcher (putting it into the pending state): O(1)" 3356.IX Item "Activating one watcher (putting it into the pending state): O(1)"
3188.PD 0 3357.PD 0
3189.IP "Priority handling: O(number_of_priorities)" 4 3358.IP "Priority handling: O(number_of_priorities)" 4
3190.IX Item "Priority handling: O(number_of_priorities)" 3359.IX Item "Priority handling: O(number_of_priorities)"
3199.IP "Processing ev_async_send: O(number_of_async_watchers)" 4 3368.IP "Processing ev_async_send: O(number_of_async_watchers)" 4
3200.IX Item "Processing ev_async_send: O(number_of_async_watchers)" 3369.IX Item "Processing ev_async_send: O(number_of_async_watchers)"
3201.IP "Processing signals: O(max_signal_number)" 4 3370.IP "Processing signals: O(max_signal_number)" 4
3202.IX Item "Processing signals: O(max_signal_number)" 3371.IX Item "Processing signals: O(max_signal_number)"
3203.PD 3372.PD
3204Sending involves a syscall \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR 3373Sending involves a system call \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR
3205calls in the current loop iteration. Checking for async and signal events 3374calls in the current loop iteration. Checking for async and signal events
3206involves iterating over all running async watchers or all signal numbers. 3375involves iterating over all running async watchers or all signal numbers.
3207.SH "Win32 platform limitations and workarounds" 3376.SH "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS"
3208.IX Header "Win32 platform limitations and workarounds" 3377.IX Header "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS"
3209Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev 3378Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev
3210requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0 3379requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0
3211model. Libev still offers limited functionality on this platform in 3380model. Libev still offers limited functionality on this platform in
3212the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket 3381the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket
3213descriptors. This only applies when using Win32 natively, not when using 3382descriptors. This only applies when using Win32 natively, not when using
3214e.g. cygwin. 3383e.g. cygwin.
3215.PP 3384.PP
3385Lifting these limitations would basically require the full
3386re-implementation of the I/O system. If you are into these kinds of
3387things, then note that glib does exactly that for you in a very portable
3388way (note also that glib is the slowest event library known to man).
3389.PP
3216There is no supported compilation method available on windows except 3390There is no supported compilation method available on windows except
3217embedding it into other applications. 3391embedding it into other applications.
3218.PP 3392.PP
3393Not a libev limitation but worth mentioning: windows apparently doesn't
3394accept large writes: instead of resulting in a partial write, windows will
3395either accept everything or return \f(CW\*(C`ENOBUFS\*(C'\fR if the buffer is too large,
3396so make sure you only write small amounts into your sockets (less than a
3397megabyte seems safe, but thsi apparently depends on the amount of memory
3398available).
3399.PP
3219Due to the many, low, and arbitrary limits on the win32 platform and the 3400Due to the many, low, and arbitrary limits on the win32 platform and
3220abysmal performance of winsockets, using a large number of sockets is not 3401the abysmal performance of winsockets, using a large number of sockets
3221recommended (and not reasonable). If your program needs to use more than 3402is not recommended (and not reasonable). If your program needs to use
3222a hundred or so sockets, then likely it needs to use a totally different 3403more than a hundred or so sockets, then likely it needs to use a totally
3223implementation for windows, as libev offers the \s-1POSIX\s0 model, which cannot 3404different implementation for windows, as libev offers the \s-1POSIX\s0 readiness
3224be implemented efficiently on windows (microsoft monopoly games). 3405notification model, which cannot be implemented efficiently on windows
3406(Microsoft monopoly games).
3407.PP
3408A typical way to use libev under windows is to embed it (see the embedding
3409section for details) and use the following \fIevwrap.h\fR header file instead
3410of \fIev.h\fR:
3411.PP
3412.Vb 2
3413\& #define EV_STANDALONE /* keeps ev from requiring config.h */
3414\& #define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */
3415\&
3416\& #include "ev.h"
3417.Ve
3418.PP
3419And compile the following \fIevwrap.c\fR file into your project (make sure
3420you do \fInot\fR compile the \fIev.c\fR or any other embedded soruce files!):
3421.PP
3422.Vb 2
3423\& #include "evwrap.h"
3424\& #include "ev.c"
3425.Ve
3225.IP "The winsocket select function" 4 3426.IP "The winsocket select function" 4
3226.IX Item "The winsocket select function" 3427.IX Item "The winsocket select function"
3227The winsocket \f(CW\*(C`select\*(C'\fR function doesn't follow \s-1POSIX\s0 in that it requires 3428The winsocket \f(CW\*(C`select\*(C'\fR function doesn't follow \s-1POSIX\s0 in that it
3228socket \fIhandles\fR and not socket \fIfile descriptors\fR. This makes select 3429requires socket \fIhandles\fR and not socket \fIfile descriptors\fR (it is
3229very inefficient, and also requires a mapping from file descriptors 3430also extremely buggy). This makes select very inefficient, and also
3230to socket handles. See the discussion of the \f(CW\*(C`EV_SELECT_USE_FD_SET\*(C'\fR, 3431requires a mapping from file descriptors to socket handles (the Microsoft
3231\&\f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR and \f(CW\*(C`EV_FD_TO_WIN32_HANDLE\*(C'\fR preprocessor 3432C runtime provides the function \f(CW\*(C`_open_osfhandle\*(C'\fR for this). See the
3232symbols for more info. 3433discussion of the \f(CW\*(C`EV_SELECT_USE_FD_SET\*(C'\fR, \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR and
3434\&\f(CW\*(C`EV_FD_TO_WIN32_HANDLE\*(C'\fR preprocessor symbols for more info.
3233.Sp 3435.Sp
3234The configuration for a \*(L"naked\*(R" win32 using the microsoft runtime 3436The configuration for a \*(L"naked\*(R" win32 using the Microsoft runtime
3235libraries and raw winsocket select is: 3437libraries and raw winsocket select is:
3236.Sp 3438.Sp
3237.Vb 2 3439.Vb 2
3238\& #define EV_USE_SELECT 1 3440\& #define EV_USE_SELECT 1
3239\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ 3441\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
3240.Ve 3442.Ve
3241.Sp 3443.Sp
3242Note that winsockets handling of fd sets is O(n), so you can easily get a 3444Note that winsockets handling of fd sets is O(n), so you can easily get a
3243complexity in the O(nA\*^X) range when using win32. 3445complexity in the O(nA\*^X) range when using win32.
3244.IP "Limited number of file descriptors" 4 3446.IP "Limited number of file descriptors" 4
3245.IX Item "Limited number of file descriptors" 3447.IX Item "Limited number of file descriptors"
3246Windows has numerous arbitrary (and low) limits on things. Early versions 3448Windows has numerous arbitrary (and low) limits on things.
3247of winsocket's select only supported waiting for a max. of \f(CW64\fR handles 3449.Sp
3248(probably owning to the fact that all windows kernels can only wait for 3450Early versions of winsocket's select only supported waiting for a maximum
3249\&\f(CW64\fR things at the same time internally; microsoft recommends spawning a 3451of \f(CW64\fR handles (probably owning to the fact that all windows kernels
3250chain of threads and wait for 63 handles and the previous thread in each). 3452can only wait for \f(CW64\fR things at the same time internally; Microsoft
3453recommends spawning a chain of threads and wait for 63 handles and the
3454previous thread in each. Great).
3251.Sp 3455.Sp
3252Newer versions support more handles, but you need to define \f(CW\*(C`FD_SETSIZE\*(C'\fR 3456Newer versions support more handles, but you need to define \f(CW\*(C`FD_SETSIZE\*(C'\fR
3253to some high number (e.g. \f(CW2048\fR) before compiling the winsocket select 3457to some high number (e.g. \f(CW2048\fR) before compiling the winsocket select
3254call (which might be in libev or elsewhere, for example, perl does its own 3458call (which might be in libev or elsewhere, for example, perl does its own
3255select emulation on windows). 3459select emulation on windows).
3256.Sp 3460.Sp
3257Another limit is the number of file descriptors in the microsoft runtime 3461Another limit is the number of file descriptors in the Microsoft runtime
3258libraries, which by default is \f(CW64\fR (there must be a hidden \fI64\fR fetish 3462libraries, which by default is \f(CW64\fR (there must be a hidden \fI64\fR fetish
3259or something like this inside microsoft). You can increase this by calling 3463or something like this inside Microsoft). You can increase this by calling
3260\&\f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR (another 3464\&\f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR (another
3261arbitrary limit), but is broken in many versions of the microsoft runtime 3465arbitrary limit), but is broken in many versions of the Microsoft runtime
3262libraries. 3466libraries.
3263.Sp 3467.Sp
3264This might get you to about \f(CW512\fR or \f(CW2048\fR sockets (depending on 3468This might get you to about \f(CW512\fR or \f(CW2048\fR sockets (depending on
3265windows version and/or the phase of the moon). To get more, you need to 3469windows version and/or the phase of the moon). To get more, you need to
3266wrap all I/O functions and provide your own fd management, but the cost of 3470wrap all I/O functions and provide your own fd management, but the cost of
3267calling select (O(nA\*^X)) will likely make this unworkable. 3471calling select (O(nA\*^X)) will likely make this unworkable.
3472.SH "PORTABILITY REQUIREMENTS"
3473.IX Header "PORTABILITY REQUIREMENTS"
3474In addition to a working ISO-C implementation, libev relies on a few
3475additional extensions:
3476.ie n .IP """void (*)(ev_watcher_type *, int revents)""\fR must have compatible calling conventions regardless of \f(CW""ev_watcher_type *""." 4
3477.el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4
3478.IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *."
3479Libev assumes not only that all watcher pointers have the same internal
3480structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO\s0 C for example), but it also
3481assumes that the same (machine) code can be used to call any watcher
3482callback: The watcher callbacks have different type signatures, but libev
3483calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally.
3484.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4
3485.el .IP "\f(CWsig_atomic_t volatile\fR must be thread-atomic as well" 4
3486.IX Item "sig_atomic_t volatile must be thread-atomic as well"
3487The type \f(CW\*(C`sig_atomic_t volatile\*(C'\fR (or whatever is defined as
3488\&\f(CW\*(C`EV_ATOMIC_T\*(C'\fR) must be atomic w.r.t. accesses from different
3489threads. This is not part of the specification for \f(CW\*(C`sig_atomic_t\*(C'\fR, but is
3490believed to be sufficiently portable.
3491.ie n .IP """sigprocmask"" must work in a threaded environment" 4
3492.el .IP "\f(CWsigprocmask\fR must work in a threaded environment" 4
3493.IX Item "sigprocmask must work in a threaded environment"
3494Libev uses \f(CW\*(C`sigprocmask\*(C'\fR to temporarily block signals. This is not
3495allowed in a threaded program (\f(CW\*(C`pthread_sigmask\*(C'\fR has to be used). Typical
3496pthread implementations will either allow \f(CW\*(C`sigprocmask\*(C'\fR in the \*(L"main
3497thread\*(R" or will block signals process-wide, both behaviours would
3498be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and
3499\&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however.
3500.Sp
3501The most portable way to handle signals is to block signals in all threads
3502except the initial one, and run the default loop in the initial thread as
3503well.
3504.ie n .IP """long"" must be large enough for common memory allocation sizes" 4
3505.el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4
3506.IX Item "long must be large enough for common memory allocation sizes"
3507To improve portability and simplify using libev, libev uses \f(CW\*(C`long\*(C'\fR
3508internally instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On
3509non-POSIX systems (Microsoft...) this might be unexpectedly low, but
3510is still at least 31 bits everywhere, which is enough for hundreds of
3511millions of watchers.
3512.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4
3513.el .IP "\f(CWdouble\fR must hold a time value in seconds with enough accuracy" 4
3514.IX Item "double must hold a time value in seconds with enough accuracy"
3515The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to
3516have at least 51 bits of mantissa (and 9 bits of exponent), which is good
3517enough for at least into the year 4000. This requirement is fulfilled by
3518implementations implementing \s-1IEEE\s0 754 (basically all existing ones).
3519.PP
3520If you know of other additional requirements drop me a note.
3521.SH "COMPILER WARNINGS"
3522.IX Header "COMPILER WARNINGS"
3523Depending on your compiler and compiler settings, you might get no or a
3524lot of warnings when compiling libev code. Some people are apparently
3525scared by this.
3526.PP
3527However, these are unavoidable for many reasons. For one, each compiler
3528has different warnings, and each user has different tastes regarding
3529warning options. \*(L"Warn-free\*(R" code therefore cannot be a goal except when
3530targeting a specific compiler and compiler-version.
3531.PP
3532Another reason is that some compiler warnings require elaborate
3533workarounds, or other changes to the code that make it less clear and less
3534maintainable.
3535.PP
3536And of course, some compiler warnings are just plain stupid, or simply
3537wrong (because they don't actually warn about the condition their message
3538seems to warn about).
3539.PP
3540While libev is written to generate as few warnings as possible,
3541\&\*(L"warn-free\*(R" code is not a goal, and it is recommended not to build libev
3542with any compiler warnings enabled unless you are prepared to cope with
3543them (e.g. by ignoring them). Remember that warnings are just that:
3544warnings, not errors, or proof of bugs.
3545.SH "VALGRIND"
3546.IX Header "VALGRIND"
3547Valgrind has a special section here because it is a popular tool that is
3548highly useful, but valgrind reports are very hard to interpret.
3549.PP
3550If you think you found a bug (memory leak, uninitialised data access etc.)
3551in libev, then check twice: If valgrind reports something like:
3552.PP
3553.Vb 3
3554\& ==2274== definitely lost: 0 bytes in 0 blocks.
3555\& ==2274== possibly lost: 0 bytes in 0 blocks.
3556\& ==2274== still reachable: 256 bytes in 1 blocks.
3557.Ve
3558.PP
3559Then there is no memory leak. Similarly, under some circumstances,
3560valgrind might report kernel bugs as if it were a bug in libev, or it
3561might be confused (it is a very good tool, but only a tool).
3562.PP
3563If you are unsure about something, feel free to contact the mailing list
3564with the full valgrind report and an explanation on why you think this is
3565a bug in libev. However, don't be annoyed when you get a brisk \*(L"this is
3566no bug\*(R" answer and take the chance of learning how to interpret valgrind
3567properly.
3568.PP
3569If you need, for some reason, empty reports from valgrind for your project
3570I suggest using suppression lists.
3268.SH "AUTHOR" 3571.SH "AUTHOR"
3269.IX Header "AUTHOR" 3572.IX Header "AUTHOR"
3270Marc Lehmann <libev@schmorp.de>. 3573Marc Lehmann <libev@schmorp.de>.
3271.SH "POD ERRORS" 3574.SH "POD ERRORS"
3272.IX Header "POD ERRORS" 3575.IX Header "POD ERRORS"
3273Hey! \fBThe above document had some coding errors, which are explained below:\fR 3576Hey! \fBThe above document had some coding errors, which are explained below:\fR
3274.IP "Around line 2996:" 4 3577.IP "Around line 3122:" 4
3275.IX Item "Around line 2996:" 3578.IX Item "Around line 3122:"
3276You forgot a '=back' before '=head2' 3579You forgot a '=back' before '=head2'

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines