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

Comparing libev/ev.pod (file contents):
Revision 1.7 by root, Mon Nov 12 08:16:02 2007 UTC vs.
Revision 1.31 by root, Fri Nov 23 05:00:45 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines