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

Comparing libev/ev.pod (file contents):
Revision 1.62 by root, Thu Nov 29 17:28:13 2007 UTC vs.
Revision 1.82 by root, Wed Dec 12 17:55:06 2007 UTC

47 47
48 return 0; 48 return 0;
49 } 49 }
50 50
51=head1 DESCRIPTION 51=head1 DESCRIPTION
52
53The newest version of this document is also available as a html-formatted
54web page you might find easier to navigate when reading it for the first
55time: L<http://cvs.schmorp.de/libev/ev.html>.
52 56
53Libev is an event loop: you register interest in certain events (such as a 57Libev is an event loop: you register interest in certain events (such as a
54file descriptor being readable or a timeout occuring), and it will manage 58file descriptor being readable or a timeout occuring), and it will manage
55these event sources and provide your program with events. 59these event sources and provide your program with events.
56 60
113 117
114=item int ev_version_major () 118=item int ev_version_major ()
115 119
116=item int ev_version_minor () 120=item int ev_version_minor ()
117 121
118You can find out the major and minor version numbers of the library 122You can find out the major and minor ABI version numbers of the library
119you linked against by calling the functions C<ev_version_major> and 123you linked against by calling the functions C<ev_version_major> and
120C<ev_version_minor>. If you want, you can compare against the global 124C<ev_version_minor>. If you want, you can compare against the global
121symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the 125symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the
122version of the library your program was compiled against. 126version of the library your program was compiled against.
123 127
128These version numbers refer to the ABI version of the library, not the
129release version.
130
124Usually, it's a good idea to terminate if the major versions mismatch, 131Usually, it's a good idea to terminate if the major versions mismatch,
125as this indicates an incompatible change. Minor versions are usually 132as this indicates an incompatible change. Minor versions are usually
126compatible to older versions, so a larger minor version alone is usually 133compatible to older versions, so a larger minor version alone is usually
127not a problem. 134not a problem.
128 135
129Example: Make sure we haven't accidentally been linked against the wrong 136Example: Make sure we haven't accidentally been linked against the wrong
130version. 137version.
274a fork, you can also make libev check for a fork in each iteration by 281a fork, you can also make libev check for a fork in each iteration by
275enabling this flag. 282enabling this flag.
276 283
277This works by calling C<getpid ()> on every iteration of the loop, 284This works by calling C<getpid ()> on every iteration of the loop,
278and thus this might slow down your event loop if you do a lot of loop 285and thus this might slow down your event loop if you do a lot of loop
279iterations and little real work, but is usually not noticable (on my 286iterations and little real work, but is usually not noticeable (on my
280Linux system for example, C<getpid> is actually a simple 5-insn sequence 287Linux system for example, C<getpid> is actually a simple 5-insn sequence
281without a syscall and thus I<very> fast, but my Linux system also has 288without a syscall and thus I<very> fast, but my Linux system also has
282C<pthread_atfork> which is even faster). 289C<pthread_atfork> which is even faster).
283 290
284The big advantage of this flag is that you can forget about fork (and 291The big advantage of this flag is that you can forget about fork (and
430 437
431Like C<ev_default_fork>, but acts on an event loop created by 438Like C<ev_default_fork>, but acts on an event loop created by
432C<ev_loop_new>. Yes, you have to call this on every allocated event loop 439C<ev_loop_new>. Yes, you have to call this on every allocated event loop
433after fork, and how you do this is entirely your own problem. 440after fork, and how you do this is entirely your own problem.
434 441
442=item unsigned int ev_loop_count (loop)
443
444Returns the count of loop iterations for the loop, which is identical to
445the number of times libev did poll for new events. It starts at C<0> and
446happily wraps around with enough iterations.
447
448This value can sometimes be useful as a generation counter of sorts (it
449"ticks" the number of loop iterations), as it roughly corresponds with
450C<ev_prepare> and C<ev_check> calls.
451
435=item unsigned int ev_backend (loop) 452=item unsigned int ev_backend (loop)
436 453
437Returns one of the C<EVBACKEND_*> flags indicating the event backend in 454Returns one of the C<EVBACKEND_*> flags indicating the event backend in
438use. 455use.
439 456
472libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is 489libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is
473usually a better approach for this kind of thing. 490usually a better approach for this kind of thing.
474 491
475Here are the gory details of what C<ev_loop> does: 492Here are the gory details of what C<ev_loop> does:
476 493
494 - Before the first iteration, call any pending watchers.
477 * If there are no active watchers (reference count is zero), return. 495 * If there are no active watchers (reference count is zero), return.
478 - Queue prepare watchers and then call all outstanding watchers. 496 - Queue all prepare watchers and then call all outstanding watchers.
479 - If we have been forked, recreate the kernel state. 497 - If we have been forked, recreate the kernel state.
480 - Update the kernel state with all outstanding changes. 498 - Update the kernel state with all outstanding changes.
481 - Update the "event loop time". 499 - Update the "event loop time".
482 - Calculate for how long to block. 500 - Calculate for how long to block.
483 - Block the process, waiting for any events. 501 - Block the process, waiting for any events.
722=item bool ev_is_pending (ev_TYPE *watcher) 740=item bool ev_is_pending (ev_TYPE *watcher)
723 741
724Returns a true value iff the watcher is pending, (i.e. it has outstanding 742Returns a true value iff the watcher is pending, (i.e. it has outstanding
725events but its callback has not yet been invoked). As long as a watcher 743events but its callback has not yet been invoked). As long as a watcher
726is pending (but not active) you must not call an init function on it (but 744is pending (but not active) you must not call an init function on it (but
727C<ev_TYPE_set> is safe) and you must make sure the watcher is available to 745C<ev_TYPE_set> is safe), you must not change its priority, and you must
728libev (e.g. you cnanot C<free ()> it). 746make sure the watcher is available to libev (e.g. you cannot C<free ()>
747it).
729 748
730=item callback ev_cb (ev_TYPE *watcher) 749=item callback ev_cb (ev_TYPE *watcher)
731 750
732Returns the callback currently set on the watcher. 751Returns the callback currently set on the watcher.
733 752
734=item ev_cb_set (ev_TYPE *watcher, callback) 753=item ev_cb_set (ev_TYPE *watcher, callback)
735 754
736Change the callback. You can change the callback at virtually any time 755Change the callback. You can change the callback at virtually any time
737(modulo threads). 756(modulo threads).
757
758=item ev_set_priority (ev_TYPE *watcher, priority)
759
760=item int ev_priority (ev_TYPE *watcher)
761
762Set and query the priority of the watcher. The priority is a small
763integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
764(default: C<-2>). Pending watchers with higher priority will be invoked
765before watchers with lower priority, but priority will not keep watchers
766from being executed (except for C<ev_idle> watchers).
767
768This means that priorities are I<only> used for ordering callback
769invocation after new events have been received. This is useful, for
770example, to reduce latency after idling, or more often, to bind two
771watchers on the same event and make sure one is called first.
772
773If you need to suppress invocation when higher priority events are pending
774you need to look at C<ev_idle> watchers, which provide this functionality.
775
776You I<must not> change the priority of a watcher as long as it is active or
777pending.
778
779The default priority used by watchers when no priority has been set is
780always C<0>, which is supposed to not be too high and not be too low :).
781
782Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
783fine, as long as you do not mind that the priority value you query might
784or might not have been adjusted to be within valid range.
785
786=item ev_invoke (loop, ev_TYPE *watcher, int revents)
787
788Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
789C<loop> nor C<revents> need to be valid as long as the watcher callback
790can deal with that fact.
791
792=item int ev_clear_pending (loop, ev_TYPE *watcher)
793
794If the watcher is pending, this function returns clears its pending status
795and returns its C<revents> bitset (as if its callback was invoked). If the
796watcher isn't pending it does nothing and returns C<0>.
738 797
739=back 798=back
740 799
741 800
742=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER 801=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
848it is best to always use non-blocking I/O: An extra C<read>(2) returning 907it is best to always use non-blocking I/O: An extra C<read>(2) returning
849C<EAGAIN> is far preferable to a program hanging until some data arrives. 908C<EAGAIN> is far preferable to a program hanging until some data arrives.
850 909
851If you cannot run the fd in non-blocking mode (for example you should not 910If you cannot run the fd in non-blocking mode (for example you should not
852play around with an Xlib connection), then you have to seperately re-test 911play around with an Xlib connection), then you have to seperately re-test
853wether a file descriptor is really ready with a known-to-be good interface 912whether a file descriptor is really ready with a known-to-be good interface
854such as poll (fortunately in our Xlib example, Xlib already does this on 913such as poll (fortunately in our Xlib example, Xlib already does this on
855its own, so its quite safe to use). 914its own, so its quite safe to use).
915
916=head3 The special problem of disappearing file descriptors
917
918Some backends (e.g kqueue, epoll) need to be told about closing a file
919descriptor (either by calling C<close> explicitly or by any other means,
920such as C<dup>). The reason is that you register interest in some file
921descriptor, but when it goes away, the operating system will silently drop
922this interest. If another file descriptor with the same number then is
923registered with libev, there is no efficient way to see that this is, in
924fact, a different file descriptor.
925
926To avoid having to explicitly tell libev about such cases, libev follows
927the following policy: Each time C<ev_io_set> is being called, libev
928will assume that this is potentially a new file descriptor, otherwise
929it is assumed that the file descriptor stays the same. That means that
930you I<have> to call C<ev_io_set> (or C<ev_io_init>) when you change the
931descriptor even if the file descriptor number itself did not change.
932
933This is how one would do it normally anyway, the important point is that
934the libev application should not optimise around libev but should leave
935optimisations to libev.
936
937
938=head3 Watcher-Specific Functions
856 939
857=over 4 940=over 4
858 941
859=item ev_io_init (ev_io *, callback, int fd, int events) 942=item ev_io_init (ev_io *, callback, int fd, int events)
860 943
913 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 996 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
914 997
915The callback is guarenteed to be invoked only when its timeout has passed, 998The callback is guarenteed to be invoked only when its timeout has passed,
916but if multiple timers become ready during the same loop iteration then 999but if multiple timers become ready during the same loop iteration then
917order of execution is undefined. 1000order of execution is undefined.
1001
1002=head3 Watcher-Specific Functions and Data Members
918 1003
919=over 4 1004=over 4
920 1005
921=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 1006=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
922 1007
1018but on wallclock time (absolute time). You can tell a periodic watcher 1103but on wallclock time (absolute time). You can tell a periodic watcher
1019to trigger "at" some specific point in time. For example, if you tell a 1104to trigger "at" some specific point in time. For example, if you tell a
1020periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now () 1105periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()
1021+ 10.>) and then reset your system clock to the last year, then it will 1106+ 10.>) and then reset your system clock to the last year, then it will
1022take a year to trigger the event (unlike an C<ev_timer>, which would trigger 1107take a year to trigger the event (unlike an C<ev_timer>, which would trigger
1023roughly 10 seconds later and of course not if you reset your system time 1108roughly 10 seconds later).
1024again).
1025 1109
1026They can also be used to implement vastly more complex timers, such as 1110They can also be used to implement vastly more complex timers, such as
1027triggering an event on eahc midnight, local time. 1111triggering an event on each midnight, local time or other, complicated,
1112rules.
1028 1113
1029As with timers, the callback is guarenteed to be invoked only when the 1114As with timers, the callback is guarenteed to be invoked only when the
1030time (C<at>) has been passed, but if multiple periodic timers become ready 1115time (C<at>) has been passed, but if multiple periodic timers become ready
1031during the same loop iteration then order of execution is undefined. 1116during the same loop iteration then order of execution is undefined.
1032 1117
1118=head3 Watcher-Specific Functions and Data Members
1119
1033=over 4 1120=over 4
1034 1121
1035=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb) 1122=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)
1036 1123
1037=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb) 1124=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)
1039Lots of arguments, lets sort it out... There are basically three modes of 1126Lots of arguments, lets sort it out... There are basically three modes of
1040operation, and we will explain them from simplest to complex: 1127operation, and we will explain them from simplest to complex:
1041 1128
1042=over 4 1129=over 4
1043 1130
1044=item * absolute timer (interval = reschedule_cb = 0) 1131=item * absolute timer (at = time, interval = reschedule_cb = 0)
1045 1132
1046In this configuration the watcher triggers an event at the wallclock time 1133In this configuration the watcher triggers an event at the wallclock time
1047C<at> and doesn't repeat. It will not adjust when a time jump occurs, 1134C<at> and doesn't repeat. It will not adjust when a time jump occurs,
1048that is, if it is to be run at January 1st 2011 then it will run when the 1135that is, if it is to be run at January 1st 2011 then it will run when the
1049system time reaches or surpasses this time. 1136system time reaches or surpasses this time.
1050 1137
1051=item * non-repeating interval timer (interval > 0, reschedule_cb = 0) 1138=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1052 1139
1053In this mode the watcher will always be scheduled to time out at the next 1140In this mode the watcher will always be scheduled to time out at the next
1054C<at + N * interval> time (for some integer N) and then repeat, regardless 1141C<at + N * interval> time (for some integer N, which can also be negative)
1055of any time jumps. 1142and then repeat, regardless of any time jumps.
1056 1143
1057This can be used to create timers that do not drift with respect to system 1144This can be used to create timers that do not drift with respect to system
1058time: 1145time:
1059 1146
1060 ev_periodic_set (&periodic, 0., 3600., 0); 1147 ev_periodic_set (&periodic, 0., 3600., 0);
1066 1153
1067Another way to think about it (for the mathematically inclined) is that 1154Another way to think about it (for the mathematically inclined) is that
1068C<ev_periodic> will try to run the callback in this mode at the next possible 1155C<ev_periodic> will try to run the callback in this mode at the next possible
1069time where C<time = at (mod interval)>, regardless of any time jumps. 1156time where C<time = at (mod interval)>, regardless of any time jumps.
1070 1157
1158For numerical stability it is preferable that the C<at> value is near
1159C<ev_now ()> (the current time), but there is no range requirement for
1160this value.
1161
1071=item * manual reschedule mode (reschedule_cb = callback) 1162=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)
1072 1163
1073In this mode the values for C<interval> and C<at> are both being 1164In this mode the values for C<interval> and C<at> are both being
1074ignored. Instead, each time the periodic watcher gets scheduled, the 1165ignored. Instead, each time the periodic watcher gets scheduled, the
1075reschedule callback will be called with the watcher as first, and the 1166reschedule callback will be called with the watcher as first, and the
1076current time as second argument. 1167current time as second argument.
1077 1168
1078NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, 1169NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,
1079ever, or make any event loop modifications>. If you need to stop it, 1170ever, or make any event loop modifications>. If you need to stop it,
1080return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by 1171return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by
1081starting a prepare watcher). 1172starting an C<ev_prepare> watcher, which is legal).
1082 1173
1083Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w, 1174Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
1084ev_tstamp now)>, e.g.: 1175ev_tstamp now)>, e.g.:
1085 1176
1086 static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) 1177 static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
1108 1199
1109Simply stops and restarts the periodic watcher again. This is only useful 1200Simply stops and restarts the periodic watcher again. This is only useful
1110when you changed some parameters or the reschedule callback would return 1201when you changed some parameters or the reschedule callback would return
1111a different time than the last time it was called (e.g. in a crond like 1202a different time than the last time it was called (e.g. in a crond like
1112program when the crontabs have changed). 1203program when the crontabs have changed).
1204
1205=item ev_tstamp offset [read-write]
1206
1207When repeating, this contains the offset value, otherwise this is the
1208absolute point in time (the C<at> value passed to C<ev_periodic_set>).
1209
1210Can be modified any time, but changes only take effect when the periodic
1211timer fires or C<ev_periodic_again> is being called.
1113 1212
1114=item ev_tstamp interval [read-write] 1213=item ev_tstamp interval [read-write]
1115 1214
1116The current interval value. Can be modified any time, but changes only 1215The current interval value. Can be modified any time, but changes only
1117take effect when the periodic timer fires or C<ev_periodic_again> is being 1216take effect when the periodic timer fires or C<ev_periodic_again> is being
1171with the kernel (thus it coexists with your own signal handlers as long 1270with the kernel (thus it coexists with your own signal handlers as long
1172as you don't register any with libev). Similarly, when the last signal 1271as you don't register any with libev). Similarly, when the last signal
1173watcher for a signal is stopped libev will reset the signal handler to 1272watcher for a signal is stopped libev will reset the signal handler to
1174SIG_DFL (regardless of what it was set to before). 1273SIG_DFL (regardless of what it was set to before).
1175 1274
1275=head3 Watcher-Specific Functions and Data Members
1276
1176=over 4 1277=over 4
1177 1278
1178=item ev_signal_init (ev_signal *, callback, int signum) 1279=item ev_signal_init (ev_signal *, callback, int signum)
1179 1280
1180=item ev_signal_set (ev_signal *, int signum) 1281=item ev_signal_set (ev_signal *, int signum)
1191 1292
1192=head2 C<ev_child> - watch out for process status changes 1293=head2 C<ev_child> - watch out for process status changes
1193 1294
1194Child watchers trigger when your process receives a SIGCHLD in response to 1295Child watchers trigger when your process receives a SIGCHLD in response to
1195some child status changes (most typically when a child of yours dies). 1296some child status changes (most typically when a child of yours dies).
1297
1298=head3 Watcher-Specific Functions and Data Members
1196 1299
1197=over 4 1300=over 4
1198 1301
1199=item ev_child_init (ev_child *, callback, int pid) 1302=item ev_child_init (ev_child *, callback, int pid)
1200 1303
1268reader). Inotify will be used to give hints only and should not change the 1371reader). Inotify will be used to give hints only and should not change the
1269semantics of C<ev_stat> watchers, which means that libev sometimes needs 1372semantics of C<ev_stat> watchers, which means that libev sometimes needs
1270to fall back to regular polling again even with inotify, but changes are 1373to fall back to regular polling again even with inotify, but changes are
1271usually detected immediately, and if the file exists there will be no 1374usually detected immediately, and if the file exists there will be no
1272polling. 1375polling.
1376
1377=head3 Watcher-Specific Functions and Data Members
1273 1378
1274=over 4 1379=over 4
1275 1380
1276=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval) 1381=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)
1277 1382
1341 ev_stat_start (loop, &passwd); 1446 ev_stat_start (loop, &passwd);
1342 1447
1343 1448
1344=head2 C<ev_idle> - when you've got nothing better to do... 1449=head2 C<ev_idle> - when you've got nothing better to do...
1345 1450
1346Idle watchers trigger events when there are no other events are pending 1451Idle watchers trigger events when no other events of the same or higher
1347(prepare, check and other idle watchers do not count). That is, as long 1452priority are pending (prepare, check and other idle watchers do not
1348as your process is busy handling sockets or timeouts (or even signals, 1453count).
1349imagine) it will not be triggered. But when your process is idle all idle 1454
1350watchers are being called again and again, once per event loop iteration - 1455That is, as long as your process is busy handling sockets or timeouts
1456(or even signals, imagine) of the same or higher priority it will not be
1457triggered. But when your process is idle (or only lower-priority watchers
1458are pending), the idle watchers are being called once per event loop
1351until stopped, that is, or your process receives more events and becomes 1459iteration - until stopped, that is, or your process receives more events
1352busy. 1460and becomes busy again with higher priority stuff.
1353 1461
1354The most noteworthy effect is that as long as any idle watchers are 1462The most noteworthy effect is that as long as any idle watchers are
1355active, the process will not block when waiting for new events. 1463active, the process will not block when waiting for new events.
1356 1464
1357Apart from keeping your process non-blocking (which is a useful 1465Apart from keeping your process non-blocking (which is a useful
1358effect on its own sometimes), idle watchers are a good place to do 1466effect on its own sometimes), idle watchers are a good place to do
1359"pseudo-background processing", or delay processing stuff to after the 1467"pseudo-background processing", or delay processing stuff to after the
1360event loop has handled all outstanding events. 1468event loop has handled all outstanding events.
1469
1470=head3 Watcher-Specific Functions and Data Members
1361 1471
1362=over 4 1472=over 4
1363 1473
1364=item ev_idle_init (ev_signal *, callback) 1474=item ev_idle_init (ev_signal *, callback)
1365 1475
1423with priority higher than or equal to the event loop and one coroutine 1533with priority higher than or equal to the event loop and one coroutine
1424of lower priority, but only once, using idle watchers to keep the event 1534of lower priority, but only once, using idle watchers to keep the event
1425loop from blocking if lower-priority coroutines are active, thus mapping 1535loop from blocking if lower-priority coroutines are active, thus mapping
1426low-priority coroutines to idle/background tasks). 1536low-priority coroutines to idle/background tasks).
1427 1537
1538It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
1539priority, to ensure that they are being run before any other watchers
1540after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,
1541too) should not activate ("feed") events into libev. While libev fully
1542supports this, they will be called before other C<ev_check> watchers did
1543their job. As C<ev_check> watchers are often used to embed other event
1544loops those other event loops might be in an unusable state until their
1545C<ev_check> watcher ran (always remind yourself to coexist peacefully with
1546others).
1547
1548=head3 Watcher-Specific Functions and Data Members
1549
1428=over 4 1550=over 4
1429 1551
1430=item ev_prepare_init (ev_prepare *, callback) 1552=item ev_prepare_init (ev_prepare *, callback)
1431 1553
1432=item ev_check_init (ev_check *, callback) 1554=item ev_check_init (ev_check *, callback)
1435parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> 1557parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1436macros, but using them is utterly, utterly and completely pointless. 1558macros, but using them is utterly, utterly and completely pointless.
1437 1559
1438=back 1560=back
1439 1561
1440Example: To include a library such as adns, you would add IO watchers 1562There are a number of principal ways to embed other event loops or modules
1441and a timeout watcher in a prepare handler, as required by libadns, and 1563into libev. Here are some ideas on how to include libadns into libev
1564(there is a Perl module named C<EV::ADNS> that does this, which you could
1565use for an actually working example. Another Perl module named C<EV::Glib>
1566embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV
1567into the Glib event loop).
1568
1569Method 1: Add IO watchers and a timeout watcher in a prepare handler,
1442in a check watcher, destroy them and call into libadns. What follows is 1570and in a check watcher, destroy them and call into libadns. What follows
1443pseudo-code only of course: 1571is pseudo-code only of course. This requires you to either use a low
1572priority for the check watcher or use C<ev_clear_pending> explicitly, as
1573the callbacks for the IO/timeout watchers might not have been called yet.
1444 1574
1445 static ev_io iow [nfd]; 1575 static ev_io iow [nfd];
1446 static ev_timer tw; 1576 static ev_timer tw;
1447 1577
1448 static void 1578 static void
1449 io_cb (ev_loop *loop, ev_io *w, int revents) 1579 io_cb (ev_loop *loop, ev_io *w, int revents)
1450 { 1580 {
1451 // set the relevant poll flags
1452 // could also call adns_processreadable etc. here
1453 struct pollfd *fd = (struct pollfd *)w->data;
1454 if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1455 if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1456 } 1581 }
1457 1582
1458 // create io watchers for each fd and a timer before blocking 1583 // create io watchers for each fd and a timer before blocking
1459 static void 1584 static void
1460 adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) 1585 adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
1461 { 1586 {
1462 int timeout = 3600000;truct pollfd fds [nfd]; 1587 int timeout = 3600000;
1588 struct pollfd fds [nfd];
1463 // actual code will need to loop here and realloc etc. 1589 // actual code will need to loop here and realloc etc.
1464 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); 1590 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1465 1591
1466 /* the callback is illegal, but won't be called as we stop during check */ 1592 /* the callback is illegal, but won't be called as we stop during check */
1467 ev_timer_init (&tw, 0, timeout * 1e-3); 1593 ev_timer_init (&tw, 0, timeout * 1e-3);
1468 ev_timer_start (loop, &tw); 1594 ev_timer_start (loop, &tw);
1469 1595
1470 // create on ev_io per pollfd 1596 // create one ev_io per pollfd
1471 for (int i = 0; i < nfd; ++i) 1597 for (int i = 0; i < nfd; ++i)
1472 { 1598 {
1473 ev_io_init (iow + i, io_cb, fds [i].fd, 1599 ev_io_init (iow + i, io_cb, fds [i].fd,
1474 ((fds [i].events & POLLIN ? EV_READ : 0) 1600 ((fds [i].events & POLLIN ? EV_READ : 0)
1475 | (fds [i].events & POLLOUT ? EV_WRITE : 0))); 1601 | (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1476 1602
1477 fds [i].revents = 0; 1603 fds [i].revents = 0;
1478 iow [i].data = fds + i;
1479 ev_io_start (loop, iow + i); 1604 ev_io_start (loop, iow + i);
1480 } 1605 }
1481 } 1606 }
1482 1607
1483 // stop all watchers after blocking 1608 // stop all watchers after blocking
1485 adns_check_cb (ev_loop *loop, ev_check *w, int revents) 1610 adns_check_cb (ev_loop *loop, ev_check *w, int revents)
1486 { 1611 {
1487 ev_timer_stop (loop, &tw); 1612 ev_timer_stop (loop, &tw);
1488 1613
1489 for (int i = 0; i < nfd; ++i) 1614 for (int i = 0; i < nfd; ++i)
1615 {
1616 // set the relevant poll flags
1617 // could also call adns_processreadable etc. here
1618 struct pollfd *fd = fds + i;
1619 int revents = ev_clear_pending (iow + i);
1620 if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1621 if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1622
1623 // now stop the watcher
1490 ev_io_stop (loop, iow + i); 1624 ev_io_stop (loop, iow + i);
1625 }
1491 1626
1492 adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); 1627 adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
1628 }
1629
1630Method 2: This would be just like method 1, but you run C<adns_afterpoll>
1631in the prepare watcher and would dispose of the check watcher.
1632
1633Method 3: If the module to be embedded supports explicit event
1634notification (adns does), you can also make use of the actual watcher
1635callbacks, and only destroy/create the watchers in the prepare watcher.
1636
1637 static void
1638 timer_cb (EV_P_ ev_timer *w, int revents)
1639 {
1640 adns_state ads = (adns_state)w->data;
1641 update_now (EV_A);
1642
1643 adns_processtimeouts (ads, &tv_now);
1644 }
1645
1646 static void
1647 io_cb (EV_P_ ev_io *w, int revents)
1648 {
1649 adns_state ads = (adns_state)w->data;
1650 update_now (EV_A);
1651
1652 if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
1653 if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
1654 }
1655
1656 // do not ever call adns_afterpoll
1657
1658Method 4: Do not use a prepare or check watcher because the module you
1659want to embed is too inflexible to support it. Instead, youc na override
1660their poll function. The drawback with this solution is that the main
1661loop is now no longer controllable by EV. The C<Glib::EV> module does
1662this.
1663
1664 static gint
1665 event_poll_func (GPollFD *fds, guint nfds, gint timeout)
1666 {
1667 int got_events = 0;
1668
1669 for (n = 0; n < nfds; ++n)
1670 // create/start io watcher that sets the relevant bits in fds[n] and increment got_events
1671
1672 if (timeout >= 0)
1673 // create/start timer
1674
1675 // poll
1676 ev_loop (EV_A_ 0);
1677
1678 // stop timer again
1679 if (timeout >= 0)
1680 ev_timer_stop (EV_A_ &to);
1681
1682 // stop io watchers again - their callbacks should have set
1683 for (n = 0; n < nfds; ++n)
1684 ev_io_stop (EV_A_ iow [n]);
1685
1686 return got_events;
1493 } 1687 }
1494 1688
1495 1689
1496=head2 C<ev_embed> - when one backend isn't enough... 1690=head2 C<ev_embed> - when one backend isn't enough...
1497 1691
1561 ev_embed_start (loop_hi, &embed); 1755 ev_embed_start (loop_hi, &embed);
1562 } 1756 }
1563 else 1757 else
1564 loop_lo = loop_hi; 1758 loop_lo = loop_hi;
1565 1759
1760=head3 Watcher-Specific Functions and Data Members
1761
1566=over 4 1762=over 4
1567 1763
1568=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) 1764=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
1569 1765
1570=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) 1766=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)
1701 1897
1702To use it, 1898To use it,
1703 1899
1704 #include <ev++.h> 1900 #include <ev++.h>
1705 1901
1706(it is not installed by default). This automatically includes F<ev.h> 1902This automatically includes F<ev.h> and puts all of its definitions (many
1707and puts all of its definitions (many of them macros) into the global 1903of them macros) into the global namespace. All C++ specific things are
1708namespace. All C++ specific things are put into the C<ev> namespace. 1904put into the C<ev> namespace. It should support all the same embedding
1905options as F<ev.h>, most notably C<EV_MULTIPLICITY>.
1709 1906
1710It should support all the same embedding options as F<ev.h>, most notably 1907Care has been taken to keep the overhead low. The only data member the C++
1711C<EV_MULTIPLICITY>. 1908classes add (compared to plain C-style watchers) is the event loop pointer
1909that the watcher is associated with (or no additional members at all if
1910you disable C<EV_MULTIPLICITY> when embedding libev).
1911
1912Currently, functions, and static and non-static member functions can be
1913used as callbacks. Other types should be easy to add as long as they only
1914need one additional pointer for context. If you need support for other
1915types of functors please contact the author (preferably after implementing
1916it).
1712 1917
1713Here is a list of things available in the C<ev> namespace: 1918Here is a list of things available in the C<ev> namespace:
1714 1919
1715=over 4 1920=over 4
1716 1921
1732 1937
1733All of those classes have these methods: 1938All of those classes have these methods:
1734 1939
1735=over 4 1940=over 4
1736 1941
1737=item ev::TYPE::TYPE (object *, object::method *) 1942=item ev::TYPE::TYPE ()
1738 1943
1739=item ev::TYPE::TYPE (object *, object::method *, struct ev_loop *) 1944=item ev::TYPE::TYPE (struct ev_loop *)
1740 1945
1741=item ev::TYPE::~TYPE 1946=item ev::TYPE::~TYPE
1742 1947
1743The constructor takes a pointer to an object and a method pointer to 1948The constructor (optionally) takes an event loop to associate the watcher
1744the event handler callback to call in this class. The constructor calls 1949with. If it is omitted, it will use C<EV_DEFAULT>.
1745C<ev_init> for you, which means you have to call the C<set> method 1950
1746before starting it. If you do not specify a loop then the constructor 1951The constructor calls C<ev_init> for you, which means you have to call the
1747automatically associates the default loop with this watcher. 1952C<set> method before starting it.
1953
1954It will not set a callback, however: You have to call the templated C<set>
1955method to set a callback before you can start the watcher.
1956
1957(The reason why you have to use a method is a limitation in C++ which does
1958not allow explicit template arguments for constructors).
1748 1959
1749The destructor automatically stops the watcher if it is active. 1960The destructor automatically stops the watcher if it is active.
1961
1962=item w->set<class, &class::method> (object *)
1963
1964This method sets the callback method to call. The method has to have a
1965signature of C<void (*)(ev_TYPE &, int)>, it receives the watcher as
1966first argument and the C<revents> as second. The object must be given as
1967parameter and is stored in the C<data> member of the watcher.
1968
1969This method synthesizes efficient thunking code to call your method from
1970the C callback that libev requires. If your compiler can inline your
1971callback (i.e. it is visible to it at the place of the C<set> call and
1972your compiler is good :), then the method will be fully inlined into the
1973thunking function, making it as fast as a direct C callback.
1974
1975Example: simple class declaration and watcher initialisation
1976
1977 struct myclass
1978 {
1979 void io_cb (ev::io &w, int revents) { }
1980 }
1981
1982 myclass obj;
1983 ev::io iow;
1984 iow.set <myclass, &myclass::io_cb> (&obj);
1985
1986=item w->set<function> (void *data = 0)
1987
1988Also sets a callback, but uses a static method or plain function as
1989callback. The optional C<data> argument will be stored in the watcher's
1990C<data> member and is free for you to use.
1991
1992The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
1993
1994See the method-C<set> above for more details.
1995
1996Example:
1997
1998 static void io_cb (ev::io &w, int revents) { }
1999 iow.set <io_cb> ();
1750 2000
1751=item w->set (struct ev_loop *) 2001=item w->set (struct ev_loop *)
1752 2002
1753Associates a different C<struct ev_loop> with this watcher. You can only 2003Associates a different C<struct ev_loop> with this watcher. You can only
1754do this when the watcher is inactive (and not pending either). 2004do this when the watcher is inactive (and not pending either).
1755 2005
1756=item w->set ([args]) 2006=item w->set ([args])
1757 2007
1758Basically the same as C<ev_TYPE_set>, with the same args. Must be 2008Basically the same as C<ev_TYPE_set>, with the same args. Must be
1759called at least once. Unlike the C counterpart, an active watcher gets 2009called at least once. Unlike the C counterpart, an active watcher gets
1760automatically stopped and restarted. 2010automatically stopped and restarted when reconfiguring it with this
2011method.
1761 2012
1762=item w->start () 2013=item w->start ()
1763 2014
1764Starts the watcher. Note that there is no C<loop> argument as the 2015Starts the watcher. Note that there is no C<loop> argument, as the
1765constructor already takes the loop. 2016constructor already stores the event loop.
1766 2017
1767=item w->stop () 2018=item w->stop ()
1768 2019
1769Stops the watcher if it is active. Again, no C<loop> argument. 2020Stops the watcher if it is active. Again, no C<loop> argument.
1770 2021
1795 2046
1796 myclass (); 2047 myclass ();
1797 } 2048 }
1798 2049
1799 myclass::myclass (int fd) 2050 myclass::myclass (int fd)
1800 : io (this, &myclass::io_cb),
1801 idle (this, &myclass::idle_cb)
1802 { 2051 {
2052 io .set <myclass, &myclass::io_cb > (this);
2053 idle.set <myclass, &myclass::idle_cb> (this);
2054
1803 io.start (fd, ev::READ); 2055 io.start (fd, ev::READ);
1804 } 2056 }
1805 2057
1806 2058
1807=head1 MACRO MAGIC 2059=head1 MACRO MAGIC
1808 2060
1809Libev can be compiled with a variety of options, the most fundemantal is 2061Libev can be compiled with a variety of options, the most fundemantal is
1810C<EV_MULTIPLICITY>. This option determines wether (most) functions and 2062C<EV_MULTIPLICITY>. This option determines whether (most) functions and
1811callbacks have an initial C<struct ev_loop *> argument. 2063callbacks have an initial C<struct ev_loop *> argument.
1812 2064
1813To make it easier to write programs that cope with either variant, the 2065To make it easier to write programs that cope with either variant, the
1814following macros are defined: 2066following macros are defined:
1815 2067
1848Similar to the other two macros, this gives you the value of the default 2100Similar to the other two macros, this gives you the value of the default
1849loop, if multiple loops are supported ("ev loop default"). 2101loop, if multiple loops are supported ("ev loop default").
1850 2102
1851=back 2103=back
1852 2104
1853Example: Declare and initialise a check watcher, working regardless of 2105Example: Declare and initialise a check watcher, utilising the above
1854wether multiple loops are supported or not. 2106macros so it will work regardless of whether multiple loops are supported
2107or not.
1855 2108
1856 static void 2109 static void
1857 check_cb (EV_P_ ev_timer *w, int revents) 2110 check_cb (EV_P_ ev_timer *w, int revents)
1858 { 2111 {
1859 ev_check_stop (EV_A_ w); 2112 ev_check_stop (EV_A_ w);
1861 2114
1862 ev_check check; 2115 ev_check check;
1863 ev_check_init (&check, check_cb); 2116 ev_check_init (&check, check_cb);
1864 ev_check_start (EV_DEFAULT_ &check); 2117 ev_check_start (EV_DEFAULT_ &check);
1865 ev_loop (EV_DEFAULT_ 0); 2118 ev_loop (EV_DEFAULT_ 0);
1866
1867 2119
1868=head1 EMBEDDING 2120=head1 EMBEDDING
1869 2121
1870Libev can (and often is) directly embedded into host 2122Libev can (and often is) directly embedded into host
1871applications. Examples of applications that embed it include the Deliantra 2123applications. Examples of applications that embed it include the Deliantra
1911 ev_vars.h 2163 ev_vars.h
1912 ev_wrap.h 2164 ev_wrap.h
1913 2165
1914 ev_win32.c required on win32 platforms only 2166 ev_win32.c required on win32 platforms only
1915 2167
1916 ev_select.c only when select backend is enabled (which is by default) 2168 ev_select.c only when select backend is enabled (which is enabled by default)
1917 ev_poll.c only when poll backend is enabled (disabled by default) 2169 ev_poll.c only when poll backend is enabled (disabled by default)
1918 ev_epoll.c only when the epoll backend is enabled (disabled by default) 2170 ev_epoll.c only when the epoll backend is enabled (disabled by default)
1919 ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 2171 ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
1920 ev_port.c only when the solaris port backend is enabled (disabled by default) 2172 ev_port.c only when the solaris port backend is enabled (disabled by default)
1921 2173
2084will have the C<struct ev_loop *> as first argument, and you can create 2336will have the C<struct ev_loop *> as first argument, and you can create
2085additional independent event loops. Otherwise there will be no support 2337additional independent event loops. Otherwise there will be no support
2086for multiple event loops and there is no first event loop pointer 2338for multiple event loops and there is no first event loop pointer
2087argument. Instead, all functions act on the single default loop. 2339argument. Instead, all functions act on the single default loop.
2088 2340
2341=item EV_MINPRI
2342
2343=item EV_MAXPRI
2344
2345The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
2346C<EV_MAXPRI>, but otherwise there are no non-obvious limitations. You can
2347provide for more priorities by overriding those symbols (usually defined
2348to be C<-2> and C<2>, respectively).
2349
2350When doing priority-based operations, libev usually has to linearly search
2351all the priorities, so having many of them (hundreds) uses a lot of space
2352and time, so using the defaults of five priorities (-2 .. +2) is usually
2353fine.
2354
2355If your embedding app does not need any priorities, defining these both to
2356C<0> will save some memory and cpu.
2357
2089=item EV_PERIODIC_ENABLE 2358=item EV_PERIODIC_ENABLE
2090 2359
2091If undefined or defined to be C<1>, then periodic timers are supported. If 2360If undefined or defined to be C<1>, then periodic timers are supported. If
2361defined to be C<0>, then they are not. Disabling them saves a few kB of
2362code.
2363
2364=item EV_IDLE_ENABLE
2365
2366If undefined or defined to be C<1>, then idle watchers are supported. If
2092defined to be C<0>, then they are not. Disabling them saves a few kB of 2367defined to be C<0>, then they are not. Disabling them saves a few kB of
2093code. 2368code.
2094 2369
2095=item EV_EMBED_ENABLE 2370=item EV_EMBED_ENABLE
2096 2371
2163interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file 2438interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file
2164will be compiled. It is pretty complex because it provides its own header 2439will be compiled. It is pretty complex because it provides its own header
2165file. 2440file.
2166 2441
2167The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file 2442The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
2168that everybody includes and which overrides some autoconf choices: 2443that everybody includes and which overrides some configure choices:
2169 2444
2445 #define EV_MINIMAL 1
2170 #define EV_USE_POLL 0 2446 #define EV_USE_POLL 0
2171 #define EV_MULTIPLICITY 0 2447 #define EV_MULTIPLICITY 0
2172 #define EV_PERIODICS 0 2448 #define EV_PERIODIC_ENABLE 0
2449 #define EV_STAT_ENABLE 0
2450 #define EV_FORK_ENABLE 0
2173 #define EV_CONFIG_H <config.h> 2451 #define EV_CONFIG_H <config.h>
2452 #define EV_MINPRI 0
2453 #define EV_MAXPRI 0
2174 2454
2175 #include "ev++.h" 2455 #include "ev++.h"
2176 2456
2177And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: 2457And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
2178 2458
2184 2464
2185In this section the complexities of (many of) the algorithms used inside 2465In this section the complexities of (many of) the algorithms used inside
2186libev will be explained. For complexity discussions about backends see the 2466libev will be explained. For complexity discussions about backends see the
2187documentation for C<ev_default_init>. 2467documentation for C<ev_default_init>.
2188 2468
2469All of the following are about amortised time: If an array needs to be
2470extended, libev needs to realloc and move the whole array, but this
2471happens asymptotically never with higher number of elements, so O(1) might
2472mean it might do a lengthy realloc operation in rare cases, but on average
2473it is much faster and asymptotically approaches constant time.
2474
2189=over 4 2475=over 4
2190 2476
2191=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) 2477=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
2192 2478
2479This means that, when you have a watcher that triggers in one hour and
2480there are 100 watchers that would trigger before that then inserting will
2481have to skip those 100 watchers.
2482
2193=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers) 2483=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)
2194 2484
2485That means that for changing a timer costs less than removing/adding them
2486as only the relative motion in the event queue has to be paid for.
2487
2195=item Starting io/check/prepare/idle/signal/child watchers: O(1) 2488=item Starting io/check/prepare/idle/signal/child watchers: O(1)
2196 2489
2490These just add the watcher into an array or at the head of a list.
2197=item Stopping check/prepare/idle watchers: O(1) 2491=item Stopping check/prepare/idle watchers: O(1)
2198 2492
2199=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) 2493=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
2200 2494
2495These watchers are stored in lists then need to be walked to find the
2496correct watcher to remove. The lists are usually short (you don't usually
2497have many watchers waiting for the same fd or signal).
2498
2201=item Finding the next timer per loop iteration: O(1) 2499=item Finding the next timer per loop iteration: O(1)
2202 2500
2203=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) 2501=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2204 2502
2503A change means an I/O watcher gets started or stopped, which requires
2504libev to recalculate its status (and possibly tell the kernel).
2505
2205=item Activating one watcher: O(1) 2506=item Activating one watcher: O(1)
2206 2507
2508=item Priority handling: O(number_of_priorities)
2509
2510Priorities are implemented by allocating some space for each
2511priority. When doing priority-based operations, libev usually has to
2512linearly search all the priorities.
2513
2207=back 2514=back
2208 2515
2209 2516
2210=head1 AUTHOR 2517=head1 AUTHOR
2211 2518

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines