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

Comparing libev/ev.pod (file contents):
Revision 1.5 by root, Mon Nov 12 08:11:57 2007 UTC vs.
Revision 1.30 by root, Fri Nov 23 04:36:03 2007 UTC

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). It also is quite 30loop mechanism itself (idle, prepare and check watchers). It also is quite
31fast (see a L<http://libev.schmorp.de/bench.html|benchmark> comparing it 31fast (see this L<benchmark|http://libev.schmorp.de/bench.html> comparing
32to libevent). 32it to libevent for example).
33 33
34=head1 CONVENTIONS 34=head1 CONVENTIONS
35 35
36Libev is very configurable. In this manual the default configuration 36Libev is very configurable. In this manual the default configuration
37will be described, which supports multiple event loops. For more info 37will be described, which supports multiple event loops. For more info
38about various configuraiton options please have a look at the file 38about various configuration options please have a look at the file
39F<README.embed> in the libev distribution. If libev was configured without 39F<README.embed> in the libev distribution. If libev was configured without
40support for multiple event loops, then all functions taking an initial 40support for multiple event loops, then all functions taking an initial
41argument 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 *>)
42will not have this argument. 42will not have this argument.
43 43
44=head1 TIME AND OTHER GLOBAL FUNCTIONS 44=head1 TIME REPRESENTATION
45 45
46Libev represents time as a single floating point number, representing the 46Libev represents time as a single floating point number, representing the
47(fractional) number of seconds since the (POSIX) epoch (somewhere near 47(fractional) number of seconds since the (POSIX) epoch (somewhere near
48the 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
49called 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
50to the double type in C. 50to the double type in C.
51 51
52=head1 GLOBAL FUNCTIONS
53
54These functions can be called anytime, even before initialising the
55library in any way.
56
52=over 4 57=over 4
53 58
54=item ev_tstamp ev_time () 59=item ev_tstamp ev_time ()
55 60
56Returns the current time as libev would use it. 61Returns the current time as libev would use it. Please note that the
62C<ev_now> function is usually faster and also often returns the timestamp
63you actually want to know.
57 64
58=item int ev_version_major () 65=item int ev_version_major ()
59 66
60=item int ev_version_minor () 67=item int ev_version_minor ()
61 68
63you linked against by calling the functions C<ev_version_major> and 70you linked against by calling the functions C<ev_version_major> and
64C<ev_version_minor>. If you want, you can compare against the global 71C<ev_version_minor>. If you want, you can compare against the global
65symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the 72symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the
66version of the library your program was compiled against. 73version of the library your program was compiled against.
67 74
68Usually, its a good idea to terminate if the major versions mismatch, 75Usually, it's a good idea to terminate if the major versions mismatch,
69as this indicates an incompatible change. Minor versions are usually 76as this indicates an incompatible change. Minor versions are usually
70compatible to older versions, so a larger minor version alone is usually 77compatible to older versions, so a larger minor version alone is usually
71not a problem. 78not a problem.
72 79
73=item ev_set_allocator (void *(*cb)(void *ptr, long size)) 80=item ev_set_allocator (void *(*cb)(void *ptr, long size))
74 81
75Sets the allocation function to use (the prototype is similar to the 82Sets the allocation function to use (the prototype is similar to the
76realloc function). It is used to allocate and free memory (no surprises 83realloc C function, the semantics are identical). It is used to allocate
77here). If it returns zero when memory needs to be allocated, the library 84and free memory (no surprises here). If it returns zero when memory
78might abort or take some potentially destructive action. The default is 85needs to be allocated, the library might abort or take some potentially
79your system realloc function. 86destructive action. The default is your system realloc function.
80 87
81You could override this function in high-availability programs to, say, 88You could override this function in high-availability programs to, say,
82free some memory if it cannot allocate memory, to use a special allocator, 89free some memory if it cannot allocate memory, to use a special allocator,
83or even to sleep a while and retry until some memory is available. 90or even to sleep a while and retry until some memory is available.
84 91
86 93
87Set the callback function to call on a retryable syscall error (such 94Set the callback function to call on a retryable syscall error (such
88as failed select, poll, epoll_wait). The message is a printable string 95as failed select, poll, epoll_wait). The message is a printable string
89indicating the system call or subsystem causing the problem. If this 96indicating the system call or subsystem causing the problem. If this
90callback is set, then libev will expect it to remedy the sitution, no 97callback is set, then libev will expect it to remedy the sitution, no
91matter what, when it returns. That is, libev will geenrally retry the 98matter what, when it returns. That is, libev will generally retry the
92requested operation, or, if the condition doesn't go away, do bad stuff 99requested operation, or, if the condition doesn't go away, do bad stuff
93(such as abort). 100(such as abort).
94 101
95=back 102=back
96 103
99An event loop is described by a C<struct ev_loop *>. The library knows two 106An event loop is described by a C<struct ev_loop *>. The library knows two
100types of such loops, the I<default> loop, which supports signals and child 107types of such loops, the I<default> loop, which supports signals and child
101events, and dynamically created loops which do not. 108events, and dynamically created loops which do not.
102 109
103If you use threads, a common model is to run the default event loop 110If you use threads, a common model is to run the default event loop
104in your main thread (or in a separate thrad) and for each thread you 111in your main thread (or in a separate thread) and for each thread you
105create, you also create another event loop. Libev itself does no lockign 112create, you also create another event loop. Libev itself does no locking
106whatsoever, so if you mix calls to different event loops, make sure you 113whatsoever, so if you mix calls to the same event loop in different
107lock (this is usually a bad idea, though, even if done right). 114threads, make sure you lock (this is usually a bad idea, though, even if
115done correctly, because it's hideous and inefficient).
108 116
109=over 4 117=over 4
110 118
111=item struct ev_loop *ev_default_loop (unsigned int flags) 119=item struct ev_loop *ev_default_loop (unsigned int flags)
112 120
117 125
118If you don't know what event loop to use, use the one returned from this 126If you don't know what event loop to use, use the one returned from this
119function. 127function.
120 128
121The flags argument can be used to specify special behaviour or specific 129The flags argument can be used to specify special behaviour or specific
122backends to use, and is usually specified as 0 (or EVFLAG_AUTO) 130backends to use, and is usually specified as 0 (or EVFLAG_AUTO).
123 131
124It supports the following flags: 132It supports the following flags:
125 133
126=over 4 134=over 4
127 135
128=item EVFLAG_AUTO 136=item C<EVFLAG_AUTO>
129 137
130The default flags value. Use this if you have no clue (its the right 138The default flags value. Use this if you have no clue (it's the right
131thing, believe me). 139thing, believe me).
132 140
133=item EVFLAG_NOENV 141=item C<EVFLAG_NOENV>
134 142
135If this flag bit is ored into the flag value then libev will I<not> look 143If this flag bit is ored into the flag value (or the program runs setuid
136at the environment variable C<LIBEV_FLAGS>. Otherwise (the default), this 144or setgid) then libev will I<not> look at the environment variable
137environment variable will override the flags completely. This is useful 145C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
146override the flags completely if it is found in the environment. This is
138to try out specific backends to tets their performance, or to work around 147useful to try out specific backends to test their performance, or to work
139bugs. 148around bugs.
140 149
141=item EVMETHOD_SELECT portable select backend 150=item C<EVMETHOD_SELECT> (value 1, portable select backend)
142 151
152This is your standard select(2) backend. Not I<completely> standard, as
153libev tries to roll its own fd_set with no limits on the number of fds,
154but if that fails, expect a fairly low limit on the number of fds when
155using this backend. It doesn't scale too well (O(highest_fd)), but its usually
156the fastest backend for a low number of fds.
157
143=item EVMETHOD_POLL poll backend (everywhere except windows) 158=item C<EVMETHOD_POLL> (value 2, poll backend, available everywhere except on windows)
144 159
145=item EVMETHOD_EPOLL linux only 160And this is your standard poll(2) backend. It's more complicated than
161select, but handles sparse fds better and has no artificial limit on the
162number of fds you can use (except it will slow down considerably with a
163lot of inactive fds). It scales similarly to select, i.e. O(total_fds).
146 164
147=item EVMETHOD_KQUEUE some bsds only 165=item C<EVMETHOD_EPOLL> (value 4, Linux)
148 166
149=item EVMETHOD_DEVPOLL solaris 8 only 167For few fds, this backend is a bit little slower than poll and select,
168but it scales phenomenally better. While poll and select usually scale like
169O(total_fds) where n is the total number of fds (or the highest fd), epoll scales
170either O(1) or O(active_fds).
150 171
151=item EVMETHOD_PORT solaris 10 only 172While stopping and starting an I/O watcher in the same iteration will
173result in some caching, there is still a syscall per such incident
174(because the fd could point to a different file description now), so its
175best to avoid that. Also, dup()ed file descriptors might not work very
176well if you register events for both fds.
177
178=item C<EVMETHOD_KQUEUE> (value 8, most BSD clones)
179
180Kqueue deserves special mention, as at the time of this writing, it
181was broken on all BSDs except NetBSD (usually it doesn't work with
182anything but sockets and pipes, except on Darwin, where of course its
183completely useless). For this reason its not being "autodetected" unless
184you explicitly specify the flags (i.e. you don't use EVFLAG_AUTO).
185
186It scales in the same way as the epoll backend, but the interface to the
187kernel is more efficient (which says nothing about its actual speed, of
188course). While starting and stopping an I/O watcher does not cause an
189extra syscall as with epoll, it still adds up to four event changes per
190incident, so its best to avoid that.
191
192=item C<EVMETHOD_DEVPOLL> (value 16, Solaris 8)
193
194This is not implemented yet (and might never be).
195
196=item C<EVMETHOD_PORT> (value 32, Solaris 10)
197
198This uses the Solaris 10 port mechanism. As with everything on Solaris,
199it's really slow, but it still scales very well (O(active_fds)).
200
201=item C<EVMETHOD_ALL>
202
203Try all backends (even potentially broken ones that wouldn't be tried
204with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
205C<EVMETHOD_ALL & ~EVMETHOD_KQUEUE>.
206
207=back
152 208
153If one or more of these are ored into the flags value, then only these 209If one or more of these are ored into the flags value, then only these
154backends will be tried (in the reverse order as given here). If one are 210backends will be tried (in the reverse order as given here). If none are
155specified, any backend will do. 211specified, most compiled-in backend will be tried, usually in reverse
156 212order of their flag values :)
157=back
158 213
159=item struct ev_loop *ev_loop_new (unsigned int flags) 214=item struct ev_loop *ev_loop_new (unsigned int flags)
160 215
161Similar to C<ev_default_loop>, but always creates a new event loop that is 216Similar to C<ev_default_loop>, but always creates a new event loop that is
162always distinct from the default loop. Unlike the default loop, it cannot 217always distinct from the default loop. Unlike the default loop, it cannot
165 220
166=item ev_default_destroy () 221=item ev_default_destroy ()
167 222
168Destroys the default loop again (frees all memory and kernel state 223Destroys the default loop again (frees all memory and kernel state
169etc.). This stops all registered event watchers (by not touching them in 224etc.). This stops all registered event watchers (by not touching them in
170any way whatsoever, although you cnanot rely on this :). 225any way whatsoever, although you cannot rely on this :).
171 226
172=item ev_loop_destroy (loop) 227=item ev_loop_destroy (loop)
173 228
174Like C<ev_default_destroy>, but destroys an event loop created by an 229Like C<ev_default_destroy>, but destroys an event loop created by an
175earlier call to C<ev_loop_new>. 230earlier call to C<ev_loop_new>.
179This function reinitialises the kernel state for backends that have 234This function reinitialises the kernel state for backends that have
180one. Despite the name, you can call it anytime, but it makes most sense 235one. Despite the name, you can call it anytime, but it makes most sense
181after forking, in either the parent or child process (or both, but that 236after forking, in either the parent or child process (or both, but that
182again makes little sense). 237again makes little sense).
183 238
184You I<must> call this function after forking if and only if you want to 239You I<must> call this function in the child process after forking if and
185use the event library in both processes. If you just fork+exec, you don't 240only if you want to use the event library in both processes. If you just
186have to call it. 241fork+exec, you don't have to call it.
187 242
188The function itself is quite fast and its usually not a problem to call 243The function itself is quite fast and it's usually not a problem to call
189it just in case after a fork. To make this easy, the function will fit in 244it just in case after a fork. To make this easy, the function will fit in
190quite nicely into a call to C<pthread_atfork>: 245quite nicely into a call to C<pthread_atfork>:
191 246
192 pthread_atfork (0, 0, ev_default_fork); 247 pthread_atfork (0, 0, ev_default_fork);
193 248
200=item unsigned int ev_method (loop) 255=item unsigned int ev_method (loop)
201 256
202Returns one of the C<EVMETHOD_*> flags indicating the event backend in 257Returns one of the C<EVMETHOD_*> flags indicating the event backend in
203use. 258use.
204 259
205=item ev_tstamp = ev_now (loop) 260=item ev_tstamp ev_now (loop)
206 261
207Returns the current "event loop time", which is the time the event loop 262Returns the current "event loop time", which is the time the event loop
208got events and started processing them. This timestamp does not change 263got events and started processing them. This timestamp does not change
209as long as callbacks are being processed, and this is also the base time 264as long as callbacks are being processed, and this is also the base time
210used for relative timers. You can treat it as the timestamp of the event 265used for relative timers. You can treat it as the timestamp of the event
219If the flags argument is specified as 0, it will not return until either 274If the flags argument is specified as 0, it will not return until either
220no event watchers are active anymore or C<ev_unloop> was called. 275no event watchers are active anymore or C<ev_unloop> was called.
221 276
222A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle 277A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle
223those events and any outstanding ones, but will not block your process in 278those events and any outstanding ones, but will not block your process in
224case there are no events. 279case there are no events and will return after one iteration of the loop.
225 280
226A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if 281A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if
227neccessary) and will handle those and any outstanding ones. It will block 282neccessary) and will handle those and any outstanding ones. It will block
228your process until at least one new event arrives. 283your process until at least one new event arrives, and will return after
284one iteration of the loop.
229 285
230This flags value could be used to implement alternative looping 286This flags value could be used to implement alternative looping
231constructs, but the C<prepare> and C<check> watchers provide a better and 287constructs, but the C<prepare> and C<check> watchers provide a better and
232more generic mechanism. 288more generic mechanism.
233 289
290Here are the gory details of what ev_loop does:
291
292 1. If there are no active watchers (reference count is zero), return.
293 2. Queue and immediately call all prepare watchers.
294 3. If we have been forked, recreate the kernel state.
295 4. Update the kernel state with all outstanding changes.
296 5. Update the "event loop time".
297 6. Calculate for how long to block.
298 7. Block the process, waiting for events.
299 8. Update the "event loop time" and do time jump handling.
300 9. Queue all outstanding timers.
301 10. Queue all outstanding periodics.
302 11. If no events are pending now, queue all idle watchers.
303 12. Queue all check watchers.
304 13. Call all queued watchers in reverse order (i.e. check watchers first).
305 14. If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
306 was used, return, otherwise continue with step #1.
307
234=item ev_unloop (loop, how) 308=item ev_unloop (loop, how)
235 309
236Can be used to make a call to C<ev_loop> return early. The C<how> argument 310Can be used to make a call to C<ev_loop> return early (but only after it
311has processed all outstanding events). The C<how> argument must be either
237must be either C<EVUNLOOP_ONCE>, which will make the innermost C<ev_loop> 312C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or
238call return, or C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> 313C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.
239calls return.
240 314
241=item ev_ref (loop) 315=item ev_ref (loop)
242 316
243=item ev_unref (loop) 317=item ev_unref (loop)
244 318
245Ref/unref can be used to add or remove a refcount on the event loop: Every 319Ref/unref can be used to add or remove a reference count on the event
246watcher keeps one reference. If you have a long-runing watcher you never 320loop: Every watcher keeps one reference, and as long as the reference
247unregister that should not keep ev_loop from running, ev_unref() after 321count is nonzero, C<ev_loop> will not return on its own. If you have
248starting, and ev_ref() before stopping it. Libev itself uses this for 322a watcher you never unregister that should not keep C<ev_loop> from
249example for its internal signal pipe: It is not visible to you as a user 323returning, ev_unref() after starting, and ev_ref() before stopping it. For
250and should not keep C<ev_loop> from exiting if the work is done. It is 324example, libev itself uses this for its internal signal pipe: It is not
251also an excellent way to do this for generic recurring timers or from 325visible to the libev user and should not keep C<ev_loop> from exiting if
252within third-party libraries. Just remember to unref after start and ref 326no event watchers registered by it are active. It is also an excellent
253before stop. 327way to do this for generic recurring timers or from within third-party
328libraries. Just remember to I<unref after start> and I<ref before stop>.
254 329
255=back 330=back
256 331
257=head1 ANATOMY OF A WATCHER 332=head1 ANATOMY OF A WATCHER
258 333
259A watcher is a structure that you create and register to record your 334A watcher is a structure that you create and register to record your
260interest in some event. For instance, if you want to wait for STDIN to 335interest in some event. For instance, if you want to wait for STDIN to
261become readable, you would create an ev_io watcher for that: 336become readable, you would create an C<ev_io> watcher for that:
262 337
263 static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) 338 static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)
264 { 339 {
265 ev_io_stop (w); 340 ev_io_stop (w);
266 ev_unloop (loop, EVUNLOOP_ALL); 341 ev_unloop (loop, EVUNLOOP_ALL);
295 370
296As long as your watcher is active (has been started but not stopped) you 371As long as your watcher is active (has been started but not stopped) you
297must not touch the values stored in it. Most specifically you must never 372must not touch the values stored in it. Most specifically you must never
298reinitialise it or call its set method. 373reinitialise it or call its set method.
299 374
300You cna check whether an event is active by calling the C<ev_is_active 375You can check whether an event is active by calling the C<ev_is_active
301(watcher *)> macro. To see whether an event is outstanding (but the 376(watcher *)> macro. To see whether an event is outstanding (but the
302callback for it has not been called yet) you cna use the C<ev_is_pending 377callback for it has not been called yet) you can use the C<ev_is_pending
303(watcher *)> macro. 378(watcher *)> macro.
304 379
305Each and every callback receives the event loop pointer as first, the 380Each and every callback receives the event loop pointer as first, the
306registered watcher structure as second, and a bitset of received events as 381registered watcher structure as second, and a bitset of received events as
307third argument. 382third argument.
308 383
309The rceeived events usually include a single bit per event type received 384The received events usually include a single bit per event type received
310(you can receive multiple events at the same time). The possible bit masks 385(you can receive multiple events at the same time). The possible bit masks
311are: 386are:
312 387
313=over 4 388=over 4
314 389
315=item EV_READ 390=item C<EV_READ>
316 391
317=item EV_WRITE 392=item C<EV_WRITE>
318 393
319The file descriptor in the ev_io watcher has become readable and/or 394The file descriptor in the C<ev_io> watcher has become readable and/or
320writable. 395writable.
321 396
322=item EV_TIMEOUT 397=item C<EV_TIMEOUT>
323 398
324The ev_timer watcher has timed out. 399The C<ev_timer> watcher has timed out.
325 400
326=item EV_PERIODIC 401=item C<EV_PERIODIC>
327 402
328The ev_periodic watcher has timed out. 403The C<ev_periodic> watcher has timed out.
329 404
330=item EV_SIGNAL 405=item C<EV_SIGNAL>
331 406
332The signal specified in the ev_signal watcher has been received by a thread. 407The signal specified in the C<ev_signal> watcher has been received by a thread.
333 408
334=item EV_CHILD 409=item C<EV_CHILD>
335 410
336The pid specified in the ev_child watcher has received a status change. 411The pid specified in the C<ev_child> watcher has received a status change.
337 412
338=item EV_IDLE 413=item C<EV_IDLE>
339 414
340The ev_idle watcher has determined that you have nothing better to do. 415The C<ev_idle> watcher has determined that you have nothing better to do.
341 416
342=item EV_PREPARE 417=item C<EV_PREPARE>
343 418
344=item EV_CHECK 419=item C<EV_CHECK>
345 420
346All ev_prepare watchers are invoked just I<before> C<ev_loop> starts 421All C<ev_prepare> watchers are invoked just I<before> C<ev_loop> starts
347to gather new events, and all ev_check watchers are invoked just after 422to gather new events, and all C<ev_check> watchers are invoked just after
348C<ev_loop> has gathered them, but before it invokes any callbacks for any 423C<ev_loop> has gathered them, but before it invokes any callbacks for any
349received events. Callbacks of both watcher types can start and stop as 424received events. Callbacks of both watcher types can start and stop as
350many watchers as they want, and all of them will be taken into account 425many watchers as they want, and all of them will be taken into account
351(for example, a ev_prepare watcher might start an idle watcher to keep 426(for example, a C<ev_prepare> watcher might start an idle watcher to keep
352C<ev_loop> from blocking). 427C<ev_loop> from blocking).
353 428
354=item EV_ERROR 429=item C<EV_ERROR>
355 430
356An unspecified error has occured, the watcher has been stopped. This might 431An unspecified error has occured, the watcher has been stopped. This might
357happen because the watcher could not be properly started because libev 432happen because the watcher could not be properly started because libev
358ran out of memory, a file descriptor was found to be closed or any other 433ran out of memory, a file descriptor was found to be closed or any other
359problem. You best act on it by reporting the problem and somehow coping 434problem. You best act on it by reporting the problem and somehow coping
368=back 443=back
369 444
370=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER 445=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
371 446
372Each watcher has, by default, a member C<void *data> that you can change 447Each watcher has, by default, a member C<void *data> that you can change
373and read at any time, libev will completely ignore it. This cna be used 448and read at any time, libev will completely ignore it. This can be used
374to associate arbitrary data with your watcher. If you need more data and 449to associate arbitrary data with your watcher. If you need more data and
375don't want to allocate memory and store a pointer to it in that data 450don't want to allocate memory and store a pointer to it in that data
376member, you can also "subclass" the watcher type and provide your own 451member, you can also "subclass" the watcher type and provide your own
377data: 452data:
378 453
400=head1 WATCHER TYPES 475=head1 WATCHER TYPES
401 476
402This section describes each watcher in detail, but will not repeat 477This section describes each watcher in detail, but will not repeat
403information given in the last section. 478information given in the last section.
404 479
405=head2 struct ev_io - is my file descriptor readable or writable 480=head2 C<ev_io> - is this file descriptor readable or writable
406 481
407I/O watchers check whether a file descriptor is readable or writable 482I/O watchers check whether a file descriptor is readable or writable
408in each iteration of the event loop (This behaviour is called 483in each iteration of the event loop (This behaviour is called
409level-triggering because you keep receiving events as long as the 484level-triggering because you keep receiving events as long as the
410condition persists. Remember you cna stop the watcher if you don't want to 485condition persists. Remember you can stop the watcher if you don't want to
411act on the event and neither want to receive future events). 486act on the event and neither want to receive future events).
412 487
488In general you can register as many read and/or write event watchers per
489fd as you want (as long as you don't confuse yourself). Setting all file
490descriptors to non-blocking mode is also usually a good idea (but not
491required if you know what you are doing).
492
493You have to be careful with dup'ed file descriptors, though. Some backends
494(the linux epoll backend is a notable example) cannot handle dup'ed file
495descriptors correctly if you register interest in two or more fds pointing
496to the same underlying file/socket etc. description (that is, they share
497the same underlying "file open").
498
499If you must do this, then force the use of a known-to-be-good backend
500(at the time of this writing, this includes only EVMETHOD_SELECT and
501EVMETHOD_POLL).
502
413=over 4 503=over 4
414 504
415=item ev_io_init (ev_io *, callback, int fd, int events) 505=item ev_io_init (ev_io *, callback, int fd, int events)
416 506
417=item ev_io_set (ev_io *, int fd, int events) 507=item ev_io_set (ev_io *, int fd, int events)
418 508
419Configures an ev_io watcher. The fd is the file descriptor to rceeive 509Configures an C<ev_io> watcher. The fd is the file descriptor to rceeive
420events for and events is either C<EV_READ>, C<EV_WRITE> or C<EV_READ | 510events for and events is either C<EV_READ>, C<EV_WRITE> or C<EV_READ |
421EV_WRITE> to receive the given events. 511EV_WRITE> to receive the given events.
422 512
423=back 513=back
424 514
425=head2 struct ev_timer - relative and optionally recurring timeouts 515=head2 C<ev_timer> - relative and optionally recurring timeouts
426 516
427Timer watchers are simple relative timers that generate an event after a 517Timer watchers are simple relative timers that generate an event after a
428given time, and optionally repeating in regular intervals after that. 518given time, and optionally repeating in regular intervals after that.
429 519
430The timers are based on real time, that is, if you register an event that 520The timers are based on real time, that is, if you register an event that
431times out after an hour and youreset your system clock to last years 521times out after an hour and you reset your system clock to last years
432time, it will still time out after (roughly) and hour. "Roughly" because 522time, it will still time out after (roughly) and hour. "Roughly" because
433detecting time jumps is hard, and soem inaccuracies are unavoidable (the 523detecting time jumps is hard, and some inaccuracies are unavoidable (the
434monotonic clock option helps a lot here). 524monotonic clock option helps a lot here).
525
526The relative timeouts are calculated relative to the C<ev_now ()>
527time. This is usually the right thing as this timestamp refers to the time
528of the event triggering whatever timeout you are modifying/starting. If
529you suspect event processing to be delayed and you I<need> to base the timeout
530on the current time, use something like this to adjust for this:
531
532 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
533
534The callback is guarenteed to be invoked only when its timeout has passed,
535but if multiple timers become ready during the same loop iteration then
536order of execution is undefined.
435 537
436=over 4 538=over 4
437 539
438=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 540=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
439 541
445later, again, and again, until stopped manually. 547later, again, and again, until stopped manually.
446 548
447The timer itself will do a best-effort at avoiding drift, that is, if you 549The timer itself will do a best-effort at avoiding drift, that is, if you
448configure a timer to trigger every 10 seconds, then it will trigger at 550configure a timer to trigger every 10 seconds, then it will trigger at
449exactly 10 second intervals. If, however, your program cannot keep up with 551exactly 10 second intervals. If, however, your program cannot keep up with
450the timer (ecause it takes longer than those 10 seconds to do stuff) the 552the timer (because it takes longer than those 10 seconds to do stuff) the
451timer will not fire more than once per event loop iteration. 553timer will not fire more than once per event loop iteration.
452 554
453=item ev_timer_again (loop) 555=item ev_timer_again (loop)
454 556
455This will act as if the timer timed out and restart it again if it is 557This will act as if the timer timed out and restart it again if it is
462 564
463This sounds a bit complicated, but here is a useful and typical 565This sounds a bit complicated, but here is a useful and typical
464example: Imagine you have a tcp connection and you want a so-called idle 566example: Imagine you have a tcp connection and you want a so-called idle
465timeout, that is, you want to be called when there have been, say, 60 567timeout, that is, you want to be called when there have been, say, 60
466seconds of inactivity on the socket. The easiest way to do this is to 568seconds of inactivity on the socket. The easiest way to do this is to
467configure an ev_timer with after=repeat=60 and calling ev_timer_again each 569configure an C<ev_timer> with after=repeat=60 and calling ev_timer_again each
468time you successfully read or write some data. If you go into an idle 570time you successfully read or write some data. If you go into an idle
469state where you do not expect data to travel on the socket, you can stop 571state where you do not expect data to travel on the socket, you can stop
470the timer, and again will automatically restart it if need be. 572the timer, and again will automatically restart it if need be.
471 573
472=back 574=back
473 575
474=head2 ev_periodic - to cron or not to cron it 576=head2 C<ev_periodic> - to cron or not to cron
475 577
476Periodic watchers are also timers of a kind, but they are very versatile 578Periodic watchers are also timers of a kind, but they are very versatile
477(and unfortunately a bit complex). 579(and unfortunately a bit complex).
478 580
479Unlike ev_timer's, they are not based on real time (or relative time) 581Unlike C<ev_timer>'s, they are not based on real time (or relative time)
480but on wallclock time (absolute time). You can tell a periodic watcher 582but on wallclock time (absolute time). You can tell a periodic watcher
481to trigger "at" some specific point in time. For example, if you tell a 583to trigger "at" some specific point in time. For example, if you tell a
482periodic watcher to trigger in 10 seconds (by specifiying e.g. c<ev_now () 584periodic watcher to trigger in 10 seconds (by specifiying e.g. c<ev_now ()
483+ 10.>) and then reset your system clock to the last year, then it will 585+ 10.>) and then reset your system clock to the last year, then it will
484take a year to trigger the event (unlike an ev_timer, which would trigger 586take a year to trigger the event (unlike an C<ev_timer>, which would trigger
485roughly 10 seconds later and of course not if you reset your system time 587roughly 10 seconds later and of course not if you reset your system time
486again). 588again).
487 589
488They can also be used to implement vastly more complex timers, such as 590They can also be used to implement vastly more complex timers, such as
489triggering an event on eahc midnight, local time. 591triggering an event on eahc midnight, local time.
490 592
593As with timers, the callback is guarenteed to be invoked only when the
594time (C<at>) has been passed, but if multiple periodic timers become ready
595during the same loop iteration then order of execution is undefined.
596
491=over 4 597=over 4
492 598
493=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb) 599=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)
494 600
495=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb) 601=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)
496 602
497Lots of arguments, lets sort it out... There are basically three modes of 603Lots of arguments, lets sort it out... There are basically three modes of
498operation, and we will explain them from simplest to complex: 604operation, and we will explain them from simplest to complex:
499
500 605
501=over 4 606=over 4
502 607
503=item * absolute timer (interval = reschedule_cb = 0) 608=item * absolute timer (interval = reschedule_cb = 0)
504 609
518 623
519 ev_periodic_set (&periodic, 0., 3600., 0); 624 ev_periodic_set (&periodic, 0., 3600., 0);
520 625
521This doesn't mean there will always be 3600 seconds in between triggers, 626This doesn't mean there will always be 3600 seconds in between triggers,
522but only that the the callback will be called when the system time shows a 627but only that the the callback will be called when the system time shows a
523full hour (UTC), or more correct, when the system time is evenly divisible 628full hour (UTC), or more correctly, when the system time is evenly divisible
524by 3600. 629by 3600.
525 630
526Another way to think about it (for the mathematically inclined) is that 631Another way to think about it (for the mathematically inclined) is that
527ev_periodic will try to run the callback in this mode at the next possible 632C<ev_periodic> will try to run the callback in this mode at the next possible
528time where C<time = at (mod interval)>, regardless of any time jumps. 633time where C<time = at (mod interval)>, regardless of any time jumps.
529 634
530=item * manual reschedule mode (reschedule_cb = callback) 635=item * manual reschedule mode (reschedule_cb = callback)
531 636
532In this mode the values for C<interval> and C<at> are both being 637In this mode the values for C<interval> and C<at> are both being
533ignored. Instead, each time the periodic watcher gets scheduled, the 638ignored. Instead, each time the periodic watcher gets scheduled, the
534reschedule callback will be called with the watcher as first, and the 639reschedule callback will be called with the watcher as first, and the
535current time as second argument. 640current time as second argument.
536 641
537NOTE: I<This callback MUST NOT stop or destroy the periodic or any other 642NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,
538periodic watcher, ever, or make any event loop modificstions>. If you need 643ever, or make any event loop modifications>. If you need to stop it,
539to stop it, return 1e30 (or so, fudge fudge) and stop it afterwards. 644return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by
645starting a prepare watcher).
540 646
541Its prototype is c<ev_tstamp (*reschedule_cb)(struct ev_periodic *w, 647Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
542ev_tstamp now)>, e.g.: 648ev_tstamp now)>, e.g.:
543 649
544 static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) 650 static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
545 { 651 {
546 return now + 60.; 652 return now + 60.;
549It must return the next time to trigger, based on the passed time value 655It must return the next time to trigger, based on the passed time value
550(that is, the lowest time value larger than to the second argument). It 656(that is, the lowest time value larger than to the second argument). It
551will usually be called just before the callback will be triggered, but 657will usually be called just before the callback will be triggered, but
552might be called at other times, too. 658might be called at other times, too.
553 659
660NOTE: I<< This callback must always return a time that is later than the
661passed C<now> value >>. Not even C<now> itself will do, it I<must> be larger.
662
554This can be used to create very complex timers, such as a timer that 663This can be used to create very complex timers, such as a timer that
555triggers on each midnight, local time. To do this, you would calculate the 664triggers on each midnight, local time. To do this, you would calculate the
556next midnight after C<now> and return the timestamp value for this. How you do this 665next midnight after C<now> and return the timestamp value for this. How
557is, again, up to you (but it is not trivial). 666you do this is, again, up to you (but it is not trivial, which is the main
667reason I omitted it as an example).
558 668
559=back 669=back
560 670
561=item ev_periodic_again (loop, ev_periodic *) 671=item ev_periodic_again (loop, ev_periodic *)
562 672
565a different time than the last time it was called (e.g. in a crond like 675a different time than the last time it was called (e.g. in a crond like
566program when the crontabs have changed). 676program when the crontabs have changed).
567 677
568=back 678=back
569 679
570=head2 ev_signal - signal me when a signal gets signalled 680=head2 C<ev_signal> - signal me when a signal gets signalled
571 681
572Signal watchers will trigger an event when the process receives a specific 682Signal watchers will trigger an event when the process receives a specific
573signal one or more times. Even though signals are very asynchronous, libev 683signal one or more times. Even though signals are very asynchronous, libev
574will try its best to deliver signals synchronously, i.e. as part of the 684will try it's best to deliver signals synchronously, i.e. as part of the
575normal event processing, like any other event. 685normal event processing, like any other event.
576 686
577You cna configure as many watchers as you like per signal. Only when the 687You can configure as many watchers as you like per signal. Only when the
578first watcher gets started will libev actually register a signal watcher 688first watcher gets started will libev actually register a signal watcher
579with the kernel (thus it coexists with your own signal handlers as long 689with the kernel (thus it coexists with your own signal handlers as long
580as you don't register any with libev). Similarly, when the last signal 690as you don't register any with libev). Similarly, when the last signal
581watcher for a signal is stopped libev will reset the signal handler to 691watcher for a signal is stopped libev will reset the signal handler to
582SIG_DFL (regardless of what it was set to before). 692SIG_DFL (regardless of what it was set to before).
590Configures the watcher to trigger on the given signal number (usually one 700Configures the watcher to trigger on the given signal number (usually one
591of the C<SIGxxx> constants). 701of the C<SIGxxx> constants).
592 702
593=back 703=back
594 704
595=head2 ev_child - wait for pid status changes 705=head2 C<ev_child> - wait for pid status changes
596 706
597Child watchers trigger when your process receives a SIGCHLD in response to 707Child watchers trigger when your process receives a SIGCHLD in response to
598some child status changes (most typically when a child of yours dies). 708some child status changes (most typically when a child of yours dies).
599 709
600=over 4 710=over 4
604=item ev_child_set (ev_child *, int pid) 714=item ev_child_set (ev_child *, int pid)
605 715
606Configures the watcher to wait for status changes of process C<pid> (or 716Configures the watcher to wait for status changes of process C<pid> (or
607I<any> process if C<pid> is specified as C<0>). The callback can look 717I<any> process if C<pid> is specified as C<0>). The callback can look
608at the C<rstatus> member of the C<ev_child> watcher structure to see 718at the C<rstatus> member of the C<ev_child> watcher structure to see
609the status word (use the macros from C<sys/wait.h>). The C<rpid> member 719the status word (use the macros from C<sys/wait.h> and see your systems
610contains the pid of the process causing the status change. 720C<waitpid> documentation). The C<rpid> member contains the pid of the
721process causing the status change.
611 722
612=back 723=back
613 724
614=head2 ev_idle - when you've got nothing better to do 725=head2 C<ev_idle> - when you've got nothing better to do
615 726
616Idle watchers trigger events when there are no other I/O or timer (or 727Idle watchers trigger events when there are no other events are pending
617periodic) events pending. That is, as long as your process is busy 728(prepare, check and other idle watchers do not count). That is, as long
618handling sockets or timeouts it will not be called. But when your process 729as your process is busy handling sockets or timeouts (or even signals,
619is idle all idle watchers are being called again and again - until 730imagine) it will not be triggered. But when your process is idle all idle
731watchers are being called again and again, once per event loop iteration -
620stopped, that is, or your process receives more events. 732until stopped, that is, or your process receives more events and becomes
733busy.
621 734
622The most noteworthy effect is that as long as any idle watchers are 735The most noteworthy effect is that as long as any idle watchers are
623active, the process will not block when waiting for new events. 736active, the process will not block when waiting for new events.
624 737
625Apart from keeping your process non-blocking (which is a useful 738Apart from keeping your process non-blocking (which is a useful
635kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, 748kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
636believe me. 749believe me.
637 750
638=back 751=back
639 752
640=head2 prepare and check - your hooks into the event loop 753=head2 C<ev_prepare> and C<ev_check> - customise your event loop
641 754
642Prepare and check watchers usually (but not always) are used in 755Prepare and check watchers are usually (but not always) used in tandem:
643tandom. Prepare watchers get invoked before the process blocks and check 756prepare watchers get invoked before the process blocks and check watchers
644watchers afterwards. 757afterwards.
645 758
646Their main purpose is to integrate other event mechanisms into libev. This 759Their main purpose is to integrate other event mechanisms into libev. This
647could be used, for example, to track variable changes, implement your own 760could be used, for example, to track variable changes, implement your own
648watchers, integrate net-snmp or a coroutine library and lots more. 761watchers, integrate net-snmp or a coroutine library and lots more.
649 762
650This is done by examining in each prepare call which file descriptors need 763This is done by examining in each prepare call which file descriptors need
651to be watched by the other library, registering ev_io watchers for them 764to be watched by the other library, registering C<ev_io> watchers for
652and starting an ev_timer watcher for any timeouts (many libraries provide 765them and starting an C<ev_timer> watcher for any timeouts (many libraries
653just this functionality). Then, in the check watcher you check for any 766provide just this functionality). Then, in the check watcher you check for
654events that occured (by making your callbacks set soem flags for example) 767any events that occured (by checking the pending status of all watchers
655and call back into the library. 768and stopping them) and call back into the library. The I/O and timer
769callbacks will never actually be called (but must be valid nevertheless,
770because you never know, you know?).
656 771
657As another example, the perl Coro module uses these hooks to integrate 772As another example, the Perl Coro module uses these hooks to integrate
658coroutines into libev programs, by yielding to other active coroutines 773coroutines into libev programs, by yielding to other active coroutines
659during each prepare and only letting the process block if no coroutines 774during each prepare and only letting the process block if no coroutines
660are ready to run. 775are ready to run (it's actually more complicated: it only runs coroutines
776with priority higher than or equal to the event loop and one coroutine
777of lower priority, but only once, using idle watchers to keep the event
778loop from blocking if lower-priority coroutines are active, thus mapping
779low-priority coroutines to idle/background tasks).
661 780
662=over 4 781=over 4
663 782
664=item ev_prepare_init (ev_prepare *, callback) 783=item ev_prepare_init (ev_prepare *, callback)
665 784
666=item ev_check_init (ev_check *, callback) 785=item ev_check_init (ev_check *, callback)
667 786
668Initialises and configures the prepare or check watcher - they have no 787Initialises and configures the prepare or check watcher - they have no
669parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> 788parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
670macros, but using them is utterly, utterly pointless. 789macros, but using them is utterly, utterly and completely pointless.
671 790
672=back 791=back
673 792
674=head1 OTHER FUNCTIONS 793=head1 OTHER FUNCTIONS
675 794
676There are some other fucntions of possible interest. Described. Here. Now. 795There are some other functions of possible interest. Described. Here. Now.
677 796
678=over 4 797=over 4
679 798
680=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) 799=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)
681 800
682This function combines a simple timer and an I/O watcher, calls your 801This function combines a simple timer and an I/O watcher, calls your
683callback on whichever event happens first and automatically stop both 802callback on whichever event happens first and automatically stop both
684watchers. This is useful if you want to wait for a single event on an fd 803watchers. This is useful if you want to wait for a single event on an fd
685or timeout without havign to allocate/configure/start/stop/free one or 804or timeout without having to allocate/configure/start/stop/free one or
686more watchers yourself. 805more watchers yourself.
687 806
688If C<fd> is less than 0, then no I/O watcher will be started and events is 807If C<fd> is less than 0, then no I/O watcher will be started and events
689ignored. Otherwise, an ev_io watcher for the given C<fd> and C<events> set 808is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and
690will be craeted and started. 809C<events> set will be craeted and started.
691 810
692If C<timeout> is less than 0, then no timeout watcher will be 811If C<timeout> is less than 0, then no timeout watcher will be
693started. Otherwise an ev_timer watcher with after = C<timeout> (and repeat 812started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
694= 0) will be started. 813repeat = 0) will be started. While C<0> is a valid timeout, it is of
814dubious value.
695 815
696The callback has the type C<void (*cb)(int revents, void *arg)> and 816The callback has the type C<void (*cb)(int revents, void *arg)> and gets
697gets passed an events set (normally a combination of EV_ERROR, EV_READ, 817passed an C<revents> set like normal event callbacks (a combination of
698EV_WRITE or EV_TIMEOUT) and the C<arg> value passed to C<ev_once>: 818C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>
819value passed to C<ev_once>:
699 820
700 static void stdin_ready (int revents, void *arg) 821 static void stdin_ready (int revents, void *arg)
701 { 822 {
702 if (revents & EV_TIMEOUT) 823 if (revents & EV_TIMEOUT)
703 /* doh, nothing entered */ 824 /* doh, nothing entered */;
704 else if (revents & EV_READ) 825 else if (revents & EV_READ)
705 /* stdin might have data for us, joy! */ 826 /* stdin might have data for us, joy! */;
706 } 827 }
707 828
708 ev_once (STDIN_FILENO, EV_READm 10., stdin_ready, 0); 829 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
709 830
710=item ev_feed_event (loop, watcher, int events) 831=item ev_feed_event (loop, watcher, int events)
711 832
712Feeds the given event set into the event loop, as if the specified event 833Feeds the given event set into the event loop, as if the specified event
713has happened for the specified watcher (which must be a pointer to an 834had happened for the specified watcher (which must be a pointer to an
714initialised but not necessarily active event watcher). 835initialised but not necessarily started event watcher).
715 836
716=item ev_feed_fd_event (loop, int fd, int revents) 837=item ev_feed_fd_event (loop, int fd, int revents)
717 838
718Feed an event on the given fd, as if a file descriptor backend detected it. 839Feed an event on the given fd, as if a file descriptor backend detected
840the given events it.
719 841
720=item ev_feed_signal_event (loop, int signum) 842=item ev_feed_signal_event (loop, int signum)
721 843
722Feed an event as if the given signal occured (loop must be the default loop!). 844Feed an event as if the given signal occured (loop must be the default loop!).
723 845
724=back 846=back
725 847
848=head1 LIBEVENT EMULATION
849
850Libev offers a compatibility emulation layer for libevent. It cannot
851emulate the internals of libevent, so here are some usage hints:
852
853=over 4
854
855=item * Use it by including <event.h>, as usual.
856
857=item * The following members are fully supported: ev_base, ev_callback,
858ev_arg, ev_fd, ev_res, ev_events.
859
860=item * Avoid using ev_flags and the EVLIST_*-macros, while it is
861maintained by libev, it does not work exactly the same way as in libevent (consider
862it a private API).
863
864=item * Priorities are not currently supported. Initialising priorities
865will fail and all watchers will have the same priority, even though there
866is an ev_pri field.
867
868=item * Other members are not supported.
869
870=item * The libev emulation is I<not> ABI compatible to libevent, you need
871to use the libev header file and library.
872
873=back
874
875=head1 C++ SUPPORT
876
877TBD.
878
726=head1 AUTHOR 879=head1 AUTHOR
727 880
728Marc Lehmann <libev@schmorp.de>. 881Marc Lehmann <libev@schmorp.de>.
729 882

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines