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

Comparing libev/ev.pod (file contents):
Revision 1.334 by root, Mon Oct 25 10:30:23 2010 UTC vs.
Revision 1.357 by root, Tue Jan 11 02:15:58 2011 UTC

241the current system, you would need to look at C<ev_embeddable_backends () 241the current system, you would need to look at C<ev_embeddable_backends ()
242& ev_supported_backends ()>, likewise for recommended ones. 242& ev_supported_backends ()>, likewise for recommended ones.
243 243
244See the description of C<ev_embed> watchers for more info. 244See the description of C<ev_embed> watchers for more info.
245 245
246=item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT] 246=item ev_set_allocator (void *(*cb)(void *ptr, long size))
247 247
248Sets the allocation function to use (the prototype is similar - the 248Sets the allocation function to use (the prototype is similar - the
249semantics are identical to the C<realloc> C89/SuS/POSIX function). It is 249semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
250used to allocate and free memory (no surprises here). If it returns zero 250used to allocate and free memory (no surprises here). If it returns zero
251when memory needs to be allocated (C<size != 0>), the library might abort 251when memory needs to be allocated (C<size != 0>), the library might abort
277 } 277 }
278 278
279 ... 279 ...
280 ev_set_allocator (persistent_realloc); 280 ev_set_allocator (persistent_realloc);
281 281
282=item ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT] 282=item ev_set_syserr_cb (void (*cb)(const char *msg))
283 283
284Set the callback function to call on a retryable system call error (such 284Set the callback function to call on a retryable system call error (such
285as failed select, poll, epoll_wait). The message is a printable string 285as failed select, poll, epoll_wait). The message is a printable string
286indicating the system call or subsystem causing the problem. If this 286indicating the system call or subsystem causing the problem. If this
287callback is set, then libev will expect it to remedy the situation, no 287callback is set, then libev will expect it to remedy the situation, no
299 } 299 }
300 300
301 ... 301 ...
302 ev_set_syserr_cb (fatal_error); 302 ev_set_syserr_cb (fatal_error);
303 303
304=item ev_feed_signal (int signum)
305
306This function can be used to "simulate" a signal receive. It is completely
307safe to call this function at any time, from any context, including signal
308handlers or random threads.
309
310Its main use is to customise signal handling in your process, especially
311in the presence of threads. For example, you could block signals
312by default in all threads (and specifying C<EVFLAG_NOSIGMASK> when
313creating any loops), and in one thread, use C<sigwait> or any other
314mechanism to wait for signals, then "deliver" them to libev by calling
315C<ev_feed_signal>.
316
304=back 317=back
305 318
306=head1 FUNCTIONS CONTROLLING EVENT LOOPS 319=head1 FUNCTIONS CONTROLLING EVENT LOOPS
307 320
308An event loop is described by a C<struct ev_loop *> (the C<struct> is 321An event loop is described by a C<struct ev_loop *> (the C<struct> is
355=item struct ev_loop *ev_loop_new (unsigned int flags) 368=item struct ev_loop *ev_loop_new (unsigned int flags)
356 369
357This will create and initialise a new event loop object. If the loop 370This will create and initialise a new event loop object. If the loop
358could not be initialised, returns false. 371could not be initialised, returns false.
359 372
360Note that this function I<is> thread-safe, and one common way to use 373This function is thread-safe, and one common way to use libev with
361libev with threads is indeed to create one loop per thread, and using the 374threads is indeed to create one loop per thread, and using the default
362default loop in the "main" or "initial" thread. 375loop in the "main" or "initial" thread.
363 376
364The flags argument can be used to specify special behaviour or specific 377The flags argument can be used to specify special behaviour or specific
365backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>). 378backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).
366 379
367The following flags are supported: 380The following flags are supported:
402environment variable. 415environment variable.
403 416
404=item C<EVFLAG_NOINOTIFY> 417=item C<EVFLAG_NOINOTIFY>
405 418
406When this flag is specified, then libev will not attempt to use the 419When this flag is specified, then libev will not attempt to use the
407I<inotify> API for it's C<ev_stat> watchers. Apart from debugging and 420I<inotify> API for its C<ev_stat> watchers. Apart from debugging and
408testing, this flag can be useful to conserve inotify file descriptors, as 421testing, this flag can be useful to conserve inotify file descriptors, as
409otherwise each loop using C<ev_stat> watchers consumes one inotify handle. 422otherwise each loop using C<ev_stat> watchers consumes one inotify handle.
410 423
411=item C<EVFLAG_SIGNALFD> 424=item C<EVFLAG_SIGNALFD>
412 425
413When this flag is specified, then libev will attempt to use the 426When this flag is specified, then libev will attempt to use the
414I<signalfd> API for it's C<ev_signal> (and C<ev_child>) watchers. This API 427I<signalfd> API for its C<ev_signal> (and C<ev_child>) watchers. This API
415delivers signals synchronously, which makes it both faster and might make 428delivers signals synchronously, which makes it both faster and might make
416it possible to get the queued signal data. It can also simplify signal 429it possible to get the queued signal data. It can also simplify signal
417handling with threads, as long as you properly block signals in your 430handling with threads, as long as you properly block signals in your
418threads that are not interested in handling them. 431threads that are not interested in handling them.
419 432
420Signalfd will not be used by default as this changes your signal mask, and 433Signalfd will not be used by default as this changes your signal mask, and
421there are a lot of shoddy libraries and programs (glib's threadpool for 434there are a lot of shoddy libraries and programs (glib's threadpool for
422example) that can't properly initialise their signal masks. 435example) that can't properly initialise their signal masks.
436
437=item C<EVFLAG_NOSIGMASK>
438
439When this flag is specified, then libev will avoid to modify the signal
440mask. Specifically, this means you ahve to make sure signals are unblocked
441when you want to receive them.
442
443This behaviour is useful when you want to do your own signal handling, or
444want to handle signals only in specific threads and want to avoid libev
445unblocking the signals.
446
447This flag's behaviour will become the default in future versions of libev.
423 448
424=item C<EVBACKEND_SELECT> (value 1, portable select backend) 449=item C<EVBACKEND_SELECT> (value 1, portable select backend)
425 450
426This is your standard select(2) backend. Not I<completely> standard, as 451This is your standard select(2) backend. Not I<completely> standard, as
427libev tries to roll its own fd_set with no limits on the number of fds, 452libev tries to roll its own fd_set with no limits on the number of fds,
463epoll scales either O(1) or O(active_fds). 488epoll scales either O(1) or O(active_fds).
464 489
465The epoll mechanism deserves honorable mention as the most misdesigned 490The epoll mechanism deserves honorable mention as the most misdesigned
466of the more advanced event mechanisms: mere annoyances include silently 491of the more advanced event mechanisms: mere annoyances include silently
467dropping file descriptors, requiring a system call per change per file 492dropping file descriptors, requiring a system call per change per file
468descriptor (and unnecessary guessing of parameters), problems with dup and 493descriptor (and unnecessary guessing of parameters), problems with dup,
494returning before the timeout value, resulting in additional iterations
495(and only giving 5ms accuracy while select on the same platform gives
469so on. The biggest issue is fork races, however - if a program forks then 4960.1ms) and so on. The biggest issue is fork races, however - if a program
470I<both> parent and child process have to recreate the epoll set, which can 497forks then I<both> parent and child process have to recreate the epoll
471take considerable time (one syscall per file descriptor) and is of course 498set, which can take considerable time (one syscall per file descriptor)
472hard to detect. 499and is of course hard to detect.
473 500
474Epoll is also notoriously buggy - embedding epoll fds I<should> work, but 501Epoll is also notoriously buggy - embedding epoll fds I<should> work, but
475of course I<doesn't>, and epoll just loves to report events for totally 502of course I<doesn't>, and epoll just loves to report events for totally
476I<different> file descriptors (even already closed ones, so one cannot 503I<different> file descriptors (even already closed ones, so one cannot
477even remove them from the set) than registered in the set (especially 504even remove them from the set) than registered in the set (especially
479employing an additional generation counter and comparing that against the 506employing an additional generation counter and comparing that against the
480events to filter out spurious ones, recreating the set when required. Last 507events to filter out spurious ones, recreating the set when required. Last
481not least, it also refuses to work with some file descriptors which work 508not least, it also refuses to work with some file descriptors which work
482perfectly fine with C<select> (files, many character devices...). 509perfectly fine with C<select> (files, many character devices...).
483 510
511Epoll is truly the train wreck analog among event poll mechanisms,
512a frankenpoll, cobbled together in a hurry, no thought to design or
513interaction with others.
514
484While stopping, setting and starting an I/O watcher in the same iteration 515While stopping, setting and starting an I/O watcher in the same iteration
485will result in some caching, there is still a system call per such 516will result in some caching, there is still a system call per such
486incident (because the same I<file descriptor> could point to a different 517incident (because the same I<file descriptor> could point to a different
487I<file description> now), so its best to avoid that. Also, C<dup ()>'ed 518I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
488file descriptors might not work very well if you register events for both 519file descriptors might not work very well if you register events for both
553=item C<EVBACKEND_PORT> (value 32, Solaris 10) 584=item C<EVBACKEND_PORT> (value 32, Solaris 10)
554 585
555This uses the Solaris 10 event port mechanism. As with everything on Solaris, 586This uses the Solaris 10 event port mechanism. As with everything on Solaris,
556it's really slow, but it still scales very well (O(active_fds)). 587it's really slow, but it still scales very well (O(active_fds)).
557 588
558Please note that Solaris event ports can deliver a lot of spurious
559notifications, so you need to use non-blocking I/O or other means to avoid
560blocking when no data (or space) is available.
561
562While this backend scales well, it requires one system call per active 589While this backend scales well, it requires one system call per active
563file descriptor per loop iteration. For small and medium numbers of file 590file descriptor per loop iteration. For small and medium numbers of file
564descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend 591descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
565might perform better. 592might perform better.
566 593
567On the positive side, with the exception of the spurious readiness 594On the positive side, this backend actually performed fully to
568notifications, this backend actually performed fully to specification
569in all tests and is fully embeddable, which is a rare feat among the 595specification in all tests and is fully embeddable, which is a rare feat
570OS-specific backends (I vastly prefer correctness over speed hacks). 596among the OS-specific backends (I vastly prefer correctness over speed
597hacks).
598
599On the negative side, the interface is I<bizarre> - so bizarre that
600even sun itself gets it wrong in their code examples: The event polling
601function sometimes returning events to the caller even though an error
602occurred, but with no indication whether it has done so or not (yes, it's
603even documented that way) - deadly for edge-triggered interfaces where
604you absolutely have to know whether an event occurred or not because you
605have to re-arm the watcher.
606
607Fortunately libev seems to be able to work around these idiocies.
571 608
572This backend maps C<EV_READ> and C<EV_WRITE> in the same way as 609This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
573C<EVBACKEND_POLL>. 610C<EVBACKEND_POLL>.
574 611
575=item C<EVBACKEND_ALL> 612=item C<EVBACKEND_ALL>
576 613
577Try all backends (even potentially broken ones that wouldn't be tried 614Try all backends (even potentially broken ones that wouldn't be tried
578with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as 615with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
579C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>. 616C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
580 617
581It is definitely not recommended to use this flag. 618It is definitely not recommended to use this flag, use whatever
619C<ev_recommended_backends ()> returns, or simply do not specify a backend
620at all.
621
622=item C<EVBACKEND_MASK>
623
624Not a backend at all, but a mask to select all backend bits from a
625C<flags> value, in case you want to mask out any backends from a flags
626value (e.g. when modifying the C<LIBEV_FLAGS> environment variable).
582 627
583=back 628=back
584 629
585If one or more of the backend flags are or'ed into the flags value, 630If one or more of the backend flags are or'ed into the flags value,
586then only these backends will be tried (in the reverse order as listed 631then only these backends will be tried (in the reverse order as listed
615This function is normally used on loop objects allocated by 660This function is normally used on loop objects allocated by
616C<ev_loop_new>, but it can also be used on the default loop returned by 661C<ev_loop_new>, but it can also be used on the default loop returned by
617C<ev_default_loop>, in which case it is not thread-safe. 662C<ev_default_loop>, in which case it is not thread-safe.
618 663
619Note that it is not advisable to call this function on the default loop 664Note that it is not advisable to call this function on the default loop
620except in the rare occasion where you really need to free it's resources. 665except in the rare occasion where you really need to free its resources.
621If you need dynamically allocated loops it is better to use C<ev_loop_new> 666If you need dynamically allocated loops it is better to use C<ev_loop_new>
622and C<ev_loop_destroy>. 667and C<ev_loop_destroy>.
623 668
624=item ev_loop_fork (loop) 669=item ev_loop_fork (loop)
625 670
673prepare and check phases. 718prepare and check phases.
674 719
675=item unsigned int ev_depth (loop) 720=item unsigned int ev_depth (loop)
676 721
677Returns the number of times C<ev_run> was entered minus the number of 722Returns the number of times C<ev_run> was entered minus the number of
678times C<ev_run> was exited, in other words, the recursion depth. 723times C<ev_run> was exited normally, in other words, the recursion depth.
679 724
680Outside C<ev_run>, this number is zero. In a callback, this number is 725Outside C<ev_run>, this number is zero. In a callback, this number is
681C<1>, unless C<ev_run> was invoked recursively (or from another thread), 726C<1>, unless C<ev_run> was invoked recursively (or from another thread),
682in which case it is higher. 727in which case it is higher.
683 728
684Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread 729Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread,
685etc.), doesn't count as "exit" - consider this as a hint to avoid such 730throwing an exception etc.), doesn't count as "exit" - consider this
686ungentleman-like behaviour unless it's really convenient. 731as a hint to avoid such ungentleman-like behaviour unless it's really
732convenient, in which case it is fully supported.
687 733
688=item unsigned int ev_backend (loop) 734=item unsigned int ev_backend (loop)
689 735
690Returns one of the C<EVBACKEND_*> flags indicating the event backend in 736Returns one of the C<EVBACKEND_*> flags indicating the event backend in
691use. 737use.
752relying on all watchers to be stopped when deciding when a program has 798relying on all watchers to be stopped when deciding when a program has
753finished (especially in interactive programs), but having a program 799finished (especially in interactive programs), but having a program
754that automatically loops as long as it has to and no longer by virtue 800that automatically loops as long as it has to and no longer by virtue
755of relying on its watchers stopping correctly, that is truly a thing of 801of relying on its watchers stopping correctly, that is truly a thing of
756beauty. 802beauty.
803
804This function is also I<mostly> exception-safe - you can break out of
805a C<ev_run> call by calling C<longjmp> in a callback, throwing a C++
806exception and so on. This does not decrement the C<ev_depth> value, nor
807will it clear any outstanding C<EVBREAK_ONE> breaks.
757 808
758A flags value of C<EVRUN_NOWAIT> will look for new events, will handle 809A flags value of C<EVRUN_NOWAIT> will look for new events, will handle
759those events and any already outstanding ones, but will not wait and 810those events and any already outstanding ones, but will not wait and
760block your process in case there are no events and will return after one 811block your process in case there are no events and will return after one
761iteration of the loop. This is sometimes useful to poll and handle new 812iteration of the loop. This is sometimes useful to poll and handle new
823Can be used to make a call to C<ev_run> return early (but only after it 874Can be used to make a call to C<ev_run> return early (but only after it
824has processed all outstanding events). The C<how> argument must be either 875has processed all outstanding events). The C<how> argument must be either
825C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or 876C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or
826C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return. 877C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.
827 878
828This "unloop state" will be cleared when entering C<ev_run> again. 879This "break state" will be cleared on the next call to C<ev_run>.
829 880
830It is safe to call C<ev_break> from outside any C<ev_run> calls. ##TODO## 881It is safe to call C<ev_break> from outside any C<ev_run> calls, too, in
882which case it will have no effect.
831 883
832=item ev_ref (loop) 884=item ev_ref (loop)
833 885
834=item ev_unref (loop) 886=item ev_unref (loop)
835 887
856running when nothing else is active. 908running when nothing else is active.
857 909
858 ev_signal exitsig; 910 ev_signal exitsig;
859 ev_signal_init (&exitsig, sig_cb, SIGINT); 911 ev_signal_init (&exitsig, sig_cb, SIGINT);
860 ev_signal_start (loop, &exitsig); 912 ev_signal_start (loop, &exitsig);
861 evf_unref (loop); 913 ev_unref (loop);
862 914
863Example: For some weird reason, unregister the above signal handler again. 915Example: For some weird reason, unregister the above signal handler again.
864 916
865 ev_ref (loop); 917 ev_ref (loop);
866 ev_signal_stop (loop, &exitsig); 918 ev_signal_stop (loop, &exitsig);
978See also the locking example in the C<THREADS> section later in this 1030See also the locking example in the C<THREADS> section later in this
979document. 1031document.
980 1032
981=item ev_set_userdata (loop, void *data) 1033=item ev_set_userdata (loop, void *data)
982 1034
983=item ev_userdata (loop) 1035=item void *ev_userdata (loop)
984 1036
985Set and retrieve a single C<void *> associated with a loop. When 1037Set and retrieve a single C<void *> associated with a loop. When
986C<ev_set_userdata> has never been called, then C<ev_userdata> returns 1038C<ev_set_userdata> has never been called, then C<ev_userdata> returns
987C<0.> 1039C<0>.
988 1040
989These two functions can be used to associate arbitrary data with a loop, 1041These two functions can be used to associate arbitrary data with a loop,
990and are intended solely for the C<invoke_pending_cb>, C<release> and 1042and are intended solely for the C<invoke_pending_cb>, C<release> and
991C<acquire> callbacks described above, but of course can be (ab-)used for 1043C<acquire> callbacks described above, but of course can be (ab-)used for
992any other purpose as well. 1044any other purpose as well.
1154programs, though, as the fd could already be closed and reused for another 1206programs, though, as the fd could already be closed and reused for another
1155thing, so beware. 1207thing, so beware.
1156 1208
1157=back 1209=back
1158 1210
1211=head2 GENERIC WATCHER FUNCTIONS
1212
1213=over 4
1214
1215=item C<ev_init> (ev_TYPE *watcher, callback)
1216
1217This macro initialises the generic portion of a watcher. The contents
1218of the watcher object can be arbitrary (so C<malloc> will do). Only
1219the generic parts of the watcher are initialised, you I<need> to call
1220the type-specific C<ev_TYPE_set> macro afterwards to initialise the
1221type-specific parts. For each type there is also a C<ev_TYPE_init> macro
1222which rolls both calls into one.
1223
1224You can reinitialise a watcher at any time as long as it has been stopped
1225(or never started) and there are no pending events outstanding.
1226
1227The callback is always of type C<void (*)(struct ev_loop *loop, ev_TYPE *watcher,
1228int revents)>.
1229
1230Example: Initialise an C<ev_io> watcher in two steps.
1231
1232 ev_io w;
1233 ev_init (&w, my_cb);
1234 ev_io_set (&w, STDIN_FILENO, EV_READ);
1235
1236=item C<ev_TYPE_set> (ev_TYPE *watcher, [args])
1237
1238This macro initialises the type-specific parts of a watcher. You need to
1239call C<ev_init> at least once before you call this macro, but you can
1240call C<ev_TYPE_set> any number of times. You must not, however, call this
1241macro on a watcher that is active (it can be pending, however, which is a
1242difference to the C<ev_init> macro).
1243
1244Although some watcher types do not have type-specific arguments
1245(e.g. C<ev_prepare>) you still need to call its C<set> macro.
1246
1247See C<ev_init>, above, for an example.
1248
1249=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])
1250
1251This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro
1252calls into a single call. This is the most convenient method to initialise
1253a watcher. The same limitations apply, of course.
1254
1255Example: Initialise and set an C<ev_io> watcher in one step.
1256
1257 ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
1258
1259=item C<ev_TYPE_start> (loop, ev_TYPE *watcher)
1260
1261Starts (activates) the given watcher. Only active watchers will receive
1262events. If the watcher is already active nothing will happen.
1263
1264Example: Start the C<ev_io> watcher that is being abused as example in this
1265whole section.
1266
1267 ev_io_start (EV_DEFAULT_UC, &w);
1268
1269=item C<ev_TYPE_stop> (loop, ev_TYPE *watcher)
1270
1271Stops the given watcher if active, and clears the pending status (whether
1272the watcher was active or not).
1273
1274It is possible that stopped watchers are pending - for example,
1275non-repeating timers are being stopped when they become pending - but
1276calling C<ev_TYPE_stop> ensures that the watcher is neither active nor
1277pending. If you want to free or reuse the memory used by the watcher it is
1278therefore a good idea to always call its C<ev_TYPE_stop> function.
1279
1280=item bool ev_is_active (ev_TYPE *watcher)
1281
1282Returns a true value iff the watcher is active (i.e. it has been started
1283and not yet been stopped). As long as a watcher is active you must not modify
1284it.
1285
1286=item bool ev_is_pending (ev_TYPE *watcher)
1287
1288Returns a true value iff the watcher is pending, (i.e. it has outstanding
1289events but its callback has not yet been invoked). As long as a watcher
1290is pending (but not active) you must not call an init function on it (but
1291C<ev_TYPE_set> is safe), you must not change its priority, and you must
1292make sure the watcher is available to libev (e.g. you cannot C<free ()>
1293it).
1294
1295=item callback ev_cb (ev_TYPE *watcher)
1296
1297Returns the callback currently set on the watcher.
1298
1299=item ev_cb_set (ev_TYPE *watcher, callback)
1300
1301Change the callback. You can change the callback at virtually any time
1302(modulo threads).
1303
1304=item ev_set_priority (ev_TYPE *watcher, int priority)
1305
1306=item int ev_priority (ev_TYPE *watcher)
1307
1308Set and query the priority of the watcher. The priority is a small
1309integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
1310(default: C<-2>). Pending watchers with higher priority will be invoked
1311before watchers with lower priority, but priority will not keep watchers
1312from being executed (except for C<ev_idle> watchers).
1313
1314If you need to suppress invocation when higher priority events are pending
1315you need to look at C<ev_idle> watchers, which provide this functionality.
1316
1317You I<must not> change the priority of a watcher as long as it is active or
1318pending.
1319
1320Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
1321fine, as long as you do not mind that the priority value you query might
1322or might not have been clamped to the valid range.
1323
1324The default priority used by watchers when no priority has been set is
1325always C<0>, which is supposed to not be too high and not be too low :).
1326
1327See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1328priorities.
1329
1330=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1331
1332Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
1333C<loop> nor C<revents> need to be valid as long as the watcher callback
1334can deal with that fact, as both are simply passed through to the
1335callback.
1336
1337=item int ev_clear_pending (loop, ev_TYPE *watcher)
1338
1339If the watcher is pending, this function clears its pending status and
1340returns its C<revents> bitset (as if its callback was invoked). If the
1341watcher isn't pending it does nothing and returns C<0>.
1342
1343Sometimes it can be useful to "poll" a watcher instead of waiting for its
1344callback to be invoked, which can be accomplished with this function.
1345
1346=item ev_feed_event (loop, ev_TYPE *watcher, int revents)
1347
1348Feeds the given event set into the event loop, as if the specified event
1349had happened for the specified watcher (which must be a pointer to an
1350initialised but not necessarily started event watcher). Obviously you must
1351not free the watcher as long as it has pending events.
1352
1353Stopping the watcher, letting libev invoke it, or calling
1354C<ev_clear_pending> will clear the pending event, even if the watcher was
1355not started in the first place.
1356
1357See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1358functions that do not need a watcher.
1359
1360=back
1361
1362See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR
1363OWN COMPOSITE WATCHERS> idioms.
1364
1159=head2 WATCHER STATES 1365=head2 WATCHER STATES
1160 1366
1161There are various watcher states mentioned throughout this manual - 1367There are various watcher states mentioned throughout this manual -
1162active, pending and so on. In this section these states and the rules to 1368active, pending and so on. In this section these states and the rules to
1163transition between them will be described in more detail - and while these 1369transition between them will be described in more detail - and while these
1212While stopped (and not pending) the watcher is essentially in the 1418While stopped (and not pending) the watcher is essentially in the
1213initialised state, that is it can be reused, moved, modified in any way 1419initialised state, that is it can be reused, moved, modified in any way
1214you wish. 1420you wish.
1215 1421
1216=back 1422=back
1217
1218=head2 GENERIC WATCHER FUNCTIONS
1219
1220=over 4
1221
1222=item C<ev_init> (ev_TYPE *watcher, callback)
1223
1224This macro initialises the generic portion of a watcher. The contents
1225of the watcher object can be arbitrary (so C<malloc> will do). Only
1226the generic parts of the watcher are initialised, you I<need> to call
1227the type-specific C<ev_TYPE_set> macro afterwards to initialise the
1228type-specific parts. For each type there is also a C<ev_TYPE_init> macro
1229which rolls both calls into one.
1230
1231You can reinitialise a watcher at any time as long as it has been stopped
1232(or never started) and there are no pending events outstanding.
1233
1234The callback is always of type C<void (*)(struct ev_loop *loop, ev_TYPE *watcher,
1235int revents)>.
1236
1237Example: Initialise an C<ev_io> watcher in two steps.
1238
1239 ev_io w;
1240 ev_init (&w, my_cb);
1241 ev_io_set (&w, STDIN_FILENO, EV_READ);
1242
1243=item C<ev_TYPE_set> (ev_TYPE *watcher, [args])
1244
1245This macro initialises the type-specific parts of a watcher. You need to
1246call C<ev_init> at least once before you call this macro, but you can
1247call C<ev_TYPE_set> any number of times. You must not, however, call this
1248macro on a watcher that is active (it can be pending, however, which is a
1249difference to the C<ev_init> macro).
1250
1251Although some watcher types do not have type-specific arguments
1252(e.g. C<ev_prepare>) you still need to call its C<set> macro.
1253
1254See C<ev_init>, above, for an example.
1255
1256=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])
1257
1258This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro
1259calls into a single call. This is the most convenient method to initialise
1260a watcher. The same limitations apply, of course.
1261
1262Example: Initialise and set an C<ev_io> watcher in one step.
1263
1264 ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
1265
1266=item C<ev_TYPE_start> (loop, ev_TYPE *watcher)
1267
1268Starts (activates) the given watcher. Only active watchers will receive
1269events. If the watcher is already active nothing will happen.
1270
1271Example: Start the C<ev_io> watcher that is being abused as example in this
1272whole section.
1273
1274 ev_io_start (EV_DEFAULT_UC, &w);
1275
1276=item C<ev_TYPE_stop> (loop, ev_TYPE *watcher)
1277
1278Stops the given watcher if active, and clears the pending status (whether
1279the watcher was active or not).
1280
1281It is possible that stopped watchers are pending - for example,
1282non-repeating timers are being stopped when they become pending - but
1283calling C<ev_TYPE_stop> ensures that the watcher is neither active nor
1284pending. If you want to free or reuse the memory used by the watcher it is
1285therefore a good idea to always call its C<ev_TYPE_stop> function.
1286
1287=item bool ev_is_active (ev_TYPE *watcher)
1288
1289Returns a true value iff the watcher is active (i.e. it has been started
1290and not yet been stopped). As long as a watcher is active you must not modify
1291it.
1292
1293=item bool ev_is_pending (ev_TYPE *watcher)
1294
1295Returns a true value iff the watcher is pending, (i.e. it has outstanding
1296events but its callback has not yet been invoked). As long as a watcher
1297is pending (but not active) you must not call an init function on it (but
1298C<ev_TYPE_set> is safe), you must not change its priority, and you must
1299make sure the watcher is available to libev (e.g. you cannot C<free ()>
1300it).
1301
1302=item callback ev_cb (ev_TYPE *watcher)
1303
1304Returns the callback currently set on the watcher.
1305
1306=item ev_cb_set (ev_TYPE *watcher, callback)
1307
1308Change the callback. You can change the callback at virtually any time
1309(modulo threads).
1310
1311=item ev_set_priority (ev_TYPE *watcher, int priority)
1312
1313=item int ev_priority (ev_TYPE *watcher)
1314
1315Set and query the priority of the watcher. The priority is a small
1316integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
1317(default: C<-2>). Pending watchers with higher priority will be invoked
1318before watchers with lower priority, but priority will not keep watchers
1319from being executed (except for C<ev_idle> watchers).
1320
1321If you need to suppress invocation when higher priority events are pending
1322you need to look at C<ev_idle> watchers, which provide this functionality.
1323
1324You I<must not> change the priority of a watcher as long as it is active or
1325pending.
1326
1327Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
1328fine, as long as you do not mind that the priority value you query might
1329or might not have been clamped to the valid range.
1330
1331The default priority used by watchers when no priority has been set is
1332always C<0>, which is supposed to not be too high and not be too low :).
1333
1334See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1335priorities.
1336
1337=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1338
1339Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
1340C<loop> nor C<revents> need to be valid as long as the watcher callback
1341can deal with that fact, as both are simply passed through to the
1342callback.
1343
1344=item int ev_clear_pending (loop, ev_TYPE *watcher)
1345
1346If the watcher is pending, this function clears its pending status and
1347returns its C<revents> bitset (as if its callback was invoked). If the
1348watcher isn't pending it does nothing and returns C<0>.
1349
1350Sometimes it can be useful to "poll" a watcher instead of waiting for its
1351callback to be invoked, which can be accomplished with this function.
1352
1353=item ev_feed_event (loop, ev_TYPE *watcher, int revents)
1354
1355Feeds the given event set into the event loop, as if the specified event
1356had happened for the specified watcher (which must be a pointer to an
1357initialised but not necessarily started event watcher). Obviously you must
1358not free the watcher as long as it has pending events.
1359
1360Stopping the watcher, letting libev invoke it, or calling
1361C<ev_clear_pending> will clear the pending event, even if the watcher was
1362not started in the first place.
1363
1364See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1365functions that do not need a watcher.
1366
1367=back
1368
1369
1370=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
1371
1372Each watcher has, by default, a member C<void *data> that you can change
1373and read at any time: libev will completely ignore it. This can be used
1374to associate arbitrary data with your watcher. If you need more data and
1375don't want to allocate memory and store a pointer to it in that data
1376member, you can also "subclass" the watcher type and provide your own
1377data:
1378
1379 struct my_io
1380 {
1381 ev_io io;
1382 int otherfd;
1383 void *somedata;
1384 struct whatever *mostinteresting;
1385 };
1386
1387 ...
1388 struct my_io w;
1389 ev_io_init (&w.io, my_cb, fd, EV_READ);
1390
1391And since your callback will be called with a pointer to the watcher, you
1392can cast it back to your own type:
1393
1394 static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
1395 {
1396 struct my_io *w = (struct my_io *)w_;
1397 ...
1398 }
1399
1400More interesting and less C-conformant ways of casting your callback type
1401instead have been omitted.
1402
1403Another common scenario is to use some data structure with multiple
1404embedded watchers:
1405
1406 struct my_biggy
1407 {
1408 int some_data;
1409 ev_timer t1;
1410 ev_timer t2;
1411 }
1412
1413In this case getting the pointer to C<my_biggy> is a bit more
1414complicated: Either you store the address of your C<my_biggy> struct
1415in the C<data> member of the watcher (for woozies), or you need to use
1416some pointer arithmetic using C<offsetof> inside your watchers (for real
1417programmers):
1418
1419 #include <stddef.h>
1420
1421 static void
1422 t1_cb (EV_P_ ev_timer *w, int revents)
1423 {
1424 struct my_biggy big = (struct my_biggy *)
1425 (((char *)w) - offsetof (struct my_biggy, t1));
1426 }
1427
1428 static void
1429 t2_cb (EV_P_ ev_timer *w, int revents)
1430 {
1431 struct my_biggy big = (struct my_biggy *)
1432 (((char *)w) - offsetof (struct my_biggy, t2));
1433 }
1434 1423
1435=head2 WATCHER PRIORITY MODELS 1424=head2 WATCHER PRIORITY MODELS
1436 1425
1437Many event loops support I<watcher priorities>, which are usually small 1426Many event loops support I<watcher priorities>, which are usually small
1438integers that influence the ordering of event callback invocation 1427integers that influence the ordering of event callback invocation
1565In general you can register as many read and/or write event watchers per 1554In general you can register as many read and/or write event watchers per
1566fd as you want (as long as you don't confuse yourself). Setting all file 1555fd as you want (as long as you don't confuse yourself). Setting all file
1567descriptors to non-blocking mode is also usually a good idea (but not 1556descriptors to non-blocking mode is also usually a good idea (but not
1568required if you know what you are doing). 1557required if you know what you are doing).
1569 1558
1570If you cannot use non-blocking mode, then force the use of a
1571known-to-be-good backend (at the time of this writing, this includes only
1572C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1573descriptors for which non-blocking operation makes no sense (such as
1574files) - libev doesn't guarantee any specific behaviour in that case.
1575
1576Another thing you have to watch out for is that it is quite easy to 1559Another thing you have to watch out for is that it is quite easy to
1577receive "spurious" readiness notifications, that is your callback might 1560receive "spurious" readiness notifications, that is, your callback might
1578be called with C<EV_READ> but a subsequent C<read>(2) will actually block 1561be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1579because there is no data. Not only are some backends known to create a 1562because there is no data. It is very easy to get into this situation even
1580lot of those (for example Solaris ports), it is very easy to get into 1563with a relatively standard program structure. Thus it is best to always
1581this situation even with a relatively standard program structure. Thus 1564use non-blocking I/O: An extra C<read>(2) returning C<EAGAIN> is far
1582it is best to always use non-blocking I/O: An extra C<read>(2) returning
1583C<EAGAIN> is far preferable to a program hanging until some data arrives. 1565preferable to a program hanging until some data arrives.
1584 1566
1585If you cannot run the fd in non-blocking mode (for example you should 1567If you cannot run the fd in non-blocking mode (for example you should
1586not play around with an Xlib connection), then you have to separately 1568not play around with an Xlib connection), then you have to separately
1587re-test whether a file descriptor is really ready with a known-to-be good 1569re-test whether a file descriptor is really ready with a known-to-be good
1588interface such as poll (fortunately in our Xlib example, Xlib already 1570interface such as poll (fortunately in the case of Xlib, it already does
1589does this on its own, so its quite safe to use). Some people additionally 1571this on its own, so its quite safe to use). Some people additionally
1590use C<SIGALRM> and an interval timer, just to be sure you won't block 1572use C<SIGALRM> and an interval timer, just to be sure you won't block
1591indefinitely. 1573indefinitely.
1592 1574
1593But really, best use non-blocking mode. 1575But really, best use non-blocking mode.
1594 1576
1622 1604
1623There is no workaround possible except not registering events 1605There is no workaround possible except not registering events
1624for potentially C<dup ()>'ed file descriptors, or to resort to 1606for potentially C<dup ()>'ed file descriptors, or to resort to
1625C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. 1607C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1626 1608
1609=head3 The special problem of files
1610
1611Many people try to use C<select> (or libev) on file descriptors
1612representing files, and expect it to become ready when their program
1613doesn't block on disk accesses (which can take a long time on their own).
1614
1615However, this cannot ever work in the "expected" way - you get a readiness
1616notification as soon as the kernel knows whether and how much data is
1617there, and in the case of open files, that's always the case, so you
1618always get a readiness notification instantly, and your read (or possibly
1619write) will still block on the disk I/O.
1620
1621Another way to view it is that in the case of sockets, pipes, character
1622devices and so on, there is another party (the sender) that delivers data
1623on it's own, but in the case of files, there is no such thing: the disk
1624will not send data on it's own, simply because it doesn't know what you
1625wish to read - you would first have to request some data.
1626
1627Since files are typically not-so-well supported by advanced notification
1628mechanism, libev tries hard to emulate POSIX behaviour with respect
1629to files, even though you should not use it. The reason for this is
1630convenience: sometimes you want to watch STDIN or STDOUT, which is
1631usually a tty, often a pipe, but also sometimes files or special devices
1632(for example, C<epoll> on Linux works with F</dev/random> but not with
1633F</dev/urandom>), and even though the file might better be served with
1634asynchronous I/O instead of with non-blocking I/O, it is still useful when
1635it "just works" instead of freezing.
1636
1637So avoid file descriptors pointing to files when you know it (e.g. use
1638libeio), but use them when it is convenient, e.g. for STDIN/STDOUT, or
1639when you rarely read from a file instead of from a socket, and want to
1640reuse the same code path.
1641
1627=head3 The special problem of fork 1642=head3 The special problem of fork
1628 1643
1629Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit 1644Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
1630useless behaviour. Libev fully supports fork, but needs to be told about 1645useless behaviour. Libev fully supports fork, but needs to be told about
1631it in the child. 1646it in the child if you want to continue to use it in the child.
1632 1647
1633To support fork in your programs, you either have to call 1648To support fork in your child processes, you have to call C<ev_loop_fork
1634C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child, 1649()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1635enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or 1650C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1636C<EVBACKEND_POLL>.
1637 1651
1638=head3 The special problem of SIGPIPE 1652=head3 The special problem of SIGPIPE
1639 1653
1640While not really specific to libev, it is easy to forget about C<SIGPIPE>: 1654While not really specific to libev, it is easy to forget about C<SIGPIPE>:
1641when writing to a pipe whose other end has been closed, your program gets 1655when writing to a pipe whose other end has been closed, your program gets
2257 2271
2258=head2 C<ev_signal> - signal me when a signal gets signalled! 2272=head2 C<ev_signal> - signal me when a signal gets signalled!
2259 2273
2260Signal watchers will trigger an event when the process receives a specific 2274Signal watchers will trigger an event when the process receives a specific
2261signal one or more times. Even though signals are very asynchronous, libev 2275signal one or more times. Even though signals are very asynchronous, libev
2262will try it's best to deliver signals synchronously, i.e. as part of the 2276will try its best to deliver signals synchronously, i.e. as part of the
2263normal event processing, like any other event. 2277normal event processing, like any other event.
2264 2278
2265If you want signals to be delivered truly asynchronously, just use 2279If you want signals to be delivered truly asynchronously, just use
2266C<sigaction> as you would do without libev and forget about sharing 2280C<sigaction> as you would do without libev and forget about sharing
2267the signal. You can even use C<ev_async> from a signal handler to 2281the signal. You can even use C<ev_async> from a signal handler to
2309I<has> to modify the signal mask, at least temporarily. 2323I<has> to modify the signal mask, at least temporarily.
2310 2324
2311So I can't stress this enough: I<If you do not reset your signal mask when 2325So I can't stress this enough: I<If you do not reset your signal mask when
2312you expect it to be empty, you have a race condition in your code>. This 2326you expect it to be empty, you have a race condition in your code>. This
2313is not a libev-specific thing, this is true for most event libraries. 2327is not a libev-specific thing, this is true for most event libraries.
2328
2329=head3 The special problem of threads signal handling
2330
2331POSIX threads has problematic signal handling semantics, specifically,
2332a lot of functionality (sigfd, sigwait etc.) only really works if all
2333threads in a process block signals, which is hard to achieve.
2334
2335When you want to use sigwait (or mix libev signal handling with your own
2336for the same signals), you can tackle this problem by globally blocking
2337all signals before creating any threads (or creating them with a fully set
2338sigprocmask) and also specifying the C<EVFLAG_NOSIGMASK> when creating
2339loops. Then designate one thread as "signal receiver thread" which handles
2340these signals. You can pass on any signals that libev might be interested
2341in by calling C<ev_feed_signal>.
2314 2342
2315=head3 Watcher-Specific Functions and Data Members 2343=head3 Watcher-Specific Functions and Data Members
2316 2344
2317=over 4 2345=over 4
2318 2346
3165it by calling C<ev_async_send>, which is thread- and signal safe. 3193it by calling C<ev_async_send>, which is thread- and signal safe.
3166 3194
3167This functionality is very similar to C<ev_signal> watchers, as signals, 3195This functionality is very similar to C<ev_signal> watchers, as signals,
3168too, are asynchronous in nature, and signals, too, will be compressed 3196too, are asynchronous in nature, and signals, too, will be compressed
3169(i.e. the number of callback invocations may be less than the number of 3197(i.e. the number of callback invocations may be less than the number of
3170C<ev_async_sent> calls). 3198C<ev_async_sent> calls). In fact, you could use signal watchers as a kind
3199of "global async watchers" by using a watcher on an otherwise unused
3200signal, and C<ev_feed_signal> to signal this watcher from another thread,
3201even without knowing which loop owns the signal.
3171 3202
3172Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not 3203Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
3173just the default loop. 3204just the default loop.
3174 3205
3175=head3 Queueing 3206=head3 Queueing
3351Feed an event on the given fd, as if a file descriptor backend detected 3382Feed an event on the given fd, as if a file descriptor backend detected
3352the given events it. 3383the given events it.
3353 3384
3354=item ev_feed_signal_event (loop, int signum) 3385=item ev_feed_signal_event (loop, int signum)
3355 3386
3356Feed an event as if the given signal occurred (C<loop> must be the default 3387Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
3357loop!). 3388which is async-safe.
3358 3389
3359=back 3390=back
3391
3392
3393=head1 COMMON OR USEFUL IDIOMS (OR BOTH)
3394
3395This section explains some common idioms that are not immediately
3396obvious. Note that examples are sprinkled over the whole manual, and this
3397section only contains stuff that wouldn't fit anywhere else.
3398
3399=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
3400
3401Each watcher has, by default, a C<void *data> member that you can read
3402or modify at any time: libev will completely ignore it. This can be used
3403to associate arbitrary data with your watcher. If you need more data and
3404don't want to allocate memory separately and store a pointer to it in that
3405data member, you can also "subclass" the watcher type and provide your own
3406data:
3407
3408 struct my_io
3409 {
3410 ev_io io;
3411 int otherfd;
3412 void *somedata;
3413 struct whatever *mostinteresting;
3414 };
3415
3416 ...
3417 struct my_io w;
3418 ev_io_init (&w.io, my_cb, fd, EV_READ);
3419
3420And since your callback will be called with a pointer to the watcher, you
3421can cast it back to your own type:
3422
3423 static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
3424 {
3425 struct my_io *w = (struct my_io *)w_;
3426 ...
3427 }
3428
3429More interesting and less C-conformant ways of casting your callback
3430function type instead have been omitted.
3431
3432=head2 BUILDING YOUR OWN COMPOSITE WATCHERS
3433
3434Another common scenario is to use some data structure with multiple
3435embedded watchers, in effect creating your own watcher that combines
3436multiple libev event sources into one "super-watcher":
3437
3438 struct my_biggy
3439 {
3440 int some_data;
3441 ev_timer t1;
3442 ev_timer t2;
3443 }
3444
3445In this case getting the pointer to C<my_biggy> is a bit more
3446complicated: Either you store the address of your C<my_biggy> struct in
3447the C<data> member of the watcher (for woozies or C++ coders), or you need
3448to use some pointer arithmetic using C<offsetof> inside your watchers (for
3449real programmers):
3450
3451 #include <stddef.h>
3452
3453 static void
3454 t1_cb (EV_P_ ev_timer *w, int revents)
3455 {
3456 struct my_biggy big = (struct my_biggy *)
3457 (((char *)w) - offsetof (struct my_biggy, t1));
3458 }
3459
3460 static void
3461 t2_cb (EV_P_ ev_timer *w, int revents)
3462 {
3463 struct my_biggy big = (struct my_biggy *)
3464 (((char *)w) - offsetof (struct my_biggy, t2));
3465 }
3466
3467=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
3468
3469Often (especially in GUI toolkits) there are places where you have
3470I<modal> interaction, which is most easily implemented by recursively
3471invoking C<ev_run>.
3472
3473This brings the problem of exiting - a callback might want to finish the
3474main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
3475a modal "Are you sure?" dialog is still waiting), or just the nested one
3476and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
3477other combination: In these cases, C<ev_break> will not work alone.
3478
3479The solution is to maintain "break this loop" variable for each C<ev_run>
3480invocation, and use a loop around C<ev_run> until the condition is
3481triggered, using C<EVRUN_ONCE>:
3482
3483 // main loop
3484 int exit_main_loop = 0;
3485
3486 while (!exit_main_loop)
3487 ev_run (EV_DEFAULT_ EVRUN_ONCE);
3488
3489 // in a model watcher
3490 int exit_nested_loop = 0;
3491
3492 while (!exit_nested_loop)
3493 ev_run (EV_A_ EVRUN_ONCE);
3494
3495To exit from any of these loops, just set the corresponding exit variable:
3496
3497 // exit modal loop
3498 exit_nested_loop = 1;
3499
3500 // exit main program, after modal loop is finished
3501 exit_main_loop = 1;
3502
3503 // exit both
3504 exit_main_loop = exit_nested_loop = 1;
3505
3506=head2 THREAD LOCKING EXAMPLE
3507
3508Here is a fictitious example of how to run an event loop in a different
3509thread than where callbacks are being invoked and watchers are
3510created/added/removed.
3511
3512For a real-world example, see the C<EV::Loop::Async> perl module,
3513which uses exactly this technique (which is suited for many high-level
3514languages).
3515
3516The example uses a pthread mutex to protect the loop data, a condition
3517variable to wait for callback invocations, an async watcher to notify the
3518event loop thread and an unspecified mechanism to wake up the main thread.
3519
3520First, you need to associate some data with the event loop:
3521
3522 typedef struct {
3523 mutex_t lock; /* global loop lock */
3524 ev_async async_w;
3525 thread_t tid;
3526 cond_t invoke_cv;
3527 } userdata;
3528
3529 void prepare_loop (EV_P)
3530 {
3531 // for simplicity, we use a static userdata struct.
3532 static userdata u;
3533
3534 ev_async_init (&u->async_w, async_cb);
3535 ev_async_start (EV_A_ &u->async_w);
3536
3537 pthread_mutex_init (&u->lock, 0);
3538 pthread_cond_init (&u->invoke_cv, 0);
3539
3540 // now associate this with the loop
3541 ev_set_userdata (EV_A_ u);
3542 ev_set_invoke_pending_cb (EV_A_ l_invoke);
3543 ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
3544
3545 // then create the thread running ev_loop
3546 pthread_create (&u->tid, 0, l_run, EV_A);
3547 }
3548
3549The callback for the C<ev_async> watcher does nothing: the watcher is used
3550solely to wake up the event loop so it takes notice of any new watchers
3551that might have been added:
3552
3553 static void
3554 async_cb (EV_P_ ev_async *w, int revents)
3555 {
3556 // just used for the side effects
3557 }
3558
3559The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
3560protecting the loop data, respectively.
3561
3562 static void
3563 l_release (EV_P)
3564 {
3565 userdata *u = ev_userdata (EV_A);
3566 pthread_mutex_unlock (&u->lock);
3567 }
3568
3569 static void
3570 l_acquire (EV_P)
3571 {
3572 userdata *u = ev_userdata (EV_A);
3573 pthread_mutex_lock (&u->lock);
3574 }
3575
3576The event loop thread first acquires the mutex, and then jumps straight
3577into C<ev_run>:
3578
3579 void *
3580 l_run (void *thr_arg)
3581 {
3582 struct ev_loop *loop = (struct ev_loop *)thr_arg;
3583
3584 l_acquire (EV_A);
3585 pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
3586 ev_run (EV_A_ 0);
3587 l_release (EV_A);
3588
3589 return 0;
3590 }
3591
3592Instead of invoking all pending watchers, the C<l_invoke> callback will
3593signal the main thread via some unspecified mechanism (signals? pipe
3594writes? C<Async::Interrupt>?) and then waits until all pending watchers
3595have been called (in a while loop because a) spurious wakeups are possible
3596and b) skipping inter-thread-communication when there are no pending
3597watchers is very beneficial):
3598
3599 static void
3600 l_invoke (EV_P)
3601 {
3602 userdata *u = ev_userdata (EV_A);
3603
3604 while (ev_pending_count (EV_A))
3605 {
3606 wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
3607 pthread_cond_wait (&u->invoke_cv, &u->lock);
3608 }
3609 }
3610
3611Now, whenever the main thread gets told to invoke pending watchers, it
3612will grab the lock, call C<ev_invoke_pending> and then signal the loop
3613thread to continue:
3614
3615 static void
3616 real_invoke_pending (EV_P)
3617 {
3618 userdata *u = ev_userdata (EV_A);
3619
3620 pthread_mutex_lock (&u->lock);
3621 ev_invoke_pending (EV_A);
3622 pthread_cond_signal (&u->invoke_cv);
3623 pthread_mutex_unlock (&u->lock);
3624 }
3625
3626Whenever you want to start/stop a watcher or do other modifications to an
3627event loop, you will now have to lock:
3628
3629 ev_timer timeout_watcher;
3630 userdata *u = ev_userdata (EV_A);
3631
3632 ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
3633
3634 pthread_mutex_lock (&u->lock);
3635 ev_timer_start (EV_A_ &timeout_watcher);
3636 ev_async_send (EV_A_ &u->async_w);
3637 pthread_mutex_unlock (&u->lock);
3638
3639Note that sending the C<ev_async> watcher is required because otherwise
3640an event loop currently blocking in the kernel will have no knowledge
3641about the newly added timer. By waking up the loop it will pick up any new
3642watchers in the next event loop iteration.
3643
3644=head2 THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS
3645
3646While the overhead of a callback that e.g. schedules a thread is small, it
3647is still an overhead. If you embed libev, and your main usage is with some
3648kind of threads or coroutines, you might want to customise libev so that
3649doesn't need callbacks anymore.
3650
3651Imagine you have coroutines that you can switch to using a function
3652C<switch_to (coro)>, that libev runs in a coroutine called C<libev_coro>
3653and that due to some magic, the currently active coroutine is stored in a
3654global called C<current_coro>. Then you can build your own "wait for libev
3655event" primitive by changing C<EV_CB_DECLARE> and C<EV_CB_INVOKE> (note
3656the differing C<;> conventions):
3657
3658 #define EV_CB_DECLARE(type) struct my_coro *cb;
3659 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
3660
3661That means instead of having a C callback function, you store the
3662coroutine to switch to in each watcher, and instead of having libev call
3663your callback, you instead have it switch to that coroutine.
3664
3665A coroutine might now wait for an event with a function called
3666C<wait_for_event>. (the watcher needs to be started, as always, but it doesn't
3667matter when, or whether the watcher is active or not when this function is
3668called):
3669
3670 void
3671 wait_for_event (ev_watcher *w)
3672 {
3673 ev_cb_set (w) = current_coro;
3674 switch_to (libev_coro);
3675 }
3676
3677That basically suspends the coroutine inside C<wait_for_event> and
3678continues the libev coroutine, which, when appropriate, switches back to
3679this or any other coroutine. I am sure if you sue this your own :)
3680
3681You can do similar tricks if you have, say, threads with an event queue -
3682instead of storing a coroutine, you store the queue object and instead of
3683switching to a coroutine, you push the watcher onto the queue and notify
3684any waiters.
3685
3686To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two
3687files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
3688
3689 // my_ev.h
3690 #define EV_CB_DECLARE(type) struct my_coro *cb;
3691 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb);
3692 #include "../libev/ev.h"
3693
3694 // my_ev.c
3695 #define EV_H "my_ev.h"
3696 #include "../libev/ev.c"
3697
3698And then use F<my_ev.h> when you would normally use F<ev.h>, and compile
3699F<my_ev.c> into your project. When properly specifying include paths, you
3700can even use F<ev.h> as header file name directly.
3360 3701
3361 3702
3362=head1 LIBEVENT EMULATION 3703=head1 LIBEVENT EMULATION
3363 3704
3364Libev offers a compatibility emulation layer for libevent. It cannot 3705Libev offers a compatibility emulation layer for libevent. It cannot
3365emulate the internals of libevent, so here are some usage hints: 3706emulate the internals of libevent, so here are some usage hints:
3366 3707
3367=over 4 3708=over 4
3709
3710=item * Only the libevent-1.4.1-beta API is being emulated.
3711
3712This was the newest libevent version available when libev was implemented,
3713and is still mostly unchanged in 2010.
3368 3714
3369=item * Use it by including <event.h>, as usual. 3715=item * Use it by including <event.h>, as usual.
3370 3716
3371=item * The following members are fully supported: ev_base, ev_callback, 3717=item * The following members are fully supported: ev_base, ev_callback,
3372ev_arg, ev_fd, ev_res, ev_events. 3718ev_arg, ev_fd, ev_res, ev_events.
3378=item * Priorities are not currently supported. Initialising priorities 3724=item * Priorities are not currently supported. Initialising priorities
3379will fail and all watchers will have the same priority, even though there 3725will fail and all watchers will have the same priority, even though there
3380is an ev_pri field. 3726is an ev_pri field.
3381 3727
3382=item * In libevent, the last base created gets the signals, in libev, the 3728=item * In libevent, the last base created gets the signals, in libev, the
3383first base created (== the default loop) gets the signals. 3729base that registered the signal gets the signals.
3384 3730
3385=item * Other members are not supported. 3731=item * Other members are not supported.
3386 3732
3387=item * The libev emulation is I<not> ABI compatible to libevent, you need 3733=item * The libev emulation is I<not> ABI compatible to libevent, you need
3388to use the libev header file and library. 3734to use the libev header file and library.
3407Care has been taken to keep the overhead low. The only data member the C++ 3753Care has been taken to keep the overhead low. The only data member the C++
3408classes add (compared to plain C-style watchers) is the event loop pointer 3754classes add (compared to plain C-style watchers) is the event loop pointer
3409that the watcher is associated with (or no additional members at all if 3755that the watcher is associated with (or no additional members at all if
3410you disable C<EV_MULTIPLICITY> when embedding libev). 3756you disable C<EV_MULTIPLICITY> when embedding libev).
3411 3757
3412Currently, functions, and static and non-static member functions can be 3758Currently, functions, static and non-static member functions and classes
3413used as callbacks. Other types should be easy to add as long as they only 3759with C<operator ()> can be used as callbacks. Other types should be easy
3414need one additional pointer for context. If you need support for other 3760to add as long as they only need one additional pointer for context. If
3415types of functors please contact the author (preferably after implementing 3761you need support for other types of functors please contact the author
3416it). 3762(preferably after implementing it).
3417 3763
3418Here is a list of things available in the C<ev> namespace: 3764Here is a list of things available in the C<ev> namespace:
3419 3765
3420=over 4 3766=over 4
3421 3767
4289And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: 4635And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
4290 4636
4291 #include "ev_cpp.h" 4637 #include "ev_cpp.h"
4292 #include "ev.c" 4638 #include "ev.c"
4293 4639
4294=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES 4640=head1 INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT
4295 4641
4296=head2 THREADS AND COROUTINES 4642=head2 THREADS AND COROUTINES
4297 4643
4298=head3 THREADS 4644=head3 THREADS
4299 4645
4350default loop and triggering an C<ev_async> watcher from the default loop 4696default loop and triggering an C<ev_async> watcher from the default loop
4351watcher callback into the event loop interested in the signal. 4697watcher callback into the event loop interested in the signal.
4352 4698
4353=back 4699=back
4354 4700
4355=head4 THREAD LOCKING EXAMPLE 4701See also L<THREAD LOCKING EXAMPLE>.
4356
4357Here is a fictitious example of how to run an event loop in a different
4358thread than where callbacks are being invoked and watchers are
4359created/added/removed.
4360
4361For a real-world example, see the C<EV::Loop::Async> perl module,
4362which uses exactly this technique (which is suited for many high-level
4363languages).
4364
4365The example uses a pthread mutex to protect the loop data, a condition
4366variable to wait for callback invocations, an async watcher to notify the
4367event loop thread and an unspecified mechanism to wake up the main thread.
4368
4369First, you need to associate some data with the event loop:
4370
4371 typedef struct {
4372 mutex_t lock; /* global loop lock */
4373 ev_async async_w;
4374 thread_t tid;
4375 cond_t invoke_cv;
4376 } userdata;
4377
4378 void prepare_loop (EV_P)
4379 {
4380 // for simplicity, we use a static userdata struct.
4381 static userdata u;
4382
4383 ev_async_init (&u->async_w, async_cb);
4384 ev_async_start (EV_A_ &u->async_w);
4385
4386 pthread_mutex_init (&u->lock, 0);
4387 pthread_cond_init (&u->invoke_cv, 0);
4388
4389 // now associate this with the loop
4390 ev_set_userdata (EV_A_ u);
4391 ev_set_invoke_pending_cb (EV_A_ l_invoke);
4392 ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4393
4394 // then create the thread running ev_loop
4395 pthread_create (&u->tid, 0, l_run, EV_A);
4396 }
4397
4398The callback for the C<ev_async> watcher does nothing: the watcher is used
4399solely to wake up the event loop so it takes notice of any new watchers
4400that might have been added:
4401
4402 static void
4403 async_cb (EV_P_ ev_async *w, int revents)
4404 {
4405 // just used for the side effects
4406 }
4407
4408The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
4409protecting the loop data, respectively.
4410
4411 static void
4412 l_release (EV_P)
4413 {
4414 userdata *u = ev_userdata (EV_A);
4415 pthread_mutex_unlock (&u->lock);
4416 }
4417
4418 static void
4419 l_acquire (EV_P)
4420 {
4421 userdata *u = ev_userdata (EV_A);
4422 pthread_mutex_lock (&u->lock);
4423 }
4424
4425The event loop thread first acquires the mutex, and then jumps straight
4426into C<ev_run>:
4427
4428 void *
4429 l_run (void *thr_arg)
4430 {
4431 struct ev_loop *loop = (struct ev_loop *)thr_arg;
4432
4433 l_acquire (EV_A);
4434 pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4435 ev_run (EV_A_ 0);
4436 l_release (EV_A);
4437
4438 return 0;
4439 }
4440
4441Instead of invoking all pending watchers, the C<l_invoke> callback will
4442signal the main thread via some unspecified mechanism (signals? pipe
4443writes? C<Async::Interrupt>?) and then waits until all pending watchers
4444have been called (in a while loop because a) spurious wakeups are possible
4445and b) skipping inter-thread-communication when there are no pending
4446watchers is very beneficial):
4447
4448 static void
4449 l_invoke (EV_P)
4450 {
4451 userdata *u = ev_userdata (EV_A);
4452
4453 while (ev_pending_count (EV_A))
4454 {
4455 wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4456 pthread_cond_wait (&u->invoke_cv, &u->lock);
4457 }
4458 }
4459
4460Now, whenever the main thread gets told to invoke pending watchers, it
4461will grab the lock, call C<ev_invoke_pending> and then signal the loop
4462thread to continue:
4463
4464 static void
4465 real_invoke_pending (EV_P)
4466 {
4467 userdata *u = ev_userdata (EV_A);
4468
4469 pthread_mutex_lock (&u->lock);
4470 ev_invoke_pending (EV_A);
4471 pthread_cond_signal (&u->invoke_cv);
4472 pthread_mutex_unlock (&u->lock);
4473 }
4474
4475Whenever you want to start/stop a watcher or do other modifications to an
4476event loop, you will now have to lock:
4477
4478 ev_timer timeout_watcher;
4479 userdata *u = ev_userdata (EV_A);
4480
4481 ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4482
4483 pthread_mutex_lock (&u->lock);
4484 ev_timer_start (EV_A_ &timeout_watcher);
4485 ev_async_send (EV_A_ &u->async_w);
4486 pthread_mutex_unlock (&u->lock);
4487
4488Note that sending the C<ev_async> watcher is required because otherwise
4489an event loop currently blocking in the kernel will have no knowledge
4490about the newly added timer. By waking up the loop it will pick up any new
4491watchers in the next event loop iteration.
4492 4702
4493=head3 COROUTINES 4703=head3 COROUTINES
4494 4704
4495Libev is very accommodating to coroutines ("cooperative threads"): 4705Libev is very accommodating to coroutines ("cooperative threads"):
4496libev fully supports nesting calls to its functions from different 4706libev fully supports nesting calls to its functions from different

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines