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

Comparing libev/ev.pod (file contents):
Revision 1.3 by root, Mon Nov 12 08:03:31 2007 UTC vs.
Revision 1.17 by root, Mon Nov 12 08:57:03 2007 UTC

… …
8 8
9=head1 DESCRIPTION 9=head1 DESCRIPTION
10 10
11Libev is an event loop: you register interest in certain events (such as a 11Libev is an event loop: you register interest in certain events (such as a
12file descriptor being readable or a timeout occuring), and it will manage 12file descriptor being readable or a timeout occuring), and it will manage
13these event sources and provide your program events. 13these event sources and provide your program with events.
14 14
15To do this, it must take more or less complete control over your process 15To do this, it must take more or less complete control over your process
16(or thread) by executing the I<event loop> handler, and will then 16(or thread) by executing the I<event loop> handler, and will then
17communicate events via a callback mechanism. 17communicate events via a callback mechanism.
18 18
… …
25 25
26Libev supports select, poll, the linux-specific epoll and the bsd-specific 26Libev supports select, poll, the linux-specific epoll and the bsd-specific
27kqueue mechanisms for file descriptor events, relative timers, absolute 27kqueue mechanisms for file descriptor events, relative timers, absolute
28timers with customised rescheduling, signal events, process status change 28timers with customised rescheduling, signal events, process status change
29events (related to SIGCHLD), and event watchers dealing with the event 29events (related to SIGCHLD), and event watchers dealing with the event
30loop mechanism itself (idle, prepare and check watchers). 30loop mechanism itself (idle, prepare and check watchers). It also is quite
31fast (see this L<benchmark|http://libev.schmorp.de/bench.html> comparing
32it to libevent for example).
31 33
32=head1 CONVENTIONS 34=head1 CONVENTIONS
33 35
34Libev is very configurable. In this manual the default configuration 36Libev is very configurable. In this manual the default configuration
35will be described, which supports multiple event loops. For more info 37will be described, which supports multiple event loops. For more info
36about various configuraiton options please have a look at the file 38about various configuration options please have a look at the file
37F<README.embed> in the libev distribution. If libev was configured without 39F<README.embed> in the libev distribution. If libev was configured without
38support for multiple event loops, then all functions taking an initial 40support for multiple event loops, then all functions taking an initial
39argument of name C<loop> (which is always of type C<struct ev_loop *>) 41argument of name C<loop> (which is always of type C<struct ev_loop *>)
40will not have this argument. 42will not have this argument.
41 43
42=head1 TIME AND OTHER GLOBAL FUNCTIONS 44=head1 TIME REPRESENTATION
43 45
44Libev represents time as a single floating point number, representing the 46Libev represents time as a single floating point number, representing the
45(fractional) number of seconds since the (POSIX) epoch (somewhere near 47(fractional) number of seconds since the (POSIX) epoch (somewhere near
46the beginning of 1970, details are complicated, don't ask). This type is 48the beginning of 1970, details are complicated, don't ask). This type is
47called C<ev_tstamp>, which is what you should use too. It usually aliases 49called C<ev_tstamp>, which is what you should use too. It usually aliases
48to the double type in C. 50to the double type in C.
49 51
52=head1 GLOBAL FUNCTIONS
53
50=over 4 54=over 4
51 55
52=item ev_tstamp ev_time () 56=item ev_tstamp ev_time ()
53 57
54Returns the current time as libev would use it. 58Returns the current time as libev would use it.
… …
61you linked against by calling the functions C<ev_version_major> and 65you linked against by calling the functions C<ev_version_major> and
62C<ev_version_minor>. If you want, you can compare against the global 66C<ev_version_minor>. If you want, you can compare against the global
63symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the 67symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the
64version of the library your program was compiled against. 68version of the library your program was compiled against.
65 69
66Usually, its a good idea to terminate if the major versions mismatch, 70Usually, it's a good idea to terminate if the major versions mismatch,
67as this indicates an incompatible change. Minor versions are usually 71as this indicates an incompatible change. Minor versions are usually
68compatible to older versions, so a larger minor version alone is usually 72compatible to older versions, so a larger minor version alone is usually
69not a problem. 73not a problem.
70 74
71=item ev_set_allocator (void *(*cb)(void *ptr, long size)) 75=item ev_set_allocator (void *(*cb)(void *ptr, long size))
72 76
73Sets the allocation function to use (the prototype is similar to the 77Sets the allocation function to use (the prototype is similar to the
74realloc function). It is used to allocate and free memory (no surprises 78realloc C function, the semantics are identical). It is used to allocate
75here). If it returns zero when memory needs to be allocated, the library 79and free memory (no surprises here). If it returns zero when memory
76might abort or take some potentially destructive action. The default is 80needs to be allocated, the library might abort or take some potentially
77your system realloc function. 81destructive action. The default is your system realloc function.
78 82
79You could override this function in high-availability programs to, say, 83You could override this function in high-availability programs to, say,
80free some memory if it cannot allocate memory, to use a special allocator, 84free some memory if it cannot allocate memory, to use a special allocator,
81or even to sleep a while and retry until some memory is available. 85or even to sleep a while and retry until some memory is available.
82 86
… …
84 88
85Set the callback function to call on a retryable syscall error (such 89Set the callback function to call on a retryable syscall error (such
86as failed select, poll, epoll_wait). The message is a printable string 90as failed select, poll, epoll_wait). The message is a printable string
87indicating the system call or subsystem causing the problem. If this 91indicating the system call or subsystem causing the problem. If this
88callback is set, then libev will expect it to remedy the sitution, no 92callback is set, then libev will expect it to remedy the sitution, no
89matter what, when it returns. That is, libev will geenrally retry the 93matter what, when it returns. That is, libev will generally retry the
90requested operation, or, if the condition doesn't go away, do bad stuff 94requested operation, or, if the condition doesn't go away, do bad stuff
91(such as abort). 95(such as abort).
92 96
93=back 97=back
94 98
… …
97An event loop is described by a C<struct ev_loop *>. The library knows two 101An event loop is described by a C<struct ev_loop *>. The library knows two
98types of such loops, the I<default> loop, which supports signals and child 102types of such loops, the I<default> loop, which supports signals and child
99events, and dynamically created loops which do not. 103events, and dynamically created loops which do not.
100 104
101If you use threads, a common model is to run the default event loop 105If you use threads, a common model is to run the default event loop
102in your main thread (or in a separate thrad) and for each thread you 106in your main thread (or in a separate thread) and for each thread you
103create, you also create another event loop. Libev itself does no lockign 107create, you also create another event loop. Libev itself does no locking
104whatsoever, so if you mix calls to different event loops, make sure you 108whatsoever, so if you mix calls to the same event loop in different
105lock (this is usually a bad idea, though, even if done right). 109threads, make sure you lock (this is usually a bad idea, though, even if
110done correctly, because it's hideous and inefficient).
106 111
107=over 4 112=over 4
108 113
109=item struct ev_loop *ev_default_loop (unsigned int flags) 114=item struct ev_loop *ev_default_loop (unsigned int flags)
110 115
… …
115 120
116If you don't know what event loop to use, use the one returned from this 121If you don't know what event loop to use, use the one returned from this
117function. 122function.
118 123
119The flags argument can be used to specify special behaviour or specific 124The flags argument can be used to specify special behaviour or specific
120backends to use, and is usually specified as 0 (or EVFLAG_AUTO) 125backends to use, and is usually specified as 0 (or EVFLAG_AUTO).
121 126
122It supports the following flags: 127It supports the following flags:
123 128
124=over 4 129=over 4
125 130
126=item EVFLAG_AUTO 131=item C<EVFLAG_AUTO>
127 132
128The default flags value. Use this if you have no clue (its the right 133The default flags value. Use this if you have no clue (it's the right
129thing, believe me). 134thing, believe me).
130 135
131=item EVFLAG_NOENV 136=item C<EVFLAG_NOENV>
132 137
133If this flag bit is ored into the flag value then libev will I<not> look 138If this flag bit is ored into the flag value (or the program runs setuid
134at the environment variable C<LIBEV_FLAGS>. Otherwise (the default), this 139or setgid) then libev will I<not> look at the environment variable
135environment variable will override the flags completely. This is useful 140C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
141override the flags completely if it is found in the environment. This is
136to try out specific backends to tets their performance, or to work around 142useful to try out specific backends to test their performance, or to work
137bugs. 143around bugs.
138 144
139=item EVMETHOD_SELECT portable select backend 145=item C<EVMETHOD_SELECT> (portable select backend)
140 146
141=item EVMETHOD_POLL poll backend (everywhere except windows) 147=item C<EVMETHOD_POLL> (poll backend, available everywhere except on windows)
142 148
143=item EVMETHOD_EPOLL linux only 149=item C<EVMETHOD_EPOLL> (linux only)
144 150
145=item EVMETHOD_KQUEUE some bsds only 151=item C<EVMETHOD_KQUEUE> (some bsds only)
146 152
147=item EVMETHOD_DEVPOLL solaris 8 only 153=item C<EVMETHOD_DEVPOLL> (solaris 8 only)
148 154
149=item EVMETHOD_PORT solaris 10 only 155=item C<EVMETHOD_PORT> (solaris 10 only)
150 156
151If one or more of these are ored into the flags value, then only these 157If one or more of these are ored into the flags value, then only these
152backends will be tried (in the reverse order as given here). If one are 158backends will be tried (in the reverse order as given here). If one are
153specified, any backend will do. 159specified, any backend will do.
154 160
… …
163 169
164=item ev_default_destroy () 170=item ev_default_destroy ()
165 171
166Destroys the default loop again (frees all memory and kernel state 172Destroys the default loop again (frees all memory and kernel state
167etc.). This stops all registered event watchers (by not touching them in 173etc.). This stops all registered event watchers (by not touching them in
168any way whatsoever, although you cnanot rely on this :). 174any way whatsoever, although you cannot rely on this :).
169 175
170=item ev_loop_destroy (loop) 176=item ev_loop_destroy (loop)
171 177
172Like C<ev_default_destroy>, but destroys an event loop created by an 178Like C<ev_default_destroy>, but destroys an event loop created by an
173earlier call to C<ev_loop_new>. 179earlier call to C<ev_loop_new>.
… …
181 187
182You I<must> call this function after forking if and only if you want to 188You I<must> call this function after forking if and only if you want to
183use the event library in both processes. If you just fork+exec, you don't 189use the event library in both processes. If you just fork+exec, you don't
184have to call it. 190have to call it.
185 191
186The function itself is quite fast and its usually not a problem to call 192The function itself is quite fast and it's usually not a problem to call
187it just in case after a fork. To make this easy, the function will fit in 193it just in case after a fork. To make this easy, the function will fit in
188quite nicely into a call to C<pthread_atfork>: 194quite nicely into a call to C<pthread_atfork>:
189 195
190 pthread_atfork (0, 0, ev_default_fork); 196 pthread_atfork (0, 0, ev_default_fork);
191 197
… …
198=item unsigned int ev_method (loop) 204=item unsigned int ev_method (loop)
199 205
200Returns one of the C<EVMETHOD_*> flags indicating the event backend in 206Returns one of the C<EVMETHOD_*> flags indicating the event backend in
201use. 207use.
202 208
203=item ev_tstamp = ev_now (loop) 209=item ev_tstamp ev_now (loop)
204 210
205Returns the current "event loop time", which is the time the event loop 211Returns the current "event loop time", which is the time the event loop
206got events and started processing them. This timestamp does not change 212got events and started processing them. This timestamp does not change
207as long as callbacks are being processed, and this is also the base time 213as long as callbacks are being processed, and this is also the base time
208used for relative timers. You can treat it as the timestamp of the event 214used for relative timers. You can treat it as the timestamp of the event
… …
217If the flags argument is specified as 0, it will not return until either 223If the flags argument is specified as 0, it will not return until either
218no event watchers are active anymore or C<ev_unloop> was called. 224no event watchers are active anymore or C<ev_unloop> was called.
219 225
220A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle 226A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle
221those events and any outstanding ones, but will not block your process in 227those events and any outstanding ones, but will not block your process in
222case there are no events. 228case there are no events and will return after one iteration of the loop.
223 229
224A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if 230A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if
225neccessary) and will handle those and any outstanding ones. It will block 231neccessary) and will handle those and any outstanding ones. It will block
226your process until at least one new event arrives. 232your process until at least one new event arrives, and will return after
233one iteration of the loop.
227 234
228This flags value could be used to implement alternative looping 235This flags value could be used to implement alternative looping
229constructs, but the C<prepare> and C<check> watchers provide a better and 236constructs, but the C<prepare> and C<check> watchers provide a better and
230more generic mechanism. 237more generic mechanism.
231 238
232=item ev_unloop (loop, how) 239=item ev_unloop (loop, how)
233 240
234Can be used to make a call to C<ev_loop> return early. The C<how> argument 241Can be used to make a call to C<ev_loop> return early (but only after it
242has processed all outstanding events). The C<how> argument must be either
235must be either C<EVUNLOOP_ONCE>, which will make the innermost C<ev_loop> 243C<EVUNLOOP_ONCE>, which will make the innermost C<ev_loop> call return, or
236call return, or C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> 244C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.
237calls return.
238 245
239=item ev_ref (loop) 246=item ev_ref (loop)
240 247
241=item ev_unref (loop) 248=item ev_unref (loop)
242 249
243Ref/unref can be used to add or remove a refcount on the event loop: Every 250Ref/unref can be used to add or remove a reference count on the event
244watcher keeps one reference. If you have a long-runing watcher you never 251loop: Every watcher keeps one reference, and as long as the reference
245unregister that should not keep ev_loop from running, ev_unref() after 252count is nonzero, C<ev_loop> will not return on its own. If you have
246starting, and ev_ref() before stopping it. Libev itself uses this for 253a watcher you never unregister that should not keep C<ev_loop> from
247example for its internal signal pipe: It is not visible to you as a user 254returning, ev_unref() after starting, and ev_ref() before stopping it. For
248and should not keep C<ev_loop> from exiting if the work is done. It is 255example, libev itself uses this for its internal signal pipe: It is not
249also an excellent way to do this for generic recurring timers or from 256visible to the libev user and should not keep C<ev_loop> from exiting if
250within third-party libraries. Just remember to unref after start and ref 257no event watchers registered by it are active. It is also an excellent
251before stop. 258way to do this for generic recurring timers or from within third-party
259libraries. Just remember to I<unref after start> and I<ref before stop>.
252 260
253=back 261=back
254 262
255=head1 ANATOMY OF A WATCHER 263=head1 ANATOMY OF A WATCHER
256 264
257A watcher is a structure that you create and register to record your 265A watcher is a structure that you create and register to record your
258interest in some event. For instance, if you want to wait for STDIN to 266interest in some event. For instance, if you want to wait for STDIN to
259become readable, you would create an ev_io watcher for that: 267become readable, you would create an C<ev_io> watcher for that:
260 268
261 static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) 269 static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)
262 { 270 {
263 ev_io_stop (w); 271 ev_io_stop (w);
264 ev_unloop (loop, EVUNLOOP_ALL); 272 ev_unloop (loop, EVUNLOOP_ALL);
… …
293 301
294As long as your watcher is active (has been started but not stopped) you 302As long as your watcher is active (has been started but not stopped) you
295must not touch the values stored in it. Most specifically you must never 303must not touch the values stored in it. Most specifically you must never
296reinitialise it or call its set method. 304reinitialise it or call its set method.
297 305
298You cna check wether an event is active by calling the C<ev_is_active 306You can check whether an event is active by calling the C<ev_is_active
299(watcher *)> macro. To see wether an event is outstanding (but the 307(watcher *)> macro. To see whether an event is outstanding (but the
300callback for it has not been called yet) you cna use the C<ev_is_pending 308callback for it has not been called yet) you can use the C<ev_is_pending
301(watcher *)> macro. 309(watcher *)> macro.
302 310
303Each and every callback receives the event loop pointer as first, the 311Each and every callback receives the event loop pointer as first, the
304registered watcher structure as second, and a bitset of received events as 312registered watcher structure as second, and a bitset of received events as
305third argument. 313third argument.
306 314
307The rceeived events usually include a single bit per event type received 315The received events usually include a single bit per event type received
308(you can receive multiple events at the same time). The possible bit masks 316(you can receive multiple events at the same time). The possible bit masks
309are: 317are:
310 318
311=over 4 319=over 4
312 320
313=item EV_READ 321=item C<EV_READ>
314 322
315=item EV_WRITE 323=item C<EV_WRITE>
316 324
317The file descriptor in the ev_io watcher has become readable and/or 325The file descriptor in the C<ev_io> watcher has become readable and/or
318writable. 326writable.
319 327
320=item EV_TIMEOUT 328=item C<EV_TIMEOUT>
321 329
322The ev_timer watcher has timed out. 330The C<ev_timer> watcher has timed out.
323 331
324=item EV_PERIODIC 332=item C<EV_PERIODIC>
325 333
326The ev_periodic watcher has timed out. 334The C<ev_periodic> watcher has timed out.
327 335
328=item EV_SIGNAL 336=item C<EV_SIGNAL>
329 337
330The signal specified in the ev_signal watcher has been received by a thread. 338The signal specified in the C<ev_signal> watcher has been received by a thread.
331 339
332=item EV_CHILD 340=item C<EV_CHILD>
333 341
334The pid specified in the ev_child watcher has received a status change. 342The pid specified in the C<ev_child> watcher has received a status change.
335 343
336=item EV_IDLE 344=item C<EV_IDLE>
337 345
338The ev_idle watcher has determined that you have nothing better to do. 346The C<ev_idle> watcher has determined that you have nothing better to do.
339 347
340=item EV_PREPARE 348=item C<EV_PREPARE>
341 349
342=item EV_CHECK 350=item C<EV_CHECK>
343 351
344All ev_prepare watchers are invoked just I<before> C<ev_loop> starts 352All C<ev_prepare> watchers are invoked just I<before> C<ev_loop> starts
345to gather new events, and all ev_check watchers are invoked just after 353to gather new events, and all C<ev_check> watchers are invoked just after
346C<ev_loop> has gathered them, but before it invokes any callbacks for any 354C<ev_loop> has gathered them, but before it invokes any callbacks for any
347received events. Callbacks of both watcher types can start and stop as 355received events. Callbacks of both watcher types can start and stop as
348many watchers as they want, and all of them will be taken into account 356many watchers as they want, and all of them will be taken into account
349(for example, a ev_prepare watcher might start an idle watcher to keep 357(for example, a C<ev_prepare> watcher might start an idle watcher to keep
350C<ev_loop> from blocking). 358C<ev_loop> from blocking).
351 359
352=item EV_ERROR 360=item C<EV_ERROR>
353 361
354An unspecified error has occured, the watcher has been stopped. This might 362An unspecified error has occured, the watcher has been stopped. This might
355happen because the watcher could not be properly started because libev 363happen because the watcher could not be properly started because libev
356ran out of memory, a file descriptor was found to be closed or any other 364ran out of memory, a file descriptor was found to be closed or any other
357problem. You best act on it by reporting the problem and somehow coping 365problem. You best act on it by reporting the problem and somehow coping
… …
366=back 374=back
367 375
368=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER 376=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
369 377
370Each watcher has, by default, a member C<void *data> that you can change 378Each watcher has, by default, a member C<void *data> that you can change
371and read at any time, libev will completely ignore it. This cna be used 379and read at any time, libev will completely ignore it. This can be used
372to associate arbitrary data with your watcher. If you need more data and 380to associate arbitrary data with your watcher. If you need more data and
373don't want to allocate memory and store a pointer to it in that data 381don't want to allocate memory and store a pointer to it in that data
374member, you can also "subclass" the watcher type and provide your own 382member, you can also "subclass" the watcher type and provide your own
375data: 383data:
376 384
… …
398=head1 WATCHER TYPES 406=head1 WATCHER TYPES
399 407
400This section describes each watcher in detail, but will not repeat 408This section describes each watcher in detail, but will not repeat
401information given in the last section. 409information given in the last section.
402 410
403=head2 struct ev_io - is my file descriptor readable or writable 411=head2 C<ev_io> - is this file descriptor readable or writable
404 412
405I/O watchers check wether a file descriptor is readable or writable 413I/O watchers check whether a file descriptor is readable or writable
406in each iteration of the event loop (This behaviour is called 414in each iteration of the event loop (This behaviour is called
407level-triggering because you keep receiving events as long as the 415level-triggering because you keep receiving events as long as the
408condition persists. Remember you cna stop the watcher if you don't want to 416condition persists. Remember you can stop the watcher if you don't want to
409act on the event and neither want to receive future events). 417act on the event and neither want to receive future events).
410 418
419In general you can register as many read and/or write event watchers oer
420fd as you want (as long as you don't confuse yourself). Setting all file
421descriptors to non-blocking mode is also usually a good idea (but not
422required if you know what you are doing).
423
424You have to be careful with dup'ed file descriptors, though. Some backends
425(the linux epoll backend is a notable example) cannot handle dup'ed file
426descriptors correctly if you register interest in two or more fds pointing
427to the same file/socket etc. description.
428
429If you must do this, then force the use of a known-to-be-good backend
430(at the time of this writing, this includes only EVMETHOD_SELECT and
431EVMETHOD_POLL).
432
411=over 4 433=over 4
412 434
413=item ev_io_init (ev_io *, callback, int fd, int events) 435=item ev_io_init (ev_io *, callback, int fd, int events)
414 436
415=item ev_io_set (ev_io *, int fd, int events) 437=item ev_io_set (ev_io *, int fd, int events)
416 438
417Configures an ev_io watcher. The fd is the file descriptor to rceeive 439Configures an C<ev_io> watcher. The fd is the file descriptor to rceeive
418events for and events is either C<EV_READ>, C<EV_WRITE> or C<EV_READ | 440events for and events is either C<EV_READ>, C<EV_WRITE> or C<EV_READ |
419EV_WRITE> to receive the given events. 441EV_WRITE> to receive the given events.
420 442
421=back 443=back
422 444
423=head2 struct ev_timer - relative and optionally recurring timeouts 445=head2 C<ev_timer> - relative and optionally recurring timeouts
424 446
425Timer watchers are simple relative timers that generate an event after a 447Timer watchers are simple relative timers that generate an event after a
426given time, and optionally repeating in regular intervals after that. 448given time, and optionally repeating in regular intervals after that.
427 449
428The timers are based on real time, that is, if you register an event that 450The timers are based on real time, that is, if you register an event that
429times out after an hour and youreset your system clock to last years 451times out after an hour and youreset your system clock to last years
430time, it will still time out after (roughly) and hour. "Roughly" because 452time, it will still time out after (roughly) and hour. "Roughly" because
431detecting time jumps is hard, and soem inaccuracies are unavoidable (the 453detecting time jumps is hard, and soem inaccuracies are unavoidable (the
432monotonic clock option helps a lot here). 454monotonic clock option helps a lot here).
433 455
456The relative timeouts are calculated relative to the C<ev_now ()>
457time. This is usually the right thing as this timestamp refers to the time
458of the event triggering whatever timeout you are modifying/starting. If
459you suspect event processing to be delayed and you *need* to base the timeout
460ion the current time, use something like this to adjust for this:
461
462 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
463
434=over 4 464=over 4
435 465
436=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 466=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
437 467
438=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) 468=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
… …
460 490
461This sounds a bit complicated, but here is a useful and typical 491This sounds a bit complicated, but here is a useful and typical
462example: Imagine you have a tcp connection and you want a so-called idle 492example: Imagine you have a tcp connection and you want a so-called idle
463timeout, that is, you want to be called when there have been, say, 60 493timeout, that is, you want to be called when there have been, say, 60
464seconds of inactivity on the socket. The easiest way to do this is to 494seconds of inactivity on the socket. The easiest way to do this is to
465configure an ev_timer with after=repeat=60 and calling ev_timer_again each 495configure an C<ev_timer> with after=repeat=60 and calling ev_timer_again each
466time you successfully read or write some data. If you go into an idle 496time you successfully read or write some data. If you go into an idle
467state where you do not expect data to travel on the socket, you can stop 497state where you do not expect data to travel on the socket, you can stop
468the timer, and again will automatically restart it if need be. 498the timer, and again will automatically restart it if need be.
469 499
470=back 500=back
471 501
472=head2 ev_periodic - to cron or not to cron it 502=head2 C<ev_periodic> - to cron or not to cron
473 503
474Periodic watchers are also timers of a kind, but they are very versatile 504Periodic watchers are also timers of a kind, but they are very versatile
475(and unfortunately a bit complex). 505(and unfortunately a bit complex).
476 506
477Unlike ev_timer's, they are not based on real time (or relative time) 507Unlike C<ev_timer>'s, they are not based on real time (or relative time)
478but on wallclock time (absolute time). You can tell a periodic watcher 508but on wallclock time (absolute time). You can tell a periodic watcher
479to trigger "at" some specific point in time. For example, if you tell a 509to trigger "at" some specific point in time. For example, if you tell a
480periodic watcher to trigger in 10 seconds (by specifiying e.g. c<ev_now () 510periodic watcher to trigger in 10 seconds (by specifiying e.g. c<ev_now ()
481+ 10.>) and then reset your system clock to the last year, then it will 511+ 10.>) and then reset your system clock to the last year, then it will
482take a year to trigger the event (unlike an ev_timer, which would trigger 512take a year to trigger the event (unlike an C<ev_timer>, which would trigger
483roughly 10 seconds later and of course not if you reset your system time 513roughly 10 seconds later and of course not if you reset your system time
484again). 514again).
485 515
486They can also be used to implement vastly more complex timers, such as 516They can also be used to implement vastly more complex timers, such as
487triggering an event on eahc midnight, local time. 517triggering an event on eahc midnight, local time.
… …
516 546
517 ev_periodic_set (&periodic, 0., 3600., 0); 547 ev_periodic_set (&periodic, 0., 3600., 0);
518 548
519This doesn't mean there will always be 3600 seconds in between triggers, 549This doesn't mean there will always be 3600 seconds in between triggers,
520but only that the the callback will be called when the system time shows a 550but only that the the callback will be called when the system time shows a
521full hour (UTC), or more correct, when the system time is evenly divisible 551full hour (UTC), or more correctly, when the system time is evenly divisible
522by 3600. 552by 3600.
523 553
524Another way to think about it (for the mathematically inclined) is that 554Another way to think about it (for the mathematically inclined) is that
525ev_periodic will try to run the callback in this mode at the next possible 555C<ev_periodic> will try to run the callback in this mode at the next possible
526time where C<time = at (mod interval)>, regardless of any time jumps. 556time where C<time = at (mod interval)>, regardless of any time jumps.
527 557
528=item * manual reschedule mode (reschedule_cb = callback) 558=item * manual reschedule mode (reschedule_cb = callback)
529 559
530In this mode the values for C<interval> and C<at> are both being 560In this mode the values for C<interval> and C<at> are both being
531ignored. Instead, each time the periodic watcher gets scheduled, the 561ignored. Instead, each time the periodic watcher gets scheduled, the
532reschedule callback will be called with the watcher as first, and the 562reschedule callback will be called with the watcher as first, and the
533current time as second argument. 563current time as second argument.
534 564
535NOTE: I<This callback MUST NOT stop or destroy the periodic or any other 565NOTE: I<This callback MUST NOT stop or destroy the periodic or any other
536periodic watcher, ever, or make any event loop modificstions>. If you need 566periodic watcher, ever, or make any event loop modifications>. If you need
537to stop it, return 1e30 (or so, fudge fudge) and stop it afterwards. 567to stop it, return C<now + 1e30> (or so, fudge fudge) and stop it afterwards.
538 568
569Also, I<< this callback must always return a time that is later than the
570passed C<now> value >>. Not even C<now> itself will be ok.
571
539Its prototype is c<ev_tstamp (*reschedule_cb)(struct ev_periodic *w, 572Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
540ev_tstamp now)>, e.g.: 573ev_tstamp now)>, e.g.:
541 574
542 static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) 575 static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
543 { 576 {
544 return now + 60.; 577 return now + 60.;
… …
563a different time than the last time it was called (e.g. in a crond like 596a different time than the last time it was called (e.g. in a crond like
564program when the crontabs have changed). 597program when the crontabs have changed).
565 598
566=back 599=back
567 600
568=head2 ev_signal - signal me when a signal gets signalled 601=head2 C<ev_signal> - signal me when a signal gets signalled
569 602
570Signal watchers will trigger an event when the process receives a specific 603Signal watchers will trigger an event when the process receives a specific
571signal one or more times. Even though signals are very asynchronous, libev 604signal one or more times. Even though signals are very asynchronous, libev
572will try its best to deliver signals synchronously, i.e. as part of the 605will try it's best to deliver signals synchronously, i.e. as part of the
573normal event processing, like any other event. 606normal event processing, like any other event.
574 607
575You cna configure as many watchers as you like per signal. Only when the 608You can configure as many watchers as you like per signal. Only when the
576first watcher gets started will libev actually register a signal watcher 609first watcher gets started will libev actually register a signal watcher
577with the kernel (thus it coexists with your own signal handlers as long 610with the kernel (thus it coexists with your own signal handlers as long
578as you don't register any with libev). Similarly, when the last signal 611as you don't register any with libev). Similarly, when the last signal
579watcher for a signal is stopped libev will reset the signal handler to 612watcher for a signal is stopped libev will reset the signal handler to
580SIG_DFL (regardless of what it was set to before). 613SIG_DFL (regardless of what it was set to before).
… …
588Configures the watcher to trigger on the given signal number (usually one 621Configures the watcher to trigger on the given signal number (usually one
589of the C<SIGxxx> constants). 622of the C<SIGxxx> constants).
590 623
591=back 624=back
592 625
593=head2 ev_child - wait for pid status changes 626=head2 C<ev_child> - wait for pid status changes
594 627
595Child watchers trigger when your process receives a SIGCHLD in response to 628Child watchers trigger when your process receives a SIGCHLD in response to
596some child status changes (most typically when a child of yours dies). 629some child status changes (most typically when a child of yours dies).
597 630
598=over 4 631=over 4
… …
602=item ev_child_set (ev_child *, int pid) 635=item ev_child_set (ev_child *, int pid)
603 636
604Configures the watcher to wait for status changes of process C<pid> (or 637Configures the watcher to wait for status changes of process C<pid> (or
605I<any> process if C<pid> is specified as C<0>). The callback can look 638I<any> process if C<pid> is specified as C<0>). The callback can look
606at the C<rstatus> member of the C<ev_child> watcher structure to see 639at the C<rstatus> member of the C<ev_child> watcher structure to see
607the status word (use the macros from C<sys/wait.h>). The C<rpid> member 640the status word (use the macros from C<sys/wait.h> and see your systems
608contains the pid of the process causing the status change. 641C<waitpid> documentation). The C<rpid> member contains the pid of the
642process causing the status change.
609 643
610=back 644=back
611 645
612=head2 ev_idle - when you've got nothing better to do 646=head2 C<ev_idle> - when you've got nothing better to do
613 647
614Idle watchers trigger events when there are no other I/O or timer (or 648Idle watchers trigger events when there are no other events are pending
615periodic) events pending. That is, as long as your process is busy 649(prepare, check and other idle watchers do not count). That is, as long
616handling sockets or timeouts it will not be called. But when your process 650as your process is busy handling sockets or timeouts (or even signals,
617is idle all idle watchers are being called again and again - until 651imagine) it will not be triggered. But when your process is idle all idle
652watchers are being called again and again, once per event loop iteration -
618stopped, that is, or your process receives more events. 653until stopped, that is, or your process receives more events and becomes
654busy.
619 655
620The most noteworthy effect is that as long as any idle watchers are 656The most noteworthy effect is that as long as any idle watchers are
621active, the process will not block when waiting for new events. 657active, the process will not block when waiting for new events.
622 658
623Apart from keeping your process non-blocking (which is a useful 659Apart from keeping your process non-blocking (which is a useful
… …
633kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, 669kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
634believe me. 670believe me.
635 671
636=back 672=back
637 673
638=head2 prepare and check - your hooks into the event loop 674=head2 C<ev_prepare> and C<ev_check> - customise your event loop
639 675
640Prepare and check watchers usually (but not always) are used in 676Prepare and check watchers are usually (but not always) used in tandem:
641tandom. Prepare watchers get invoked before the process blocks and check 677Prepare watchers get invoked before the process blocks and check watchers
642watchers afterwards. 678afterwards.
643 679
644Their main purpose is to integrate other event mechanisms into libev. This 680Their main purpose is to integrate other event mechanisms into libev. This
645could be used, for example, to track variable changes, implement your own 681could be used, for example, to track variable changes, implement your own
646watchers, integrate net-snmp or a coroutine library and lots more. 682watchers, integrate net-snmp or a coroutine library and lots more.
647 683
648This is done by examining in each prepare call which file descriptors need 684This is done by examining in each prepare call which file descriptors need
649to be watched by the other library, registering ev_io watchers for them 685to be watched by the other library, registering C<ev_io> watchers for
650and starting an ev_timer watcher for any timeouts (many libraries provide 686them and starting an C<ev_timer> watcher for any timeouts (many libraries
651just this functionality). Then, in the check watcher you check for any 687provide just this functionality). Then, in the check watcher you check for
652events that occured (by making your callbacks set soem flags for example) 688any events that occured (by checking the pending status of all watchers
653and call back into the library. 689and stopping them) and call back into the library. The I/O and timer
690callbacks will never actually be called (but must be valid neverthelles,
691because you never know, you know?).
654 692
655As another example, the perl Coro module uses these hooks to integrate 693As another example, the Perl Coro module uses these hooks to integrate
656coroutines into libev programs, by yielding to other active coroutines 694coroutines into libev programs, by yielding to other active coroutines
657during each prepare and only letting the process block if no coroutines 695during each prepare and only letting the process block if no coroutines
658are ready to run. 696are ready to run (its actually more complicated, it only runs coroutines
697with priority higher than the event loop and one lower priority once,
698using idle watchers to keep the event loop from blocking if lower-priority
699coroutines exist, thus mapping low-priority coroutines to idle/background
700tasks).
659 701
660=over 4 702=over 4
661 703
662=item ev_prepare_init (ev_prepare *, callback) 704=item ev_prepare_init (ev_prepare *, callback)
663 705
664=item ev_check_init (ev_check *, callback) 706=item ev_check_init (ev_check *, callback)
665 707
666Initialises and configures the prepare or check watcher - they have no 708Initialises and configures the prepare or check watcher - they have no
667parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> 709parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
668macros, but using them is utterly, utterly pointless. 710macros, but using them is utterly, utterly and completely pointless.
669 711
670=back 712=back
671 713
672=head1 OTHER FUNCTIONS 714=head1 OTHER FUNCTIONS
673 715
674There are some other fucntions of possible interest. Described. Here. Now. 716There are some other functions of possible interest. Described. Here. Now.
675 717
676=over 4 718=over 4
677 719
678=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) 720=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)
679 721
… …
681callback on whichever event happens first and automatically stop both 723callback on whichever event happens first and automatically stop both
682watchers. This is useful if you want to wait for a single event on an fd 724watchers. This is useful if you want to wait for a single event on an fd
683or timeout without havign to allocate/configure/start/stop/free one or 725or timeout without havign to allocate/configure/start/stop/free one or
684more watchers yourself. 726more watchers yourself.
685 727
686If C<fd> is less than 0, then no I/O watcher will be started and events is 728If C<fd> is less than 0, then no I/O watcher will be started and events
687ignored. Otherwise, an ev_io watcher for the given C<fd> and C<events> set 729is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and
688will be craeted and started. 730C<events> set will be craeted and started.
689 731
690If C<timeout> is less than 0, then no timeout watcher will be 732If C<timeout> is less than 0, then no timeout watcher will be
691started. Otherwise an ev_timer watcher with after = C<timeout> (and repeat 733started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
692= 0) will be started. 734repeat = 0) will be started. While C<0> is a valid timeout, it is of
735dubious value.
693 736
694The callback has the type C<void (*cb)(int revents, void *arg)> and 737The callback has the type C<void (*cb)(int revents, void *arg)> and gets
695gets passed an events set (normally a combination of EV_ERROR, EV_READ, 738passed an events set like normal event callbacks (with a combination of
696EV_WRITE or EV_TIMEOUT) and the C<arg> value passed to C<ev_once>: 739C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>
740value passed to C<ev_once>:
697 741
698 static void stdin_ready (int revents, void *arg) 742 static void stdin_ready (int revents, void *arg)
699 { 743 {
700 if (revents & EV_TIMEOUT) 744 if (revents & EV_TIMEOUT)
701 /* doh, nothing entered */ 745 /* doh, nothing entered */;
702 else if (revents & EV_READ) 746 else if (revents & EV_READ)
703 /* stdin might have data for us, joy! */ 747 /* stdin might have data for us, joy! */;
704 } 748 }
705 749
706 ev_once (STDIN_FILENO, EV_READm 10., stdin_ready, 0); 750 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
707 751
708=item ev_feed_event (loop, watcher, int events) 752=item ev_feed_event (loop, watcher, int events)
709 753
710Feeds the given event set into the event loop, as if the specified event 754Feeds the given event set into the event loop, as if the specified event
711has happened for the specified watcher (which must be a pointer to an 755had happened for the specified watcher (which must be a pointer to an
712initialised but not necessarily active event watcher). 756initialised but not necessarily started event watcher).
713 757
714=item ev_feed_fd_event (loop, int fd, int revents) 758=item ev_feed_fd_event (loop, int fd, int revents)
715 759
716Feed an event on the given fd, as if a file descriptor backend detected it. 760Feed an event on the given fd, as if a file descriptor backend detected
761the given events it.
717 762
718=item ev_feed_signal_event (loop, int signum) 763=item ev_feed_signal_event (loop, int signum)
719 764
720Feed an event as if the given signal occured (loop must be the default loop!). 765Feed an event as if the given signal occured (loop must be the default loop!).
721 766

Diff Legend

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