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

Comparing libev/ev.3 (file contents):
Revision 1.27 by root, Tue Nov 27 20:15:01 2007 UTC vs.
Revision 1.43 by root, Sat Dec 8 14:27:38 2007 UTC

… …
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title ""<STANDARD INPUT>" 1" 131.IX Title ""<STANDARD INPUT>" 1"
132.TH "<STANDARD INPUT>" 1 "2007-11-27" "perl v5.8.8" "User Contributed Perl Documentation" 132.TH "<STANDARD INPUT>" 1 "2007-12-08" "perl v5.8.8" "User Contributed Perl Documentation"
133.SH "NAME" 133.SH "NAME"
134libev \- a high performance full\-featured event loop written in C 134libev \- a high performance full\-featured event loop written in C
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137.Vb 1
138\& #include <ev.h>
139.Ve
140.SH "EXAMPLE PROGRAM"
141.IX Header "EXAMPLE PROGRAM"
142.Vb 1
143\& #include <ev.h>
144.Ve
145.PP
137.Vb 2 146.Vb 2
138\& /* this is the only header you need */
139\& #include <ev.h>
140.Ve
141.PP
142.Vb 3
143\& /* what follows is a fully working example program */
144\& ev_io stdin_watcher; 147\& ev_io stdin_watcher;
145\& ev_timer timeout_watcher; 148\& ev_timer timeout_watcher;
146.Ve 149.Ve
147.PP 150.PP
148.Vb 8 151.Vb 8
… …
193\& return 0; 196\& return 0;
194\& } 197\& }
195.Ve 198.Ve
196.SH "DESCRIPTION" 199.SH "DESCRIPTION"
197.IX Header "DESCRIPTION" 200.IX Header "DESCRIPTION"
201The newest version of this document is also available as a html-formatted
202web page you might find easier to navigate when reading it for the first
203time: <http://cvs.schmorp.de/libev/ev.html>.
204.PP
198Libev is an event loop: you register interest in certain events (such as a 205Libev is an event loop: you register interest in certain events (such as a
199file descriptor being readable or a timeout occuring), and it will manage 206file descriptor being readable or a timeout occuring), and it will manage
200these event sources and provide your program with events. 207these event sources and provide your program with events.
201.PP 208.PP
202To do this, it must take more or less complete control over your process 209To do this, it must take more or less complete control over your process
… …
207watchers\fR, which are relatively small C structures you initialise with the 214watchers\fR, which are relatively small C structures you initialise with the
208details of the event, and then hand it over to libev by \fIstarting\fR the 215details of the event, and then hand it over to libev by \fIstarting\fR the
209watcher. 216watcher.
210.SH "FEATURES" 217.SH "FEATURES"
211.IX Header "FEATURES" 218.IX Header "FEATURES"
212Libev supports select, poll, the linux-specific epoll and the bsd-specific 219Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the
213kqueue mechanisms for file descriptor events, relative timers, absolute 220BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms
214timers with customised rescheduling, signal events, process status change 221for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface
215events (related to \s-1SIGCHLD\s0), and event watchers dealing with the event 222(for \f(CW\*(C`ev_stat\*(C'\fR), relative timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers
216loop mechanism itself (idle, prepare and check watchers). It also is quite 223with customised rescheduling (\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals
217fast (see this benchmark comparing 224(\f(CW\*(C`ev_signal\*(C'\fR), process status change events (\f(CW\*(C`ev_child\*(C'\fR), and event
218it to libevent for example). 225watchers dealing with the event loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR,
226\&\f(CW\*(C`ev_embed\*(C'\fR, \f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR watchers) as well as
227file watchers (\f(CW\*(C`ev_stat\*(C'\fR) and even limited support for fork events
228(\f(CW\*(C`ev_fork\*(C'\fR).
229.PP
230It also is quite fast (see this
231benchmark comparing it to libevent
232for example).
219.SH "CONVENTIONS" 233.SH "CONVENTIONS"
220.IX Header "CONVENTIONS" 234.IX Header "CONVENTIONS"
221Libev is very configurable. In this manual the default configuration 235Libev is very configurable. In this manual the default configuration will
222will be described, which supports multiple event loops. For more info 236be described, which supports multiple event loops. For more info about
223about various configuration options please have a look at the file 237various configuration options please have a look at \fB\s-1EMBED\s0\fR section in
224\&\fI\s-1README\s0.embed\fR in the libev distribution. If libev was configured without 238this manual. If libev was configured without support for multiple event
225support for multiple event loops, then all functions taking an initial 239loops, then all functions taking an initial argument of name \f(CW\*(C`loop\*(C'\fR
226argument of name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) 240(which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have this argument.
227will not have this argument.
228.SH "TIME REPRESENTATION" 241.SH "TIME REPRESENTATION"
229.IX Header "TIME REPRESENTATION" 242.IX Header "TIME REPRESENTATION"
230Libev represents time as a single floating point number, representing the 243Libev represents time as a single floating point number, representing the
231(fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near 244(fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near
232the beginning of 1970, details are complicated, don't ask). This type is 245the beginning of 1970, details are complicated, don't ask). This type is
… …
257Usually, it's a good idea to terminate if the major versions mismatch, 270Usually, it's a good idea to terminate if the major versions mismatch,
258as this indicates an incompatible change. Minor versions are usually 271as this indicates an incompatible change. Minor versions are usually
259compatible to older versions, so a larger minor version alone is usually 272compatible to older versions, so a larger minor version alone is usually
260not a problem. 273not a problem.
261.Sp 274.Sp
262Example: make sure we haven't accidentally been linked against the wrong 275Example: Make sure we haven't accidentally been linked against the wrong
263version: 276version.
264.Sp 277.Sp
265.Vb 3 278.Vb 3
266\& assert (("libev version mismatch", 279\& assert (("libev version mismatch",
267\& ev_version_major () == EV_VERSION_MAJOR 280\& ev_version_major () == EV_VERSION_MAJOR
268\& && ev_version_minor () >= EV_VERSION_MINOR)); 281\& && ev_version_minor () >= EV_VERSION_MINOR));
… …
296might be supported on the current system, you would need to look at 309might be supported on the current system, you would need to look at
297\&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for 310\&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for
298recommended ones. 311recommended ones.
299.Sp 312.Sp
300See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. 313See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
301.IP "ev_set_allocator (void *(*cb)(void *ptr, size_t size))" 4 314.IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4
302.IX Item "ev_set_allocator (void *(*cb)(void *ptr, size_t size))" 315.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))"
303Sets the allocation function to use (the prototype and semantics are 316Sets the allocation function to use (the prototype is similar \- the
304identical to the realloc C function). It is used to allocate and free 317semantics is identical \- to the realloc C function). It is used to
305memory (no surprises here). If it returns zero when memory needs to be 318allocate and free memory (no surprises here). If it returns zero when
306allocated, the library might abort or take some potentially destructive 319memory needs to be allocated, the library might abort or take some
307action. The default is your system realloc function. 320potentially destructive action. The default is your system realloc
321function.
308.Sp 322.Sp
309You could override this function in high-availability programs to, say, 323You could override this function in high-availability programs to, say,
310free some memory if it cannot allocate memory, to use a special allocator, 324free some memory if it cannot allocate memory, to use a special allocator,
311or even to sleep a while and retry until some memory is available. 325or even to sleep a while and retry until some memory is available.
312.Sp 326.Sp
313Example: replace the libev allocator with one that waits a bit and then 327Example: Replace the libev allocator with one that waits a bit and then
314retries: better than mine). 328retries).
315.Sp 329.Sp
316.Vb 6 330.Vb 6
317\& static void * 331\& static void *
318\& persistent_realloc (void *ptr, size_t size) 332\& persistent_realloc (void *ptr, size_t size)
319\& { 333\& {
… …
345callback is set, then libev will expect it to remedy the sitution, no 359callback is set, then libev will expect it to remedy the sitution, no
346matter what, when it returns. That is, libev will generally retry the 360matter what, when it returns. That is, libev will generally retry the
347requested operation, or, if the condition doesn't go away, do bad stuff 361requested operation, or, if the condition doesn't go away, do bad stuff
348(such as abort). 362(such as abort).
349.Sp 363.Sp
350Example: do the same thing as libev does internally: 364Example: This is basically the same thing that libev does internally, too.
351.Sp 365.Sp
352.Vb 6 366.Vb 6
353\& static void 367\& static void
354\& fatal_error (const char *msg) 368\& fatal_error (const char *msg)
355\& { 369\& {
… …
401or setgid) then libev will \fInot\fR look at the environment variable 415or setgid) then libev will \fInot\fR look at the environment variable
402\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will 416\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will
403override the flags completely if it is found in the environment. This is 417override the flags completely if it is found in the environment. This is
404useful to try out specific backends to test their performance, or to work 418useful to try out specific backends to test their performance, or to work
405around bugs. 419around bugs.
420.ie n .IP """EVFLAG_FORKCHECK""" 4
421.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4
422.IX Item "EVFLAG_FORKCHECK"
423Instead of calling \f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR manually after
424a fork, you can also make libev check for a fork in each iteration by
425enabling this flag.
426.Sp
427This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop,
428and thus this might slow down your event loop if you do a lot of loop
429iterations and little real work, but is usually not noticeable (on my
430Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence
431without a syscall and thus \fIvery\fR fast, but my Linux system also has
432\&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster).
433.Sp
434The big advantage of this flag is that you can forget about fork (and
435forget about forgetting to tell libev about forking) when you use this
436flag.
437.Sp
438This flag setting cannot be overriden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR
439environment variable.
406.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 440.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4
407.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 441.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4
408.IX Item "EVBACKEND_SELECT (value 1, portable select backend)" 442.IX Item "EVBACKEND_SELECT (value 1, portable select backend)"
409This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as 443This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as
410libev tries to roll its own fd_set with no limits on the number of fds, 444libev tries to roll its own fd_set with no limits on the number of fds,
… …
504Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is 538Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is
505always distinct from the default loop. Unlike the default loop, it cannot 539always distinct from the default loop. Unlike the default loop, it cannot
506handle signal and child watchers, and attempts to do so will be greeted by 540handle signal and child watchers, and attempts to do so will be greeted by
507undefined behaviour (or a failed assertion if assertions are enabled). 541undefined behaviour (or a failed assertion if assertions are enabled).
508.Sp 542.Sp
509Example: try to create a event loop that uses epoll and nothing else. 543Example: Try to create a event loop that uses epoll and nothing else.
510.Sp 544.Sp
511.Vb 3 545.Vb 3
512\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); 546\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
513\& if (!epoller) 547\& if (!epoller)
514\& fatal ("no epoll found here, maybe it hides under your chair"); 548\& fatal ("no epoll found here, maybe it hides under your chair");
… …
551.IP "ev_loop_fork (loop)" 4 585.IP "ev_loop_fork (loop)" 4
552.IX Item "ev_loop_fork (loop)" 586.IX Item "ev_loop_fork (loop)"
553Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by 587Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by
554\&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop 588\&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop
555after fork, and how you do this is entirely your own problem. 589after fork, and how you do this is entirely your own problem.
590.IP "unsigned int ev_loop_count (loop)" 4
591.IX Item "unsigned int ev_loop_count (loop)"
592Returns the count of loop iterations for the loop, which is identical to
593the number of times libev did poll for new events. It starts at \f(CW0\fR and
594happily wraps around with enough iterations.
595.Sp
596This value can sometimes be useful as a generation counter of sorts (it
597\&\*(L"ticks\*(R" the number of loop iterations), as it roughly corresponds with
598\&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls.
556.IP "unsigned int ev_backend (loop)" 4 599.IP "unsigned int ev_backend (loop)" 4
557.IX Item "unsigned int ev_backend (loop)" 600.IX Item "unsigned int ev_backend (loop)"
558Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in 601Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in
559use. 602use.
560.IP "ev_tstamp ev_now (loop)" 4 603.IP "ev_tstamp ev_now (loop)" 4
… …
612\& be handled here by queueing them when their watcher gets executed. 655\& be handled here by queueing them when their watcher gets executed.
613\& - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK 656\& - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
614\& were used, return, otherwise continue with step *. 657\& were used, return, otherwise continue with step *.
615.Ve 658.Ve
616.Sp 659.Sp
617Example: queue some jobs and then loop until no events are outsanding 660Example: Queue some jobs and then loop until no events are outsanding
618anymore. 661anymore.
619.Sp 662.Sp
620.Vb 4 663.Vb 4
621\& ... queue jobs here, make sure they register event watchers as long 664\& ... queue jobs here, make sure they register event watchers as long
622\& ... as they still have work to do (even an idle watcher will do..) 665\& ... as they still have work to do (even an idle watcher will do..)
… …
644visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from exiting if 687visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from exiting if
645no event watchers registered by it are active. It is also an excellent 688no event watchers registered by it are active. It is also an excellent
646way to do this for generic recurring timers or from within third-party 689way to do this for generic recurring timers or from within third-party
647libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR. 690libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR.
648.Sp 691.Sp
649Example: create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR 692Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR
650running when nothing else is active. 693running when nothing else is active.
651.Sp 694.Sp
652.Vb 4 695.Vb 4
653\& struct dv_signal exitsig; 696\& struct ev_signal exitsig;
654\& ev_signal_init (&exitsig, sig_cb, SIGINT); 697\& ev_signal_init (&exitsig, sig_cb, SIGINT);
655\& ev_signal_start (myloop, &exitsig); 698\& ev_signal_start (loop, &exitsig);
656\& evf_unref (myloop); 699\& evf_unref (loop);
657.Ve 700.Ve
658.Sp 701.Sp
659Example: for some weird reason, unregister the above signal handler again. 702Example: For some weird reason, unregister the above signal handler again.
660.Sp 703.Sp
661.Vb 2 704.Vb 2
662\& ev_ref (myloop); 705\& ev_ref (loop);
663\& ev_signal_stop (myloop, &exitsig); 706\& ev_signal_stop (loop, &exitsig);
664.Ve 707.Ve
665.SH "ANATOMY OF A WATCHER" 708.SH "ANATOMY OF A WATCHER"
666.IX Header "ANATOMY OF A WATCHER" 709.IX Header "ANATOMY OF A WATCHER"
667A watcher is a structure that you create and register to record your 710A watcher is a structure that you create and register to record your
668interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to 711interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to
… …
846.IP "bool ev_is_pending (ev_TYPE *watcher)" 4 889.IP "bool ev_is_pending (ev_TYPE *watcher)" 4
847.IX Item "bool ev_is_pending (ev_TYPE *watcher)" 890.IX Item "bool ev_is_pending (ev_TYPE *watcher)"
848Returns a true value iff the watcher is pending, (i.e. it has outstanding 891Returns a true value iff the watcher is pending, (i.e. it has outstanding
849events but its callback has not yet been invoked). As long as a watcher 892events but its callback has not yet been invoked). As long as a watcher
850is pending (but not active) you must not call an init function on it (but 893is pending (but not active) you must not call an init function on it (but
851\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe) and you must make sure the watcher is available to 894\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe), you must not change its priority, and you must
852libev (e.g. you cnanot \f(CW\*(C`free ()\*(C'\fR it). 895make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR
896it).
853.IP "callback = ev_cb (ev_TYPE *watcher)" 4 897.IP "callback ev_cb (ev_TYPE *watcher)" 4
854.IX Item "callback = ev_cb (ev_TYPE *watcher)" 898.IX Item "callback ev_cb (ev_TYPE *watcher)"
855Returns the callback currently set on the watcher. 899Returns the callback currently set on the watcher.
856.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 900.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4
857.IX Item "ev_cb_set (ev_TYPE *watcher, callback)" 901.IX Item "ev_cb_set (ev_TYPE *watcher, callback)"
858Change the callback. You can change the callback at virtually any time 902Change the callback. You can change the callback at virtually any time
859(modulo threads). 903(modulo threads).
904.IP "ev_set_priority (ev_TYPE *watcher, priority)" 4
905.IX Item "ev_set_priority (ev_TYPE *watcher, priority)"
906.PD 0
907.IP "int ev_priority (ev_TYPE *watcher)" 4
908.IX Item "int ev_priority (ev_TYPE *watcher)"
909.PD
910Set and query the priority of the watcher. The priority is a small
911integer between \f(CW\*(C`EV_MAXPRI\*(C'\fR (default: \f(CW2\fR) and \f(CW\*(C`EV_MINPRI\*(C'\fR
912(default: \f(CW\*(C`\-2\*(C'\fR). Pending watchers with higher priority will be invoked
913before watchers with lower priority, but priority will not keep watchers
914from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers).
915.Sp
916This means that priorities are \fIonly\fR used for ordering callback
917invocation after new events have been received. This is useful, for
918example, to reduce latency after idling, or more often, to bind two
919watchers on the same event and make sure one is called first.
920.Sp
921If you need to suppress invocation when higher priority events are pending
922you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality.
923.Sp
924You \fImust not\fR change the priority of a watcher as long as it is active or
925pending.
926.Sp
927The default priority used by watchers when no priority has been set is
928always \f(CW0\fR, which is supposed to not be too high and not be too low :).
929.Sp
930Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is
931fine, as long as you do not mind that the priority value you query might
932or might not have been adjusted to be within valid range.
933.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4
934.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)"
935Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither
936\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback
937can deal with that fact.
938.IP "int ev_clear_pending (loop, ev_TYPE *watcher)" 4
939.IX Item "int ev_clear_pending (loop, ev_TYPE *watcher)"
940If the watcher is pending, this function returns clears its pending status
941and returns its \f(CW\*(C`revents\*(C'\fR bitset (as if its callback was invoked). If the
942watcher isn't pending it does nothing and returns \f(CW0\fR.
860.Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" 943.Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0"
861.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" 944.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER"
862Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change 945Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change
863and read at any time, libev will completely ignore it. This can be used 946and read at any time, libev will completely ignore it. This can be used
864to associate arbitrary data with your watcher. If you need more data and 947to associate arbitrary data with your watcher. If you need more data and
… …
885\& struct my_io *w = (struct my_io *)w_; 968\& struct my_io *w = (struct my_io *)w_;
886\& ... 969\& ...
887\& } 970\& }
888.Ve 971.Ve
889.PP 972.PP
890More interesting and less C\-conformant ways of catsing your callback type 973More interesting and less C\-conformant ways of casting your callback type
891have been omitted.... 974instead have been omitted.
975.PP
976Another common scenario is having some data structure with multiple
977watchers:
978.PP
979.Vb 6
980\& struct my_biggy
981\& {
982\& int some_data;
983\& ev_timer t1;
984\& ev_timer t2;
985\& }
986.Ve
987.PP
988In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more complicated,
989you need to use \f(CW\*(C`offsetof\*(C'\fR:
990.PP
991.Vb 1
992\& #include <stddef.h>
993.Ve
994.PP
995.Vb 6
996\& static void
997\& t1_cb (EV_P_ struct ev_timer *w, int revents)
998\& {
999\& struct my_biggy big = (struct my_biggy *
1000\& (((char *)w) - offsetof (struct my_biggy, t1));
1001\& }
1002.Ve
1003.PP
1004.Vb 6
1005\& static void
1006\& t2_cb (EV_P_ struct ev_timer *w, int revents)
1007\& {
1008\& struct my_biggy big = (struct my_biggy *
1009\& (((char *)w) - offsetof (struct my_biggy, t2));
1010\& }
1011.Ve
892.SH "WATCHER TYPES" 1012.SH "WATCHER TYPES"
893.IX Header "WATCHER TYPES" 1013.IX Header "WATCHER TYPES"
894This section describes each watcher in detail, but will not repeat 1014This section describes each watcher in detail, but will not repeat
895information given in the last section. Any initialisation/set macros, 1015information given in the last section. Any initialisation/set macros,
896functions and members specific to the watcher type are explained. 1016functions and members specific to the watcher type are explained.
… …
938it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning 1058it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning
939\&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives. 1059\&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives.
940.PP 1060.PP
941If you cannot run the fd in non-blocking mode (for example you should not 1061If you cannot run the fd in non-blocking mode (for example you should not
942play around with an Xlib connection), then you have to seperately re-test 1062play around with an Xlib connection), then you have to seperately re-test
943wether a file descriptor is really ready with a known-to-be good interface 1063whether a file descriptor is really ready with a known-to-be good interface
944such as poll (fortunately in our Xlib example, Xlib already does this on 1064such as poll (fortunately in our Xlib example, Xlib already does this on
945its own, so its quite safe to use). 1065its own, so its quite safe to use).
946.IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 1066.IP "ev_io_init (ev_io *, callback, int fd, int events)" 4
947.IX Item "ev_io_init (ev_io *, callback, int fd, int events)" 1067.IX Item "ev_io_init (ev_io *, callback, int fd, int events)"
948.PD 0 1068.PD 0
… …
957The file descriptor being watched. 1077The file descriptor being watched.
958.IP "int events [read\-only]" 4 1078.IP "int events [read\-only]" 4
959.IX Item "int events [read-only]" 1079.IX Item "int events [read-only]"
960The events being watched. 1080The events being watched.
961.PP 1081.PP
962Example: call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well 1082Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well
963readable, but only once. Since it is likely line\-buffered, you could 1083readable, but only once. Since it is likely line\-buffered, you could
964attempt to read a whole line in the callback: 1084attempt to read a whole line in the callback.
965.PP 1085.PP
966.Vb 6 1086.Vb 6
967\& static void 1087\& static void
968\& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1088\& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)
969\& { 1089\& {
… …
1024.IP "ev_timer_again (loop)" 4 1144.IP "ev_timer_again (loop)" 4
1025.IX Item "ev_timer_again (loop)" 1145.IX Item "ev_timer_again (loop)"
1026This will act as if the timer timed out and restart it again if it is 1146This will act as if the timer timed out and restart it again if it is
1027repeating. The exact semantics are: 1147repeating. The exact semantics are:
1028.Sp 1148.Sp
1149If the timer is pending, its pending status is cleared.
1150.Sp
1029If the timer is started but nonrepeating, stop it. 1151If the timer is started but nonrepeating, stop it (as if it timed out).
1030.Sp 1152.Sp
1031If the timer is repeating, either start it if necessary (with the repeat 1153If the timer is repeating, either start it if necessary (with the
1032value), or reset the running timer to the repeat value. 1154\&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value.
1033.Sp 1155.Sp
1034This sounds a bit complicated, but here is a useful and typical 1156This sounds a bit complicated, but here is a useful and typical
1035example: Imagine you have a tcp connection and you want a so-called 1157example: Imagine you have a tcp connection and you want a so-called idle
1036idle timeout, that is, you want to be called when there have been, 1158timeout, that is, you want to be called when there have been, say, 60
1037say, 60 seconds of inactivity on the socket. The easiest way to do 1159seconds of inactivity on the socket. The easiest way to do this is to
1038this is to configure an \f(CW\*(C`ev_timer\*(C'\fR with \f(CW\*(C`after\*(C'\fR=\f(CW\*(C`repeat\*(C'\fR=\f(CW60\fR and calling 1160configure an \f(CW\*(C`ev_timer\*(C'\fR with a \f(CW\*(C`repeat\*(C'\fR value of \f(CW60\fR and then call
1039\&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If 1161\&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If
1040you go into an idle state where you do not expect data to travel on the 1162you go into an idle state where you do not expect data to travel on the
1041socket, you can stop the timer, and again will automatically restart it if 1163socket, you can \f(CW\*(C`ev_timer_stop\*(C'\fR the timer, and \f(CW\*(C`ev_timer_again\*(C'\fR will
1042need be. 1164automatically restart it if need be.
1043.Sp 1165.Sp
1044You can also ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR altogether 1166That means you can ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR
1045and only ever use the \f(CW\*(C`repeat\*(C'\fR value: 1167altogether and only ever use the \f(CW\*(C`repeat\*(C'\fR value and \f(CW\*(C`ev_timer_again\*(C'\fR:
1046.Sp 1168.Sp
1047.Vb 8 1169.Vb 8
1048\& ev_timer_init (timer, callback, 0., 5.); 1170\& ev_timer_init (timer, callback, 0., 5.);
1049\& ev_timer_again (loop, timer); 1171\& ev_timer_again (loop, timer);
1050\& ... 1172\& ...
… …
1053\& ... 1175\& ...
1054\& timer->again = 10.; 1176\& timer->again = 10.;
1055\& ev_timer_again (loop, timer); 1177\& ev_timer_again (loop, timer);
1056.Ve 1178.Ve
1057.Sp 1179.Sp
1058This is more efficient then stopping/starting the timer eahc time you want 1180This is more slightly efficient then stopping/starting the timer each time
1059to modify its timeout value. 1181you want to modify its timeout value.
1060.IP "ev_tstamp repeat [read\-write]" 4 1182.IP "ev_tstamp repeat [read\-write]" 4
1061.IX Item "ev_tstamp repeat [read-write]" 1183.IX Item "ev_tstamp repeat [read-write]"
1062The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out 1184The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out
1063or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any), 1185or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any),
1064which is also when any modifications are taken into account. 1186which is also when any modifications are taken into account.
1065.PP 1187.PP
1066Example: create a timer that fires after 60 seconds. 1188Example: Create a timer that fires after 60 seconds.
1067.PP 1189.PP
1068.Vb 5 1190.Vb 5
1069\& static void 1191\& static void
1070\& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1192\& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
1071\& { 1193\& {
… …
1077\& struct ev_timer mytimer; 1199\& struct ev_timer mytimer;
1078\& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); 1200\& ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
1079\& ev_timer_start (loop, &mytimer); 1201\& ev_timer_start (loop, &mytimer);
1080.Ve 1202.Ve
1081.PP 1203.PP
1082Example: create a timeout timer that times out after 10 seconds of 1204Example: Create a timeout timer that times out after 10 seconds of
1083inactivity. 1205inactivity.
1084.PP 1206.PP
1085.Vb 5 1207.Vb 5
1086\& static void 1208\& static void
1087\& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1209\& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
… …
1212.IX Item "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]" 1334.IX Item "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]"
1213The current reschedule callback, or \f(CW0\fR, if this functionality is 1335The current reschedule callback, or \f(CW0\fR, if this functionality is
1214switched off. Can be changed any time, but changes only take effect when 1336switched off. Can be changed any time, but changes only take effect when
1215the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. 1337the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called.
1216.PP 1338.PP
1217Example: call a callback every hour, or, more precisely, whenever the 1339Example: Call a callback every hour, or, more precisely, whenever the
1218system clock is divisible by 3600. The callback invocation times have 1340system clock is divisible by 3600. The callback invocation times have
1219potentially a lot of jittering, but good long-term stability. 1341potentially a lot of jittering, but good long-term stability.
1220.PP 1342.PP
1221.Vb 5 1343.Vb 5
1222\& static void 1344\& static void
… …
1230\& struct ev_periodic hourly_tick; 1352\& struct ev_periodic hourly_tick;
1231\& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); 1353\& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1232\& ev_periodic_start (loop, &hourly_tick); 1354\& ev_periodic_start (loop, &hourly_tick);
1233.Ve 1355.Ve
1234.PP 1356.PP
1235Example: the same as above, but use a reschedule callback to do it: 1357Example: The same as above, but use a reschedule callback to do it:
1236.PP 1358.PP
1237.Vb 1 1359.Vb 1
1238\& #include <math.h> 1360\& #include <math.h>
1239.Ve 1361.Ve
1240.PP 1362.PP
… …
1248.PP 1370.PP
1249.Vb 1 1371.Vb 1
1250\& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); 1372\& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1251.Ve 1373.Ve
1252.PP 1374.PP
1253Example: call a callback every hour, starting now: 1375Example: Call a callback every hour, starting now:
1254.PP 1376.PP
1255.Vb 4 1377.Vb 4
1256\& struct ev_periodic hourly_tick; 1378\& struct ev_periodic hourly_tick;
1257\& ev_periodic_init (&hourly_tick, clock_cb, 1379\& ev_periodic_init (&hourly_tick, clock_cb,
1258\& fmod (ev_now (loop), 3600.), 3600., 0); 1380\& fmod (ev_now (loop), 3600.), 3600., 0);
… …
1309.IP "int rstatus [read\-write]" 4 1431.IP "int rstatus [read\-write]" 4
1310.IX Item "int rstatus [read-write]" 1432.IX Item "int rstatus [read-write]"
1311The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems 1433The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems
1312\&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details). 1434\&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details).
1313.PP 1435.PP
1314Example: try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0. 1436Example: Try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0.
1315.PP 1437.PP
1316.Vb 5 1438.Vb 5
1317\& static void 1439\& static void
1318\& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) 1440\& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1319\& { 1441\& {
… …
1337not exist\*(R" is a status change like any other. The condition \*(L"path does 1459not exist\*(R" is a status change like any other. The condition \*(L"path does
1338not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is 1460not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is
1339otherwise always forced to be at least one) and all the other fields of 1461otherwise always forced to be at least one) and all the other fields of
1340the stat buffer having unspecified contents. 1462the stat buffer having unspecified contents.
1341.PP 1463.PP
1464The path \fIshould\fR be absolute and \fImust not\fR end in a slash. If it is
1465relative and your working directory changes, the behaviour is undefined.
1466.PP
1342Since there is no standard to do this, the portable implementation simply 1467Since there is no standard to do this, the portable implementation simply
1343calls \f(CW\*(C`stat (2)\*(C'\fR regulalry on the path to see if it changed somehow. You 1468calls \f(CW\*(C`stat (2)\*(C'\fR regularly on the path to see if it changed somehow. You
1344can specify a recommended polling interval for this case. If you specify 1469can specify a recommended polling interval for this case. If you specify
1345a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable, 1470a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable,
1346unspecified default\fR value will be used (which you can expect to be around 1471unspecified default\fR value will be used (which you can expect to be around
1347five seconds, although this might change dynamically). Libev will also 1472five seconds, although this might change dynamically). Libev will also
1348impose a minimum interval which is currently around \f(CW0.1\fR, but thats 1473impose a minimum interval which is currently around \f(CW0.1\fR, but thats
… …
1350.PP 1475.PP
1351This watcher type is not meant for massive numbers of stat watchers, 1476This watcher type is not meant for massive numbers of stat watchers,
1352as even with OS-supported change notifications, this can be 1477as even with OS-supported change notifications, this can be
1353resource\-intensive. 1478resource\-intensive.
1354.PP 1479.PP
1355At the time of this writing, no specific \s-1OS\s0 backends are implemented, but 1480At the time of this writing, only the Linux inotify interface is
1356if demand increases, at least a kqueue and inotify backend will be added. 1481implemented (implementing kqueue support is left as an exercise for the
1482reader). Inotify will be used to give hints only and should not change the
1483semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs
1484to fall back to regular polling again even with inotify, but changes are
1485usually detected immediately, and if the file exists there will be no
1486polling.
1357.IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 1487.IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4
1358.IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 1488.IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)"
1359.PD 0 1489.PD 0
1360.IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4 1490.IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4
1361.IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 1491.IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)"
… …
1422\& ev_stat_start (loop, &passwd); 1552\& ev_stat_start (loop, &passwd);
1423.Ve 1553.Ve
1424.ie n .Sh """ev_idle"" \- when you've got nothing better to do..." 1554.ie n .Sh """ev_idle"" \- when you've got nothing better to do..."
1425.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." 1555.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..."
1426.IX Subsection "ev_idle - when you've got nothing better to do..." 1556.IX Subsection "ev_idle - when you've got nothing better to do..."
1427Idle watchers trigger events when there are no other events are pending 1557Idle watchers trigger events when no other events of the same or higher
1428(prepare, check and other idle watchers do not count). That is, as long 1558priority are pending (prepare, check and other idle watchers do not
1429as your process is busy handling sockets or timeouts (or even signals, 1559count).
1430imagine) it will not be triggered. But when your process is idle all idle 1560.PP
1431watchers are being called again and again, once per event loop iteration \- 1561That is, as long as your process is busy handling sockets or timeouts
1562(or even signals, imagine) of the same or higher priority it will not be
1563triggered. But when your process is idle (or only lower-priority watchers
1564are pending), the idle watchers are being called once per event loop
1432until stopped, that is, or your process receives more events and becomes 1565iteration \- until stopped, that is, or your process receives more events
1433busy. 1566and becomes busy again with higher priority stuff.
1434.PP 1567.PP
1435The most noteworthy effect is that as long as any idle watchers are 1568The most noteworthy effect is that as long as any idle watchers are
1436active, the process will not block when waiting for new events. 1569active, the process will not block when waiting for new events.
1437.PP 1570.PP
1438Apart from keeping your process non-blocking (which is a useful 1571Apart from keeping your process non-blocking (which is a useful
… …
1443.IX Item "ev_idle_init (ev_signal *, callback)" 1576.IX Item "ev_idle_init (ev_signal *, callback)"
1444Initialises and configures the idle watcher \- it has no parameters of any 1577Initialises and configures the idle watcher \- it has no parameters of any
1445kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, 1578kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless,
1446believe me. 1579believe me.
1447.PP 1580.PP
1448Example: dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR, start it, and in the 1581Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the
1449callback, free it. Alos, use no error checking, as usual. 1582callback, free it. Also, use no error checking, as usual.
1450.PP 1583.PP
1451.Vb 7 1584.Vb 7
1452\& static void 1585\& static void
1453\& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) 1586\& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1454\& { 1587\& {
… …
1533\& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; 1666\& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1534\& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; 1667\& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1535\& } 1668\& }
1536.Ve 1669.Ve
1537.PP 1670.PP
1538.Vb 7 1671.Vb 8
1539\& // create io watchers for each fd and a timer before blocking 1672\& // create io watchers for each fd and a timer before blocking
1540\& static void 1673\& static void
1541\& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) 1674\& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
1542\& { 1675\& {
1543\& int timeout = 3600000;truct pollfd fds [nfd]; 1676\& int timeout = 3600000;
1677\& struct pollfd fds [nfd];
1544\& // actual code will need to loop here and realloc etc. 1678\& // actual code will need to loop here and realloc etc.
1545\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); 1679\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1546.Ve 1680.Ve
1547.PP 1681.PP
1548.Vb 3 1682.Vb 3
… …
1774.PP 1908.PP
1775.Vb 1 1909.Vb 1
1776\& #include <ev++.h> 1910\& #include <ev++.h>
1777.Ve 1911.Ve
1778.PP 1912.PP
1779(it is not installed by default). This automatically includes \fIev.h\fR 1913This automatically includes \fIev.h\fR and puts all of its definitions (many
1780and puts all of its definitions (many of them macros) into the global 1914of them macros) into the global namespace. All \*(C+ specific things are
1781namespace. All \*(C+ specific things are put into the \f(CW\*(C`ev\*(C'\fR namespace. 1915put into the \f(CW\*(C`ev\*(C'\fR namespace. It should support all the same embedding
1916options as \fIev.h\fR, most notably \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR.
1782.PP 1917.PP
1783It should support all the same embedding options as \fIev.h\fR, most notably 1918Care has been taken to keep the overhead low. The only data member the \*(C+
1784\&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. 1919classes add (compared to plain C\-style watchers) is the event loop pointer
1920that the watcher is associated with (or no additional members at all if
1921you disable \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR when embedding libev).
1922.PP
1923Currently, functions, and static and non-static member functions can be
1924used as callbacks. Other types should be easy to add as long as they only
1925need one additional pointer for context. If you need support for other
1926types of functors please contact the author (preferably after implementing
1927it).
1785.PP 1928.PP
1786Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: 1929Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace:
1787.ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4 1930.ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4
1788.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 1931.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4
1789.IX Item "ev::READ, ev::WRITE etc." 1932.IX Item "ev::READ, ev::WRITE etc."
… …
1801which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro 1944which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro
1802defines by many implementations. 1945defines by many implementations.
1803.Sp 1946.Sp
1804All of those classes have these methods: 1947All of those classes have these methods:
1805.RS 4 1948.RS 4
1806.IP "ev::TYPE::TYPE (object *, object::method *)" 4 1949.IP "ev::TYPE::TYPE ()" 4
1807.IX Item "ev::TYPE::TYPE (object *, object::method *)" 1950.IX Item "ev::TYPE::TYPE ()"
1808.PD 0 1951.PD 0
1809.IP "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" 4 1952.IP "ev::TYPE::TYPE (struct ev_loop *)" 4
1810.IX Item "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" 1953.IX Item "ev::TYPE::TYPE (struct ev_loop *)"
1811.IP "ev::TYPE::~TYPE" 4 1954.IP "ev::TYPE::~TYPE" 4
1812.IX Item "ev::TYPE::~TYPE" 1955.IX Item "ev::TYPE::~TYPE"
1813.PD 1956.PD
1814The constructor takes a pointer to an object and a method pointer to 1957The constructor (optionally) takes an event loop to associate the watcher
1815the event handler callback to call in this class. The constructor calls 1958with. If it is omitted, it will use \f(CW\*(C`EV_DEFAULT\*(C'\fR.
1816\&\f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the \f(CW\*(C`set\*(C'\fR method 1959.Sp
1817before starting it. If you do not specify a loop then the constructor 1960The constructor calls \f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the
1818automatically associates the default loop with this watcher. 1961\&\f(CW\*(C`set\*(C'\fR method before starting it.
1962.Sp
1963It will not set a callback, however: You have to call the templated \f(CW\*(C`set\*(C'\fR
1964method to set a callback before you can start the watcher.
1965.Sp
1966(The reason why you have to use a method is a limitation in \*(C+ which does
1967not allow explicit template arguments for constructors).
1819.Sp 1968.Sp
1820The destructor automatically stops the watcher if it is active. 1969The destructor automatically stops the watcher if it is active.
1970.IP "w\->set<class, &class::method> (object *)" 4
1971.IX Item "w->set<class, &class::method> (object *)"
1972This method sets the callback method to call. The method has to have a
1973signature of \f(CW\*(C`void (*)(ev_TYPE &, int)\*(C'\fR, it receives the watcher as
1974first argument and the \f(CW\*(C`revents\*(C'\fR as second. The object must be given as
1975parameter and is stored in the \f(CW\*(C`data\*(C'\fR member of the watcher.
1976.Sp
1977This method synthesizes efficient thunking code to call your method from
1978the C callback that libev requires. If your compiler can inline your
1979callback (i.e. it is visible to it at the place of the \f(CW\*(C`set\*(C'\fR call and
1980your compiler is good :), then the method will be fully inlined into the
1981thunking function, making it as fast as a direct C callback.
1982.Sp
1983Example: simple class declaration and watcher initialisation
1984.Sp
1985.Vb 4
1986\& struct myclass
1987\& {
1988\& void io_cb (ev::io &w, int revents) { }
1989\& }
1990.Ve
1991.Sp
1992.Vb 3
1993\& myclass obj;
1994\& ev::io iow;
1995\& iow.set <myclass, &myclass::io_cb> (&obj);
1996.Ve
1997.IP "w\->set<function> (void *data = 0)" 4
1998.IX Item "w->set<function> (void *data = 0)"
1999Also sets a callback, but uses a static method or plain function as
2000callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's
2001\&\f(CW\*(C`data\*(C'\fR member and is free for you to use.
2002.Sp
2003The prototype of the \f(CW\*(C`function\*(C'\fR must be \f(CW\*(C`void (*)(ev::TYPE &w, int)\*(C'\fR.
2004.Sp
2005See the method\-\f(CW\*(C`set\*(C'\fR above for more details.
2006.Sp
2007Example:
2008.Sp
2009.Vb 2
2010\& static void io_cb (ev::io &w, int revents) { }
2011\& iow.set <io_cb> ();
2012.Ve
1821.IP "w\->set (struct ev_loop *)" 4 2013.IP "w\->set (struct ev_loop *)" 4
1822.IX Item "w->set (struct ev_loop *)" 2014.IX Item "w->set (struct ev_loop *)"
1823Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only 2015Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only
1824do this when the watcher is inactive (and not pending either). 2016do this when the watcher is inactive (and not pending either).
1825.IP "w\->set ([args])" 4 2017.IP "w\->set ([args])" 4
1826.IX Item "w->set ([args])" 2018.IX Item "w->set ([args])"
1827Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be 2019Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be
1828called at least once. Unlike the C counterpart, an active watcher gets 2020called at least once. Unlike the C counterpart, an active watcher gets
1829automatically stopped and restarted. 2021automatically stopped and restarted when reconfiguring it with this
2022method.
1830.IP "w\->start ()" 4 2023.IP "w\->start ()" 4
1831.IX Item "w->start ()" 2024.IX Item "w->start ()"
1832Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument as the 2025Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the
1833constructor already takes the loop. 2026constructor already stores the event loop.
1834.IP "w\->stop ()" 4 2027.IP "w\->stop ()" 4
1835.IX Item "w->stop ()" 2028.IX Item "w->stop ()"
1836Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. 2029Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument.
1837.ie n .IP "w\->again () ""ev::timer""\fR, \f(CW""ev::periodic"" only" 4 2030.ie n .IP "w\->again () ""ev::timer""\fR, \f(CW""ev::periodic"" only" 4
1838.el .IP "w\->again () \f(CWev::timer\fR, \f(CWev::periodic\fR only" 4 2031.el .IP "w\->again () \f(CWev::timer\fR, \f(CWev::periodic\fR only" 4
… …
1864.Vb 2 2057.Vb 2
1865\& myclass (); 2058\& myclass ();
1866\& } 2059\& }
1867.Ve 2060.Ve
1868.PP 2061.PP
1869.Vb 6 2062.Vb 4
1870\& myclass::myclass (int fd) 2063\& myclass::myclass (int fd)
1871\& : io (this, &myclass::io_cb),
1872\& idle (this, &myclass::idle_cb)
1873\& { 2064\& {
2065\& io .set <myclass, &myclass::io_cb > (this);
2066\& idle.set <myclass, &myclass::idle_cb> (this);
2067.Ve
2068.PP
2069.Vb 2
1874\& io.start (fd, ev::READ); 2070\& io.start (fd, ev::READ);
1875\& } 2071\& }
1876.Ve 2072.Ve
1877.SH "MACRO MAGIC" 2073.SH "MACRO MAGIC"
1878.IX Header "MACRO MAGIC" 2074.IX Header "MACRO MAGIC"
1879Libev can be compiled with a variety of options, the most fundemantal is 2075Libev can be compiled with a variety of options, the most fundemantal is
1880\&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines wether (most) functions and 2076\&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) functions and
1881callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. 2077callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument.
1882.PP 2078.PP
1883To make it easier to write programs that cope with either variant, the 2079To make it easier to write programs that cope with either variant, the
1884following macros are defined: 2080following macros are defined:
1885.ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4 2081.ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4
… …
1920.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 2116.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4
1921.IX Item "EV_DEFAULT, EV_DEFAULT_" 2117.IX Item "EV_DEFAULT, EV_DEFAULT_"
1922Similar to the other two macros, this gives you the value of the default 2118Similar to the other two macros, this gives you the value of the default
1923loop, if multiple loops are supported (\*(L"ev loop default\*(R"). 2119loop, if multiple loops are supported (\*(L"ev loop default\*(R").
1924.PP 2120.PP
1925Example: Declare and initialise a check watcher, working regardless of 2121Example: Declare and initialise a check watcher, utilising the above
1926wether multiple loops are supported or not. 2122macros so it will work regardless of whether multiple loops are supported
2123or not.
1927.PP 2124.PP
1928.Vb 5 2125.Vb 5
1929\& static void 2126\& static void
1930\& check_cb (EV_P_ ev_timer *w, int revents) 2127\& check_cb (EV_P_ ev_timer *w, int revents)
1931\& { 2128\& {
… …
1994.Vb 1 2191.Vb 1
1995\& ev_win32.c required on win32 platforms only 2192\& ev_win32.c required on win32 platforms only
1996.Ve 2193.Ve
1997.PP 2194.PP
1998.Vb 5 2195.Vb 5
1999\& ev_select.c only when select backend is enabled (which is by default) 2196\& ev_select.c only when select backend is enabled (which is enabled by default)
2000\& ev_poll.c only when poll backend is enabled (disabled by default) 2197\& ev_poll.c only when poll backend is enabled (disabled by default)
2001\& ev_epoll.c only when the epoll backend is enabled (disabled by default) 2198\& ev_epoll.c only when the epoll backend is enabled (disabled by default)
2002\& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 2199\& ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
2003\& ev_port.c only when the solaris port backend is enabled (disabled by default) 2200\& ev_port.c only when the solaris port backend is enabled (disabled by default)
2004.Ve 2201.Ve
… …
2125otherwise another method will be used as fallback. This is the preferred 2322otherwise another method will be used as fallback. This is the preferred
2126backend for Solaris 10 systems. 2323backend for Solaris 10 systems.
2127.IP "\s-1EV_USE_DEVPOLL\s0" 4 2324.IP "\s-1EV_USE_DEVPOLL\s0" 4
2128.IX Item "EV_USE_DEVPOLL" 2325.IX Item "EV_USE_DEVPOLL"
2129reserved for future expansion, works like the \s-1USE\s0 symbols above. 2326reserved for future expansion, works like the \s-1USE\s0 symbols above.
2327.IP "\s-1EV_USE_INOTIFY\s0" 4
2328.IX Item "EV_USE_INOTIFY"
2329If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify
2330interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will
2331be detected at runtime.
2130.IP "\s-1EV_H\s0" 4 2332.IP "\s-1EV_H\s0" 4
2131.IX Item "EV_H" 2333.IX Item "EV_H"
2132The name of the \fIev.h\fR header file used to include it. The default if 2334The name of the \fIev.h\fR header file used to include it. The default if
2133undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This 2335undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This
2134can be used to virtually rename the \fIev.h\fR header file in case of conflicts. 2336can be used to virtually rename the \fIev.h\fR header file in case of conflicts.
… …
2152If undefined or defined to \f(CW1\fR, then all event-loop-specific functions 2354If undefined or defined to \f(CW1\fR, then all event-loop-specific functions
2153will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create 2355will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create
2154additional independent event loops. Otherwise there will be no support 2356additional independent event loops. Otherwise there will be no support
2155for multiple event loops and there is no first event loop pointer 2357for multiple event loops and there is no first event loop pointer
2156argument. Instead, all functions act on the single default loop. 2358argument. Instead, all functions act on the single default loop.
2359.IP "\s-1EV_MINPRI\s0" 4
2360.IX Item "EV_MINPRI"
2361.PD 0
2362.IP "\s-1EV_MAXPRI\s0" 4
2363.IX Item "EV_MAXPRI"
2364.PD
2365The range of allowed priorities. \f(CW\*(C`EV_MINPRI\*(C'\fR must be smaller or equal to
2366\&\f(CW\*(C`EV_MAXPRI\*(C'\fR, but otherwise there are no non-obvious limitations. You can
2367provide for more priorities by overriding those symbols (usually defined
2368to be \f(CW\*(C`\-2\*(C'\fR and \f(CW2\fR, respectively).
2369.Sp
2370When doing priority-based operations, libev usually has to linearly search
2371all the priorities, so having many of them (hundreds) uses a lot of space
2372and time, so using the defaults of five priorities (\-2 .. +2) is usually
2373fine.
2374.Sp
2375If your embedding app does not need any priorities, defining these both to
2376\&\f(CW0\fR will save some memory and cpu.
2157.IP "\s-1EV_PERIODIC_ENABLE\s0" 4 2377.IP "\s-1EV_PERIODIC_ENABLE\s0" 4
2158.IX Item "EV_PERIODIC_ENABLE" 2378.IX Item "EV_PERIODIC_ENABLE"
2159If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If 2379If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If
2380defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of
2381code.
2382.IP "\s-1EV_IDLE_ENABLE\s0" 4
2383.IX Item "EV_IDLE_ENABLE"
2384If undefined or defined to be \f(CW1\fR, then idle watchers are supported. If
2160defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of 2385defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of
2161code. 2386code.
2162.IP "\s-1EV_EMBED_ENABLE\s0" 4 2387.IP "\s-1EV_EMBED_ENABLE\s0" 4
2163.IX Item "EV_EMBED_ENABLE" 2388.IX Item "EV_EMBED_ENABLE"
2164If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If 2389If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If
… …
2179.IP "\s-1EV_PID_HASHSIZE\s0" 4 2404.IP "\s-1EV_PID_HASHSIZE\s0" 4
2180.IX Item "EV_PID_HASHSIZE" 2405.IX Item "EV_PID_HASHSIZE"
2181\&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by 2406\&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by
2182pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more 2407pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more
2183than enough. If you need to manage thousands of children you might want to 2408than enough. If you need to manage thousands of children you might want to
2184increase this value. 2409increase this value (\fImust\fR be a power of two).
2410.IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4
2411.IX Item "EV_INOTIFY_HASHSIZE"
2412\&\f(CW\*(C`ev_staz\*(C'\fR watchers use a small hash table to distribute workload by
2413inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR),
2414usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR
2415watchers you might want to increase this value (\fImust\fR be a power of
2416two).
2185.IP "\s-1EV_COMMON\s0" 4 2417.IP "\s-1EV_COMMON\s0" 4
2186.IX Item "EV_COMMON" 2418.IX Item "EV_COMMON"
2187By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining 2419By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining
2188this macro to a something else you can include more and other types of 2420this macro to a something else you can include more and other types of
2189members. You have to define it each time you include one of the files, 2421members. You have to define it each time you include one of the files,
… …
2219interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file 2451interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file
2220will be compiled. It is pretty complex because it provides its own header 2452will be compiled. It is pretty complex because it provides its own header
2221file. 2453file.
2222.Sp 2454.Sp
2223The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file 2455The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file
2224that everybody includes and which overrides some autoconf choices: 2456that everybody includes and which overrides some configure choices:
2225.Sp 2457.Sp
2226.Vb 4 2458.Vb 9
2459\& #define EV_MINIMAL 1
2227\& #define EV_USE_POLL 0 2460\& #define EV_USE_POLL 0
2228\& #define EV_MULTIPLICITY 0 2461\& #define EV_MULTIPLICITY 0
2229\& #define EV_PERIODICS 0 2462\& #define EV_PERIODIC_ENABLE 0
2463\& #define EV_STAT_ENABLE 0
2464\& #define EV_FORK_ENABLE 0
2230\& #define EV_CONFIG_H <config.h> 2465\& #define EV_CONFIG_H <config.h>
2466\& #define EV_MINPRI 0
2467\& #define EV_MAXPRI 0
2231.Ve 2468.Ve
2232.Sp 2469.Sp
2233.Vb 1 2470.Vb 1
2234\& #include "ev++.h" 2471\& #include "ev++.h"
2235.Ve 2472.Ve
… …
2243.SH "COMPLEXITIES" 2480.SH "COMPLEXITIES"
2244.IX Header "COMPLEXITIES" 2481.IX Header "COMPLEXITIES"
2245In this section the complexities of (many of) the algorithms used inside 2482In this section the complexities of (many of) the algorithms used inside
2246libev will be explained. For complexity discussions about backends see the 2483libev will be explained. For complexity discussions about backends see the
2247documentation for \f(CW\*(C`ev_default_init\*(C'\fR. 2484documentation for \f(CW\*(C`ev_default_init\*(C'\fR.
2485.Sp
2486All of the following are about amortised time: If an array needs to be
2487extended, libev needs to realloc and move the whole array, but this
2488happens asymptotically never with higher number of elements, so O(1) might
2489mean it might do a lengthy realloc operation in rare cases, but on average
2490it is much faster and asymptotically approaches constant time.
2248.RS 4 2491.RS 4
2249.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 2492.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4
2250.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 2493.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)"
2251.PD 0 2494This means that, when you have a watcher that triggers in one hour and
2495there are 100 watchers that would trigger before that then inserting will
2496have to skip those 100 watchers.
2252.IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4 2497.IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4
2253.IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 2498.IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)"
2499That means that for changing a timer costs less than removing/adding them
2500as only the relative motion in the event queue has to be paid for.
2254.IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 2501.IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4
2255.IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" 2502.IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)"
2256.IP "Stopping check/prepare/idle watchers: O(1)" 4 2503These just add the watcher into an array or at the head of a list.
2257.IX Item "Stopping check/prepare/idle watchers: O(1)" 2504=item Stopping check/prepare/idle watchers: O(1)
2258.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))" 4 2505.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4
2259.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))" 2506.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))"
2507These watchers are stored in lists then need to be walked to find the
2508correct watcher to remove. The lists are usually short (you don't usually
2509have many watchers waiting for the same fd or signal).
2260.IP "Finding the next timer per loop iteration: O(1)" 4 2510.IP "Finding the next timer per loop iteration: O(1)" 4
2261.IX Item "Finding the next timer per loop iteration: O(1)" 2511.IX Item "Finding the next timer per loop iteration: O(1)"
2512.PD 0
2262.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 2513.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4
2263.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 2514.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)"
2515.PD
2516A change means an I/O watcher gets started or stopped, which requires
2517libev to recalculate its status (and possibly tell the kernel).
2264.IP "Activating one watcher: O(1)" 4 2518.IP "Activating one watcher: O(1)" 4
2265.IX Item "Activating one watcher: O(1)" 2519.IX Item "Activating one watcher: O(1)"
2520.PD 0
2521.IP "Priority handling: O(number_of_priorities)" 4
2522.IX Item "Priority handling: O(number_of_priorities)"
2523.PD
2524Priorities are implemented by allocating some space for each
2525priority. When doing priority-based operations, libev usually has to
2526linearly search all the priorities.
2266.RE 2527.RE
2267.RS 4 2528.RS 4
2268.PD
2269.SH "AUTHOR" 2529.SH "AUTHOR"
2270.IX Header "AUTHOR" 2530.IX Header "AUTHOR"
2271Marc Lehmann <libev@schmorp.de>. 2531Marc Lehmann <libev@schmorp.de>.

Diff Legend

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