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

Comparing libev/ev.3 (file contents):
Revision 1.19 by root, Sat Nov 24 16:57:38 2007 UTC vs.
Revision 1.35 by root, Thu Nov 29 17:28:13 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-24" "perl v5.8.8" "User Contributed Perl Documentation" 132.TH "<STANDARD INPUT>" 1 "2007-11-29" "perl v5.8.8" "User Contributed Perl Documentation"
133.SH "NAME" 133.SH "NAME"
134libev \- a high performance full\-featured event loop written in C 134libev \- a high performance full\-featured event loop written in C
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137.Vb 1 137.Vb 1
138\& #include <ev.h> 138\& #include <ev.h>
139.Ve 139.Ve
140.SH "EXAMPLE PROGRAM"
141.IX Header "EXAMPLE PROGRAM"
142.Vb 1
143\& #include <ev.h>
144.Ve
145.PP
146.Vb 2
147\& ev_io stdin_watcher;
148\& ev_timer timeout_watcher;
149.Ve
150.PP
151.Vb 8
152\& /* called when data readable on stdin */
153\& static void
154\& stdin_cb (EV_P_ struct ev_io *w, int revents)
155\& {
156\& /* puts ("stdin ready"); */
157\& ev_io_stop (EV_A_ w); /* just a syntax example */
158\& ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */
159\& }
160.Ve
161.PP
162.Vb 6
163\& static void
164\& timeout_cb (EV_P_ struct ev_timer *w, int revents)
165\& {
166\& /* puts ("timeout"); */
167\& ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */
168\& }
169.Ve
170.PP
171.Vb 4
172\& int
173\& main (void)
174\& {
175\& struct ev_loop *loop = ev_default_loop (0);
176.Ve
177.PP
178.Vb 3
179\& /* initialise an io watcher, then start it */
180\& ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
181\& ev_io_start (loop, &stdin_watcher);
182.Ve
183.PP
184.Vb 3
185\& /* simple non-repeating 5.5 second timeout */
186\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
187\& ev_timer_start (loop, &timeout_watcher);
188.Ve
189.PP
190.Vb 2
191\& /* loop till timeout or data ready */
192\& ev_loop (loop, 0);
193.Ve
194.PP
195.Vb 2
196\& return 0;
197\& }
198.Ve
140.SH "DESCRIPTION" 199.SH "DESCRIPTION"
141.IX Header "DESCRIPTION" 200.IX Header "DESCRIPTION"
142Libev is an event loop: you register interest in certain events (such as a 201Libev is an event loop: you register interest in certain events (such as a
143file descriptor being readable or a timeout occuring), and it will manage 202file descriptor being readable or a timeout occuring), and it will manage
144these event sources and provide your program with events. 203these event sources and provide your program with events.
151watchers\fR, which are relatively small C structures you initialise with the 210watchers\fR, which are relatively small C structures you initialise with the
152details of the event, and then hand it over to libev by \fIstarting\fR the 211details of the event, and then hand it over to libev by \fIstarting\fR the
153watcher. 212watcher.
154.SH "FEATURES" 213.SH "FEATURES"
155.IX Header "FEATURES" 214.IX Header "FEATURES"
156Libev supports select, poll, the linux-specific epoll and the bsd-specific 215Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the
157kqueue mechanisms for file descriptor events, relative timers, absolute 216BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms
158timers with customised rescheduling, signal events, process status change 217for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface
159events (related to \s-1SIGCHLD\s0), and event watchers dealing with the event 218(for \f(CW\*(C`ev_stat\*(C'\fR), relative timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers
160loop mechanism itself (idle, prepare and check watchers). It also is quite 219with customised rescheduling (\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals
161fast (see this benchmark comparing 220(\f(CW\*(C`ev_signal\*(C'\fR), process status change events (\f(CW\*(C`ev_child\*(C'\fR), and event
162it to libevent for example). 221watchers dealing with the event loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR,
222\&\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
223file watchers (\f(CW\*(C`ev_stat\*(C'\fR) and even limited support for fork events
224(\f(CW\*(C`ev_fork\*(C'\fR).
225.PP
226It also is quite fast (see this
227benchmark comparing it to libevent
228for example).
163.SH "CONVENTIONS" 229.SH "CONVENTIONS"
164.IX Header "CONVENTIONS" 230.IX Header "CONVENTIONS"
165Libev is very configurable. In this manual the default configuration 231Libev is very configurable. In this manual the default configuration will
166will be described, which supports multiple event loops. For more info 232be described, which supports multiple event loops. For more info about
167about various configuration options please have a look at the file 233various configuration options please have a look at \fB\s-1EMBED\s0\fR section in
168\&\fI\s-1README\s0.embed\fR in the libev distribution. If libev was configured without 234this manual. If libev was configured without support for multiple event
169support for multiple event loops, then all functions taking an initial 235loops, then all functions taking an initial argument of name \f(CW\*(C`loop\*(C'\fR
170argument of name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) 236(which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have this argument.
171will not have this argument.
172.SH "TIME REPRESENTATION" 237.SH "TIME REPRESENTATION"
173.IX Header "TIME REPRESENTATION" 238.IX Header "TIME REPRESENTATION"
174Libev represents time as a single floating point number, representing the 239Libev represents time as a single floating point number, representing the
175(fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near 240(fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near
176the beginning of 1970, details are complicated, don't ask). This type is 241the beginning of 1970, details are complicated, don't ask). This type is
201Usually, it's a good idea to terminate if the major versions mismatch, 266Usually, it's a good idea to terminate if the major versions mismatch,
202as this indicates an incompatible change. Minor versions are usually 267as this indicates an incompatible change. Minor versions are usually
203compatible to older versions, so a larger minor version alone is usually 268compatible to older versions, so a larger minor version alone is usually
204not a problem. 269not a problem.
205.Sp 270.Sp
206Example: make sure we haven't accidentally been linked against the wrong 271Example: Make sure we haven't accidentally been linked against the wrong
207version: 272version.
208.Sp 273.Sp
209.Vb 3 274.Vb 3
210\& assert (("libev version mismatch", 275\& assert (("libev version mismatch",
211\& ev_version_major () == EV_VERSION_MAJOR 276\& ev_version_major () == EV_VERSION_MAJOR
212\& && ev_version_minor () >= EV_VERSION_MINOR)); 277\& && ev_version_minor () >= EV_VERSION_MINOR));
242recommended ones. 307recommended ones.
243.Sp 308.Sp
244See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. 309See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
245.IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4 310.IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4
246.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" 311.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))"
247Sets the allocation function to use (the prototype is similar to the 312Sets the allocation function to use (the prototype is similar \- the
248realloc C function, the semantics are identical). It is used to allocate 313semantics is identical \- to the realloc C function). It is used to
249and free memory (no surprises here). If it returns zero when memory 314allocate and free memory (no surprises here). If it returns zero when
250needs to be allocated, the library might abort or take some potentially 315memory needs to be allocated, the library might abort or take some
251destructive action. The default is your system realloc function. 316potentially destructive action. The default is your system realloc
317function.
252.Sp 318.Sp
253You could override this function in high-availability programs to, say, 319You could override this function in high-availability programs to, say,
254free some memory if it cannot allocate memory, to use a special allocator, 320free some memory if it cannot allocate memory, to use a special allocator,
255or even to sleep a while and retry until some memory is available. 321or even to sleep a while and retry until some memory is available.
256.Sp 322.Sp
257Example: replace the libev allocator with one that waits a bit and then 323Example: Replace the libev allocator with one that waits a bit and then
258retries: better than mine). 324retries).
259.Sp 325.Sp
260.Vb 6 326.Vb 6
261\& static void * 327\& static void *
262\& persistent_realloc (void *ptr, long size) 328\& persistent_realloc (void *ptr, size_t size)
263\& { 329\& {
264\& for (;;) 330\& for (;;)
265\& { 331\& {
266\& void *newptr = realloc (ptr, size); 332\& void *newptr = realloc (ptr, size);
267.Ve 333.Ve
289callback is set, then libev will expect it to remedy the sitution, no 355callback is set, then libev will expect it to remedy the sitution, no
290matter what, when it returns. That is, libev will generally retry the 356matter what, when it returns. That is, libev will generally retry the
291requested operation, or, if the condition doesn't go away, do bad stuff 357requested operation, or, if the condition doesn't go away, do bad stuff
292(such as abort). 358(such as abort).
293.Sp 359.Sp
294Example: do the same thing as libev does internally: 360Example: This is basically the same thing that libev does internally, too.
295.Sp 361.Sp
296.Vb 6 362.Vb 6
297\& static void 363\& static void
298\& fatal_error (const char *msg) 364\& fatal_error (const char *msg)
299\& { 365\& {
345or setgid) then libev will \fInot\fR look at the environment variable 411or setgid) then libev will \fInot\fR look at the environment variable
346\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will 412\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will
347override the flags completely if it is found in the environment. This is 413override the flags completely if it is found in the environment. This is
348useful to try out specific backends to test their performance, or to work 414useful to try out specific backends to test their performance, or to work
349around bugs. 415around bugs.
416.ie n .IP """EVFLAG_FORKCHECK""" 4
417.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4
418.IX Item "EVFLAG_FORKCHECK"
419Instead of calling \f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR manually after
420a fork, you can also make libev check for a fork in each iteration by
421enabling this flag.
422.Sp
423This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop,
424and thus this might slow down your event loop if you do a lot of loop
425iterations and little real work, but is usually not noticable (on my
426Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence
427without a syscall and thus \fIvery\fR fast, but my Linux system also has
428\&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster).
429.Sp
430The big advantage of this flag is that you can forget about fork (and
431forget about forgetting to tell libev about forking) when you use this
432flag.
433.Sp
434This flag setting cannot be overriden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR
435environment variable.
350.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 436.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4
351.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 437.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4
352.IX Item "EVBACKEND_SELECT (value 1, portable select backend)" 438.IX Item "EVBACKEND_SELECT (value 1, portable select backend)"
353This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as 439This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as
354libev tries to roll its own fd_set with no limits on the number of fds, 440libev tries to roll its own fd_set with no limits on the number of fds,
448Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is 534Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is
449always distinct from the default loop. Unlike the default loop, it cannot 535always distinct from the default loop. Unlike the default loop, it cannot
450handle signal and child watchers, and attempts to do so will be greeted by 536handle signal and child watchers, and attempts to do so will be greeted by
451undefined behaviour (or a failed assertion if assertions are enabled). 537undefined behaviour (or a failed assertion if assertions are enabled).
452.Sp 538.Sp
453Example: try to create a event loop that uses epoll and nothing else. 539Example: Try to create a event loop that uses epoll and nothing else.
454.Sp 540.Sp
455.Vb 3 541.Vb 3
456\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); 542\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
457\& if (!epoller) 543\& if (!epoller)
458\& fatal ("no epoll found here, maybe it hides under your chair"); 544\& fatal ("no epoll found here, maybe it hides under your chair");
556\& be handled here by queueing them when their watcher gets executed. 642\& be handled here by queueing them when their watcher gets executed.
557\& - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK 643\& - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
558\& were used, return, otherwise continue with step *. 644\& were used, return, otherwise continue with step *.
559.Ve 645.Ve
560.Sp 646.Sp
561Example: queue some jobs and then loop until no events are outsanding 647Example: Queue some jobs and then loop until no events are outsanding
562anymore. 648anymore.
563.Sp 649.Sp
564.Vb 4 650.Vb 4
565\& ... queue jobs here, make sure they register event watchers as long 651\& ... queue jobs here, make sure they register event watchers as long
566\& ... as they still have work to do (even an idle watcher will do..) 652\& ... as they still have work to do (even an idle watcher will do..)
588visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from exiting if 674visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from exiting if
589no event watchers registered by it are active. It is also an excellent 675no event watchers registered by it are active. It is also an excellent
590way to do this for generic recurring timers or from within third-party 676way to do this for generic recurring timers or from within third-party
591libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR. 677libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR.
592.Sp 678.Sp
593Example: create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR 679Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR
594running when nothing else is active. 680running when nothing else is active.
595.Sp 681.Sp
596.Vb 4 682.Vb 4
597\& struct dv_signal exitsig; 683\& struct ev_signal exitsig;
598\& ev_signal_init (&exitsig, sig_cb, SIGINT); 684\& ev_signal_init (&exitsig, sig_cb, SIGINT);
599\& ev_signal_start (myloop, &exitsig); 685\& ev_signal_start (loop, &exitsig);
600\& evf_unref (myloop); 686\& evf_unref (loop);
601.Ve 687.Ve
602.Sp 688.Sp
603Example: for some weird reason, unregister the above signal handler again. 689Example: For some weird reason, unregister the above signal handler again.
604.Sp 690.Sp
605.Vb 2 691.Vb 2
606\& ev_ref (myloop); 692\& ev_ref (loop);
607\& ev_signal_stop (myloop, &exitsig); 693\& ev_signal_stop (loop, &exitsig);
608.Ve 694.Ve
609.SH "ANATOMY OF A WATCHER" 695.SH "ANATOMY OF A WATCHER"
610.IX Header "ANATOMY OF A WATCHER" 696.IX Header "ANATOMY OF A WATCHER"
611A watcher is a structure that you create and register to record your 697A watcher is a structure that you create and register to record your
612interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to 698interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to
684The signal specified in the \f(CW\*(C`ev_signal\*(C'\fR watcher has been received by a thread. 770The signal specified in the \f(CW\*(C`ev_signal\*(C'\fR watcher has been received by a thread.
685.ie n .IP """EV_CHILD""" 4 771.ie n .IP """EV_CHILD""" 4
686.el .IP "\f(CWEV_CHILD\fR" 4 772.el .IP "\f(CWEV_CHILD\fR" 4
687.IX Item "EV_CHILD" 773.IX Item "EV_CHILD"
688The pid specified in the \f(CW\*(C`ev_child\*(C'\fR watcher has received a status change. 774The pid specified in the \f(CW\*(C`ev_child\*(C'\fR watcher has received a status change.
775.ie n .IP """EV_STAT""" 4
776.el .IP "\f(CWEV_STAT\fR" 4
777.IX Item "EV_STAT"
778The path specified in the \f(CW\*(C`ev_stat\*(C'\fR watcher changed its attributes somehow.
689.ie n .IP """EV_IDLE""" 4 779.ie n .IP """EV_IDLE""" 4
690.el .IP "\f(CWEV_IDLE\fR" 4 780.el .IP "\f(CWEV_IDLE\fR" 4
691.IX Item "EV_IDLE" 781.IX Item "EV_IDLE"
692The \f(CW\*(C`ev_idle\*(C'\fR watcher has determined that you have nothing better to do. 782The \f(CW\*(C`ev_idle\*(C'\fR watcher has determined that you have nothing better to do.
693.ie n .IP """EV_PREPARE""" 4 783.ie n .IP """EV_PREPARE""" 4
703\&\f(CW\*(C`ev_loop\*(C'\fR has gathered them, but before it invokes any callbacks for any 793\&\f(CW\*(C`ev_loop\*(C'\fR has gathered them, but before it invokes any callbacks for any
704received events. Callbacks of both watcher types can start and stop as 794received events. Callbacks of both watcher types can start and stop as
705many watchers as they want, and all of them will be taken into account 795many watchers as they want, and all of them will be taken into account
706(for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep 796(for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep
707\&\f(CW\*(C`ev_loop\*(C'\fR from blocking). 797\&\f(CW\*(C`ev_loop\*(C'\fR from blocking).
798.ie n .IP """EV_EMBED""" 4
799.el .IP "\f(CWEV_EMBED\fR" 4
800.IX Item "EV_EMBED"
801The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention.
802.ie n .IP """EV_FORK""" 4
803.el .IP "\f(CWEV_FORK\fR" 4
804.IX Item "EV_FORK"
805The event loop has been resumed in the child process after fork (see
806\&\f(CW\*(C`ev_fork\*(C'\fR).
708.ie n .IP """EV_ERROR""" 4 807.ie n .IP """EV_ERROR""" 4
709.el .IP "\f(CWEV_ERROR\fR" 4 808.el .IP "\f(CWEV_ERROR\fR" 4
710.IX Item "EV_ERROR" 809.IX Item "EV_ERROR"
711An unspecified error has occured, the watcher has been stopped. This might 810An unspecified error has occured, the watcher has been stopped. This might
712happen because the watcher could not be properly started because libev 811happen because the watcher could not be properly started because libev
779Returns a true value iff the watcher is pending, (i.e. it has outstanding 878Returns a true value iff the watcher is pending, (i.e. it has outstanding
780events but its callback has not yet been invoked). As long as a watcher 879events but its callback has not yet been invoked). As long as a watcher
781is pending (but not active) you must not call an init function on it (but 880is pending (but not active) you must not call an init function on it (but
782\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe) and you must make sure the watcher is available to 881\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe) and you must make sure the watcher is available to
783libev (e.g. you cnanot \f(CW\*(C`free ()\*(C'\fR it). 882libev (e.g. you cnanot \f(CW\*(C`free ()\*(C'\fR it).
784.IP "callback = ev_cb (ev_TYPE *watcher)" 4 883.IP "callback ev_cb (ev_TYPE *watcher)" 4
785.IX Item "callback = ev_cb (ev_TYPE *watcher)" 884.IX Item "callback ev_cb (ev_TYPE *watcher)"
786Returns the callback currently set on the watcher. 885Returns the callback currently set on the watcher.
787.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 886.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4
788.IX Item "ev_cb_set (ev_TYPE *watcher, callback)" 887.IX Item "ev_cb_set (ev_TYPE *watcher, callback)"
789Change the callback. You can change the callback at virtually any time 888Change the callback. You can change the callback at virtually any time
790(modulo threads). 889(modulo threads).
816\& struct my_io *w = (struct my_io *)w_; 915\& struct my_io *w = (struct my_io *)w_;
817\& ... 916\& ...
818\& } 917\& }
819.Ve 918.Ve
820.PP 919.PP
821More interesting and less C\-conformant ways of catsing your callback type 920More interesting and less C\-conformant ways of casting your callback type
822have been omitted.... 921instead have been omitted.
922.PP
923Another common scenario is having some data structure with multiple
924watchers:
925.PP
926.Vb 6
927\& struct my_biggy
928\& {
929\& int some_data;
930\& ev_timer t1;
931\& ev_timer t2;
932\& }
933.Ve
934.PP
935In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more complicated,
936you need to use \f(CW\*(C`offsetof\*(C'\fR:
937.PP
938.Vb 1
939\& #include <stddef.h>
940.Ve
941.PP
942.Vb 6
943\& static void
944\& t1_cb (EV_P_ struct ev_timer *w, int revents)
945\& {
946\& struct my_biggy big = (struct my_biggy *
947\& (((char *)w) - offsetof (struct my_biggy, t1));
948\& }
949.Ve
950.PP
951.Vb 6
952\& static void
953\& t2_cb (EV_P_ struct ev_timer *w, int revents)
954\& {
955\& struct my_biggy big = (struct my_biggy *
956\& (((char *)w) - offsetof (struct my_biggy, t2));
957\& }
958.Ve
823.SH "WATCHER TYPES" 959.SH "WATCHER TYPES"
824.IX Header "WATCHER TYPES" 960.IX Header "WATCHER TYPES"
825This section describes each watcher in detail, but will not repeat 961This section describes each watcher in detail, but will not repeat
826information given in the last section. 962information given in the last section. Any initialisation/set macros,
963functions and members specific to the watcher type are explained.
964.PP
965Members are additionally marked with either \fI[read\-only]\fR, meaning that,
966while the watcher is active, you can look at the member and expect some
967sensible content, but you must not modify it (you can modify it while the
968watcher is stopped to your hearts content), or \fI[read\-write]\fR, which
969means you can expect it to have some sensible content while the watcher
970is active, but you can also modify it. Modifying it may not do something
971sensible or take immediate effect (or do anything at all), but libev will
972not crash or malfunction in any way.
827.ie n .Sh """ev_io"" \- is this file descriptor readable or writable?" 973.ie n .Sh """ev_io"" \- is this file descriptor readable or writable?"
828.el .Sh "\f(CWev_io\fP \- is this file descriptor readable or writable?" 974.el .Sh "\f(CWev_io\fP \- is this file descriptor readable or writable?"
829.IX Subsection "ev_io - is this file descriptor readable or writable?" 975.IX Subsection "ev_io - is this file descriptor readable or writable?"
830I/O watchers check whether a file descriptor is readable or writable 976I/O watchers check whether a file descriptor is readable or writable
831in each iteration of the event loop, or, more precisely, when reading 977in each iteration of the event loop, or, more precisely, when reading
871.IX Item "ev_io_set (ev_io *, int fd, int events)" 1017.IX Item "ev_io_set (ev_io *, int fd, int events)"
872.PD 1018.PD
873Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to 1019Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to
874rceeive events for and events is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or 1020rceeive events for and events is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or
875\&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR to receive the given events. 1021\&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR to receive the given events.
1022.IP "int fd [read\-only]" 4
1023.IX Item "int fd [read-only]"
1024The file descriptor being watched.
1025.IP "int events [read\-only]" 4
1026.IX Item "int events [read-only]"
1027The events being watched.
876.PP 1028.PP
877Example: call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well 1029Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well
878readable, but only once. Since it is likely line\-buffered, you could 1030readable, but only once. Since it is likely line\-buffered, you could
879attempt to read a whole line in the callback: 1031attempt to read a whole line in the callback.
880.PP 1032.PP
881.Vb 6 1033.Vb 6
882\& static void 1034\& static void
883\& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1035\& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)
884\& { 1036\& {
939.IP "ev_timer_again (loop)" 4 1091.IP "ev_timer_again (loop)" 4
940.IX Item "ev_timer_again (loop)" 1092.IX Item "ev_timer_again (loop)"
941This will act as if the timer timed out and restart it again if it is 1093This will act as if the timer timed out and restart it again if it is
942repeating. The exact semantics are: 1094repeating. The exact semantics are:
943.Sp 1095.Sp
1096If the timer is pending, its pending status is cleared.
1097.Sp
944If the timer is started but nonrepeating, stop it. 1098If the timer is started but nonrepeating, stop it (as if it timed out).
945.Sp 1099.Sp
946If the timer is repeating, either start it if necessary (with the repeat 1100If the timer is repeating, either start it if necessary (with the
947value), or reset the running timer to the repeat value. 1101\&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value.
948.Sp 1102.Sp
949This sounds a bit complicated, but here is a useful and typical 1103This sounds a bit complicated, but here is a useful and typical
950example: Imagine you have a tcp connection and you want a so-called idle 1104example: Imagine you have a tcp connection and you want a so-called idle
951timeout, that is, you want to be called when there have been, say, 60 1105timeout, that is, you want to be called when there have been, say, 60
952seconds of inactivity on the socket. The easiest way to do this is to 1106seconds of inactivity on the socket. The easiest way to do this is to
953configure an \f(CW\*(C`ev_timer\*(C'\fR with after=repeat=60 and calling ev_timer_again each 1107configure an \f(CW\*(C`ev_timer\*(C'\fR with a \f(CW\*(C`repeat\*(C'\fR value of \f(CW60\fR and then call
954time you successfully read or write some data. If you go into an idle 1108\&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If
955state where you do not expect data to travel on the socket, you can stop 1109you go into an idle state where you do not expect data to travel on the
956the timer, and again will automatically restart it if need be. 1110socket, you can \f(CW\*(C`ev_timer_stop\*(C'\fR the timer, and \f(CW\*(C`ev_timer_again\*(C'\fR will
1111automatically restart it if need be.
1112.Sp
1113That means you can ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR
1114altogether and only ever use the \f(CW\*(C`repeat\*(C'\fR value and \f(CW\*(C`ev_timer_again\*(C'\fR:
1115.Sp
1116.Vb 8
1117\& ev_timer_init (timer, callback, 0., 5.);
1118\& ev_timer_again (loop, timer);
1119\& ...
1120\& timer->again = 17.;
1121\& ev_timer_again (loop, timer);
1122\& ...
1123\& timer->again = 10.;
1124\& ev_timer_again (loop, timer);
1125.Ve
1126.Sp
1127This is more slightly efficient then stopping/starting the timer each time
1128you want to modify its timeout value.
1129.IP "ev_tstamp repeat [read\-write]" 4
1130.IX Item "ev_tstamp repeat [read-write]"
1131The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out
1132or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any),
1133which is also when any modifications are taken into account.
957.PP 1134.PP
958Example: create a timer that fires after 60 seconds. 1135Example: Create a timer that fires after 60 seconds.
959.PP 1136.PP
960.Vb 5 1137.Vb 5
961\& static void 1138\& static void
962\& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1139\& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
963\& { 1140\& {
969\& struct ev_timer mytimer; 1146\& struct ev_timer mytimer;
970\& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); 1147\& ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
971\& ev_timer_start (loop, &mytimer); 1148\& ev_timer_start (loop, &mytimer);
972.Ve 1149.Ve
973.PP 1150.PP
974Example: create a timeout timer that times out after 10 seconds of 1151Example: Create a timeout timer that times out after 10 seconds of
975inactivity. 1152inactivity.
976.PP 1153.PP
977.Vb 5 1154.Vb 5
978\& static void 1155\& static void
979\& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1156\& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
1093.IX Item "ev_periodic_again (loop, ev_periodic *)" 1270.IX Item "ev_periodic_again (loop, ev_periodic *)"
1094Simply stops and restarts the periodic watcher again. This is only useful 1271Simply stops and restarts the periodic watcher again. This is only useful
1095when you changed some parameters or the reschedule callback would return 1272when you changed some parameters or the reschedule callback would return
1096a different time than the last time it was called (e.g. in a crond like 1273a different time than the last time it was called (e.g. in a crond like
1097program when the crontabs have changed). 1274program when the crontabs have changed).
1275.IP "ev_tstamp interval [read\-write]" 4
1276.IX Item "ev_tstamp interval [read-write]"
1277The current interval value. Can be modified any time, but changes only
1278take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being
1279called.
1280.IP "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read\-write]" 4
1281.IX Item "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]"
1282The current reschedule callback, or \f(CW0\fR, if this functionality is
1283switched off. Can be changed any time, but changes only take effect when
1284the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called.
1098.PP 1285.PP
1099Example: call a callback every hour, or, more precisely, whenever the 1286Example: Call a callback every hour, or, more precisely, whenever the
1100system clock is divisible by 3600. The callback invocation times have 1287system clock is divisible by 3600. The callback invocation times have
1101potentially a lot of jittering, but good long-term stability. 1288potentially a lot of jittering, but good long-term stability.
1102.PP 1289.PP
1103.Vb 5 1290.Vb 5
1104\& static void 1291\& static void
1112\& struct ev_periodic hourly_tick; 1299\& struct ev_periodic hourly_tick;
1113\& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); 1300\& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1114\& ev_periodic_start (loop, &hourly_tick); 1301\& ev_periodic_start (loop, &hourly_tick);
1115.Ve 1302.Ve
1116.PP 1303.PP
1117Example: the same as above, but use a reschedule callback to do it: 1304Example: The same as above, but use a reschedule callback to do it:
1118.PP 1305.PP
1119.Vb 1 1306.Vb 1
1120\& #include <math.h> 1307\& #include <math.h>
1121.Ve 1308.Ve
1122.PP 1309.PP
1130.PP 1317.PP
1131.Vb 1 1318.Vb 1
1132\& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); 1319\& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1133.Ve 1320.Ve
1134.PP 1321.PP
1135Example: call a callback every hour, starting now: 1322Example: Call a callback every hour, starting now:
1136.PP 1323.PP
1137.Vb 4 1324.Vb 4
1138\& struct ev_periodic hourly_tick; 1325\& struct ev_periodic hourly_tick;
1139\& ev_periodic_init (&hourly_tick, clock_cb, 1326\& ev_periodic_init (&hourly_tick, clock_cb,
1140\& fmod (ev_now (loop), 3600.), 3600., 0); 1327\& fmod (ev_now (loop), 3600.), 3600., 0);
1160.IP "ev_signal_set (ev_signal *, int signum)" 4 1347.IP "ev_signal_set (ev_signal *, int signum)" 4
1161.IX Item "ev_signal_set (ev_signal *, int signum)" 1348.IX Item "ev_signal_set (ev_signal *, int signum)"
1162.PD 1349.PD
1163Configures the watcher to trigger on the given signal number (usually one 1350Configures the watcher to trigger on the given signal number (usually one
1164of the \f(CW\*(C`SIGxxx\*(C'\fR constants). 1351of the \f(CW\*(C`SIGxxx\*(C'\fR constants).
1352.IP "int signum [read\-only]" 4
1353.IX Item "int signum [read-only]"
1354The signal the watcher watches out for.
1165.ie n .Sh """ev_child"" \- watch out for process status changes" 1355.ie n .Sh """ev_child"" \- watch out for process status changes"
1166.el .Sh "\f(CWev_child\fP \- watch out for process status changes" 1356.el .Sh "\f(CWev_child\fP \- watch out for process status changes"
1167.IX Subsection "ev_child - watch out for process status changes" 1357.IX Subsection "ev_child - watch out for process status changes"
1168Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to 1358Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to
1169some child status changes (most typically when a child of yours dies). 1359some child status changes (most typically when a child of yours dies).
1177\&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look 1367\&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look
1178at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see 1368at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see
1179the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems 1369the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems
1180\&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the 1370\&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the
1181process causing the status change. 1371process causing the status change.
1372.IP "int pid [read\-only]" 4
1373.IX Item "int pid [read-only]"
1374The process id this watcher watches out for, or \f(CW0\fR, meaning any process id.
1375.IP "int rpid [read\-write]" 4
1376.IX Item "int rpid [read-write]"
1377The process id that detected a status change.
1378.IP "int rstatus [read\-write]" 4
1379.IX Item "int rstatus [read-write]"
1380The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems
1381\&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details).
1182.PP 1382.PP
1183Example: try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0. 1383Example: Try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0.
1184.PP 1384.PP
1185.Vb 5 1385.Vb 5
1186\& static void 1386\& static void
1187\& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) 1387\& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1188\& { 1388\& {
1192.PP 1392.PP
1193.Vb 3 1393.Vb 3
1194\& struct ev_signal signal_watcher; 1394\& struct ev_signal signal_watcher;
1195\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT); 1395\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1196\& ev_signal_start (loop, &sigint_cb); 1396\& ev_signal_start (loop, &sigint_cb);
1397.Ve
1398.ie n .Sh """ev_stat"" \- did the file attributes just change?"
1399.el .Sh "\f(CWev_stat\fP \- did the file attributes just change?"
1400.IX Subsection "ev_stat - did the file attributes just change?"
1401This watches a filesystem path for attribute changes. That is, it calls
1402\&\f(CW\*(C`stat\*(C'\fR regularly (or when the \s-1OS\s0 says it changed) and sees if it changed
1403compared to the last time, invoking the callback if it did.
1404.PP
1405The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does
1406not exist\*(R" is a status change like any other. The condition \*(L"path does
1407not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is
1408otherwise always forced to be at least one) and all the other fields of
1409the stat buffer having unspecified contents.
1410.PP
1411The path \fIshould\fR be absolute and \fImust not\fR end in a slash. If it is
1412relative and your working directory changes, the behaviour is undefined.
1413.PP
1414Since there is no standard to do this, the portable implementation simply
1415calls \f(CW\*(C`stat (2)\*(C'\fR regularly on the path to see if it changed somehow. You
1416can specify a recommended polling interval for this case. If you specify
1417a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable,
1418unspecified default\fR value will be used (which you can expect to be around
1419five seconds, although this might change dynamically). Libev will also
1420impose a minimum interval which is currently around \f(CW0.1\fR, but thats
1421usually overkill.
1422.PP
1423This watcher type is not meant for massive numbers of stat watchers,
1424as even with OS-supported change notifications, this can be
1425resource\-intensive.
1426.PP
1427At the time of this writing, only the Linux inotify interface is
1428implemented (implementing kqueue support is left as an exercise for the
1429reader). Inotify will be used to give hints only and should not change the
1430semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs
1431to fall back to regular polling again even with inotify, but changes are
1432usually detected immediately, and if the file exists there will be no
1433polling.
1434.IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4
1435.IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)"
1436.PD 0
1437.IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4
1438.IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)"
1439.PD
1440Configures the watcher to wait for status changes of the given
1441\&\f(CW\*(C`path\*(C'\fR. The \f(CW\*(C`interval\*(C'\fR is a hint on how quickly a change is expected to
1442be detected and should normally be specified as \f(CW0\fR to let libev choose
1443a suitable value. The memory pointed to by \f(CW\*(C`path\*(C'\fR must point to the same
1444path for as long as the watcher is active.
1445.Sp
1446The callback will be receive \f(CW\*(C`EV_STAT\*(C'\fR when a change was detected,
1447relative to the attributes at the time the watcher was started (or the
1448last change was detected).
1449.IP "ev_stat_stat (ev_stat *)" 4
1450.IX Item "ev_stat_stat (ev_stat *)"
1451Updates the stat buffer immediately with new values. If you change the
1452watched path in your callback, you could call this fucntion to avoid
1453detecting this change (while introducing a race condition). Can also be
1454useful simply to find out the new values.
1455.IP "ev_statdata attr [read\-only]" 4
1456.IX Item "ev_statdata attr [read-only]"
1457The most-recently detected attributes of the file. Although the type is of
1458\&\f(CW\*(C`ev_statdata\*(C'\fR, this is usually the (or one of the) \f(CW\*(C`struct stat\*(C'\fR types
1459suitable for your system. If the \f(CW\*(C`st_nlink\*(C'\fR member is \f(CW0\fR, then there
1460was some error while \f(CW\*(C`stat\*(C'\fRing the file.
1461.IP "ev_statdata prev [read\-only]" 4
1462.IX Item "ev_statdata prev [read-only]"
1463The previous attributes of the file. The callback gets invoked whenever
1464\&\f(CW\*(C`prev\*(C'\fR != \f(CW\*(C`attr\*(C'\fR.
1465.IP "ev_tstamp interval [read\-only]" 4
1466.IX Item "ev_tstamp interval [read-only]"
1467The specified interval.
1468.IP "const char *path [read\-only]" 4
1469.IX Item "const char *path [read-only]"
1470The filesystem path that is being watched.
1471.PP
1472Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes.
1473.PP
1474.Vb 15
1475\& static void
1476\& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1477\& {
1478\& /* /etc/passwd changed in some way */
1479\& if (w->attr.st_nlink)
1480\& {
1481\& printf ("passwd current size %ld\en", (long)w->attr.st_size);
1482\& printf ("passwd current atime %ld\en", (long)w->attr.st_mtime);
1483\& printf ("passwd current mtime %ld\en", (long)w->attr.st_mtime);
1484\& }
1485\& else
1486\& /* you shalt not abuse printf for puts */
1487\& puts ("wow, /etc/passwd is not there, expect problems. "
1488\& "if this is windows, they already arrived\en");
1489\& }
1490.Ve
1491.PP
1492.Vb 2
1493\& ...
1494\& ev_stat passwd;
1495.Ve
1496.PP
1497.Vb 2
1498\& ev_stat_init (&passwd, passwd_cb, "/etc/passwd");
1499\& ev_stat_start (loop, &passwd);
1197.Ve 1500.Ve
1198.ie n .Sh """ev_idle"" \- when you've got nothing better to do..." 1501.ie n .Sh """ev_idle"" \- when you've got nothing better to do..."
1199.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." 1502.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..."
1200.IX Subsection "ev_idle - when you've got nothing better to do..." 1503.IX Subsection "ev_idle - when you've got nothing better to do..."
1201Idle watchers trigger events when there are no other events are pending 1504Idle watchers trigger events when there are no other events are pending
1217.IX Item "ev_idle_init (ev_signal *, callback)" 1520.IX Item "ev_idle_init (ev_signal *, callback)"
1218Initialises and configures the idle watcher \- it has no parameters of any 1521Initialises and configures the idle watcher \- it has no parameters of any
1219kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, 1522kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless,
1220believe me. 1523believe me.
1221.PP 1524.PP
1222Example: dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR, start it, and in the 1525Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the
1223callback, free it. Alos, use no error checking, as usual. 1526callback, free it. Also, use no error checking, as usual.
1224.PP 1527.PP
1225.Vb 7 1528.Vb 7
1226\& static void 1529\& static void
1227\& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) 1530\& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1228\& { 1531\& {
1242.IX Subsection "ev_prepare and ev_check - customise your event loop!" 1545.IX Subsection "ev_prepare and ev_check - customise your event loop!"
1243Prepare and check watchers are usually (but not always) used in tandem: 1546Prepare and check watchers are usually (but not always) used in tandem:
1244prepare watchers get invoked before the process blocks and check watchers 1547prepare watchers get invoked before the process blocks and check watchers
1245afterwards. 1548afterwards.
1246.PP 1549.PP
1550You \fImust not\fR call \f(CW\*(C`ev_loop\*(C'\fR or similar functions that enter
1551the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR
1552watchers. Other loops than the current one are fine, however. The
1553rationale behind this is that you do not need to check for recursion in
1554those watchers, i.e. the sequence will always be \f(CW\*(C`ev_prepare\*(C'\fR, blocking,
1555\&\f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each kind they will always be
1556called in pairs bracketing the blocking call.
1557.PP
1247Their main purpose is to integrate other event mechanisms into libev and 1558Their main purpose is to integrate other event mechanisms into libev and
1248their use is somewhat advanced. This could be used, for example, to track 1559their use is somewhat advanced. This could be used, for example, to track
1249variable changes, implement your own watchers, integrate net-snmp or a 1560variable changes, implement your own watchers, integrate net-snmp or a
1250coroutine library and lots more. 1561coroutine library and lots more. They are also occasionally useful if
1562you cache some data and want to flush it before blocking (for example,
1563in X programs you might want to do an \f(CW\*(C`XFlush ()\*(C'\fR in an \f(CW\*(C`ev_prepare\*(C'\fR
1564watcher).
1251.PP 1565.PP
1252This is done by examining in each prepare call which file descriptors need 1566This is done by examining in each prepare call which file descriptors need
1253to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers for 1567to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers for
1254them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many libraries 1568them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many libraries
1255provide just this functionality). Then, in the check watcher you check for 1569provide just this functionality). Then, in the check watcher you check for
1274.PD 1588.PD
1275Initialises and configures the prepare or check watcher \- they have no 1589Initialises and configures the prepare or check watcher \- they have no
1276parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR 1590parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR
1277macros, but using them is utterly, utterly and completely pointless. 1591macros, but using them is utterly, utterly and completely pointless.
1278.PP 1592.PP
1279Example: *TODO*. 1593Example: To include a library such as adns, you would add \s-1IO\s0 watchers
1594and a timeout watcher in a prepare handler, as required by libadns, and
1595in a check watcher, destroy them and call into libadns. What follows is
1596pseudo-code only of course:
1597.PP
1598.Vb 2
1599\& static ev_io iow [nfd];
1600\& static ev_timer tw;
1601.Ve
1602.PP
1603.Vb 9
1604\& static void
1605\& io_cb (ev_loop *loop, ev_io *w, int revents)
1606\& {
1607\& // set the relevant poll flags
1608\& // could also call adns_processreadable etc. here
1609\& struct pollfd *fd = (struct pollfd *)w->data;
1610\& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1611\& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1612\& }
1613.Ve
1614.PP
1615.Vb 7
1616\& // create io watchers for each fd and a timer before blocking
1617\& static void
1618\& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
1619\& {
1620\& int timeout = 3600000;truct pollfd fds [nfd];
1621\& // actual code will need to loop here and realloc etc.
1622\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1623.Ve
1624.PP
1625.Vb 3
1626\& /* the callback is illegal, but won't be called as we stop during check */
1627\& ev_timer_init (&tw, 0, timeout * 1e-3);
1628\& ev_timer_start (loop, &tw);
1629.Ve
1630.PP
1631.Vb 6
1632\& // create on ev_io per pollfd
1633\& for (int i = 0; i < nfd; ++i)
1634\& {
1635\& ev_io_init (iow + i, io_cb, fds [i].fd,
1636\& ((fds [i].events & POLLIN ? EV_READ : 0)
1637\& | (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1638.Ve
1639.PP
1640.Vb 5
1641\& fds [i].revents = 0;
1642\& iow [i].data = fds + i;
1643\& ev_io_start (loop, iow + i);
1644\& }
1645\& }
1646.Ve
1647.PP
1648.Vb 5
1649\& // stop all watchers after blocking
1650\& static void
1651\& adns_check_cb (ev_loop *loop, ev_check *w, int revents)
1652\& {
1653\& ev_timer_stop (loop, &tw);
1654.Ve
1655.PP
1656.Vb 2
1657\& for (int i = 0; i < nfd; ++i)
1658\& ev_io_stop (loop, iow + i);
1659.Ve
1660.PP
1661.Vb 2
1662\& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
1663\& }
1664.Ve
1280.ie n .Sh """ev_embed"" \- when one backend isn't enough..." 1665.ie n .Sh """ev_embed"" \- when one backend isn't enough..."
1281.el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." 1666.el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..."
1282.IX Subsection "ev_embed - when one backend isn't enough..." 1667.IX Subsection "ev_embed - when one backend isn't enough..."
1283This is a rather advanced watcher type that lets you embed one event loop 1668This is a rather advanced watcher type that lets you embed one event loop
1284into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded 1669into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded
1367.IP "ev_embed_sweep (loop, ev_embed *)" 4 1752.IP "ev_embed_sweep (loop, ev_embed *)" 4
1368.IX Item "ev_embed_sweep (loop, ev_embed *)" 1753.IX Item "ev_embed_sweep (loop, ev_embed *)"
1369Make a single, non-blocking sweep over the embedded loop. This works 1754Make a single, non-blocking sweep over the embedded loop. This works
1370similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most 1755similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most
1371apropriate way for embedded loops. 1756apropriate way for embedded loops.
1757.IP "struct ev_loop *loop [read\-only]" 4
1758.IX Item "struct ev_loop *loop [read-only]"
1759The embedded event loop.
1760.ie n .Sh """ev_fork"" \- the audacity to resume the event loop after a fork"
1761.el .Sh "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork"
1762.IX Subsection "ev_fork - the audacity to resume the event loop after a fork"
1763Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because
1764whoever is a good citizen cared to tell libev about it by calling
1765\&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the
1766event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called,
1767and only in the child after the fork. If whoever good citizen calling
1768\&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork
1769handlers will be invoked, too, of course.
1770.IP "ev_fork_init (ev_signal *, callback)" 4
1771.IX Item "ev_fork_init (ev_signal *, callback)"
1772Initialises and configures the fork watcher \- it has no parameters of any
1773kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless,
1774believe me.
1372.SH "OTHER FUNCTIONS" 1775.SH "OTHER FUNCTIONS"
1373.IX Header "OTHER FUNCTIONS" 1776.IX Header "OTHER FUNCTIONS"
1374There are some other functions of possible interest. Described. Here. Now. 1777There are some other functions of possible interest. Described. Here. Now.
1375.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 1778.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4
1376.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 1779.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)"
1515\&\f(CW\*(C`ev_TYPE_again\*(C'\fR function. 1918\&\f(CW\*(C`ev_TYPE_again\*(C'\fR function.
1516.ie n .IP "w\->sweep () ""ev::embed"" only" 4 1919.ie n .IP "w\->sweep () ""ev::embed"" only" 4
1517.el .IP "w\->sweep () \f(CWev::embed\fR only" 4 1920.el .IP "w\->sweep () \f(CWev::embed\fR only" 4
1518.IX Item "w->sweep () ev::embed only" 1921.IX Item "w->sweep () ev::embed only"
1519Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR. 1922Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR.
1923.ie n .IP "w\->update () ""ev::stat"" only" 4
1924.el .IP "w\->update () \f(CWev::stat\fR only" 4
1925.IX Item "w->update () ev::stat only"
1926Invokes \f(CW\*(C`ev_stat_stat\*(C'\fR.
1520.RE 1927.RE
1521.RS 4 1928.RS 4
1522.RE 1929.RE
1523.PP 1930.PP
1524Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in 1931Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in
1541\& : io (this, &myclass::io_cb), 1948\& : io (this, &myclass::io_cb),
1542\& idle (this, &myclass::idle_cb) 1949\& idle (this, &myclass::idle_cb)
1543\& { 1950\& {
1544\& io.start (fd, ev::READ); 1951\& io.start (fd, ev::READ);
1545\& } 1952\& }
1953.Ve
1954.SH "MACRO MAGIC"
1955.IX Header "MACRO MAGIC"
1956Libev can be compiled with a variety of options, the most fundemantal is
1957\&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines wether (most) functions and
1958callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument.
1959.PP
1960To make it easier to write programs that cope with either variant, the
1961following macros are defined:
1962.ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4
1963.el .IP "\f(CWEV_A\fR, \f(CWEV_A_\fR" 4
1964.IX Item "EV_A, EV_A_"
1965This provides the loop \fIargument\fR for functions, if one is required (\*(L"ev
1966loop argument\*(R"). The \f(CW\*(C`EV_A\*(C'\fR form is used when this is the sole argument,
1967\&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example:
1968.Sp
1969.Vb 3
1970\& ev_unref (EV_A);
1971\& ev_timer_add (EV_A_ watcher);
1972\& ev_loop (EV_A_ 0);
1973.Ve
1974.Sp
1975It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope,
1976which is often provided by the following macro.
1977.ie n .IP """EV_P""\fR, \f(CW""EV_P_""" 4
1978.el .IP "\f(CWEV_P\fR, \f(CWEV_P_\fR" 4
1979.IX Item "EV_P, EV_P_"
1980This provides the loop \fIparameter\fR for functions, if one is required (\*(L"ev
1981loop parameter\*(R"). The \f(CW\*(C`EV_P\*(C'\fR form is used when this is the sole parameter,
1982\&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example:
1983.Sp
1984.Vb 2
1985\& // this is how ev_unref is being declared
1986\& static void ev_unref (EV_P);
1987.Ve
1988.Sp
1989.Vb 2
1990\& // this is how you can declare your typical callback
1991\& static void cb (EV_P_ ev_timer *w, int revents)
1992.Ve
1993.Sp
1994It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite
1995suitable for use with \f(CW\*(C`EV_A\*(C'\fR.
1996.ie n .IP """EV_DEFAULT""\fR, \f(CW""EV_DEFAULT_""" 4
1997.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4
1998.IX Item "EV_DEFAULT, EV_DEFAULT_"
1999Similar to the other two macros, this gives you the value of the default
2000loop, if multiple loops are supported (\*(L"ev loop default\*(R").
2001.PP
2002Example: Declare and initialise a check watcher, working regardless of
2003wether multiple loops are supported or not.
2004.PP
2005.Vb 5
2006\& static void
2007\& check_cb (EV_P_ ev_timer *w, int revents)
2008\& {
2009\& ev_check_stop (EV_A_ w);
2010\& }
2011.Ve
2012.PP
2013.Vb 4
2014\& ev_check check;
2015\& ev_check_init (&check, check_cb);
2016\& ev_check_start (EV_DEFAULT_ &check);
2017\& ev_loop (EV_DEFAULT_ 0);
1546.Ve 2018.Ve
1547.SH "EMBEDDING" 2019.SH "EMBEDDING"
1548.IX Header "EMBEDDING" 2020.IX Header "EMBEDDING"
1549Libev can (and often is) directly embedded into host 2021Libev can (and often is) directly embedded into host
1550applications. Examples of applications that embed it include the Deliantra 2022applications. Examples of applications that embed it include the Deliantra
1730otherwise another method will be used as fallback. This is the preferred 2202otherwise another method will be used as fallback. This is the preferred
1731backend for Solaris 10 systems. 2203backend for Solaris 10 systems.
1732.IP "\s-1EV_USE_DEVPOLL\s0" 4 2204.IP "\s-1EV_USE_DEVPOLL\s0" 4
1733.IX Item "EV_USE_DEVPOLL" 2205.IX Item "EV_USE_DEVPOLL"
1734reserved for future expansion, works like the \s-1USE\s0 symbols above. 2206reserved for future expansion, works like the \s-1USE\s0 symbols above.
2207.IP "\s-1EV_USE_INOTIFY\s0" 4
2208.IX Item "EV_USE_INOTIFY"
2209If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify
2210interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will
2211be detected at runtime.
1735.IP "\s-1EV_H\s0" 4 2212.IP "\s-1EV_H\s0" 4
1736.IX Item "EV_H" 2213.IX Item "EV_H"
1737The name of the \fIev.h\fR header file used to include it. The default if 2214The name of the \fIev.h\fR header file used to include it. The default if
1738undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This 2215undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This
1739can be used to virtually rename the \fIev.h\fR header file in case of conflicts. 2216can be used to virtually rename the \fIev.h\fR header file in case of conflicts.
1757If undefined or defined to \f(CW1\fR, then all event-loop-specific functions 2234If undefined or defined to \f(CW1\fR, then all event-loop-specific functions
1758will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create 2235will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create
1759additional independent event loops. Otherwise there will be no support 2236additional independent event loops. Otherwise there will be no support
1760for multiple event loops and there is no first event loop pointer 2237for multiple event loops and there is no first event loop pointer
1761argument. Instead, all functions act on the single default loop. 2238argument. Instead, all functions act on the single default loop.
1762.IP "\s-1EV_PERIODICS\s0" 4 2239.IP "\s-1EV_PERIODIC_ENABLE\s0" 4
1763.IX Item "EV_PERIODICS" 2240.IX Item "EV_PERIODIC_ENABLE"
1764If undefined or defined to be \f(CW1\fR, then periodic timers are supported, 2241If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If
1765otherwise not. This saves a few kb of code. 2242defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of
2243code.
2244.IP "\s-1EV_EMBED_ENABLE\s0" 4
2245.IX Item "EV_EMBED_ENABLE"
2246If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If
2247defined to be \f(CW0\fR, then they are not.
2248.IP "\s-1EV_STAT_ENABLE\s0" 4
2249.IX Item "EV_STAT_ENABLE"
2250If undefined or defined to be \f(CW1\fR, then stat watchers are supported. If
2251defined to be \f(CW0\fR, then they are not.
2252.IP "\s-1EV_FORK_ENABLE\s0" 4
2253.IX Item "EV_FORK_ENABLE"
2254If undefined or defined to be \f(CW1\fR, then fork watchers are supported. If
2255defined to be \f(CW0\fR, then they are not.
2256.IP "\s-1EV_MINIMAL\s0" 4
2257.IX Item "EV_MINIMAL"
2258If you need to shave off some kilobytes of code at the expense of some
2259speed, define this symbol to \f(CW1\fR. Currently only used for gcc to override
2260some inlining decisions, saves roughly 30% codesize of amd64.
2261.IP "\s-1EV_PID_HASHSIZE\s0" 4
2262.IX Item "EV_PID_HASHSIZE"
2263\&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by
2264pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more
2265than enough. If you need to manage thousands of children you might want to
2266increase this value (\fImust\fR be a power of two).
2267.IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4
2268.IX Item "EV_INOTIFY_HASHSIZE"
2269\&\f(CW\*(C`ev_staz\*(C'\fR watchers use a small hash table to distribute workload by
2270inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR),
2271usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR
2272watchers you might want to increase this value (\fImust\fR be a power of
2273two).
1766.IP "\s-1EV_COMMON\s0" 4 2274.IP "\s-1EV_COMMON\s0" 4
1767.IX Item "EV_COMMON" 2275.IX Item "EV_COMMON"
1768By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining 2276By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining
1769this macro to a something else you can include more and other types of 2277this macro to a something else you can include more and other types of
1770members. You have to define it each time you include one of the files, 2278members. You have to define it each time you include one of the files,
1819.Sp 2327.Sp
1820.Vb 2 2328.Vb 2
1821\& #include "ev_cpp.h" 2329\& #include "ev_cpp.h"
1822\& #include "ev.c" 2330\& #include "ev.c"
1823.Ve 2331.Ve
2332.SH "COMPLEXITIES"
2333.IX Header "COMPLEXITIES"
2334In this section the complexities of (many of) the algorithms used inside
2335libev will be explained. For complexity discussions about backends see the
2336documentation for \f(CW\*(C`ev_default_init\*(C'\fR.
2337.RS 4
2338.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4
2339.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)"
2340.PD 0
2341.IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4
2342.IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)"
2343.IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4
2344.IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)"
2345.IP "Stopping check/prepare/idle watchers: O(1)" 4
2346.IX Item "Stopping check/prepare/idle watchers: O(1)"
2347.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4
2348.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))"
2349.IP "Finding the next timer per loop iteration: O(1)" 4
2350.IX Item "Finding the next timer per loop iteration: O(1)"
2351.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4
2352.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)"
2353.IP "Activating one watcher: O(1)" 4
2354.IX Item "Activating one watcher: O(1)"
2355.RE
2356.RS 4
2357.PD
1824.SH "AUTHOR" 2358.SH "AUTHOR"
1825.IX Header "AUTHOR" 2359.IX Header "AUTHOR"
1826Marc Lehmann <libev@schmorp.de>. 2360Marc Lehmann <libev@schmorp.de>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines