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

Comparing libev/ev.pod (file contents):
Revision 1.65 by ayin, Sat Dec 1 15:38:54 2007 UTC vs.
Revision 1.86 by root, Tue Dec 18 01:20:33 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
94Libev represents time as a single floating point number, representing the 98Libev represents time as a single floating point number, representing the
95(fractional) number of seconds since the (POSIX) epoch (somewhere near 99(fractional) number of seconds since the (POSIX) epoch (somewhere near
96the beginning of 1970, details are complicated, don't ask). This type is 100the beginning of 1970, details are complicated, don't ask). This type is
97called C<ev_tstamp>, which is what you should use too. It usually aliases 101called C<ev_tstamp>, which is what you should use too. It usually aliases
98to the C<double> type in C, and when you need to do any calculations on 102to the C<double> type in C, and when you need to do any calculations on
99it, you should treat it as such. 103it, you should treat it as some floatingpoint value. Unlike the name
104component C<stamp> might indicate, it is also used for time differences
105throughout libev.
100 106
101=head1 GLOBAL FUNCTIONS 107=head1 GLOBAL FUNCTIONS
102 108
103These functions can be called anytime, even before initialising the 109These functions can be called anytime, even before initialising the
104library in any way. 110library in any way.
113 119
114=item int ev_version_major () 120=item int ev_version_major ()
115 121
116=item int ev_version_minor () 122=item int ev_version_minor ()
117 123
118You can find out the major and minor version numbers of the library 124You 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 125you linked against by calling the functions C<ev_version_major> and
120C<ev_version_minor>. If you want, you can compare against the global 126C<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 127symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the
122version of the library your program was compiled against. 128version of the library your program was compiled against.
123 129
130These version numbers refer to the ABI version of the library, not the
131release version.
132
124Usually, it's a good idea to terminate if the major versions mismatch, 133Usually, it's a good idea to terminate if the major versions mismatch,
125as this indicates an incompatible change. Minor versions are usually 134as this indicates an incompatible change. Minor versions are usually
126compatible to older versions, so a larger minor version alone is usually 135compatible to older versions, so a larger minor version alone is usually
127not a problem. 136not a problem.
128 137
129Example: Make sure we haven't accidentally been linked against the wrong 138Example: Make sure we haven't accidentally been linked against the wrong
130version. 139version.
430 439
431Like C<ev_default_fork>, but acts on an event loop created by 440Like 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 441C<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. 442after fork, and how you do this is entirely your own problem.
434 443
444=item unsigned int ev_loop_count (loop)
445
446Returns the count of loop iterations for the loop, which is identical to
447the number of times libev did poll for new events. It starts at C<0> and
448happily wraps around with enough iterations.
449
450This value can sometimes be useful as a generation counter of sorts (it
451"ticks" the number of loop iterations), as it roughly corresponds with
452C<ev_prepare> and C<ev_check> calls.
453
435=item unsigned int ev_backend (loop) 454=item unsigned int ev_backend (loop)
436 455
437Returns one of the C<EVBACKEND_*> flags indicating the event backend in 456Returns one of the C<EVBACKEND_*> flags indicating the event backend in
438use. 457use.
439 458
472libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is 491libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is
473usually a better approach for this kind of thing. 492usually a better approach for this kind of thing.
474 493
475Here are the gory details of what C<ev_loop> does: 494Here are the gory details of what C<ev_loop> does:
476 495
496 - Before the first iteration, call any pending watchers.
477 * If there are no active watchers (reference count is zero), return. 497 * If there are no active watchers (reference count is zero), return.
478 - Queue prepare watchers and then call all outstanding watchers. 498 - Queue all prepare watchers and then call all outstanding watchers.
479 - If we have been forked, recreate the kernel state. 499 - If we have been forked, recreate the kernel state.
480 - Update the kernel state with all outstanding changes. 500 - Update the kernel state with all outstanding changes.
481 - Update the "event loop time". 501 - Update the "event loop time".
482 - Calculate for how long to block. 502 - Calculate for how long to block.
483 - Block the process, waiting for any events. 503 - Block the process, waiting for any events.
722=item bool ev_is_pending (ev_TYPE *watcher) 742=item bool ev_is_pending (ev_TYPE *watcher)
723 743
724Returns a true value iff the watcher is pending, (i.e. it has outstanding 744Returns 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 745events 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 746is 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 747C<ev_TYPE_set> is safe), you must not change its priority, and you must
728libev (e.g. you cnanot C<free ()> it). 748make sure the watcher is available to libev (e.g. you cannot C<free ()>
749it).
729 750
730=item callback ev_cb (ev_TYPE *watcher) 751=item callback ev_cb (ev_TYPE *watcher)
731 752
732Returns the callback currently set on the watcher. 753Returns the callback currently set on the watcher.
733 754
734=item ev_cb_set (ev_TYPE *watcher, callback) 755=item ev_cb_set (ev_TYPE *watcher, callback)
735 756
736Change the callback. You can change the callback at virtually any time 757Change the callback. You can change the callback at virtually any time
737(modulo threads). 758(modulo threads).
759
760=item ev_set_priority (ev_TYPE *watcher, priority)
761
762=item int ev_priority (ev_TYPE *watcher)
763
764Set and query the priority of the watcher. The priority is a small
765integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
766(default: C<-2>). Pending watchers with higher priority will be invoked
767before watchers with lower priority, but priority will not keep watchers
768from being executed (except for C<ev_idle> watchers).
769
770This means that priorities are I<only> used for ordering callback
771invocation after new events have been received. This is useful, for
772example, to reduce latency after idling, or more often, to bind two
773watchers on the same event and make sure one is called first.
774
775If you need to suppress invocation when higher priority events are pending
776you need to look at C<ev_idle> watchers, which provide this functionality.
777
778You I<must not> change the priority of a watcher as long as it is active or
779pending.
780
781The default priority used by watchers when no priority has been set is
782always C<0>, which is supposed to not be too high and not be too low :).
783
784Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
785fine, as long as you do not mind that the priority value you query might
786or might not have been adjusted to be within valid range.
787
788=item ev_invoke (loop, ev_TYPE *watcher, int revents)
789
790Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
791C<loop> nor C<revents> need to be valid as long as the watcher callback
792can deal with that fact.
793
794=item int ev_clear_pending (loop, ev_TYPE *watcher)
795
796If the watcher is pending, this function returns clears its pending status
797and returns its C<revents> bitset (as if its callback was invoked). If the
798watcher isn't pending it does nothing and returns C<0>.
738 799
739=back 800=back
740 801
741 802
742=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER 803=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
848it is best to always use non-blocking I/O: An extra C<read>(2) returning 909it 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. 910C<EAGAIN> is far preferable to a program hanging until some data arrives.
850 911
851If you cannot run the fd in non-blocking mode (for example you should not 912If 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 913play 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 914whether 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 915such as poll (fortunately in our Xlib example, Xlib already does this on
855its own, so its quite safe to use). 916its own, so its quite safe to use).
917
918=head3 The special problem of disappearing file descriptors
919
920Some backends (e.g kqueue, epoll) need to be told about closing a file
921descriptor (either by calling C<close> explicitly or by any other means,
922such as C<dup>). The reason is that you register interest in some file
923descriptor, but when it goes away, the operating system will silently drop
924this interest. If another file descriptor with the same number then is
925registered with libev, there is no efficient way to see that this is, in
926fact, a different file descriptor.
927
928To avoid having to explicitly tell libev about such cases, libev follows
929the following policy: Each time C<ev_io_set> is being called, libev
930will assume that this is potentially a new file descriptor, otherwise
931it is assumed that the file descriptor stays the same. That means that
932you I<have> to call C<ev_io_set> (or C<ev_io_init>) when you change the
933descriptor even if the file descriptor number itself did not change.
934
935This is how one would do it normally anyway, the important point is that
936the libev application should not optimise around libev but should leave
937optimisations to libev.
938
939
940=head3 Watcher-Specific Functions
856 941
857=over 4 942=over 4
858 943
859=item ev_io_init (ev_io *, callback, int fd, int events) 944=item ev_io_init (ev_io *, callback, int fd, int events)
860 945
913 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 998 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
914 999
915The callback is guarenteed to be invoked only when its timeout has passed, 1000The callback is guarenteed to be invoked only when its timeout has passed,
916but if multiple timers become ready during the same loop iteration then 1001but if multiple timers become ready during the same loop iteration then
917order of execution is undefined. 1002order of execution is undefined.
1003
1004=head3 Watcher-Specific Functions and Data Members
918 1005
919=over 4 1006=over 4
920 1007
921=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 1008=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
922 1009
1018but on wallclock time (absolute time). You can tell a periodic watcher 1105but 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 1106to 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 () 1107periodic 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 1108+ 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 1109take 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 1110roughly 10 seconds later).
1024again).
1025 1111
1026They can also be used to implement vastly more complex timers, such as 1112They can also be used to implement vastly more complex timers, such as
1027triggering an event on eahc midnight, local time. 1113triggering an event on each midnight, local time or other, complicated,
1114rules.
1028 1115
1029As with timers, the callback is guarenteed to be invoked only when the 1116As 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 1117time (C<at>) has been passed, but if multiple periodic timers become ready
1031during the same loop iteration then order of execution is undefined. 1118during the same loop iteration then order of execution is undefined.
1032 1119
1120=head3 Watcher-Specific Functions and Data Members
1121
1033=over 4 1122=over 4
1034 1123
1035=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb) 1124=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)
1036 1125
1037=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb) 1126=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 1128Lots of arguments, lets sort it out... There are basically three modes of
1040operation, and we will explain them from simplest to complex: 1129operation, and we will explain them from simplest to complex:
1041 1130
1042=over 4 1131=over 4
1043 1132
1044=item * absolute timer (interval = reschedule_cb = 0) 1133=item * absolute timer (at = time, interval = reschedule_cb = 0)
1045 1134
1046In this configuration the watcher triggers an event at the wallclock time 1135In 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, 1136C<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 1137that is, if it is to be run at January 1st 2011 then it will run when the
1049system time reaches or surpasses this time. 1138system time reaches or surpasses this time.
1050 1139
1051=item * non-repeating interval timer (interval > 0, reschedule_cb = 0) 1140=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1052 1141
1053In this mode the watcher will always be scheduled to time out at the next 1142In 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 1143C<at + N * interval> time (for some integer N, which can also be negative)
1055of any time jumps. 1144and then repeat, regardless of any time jumps.
1056 1145
1057This can be used to create timers that do not drift with respect to system 1146This can be used to create timers that do not drift with respect to system
1058time: 1147time:
1059 1148
1060 ev_periodic_set (&periodic, 0., 3600., 0); 1149 ev_periodic_set (&periodic, 0., 3600., 0);
1066 1155
1067Another way to think about it (for the mathematically inclined) is that 1156Another 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 1157C<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. 1158time where C<time = at (mod interval)>, regardless of any time jumps.
1070 1159
1160For numerical stability it is preferable that the C<at> value is near
1161C<ev_now ()> (the current time), but there is no range requirement for
1162this value.
1163
1071=item * manual reschedule mode (reschedule_cb = callback) 1164=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)
1072 1165
1073In this mode the values for C<interval> and C<at> are both being 1166In this mode the values for C<interval> and C<at> are both being
1074ignored. Instead, each time the periodic watcher gets scheduled, the 1167ignored. Instead, each time the periodic watcher gets scheduled, the
1075reschedule callback will be called with the watcher as first, and the 1168reschedule callback will be called with the watcher as first, and the
1076current time as second argument. 1169current time as second argument.
1077 1170
1078NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, 1171NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,
1079ever, or make any event loop modifications>. If you need to stop it, 1172ever, 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 1173return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by
1081starting a prepare watcher). 1174starting an C<ev_prepare> watcher, which is legal).
1082 1175
1083Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w, 1176Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
1084ev_tstamp now)>, e.g.: 1177ev_tstamp now)>, e.g.:
1085 1178
1086 static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) 1179 static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
1109Simply stops and restarts the periodic watcher again. This is only useful 1202Simply stops and restarts the periodic watcher again. This is only useful
1110when you changed some parameters or the reschedule callback would return 1203when 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 1204a different time than the last time it was called (e.g. in a crond like
1112program when the crontabs have changed). 1205program when the crontabs have changed).
1113 1206
1207=item ev_tstamp offset [read-write]
1208
1209When repeating, this contains the offset value, otherwise this is the
1210absolute point in time (the C<at> value passed to C<ev_periodic_set>).
1211
1212Can be modified any time, but changes only take effect when the periodic
1213timer fires or C<ev_periodic_again> is being called.
1214
1114=item ev_tstamp interval [read-write] 1215=item ev_tstamp interval [read-write]
1115 1216
1116The current interval value. Can be modified any time, but changes only 1217The 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 1218take effect when the periodic timer fires or C<ev_periodic_again> is being
1118called. 1219called.
1120=item ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write] 1221=item ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]
1121 1222
1122The current reschedule callback, or C<0>, if this functionality is 1223The current reschedule callback, or C<0>, if this functionality is
1123switched off. Can be changed any time, but changes only take effect when 1224switched off. Can be changed any time, but changes only take effect when
1124the periodic timer fires or C<ev_periodic_again> is being called. 1225the periodic timer fires or C<ev_periodic_again> is being called.
1226
1227=item ev_tstamp at [read-only]
1228
1229When active, contains the absolute time that the watcher is supposed to
1230trigger next.
1125 1231
1126=back 1232=back
1127 1233
1128Example: Call a callback every hour, or, more precisely, whenever the 1234Example: Call a callback every hour, or, more precisely, whenever the
1129system clock is divisible by 3600. The callback invocation times have 1235system clock is divisible by 3600. The callback invocation times have
1171with the kernel (thus it coexists with your own signal handlers as long 1277with 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 1278as 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 1279watcher for a signal is stopped libev will reset the signal handler to
1174SIG_DFL (regardless of what it was set to before). 1280SIG_DFL (regardless of what it was set to before).
1175 1281
1282=head3 Watcher-Specific Functions and Data Members
1283
1176=over 4 1284=over 4
1177 1285
1178=item ev_signal_init (ev_signal *, callback, int signum) 1286=item ev_signal_init (ev_signal *, callback, int signum)
1179 1287
1180=item ev_signal_set (ev_signal *, int signum) 1288=item ev_signal_set (ev_signal *, int signum)
1191 1299
1192=head2 C<ev_child> - watch out for process status changes 1300=head2 C<ev_child> - watch out for process status changes
1193 1301
1194Child watchers trigger when your process receives a SIGCHLD in response to 1302Child watchers trigger when your process receives a SIGCHLD in response to
1195some child status changes (most typically when a child of yours dies). 1303some child status changes (most typically when a child of yours dies).
1304
1305=head3 Watcher-Specific Functions and Data Members
1196 1306
1197=over 4 1307=over 4
1198 1308
1199=item ev_child_init (ev_child *, callback, int pid) 1309=item ev_child_init (ev_child *, callback, int pid)
1200 1310
1268reader). Inotify will be used to give hints only and should not change the 1378reader). 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 1379semantics of C<ev_stat> watchers, which means that libev sometimes needs
1270to fall back to regular polling again even with inotify, but changes are 1380to fall back to regular polling again even with inotify, but changes are
1271usually detected immediately, and if the file exists there will be no 1381usually detected immediately, and if the file exists there will be no
1272polling. 1382polling.
1383
1384=head3 Watcher-Specific Functions and Data Members
1273 1385
1274=over 4 1386=over 4
1275 1387
1276=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval) 1388=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)
1277 1389
1341 ev_stat_start (loop, &passwd); 1453 ev_stat_start (loop, &passwd);
1342 1454
1343 1455
1344=head2 C<ev_idle> - when you've got nothing better to do... 1456=head2 C<ev_idle> - when you've got nothing better to do...
1345 1457
1346Idle watchers trigger events when there are no other events are pending 1458Idle 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 1459priority are pending (prepare, check and other idle watchers do not
1348as your process is busy handling sockets or timeouts (or even signals, 1460count).
1349imagine) it will not be triggered. But when your process is idle all idle 1461
1350watchers are being called again and again, once per event loop iteration - 1462That is, as long as your process is busy handling sockets or timeouts
1463(or even signals, imagine) of the same or higher priority it will not be
1464triggered. But when your process is idle (or only lower-priority watchers
1465are pending), the idle watchers are being called once per event loop
1351until stopped, that is, or your process receives more events and becomes 1466iteration - until stopped, that is, or your process receives more events
1352busy. 1467and becomes busy again with higher priority stuff.
1353 1468
1354The most noteworthy effect is that as long as any idle watchers are 1469The most noteworthy effect is that as long as any idle watchers are
1355active, the process will not block when waiting for new events. 1470active, the process will not block when waiting for new events.
1356 1471
1357Apart from keeping your process non-blocking (which is a useful 1472Apart from keeping your process non-blocking (which is a useful
1358effect on its own sometimes), idle watchers are a good place to do 1473effect on its own sometimes), idle watchers are a good place to do
1359"pseudo-background processing", or delay processing stuff to after the 1474"pseudo-background processing", or delay processing stuff to after the
1360event loop has handled all outstanding events. 1475event loop has handled all outstanding events.
1476
1477=head3 Watcher-Specific Functions and Data Members
1361 1478
1362=over 4 1479=over 4
1363 1480
1364=item ev_idle_init (ev_signal *, callback) 1481=item ev_idle_init (ev_signal *, callback)
1365 1482
1423with priority higher than or equal to the event loop and one coroutine 1540with 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 1541of lower priority, but only once, using idle watchers to keep the event
1425loop from blocking if lower-priority coroutines are active, thus mapping 1542loop from blocking if lower-priority coroutines are active, thus mapping
1426low-priority coroutines to idle/background tasks). 1543low-priority coroutines to idle/background tasks).
1427 1544
1545It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
1546priority, to ensure that they are being run before any other watchers
1547after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,
1548too) should not activate ("feed") events into libev. While libev fully
1549supports this, they will be called before other C<ev_check> watchers did
1550their job. As C<ev_check> watchers are often used to embed other event
1551loops those other event loops might be in an unusable state until their
1552C<ev_check> watcher ran (always remind yourself to coexist peacefully with
1553others).
1554
1555=head3 Watcher-Specific Functions and Data Members
1556
1428=over 4 1557=over 4
1429 1558
1430=item ev_prepare_init (ev_prepare *, callback) 1559=item ev_prepare_init (ev_prepare *, callback)
1431 1560
1432=item ev_check_init (ev_check *, callback) 1561=item ev_check_init (ev_check *, callback)
1435parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> 1564parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1436macros, but using them is utterly, utterly and completely pointless. 1565macros, but using them is utterly, utterly and completely pointless.
1437 1566
1438=back 1567=back
1439 1568
1440Example: To include a library such as adns, you would add IO watchers 1569There 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 1570into libev. Here are some ideas on how to include libadns into libev
1571(there is a Perl module named C<EV::ADNS> that does this, which you could
1572use for an actually working example. Another Perl module named C<EV::Glib>
1573embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV
1574into the Glib event loop).
1575
1576Method 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 1577and in a check watcher, destroy them and call into libadns. What follows
1443pseudo-code only of course: 1578is pseudo-code only of course. This requires you to either use a low
1579priority for the check watcher or use C<ev_clear_pending> explicitly, as
1580the callbacks for the IO/timeout watchers might not have been called yet.
1444 1581
1445 static ev_io iow [nfd]; 1582 static ev_io iow [nfd];
1446 static ev_timer tw; 1583 static ev_timer tw;
1447 1584
1448 static void 1585 static void
1449 io_cb (ev_loop *loop, ev_io *w, int revents) 1586 io_cb (ev_loop *loop, ev_io *w, int revents)
1450 { 1587 {
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 } 1588 }
1457 1589
1458 // create io watchers for each fd and a timer before blocking 1590 // create io watchers for each fd and a timer before blocking
1459 static void 1591 static void
1460 adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) 1592 adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
1466 1598
1467 /* the callback is illegal, but won't be called as we stop during check */ 1599 /* the callback is illegal, but won't be called as we stop during check */
1468 ev_timer_init (&tw, 0, timeout * 1e-3); 1600 ev_timer_init (&tw, 0, timeout * 1e-3);
1469 ev_timer_start (loop, &tw); 1601 ev_timer_start (loop, &tw);
1470 1602
1471 // create on ev_io per pollfd 1603 // create one ev_io per pollfd
1472 for (int i = 0; i < nfd; ++i) 1604 for (int i = 0; i < nfd; ++i)
1473 { 1605 {
1474 ev_io_init (iow + i, io_cb, fds [i].fd, 1606 ev_io_init (iow + i, io_cb, fds [i].fd,
1475 ((fds [i].events & POLLIN ? EV_READ : 0) 1607 ((fds [i].events & POLLIN ? EV_READ : 0)
1476 | (fds [i].events & POLLOUT ? EV_WRITE : 0))); 1608 | (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1477 1609
1478 fds [i].revents = 0; 1610 fds [i].revents = 0;
1479 iow [i].data = fds + i;
1480 ev_io_start (loop, iow + i); 1611 ev_io_start (loop, iow + i);
1481 } 1612 }
1482 } 1613 }
1483 1614
1484 // stop all watchers after blocking 1615 // stop all watchers after blocking
1486 adns_check_cb (ev_loop *loop, ev_check *w, int revents) 1617 adns_check_cb (ev_loop *loop, ev_check *w, int revents)
1487 { 1618 {
1488 ev_timer_stop (loop, &tw); 1619 ev_timer_stop (loop, &tw);
1489 1620
1490 for (int i = 0; i < nfd; ++i) 1621 for (int i = 0; i < nfd; ++i)
1622 {
1623 // set the relevant poll flags
1624 // could also call adns_processreadable etc. here
1625 struct pollfd *fd = fds + i;
1626 int revents = ev_clear_pending (iow + i);
1627 if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1628 if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1629
1630 // now stop the watcher
1491 ev_io_stop (loop, iow + i); 1631 ev_io_stop (loop, iow + i);
1632 }
1492 1633
1493 adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); 1634 adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
1635 }
1636
1637Method 2: This would be just like method 1, but you run C<adns_afterpoll>
1638in the prepare watcher and would dispose of the check watcher.
1639
1640Method 3: If the module to be embedded supports explicit event
1641notification (adns does), you can also make use of the actual watcher
1642callbacks, and only destroy/create the watchers in the prepare watcher.
1643
1644 static void
1645 timer_cb (EV_P_ ev_timer *w, int revents)
1646 {
1647 adns_state ads = (adns_state)w->data;
1648 update_now (EV_A);
1649
1650 adns_processtimeouts (ads, &tv_now);
1651 }
1652
1653 static void
1654 io_cb (EV_P_ ev_io *w, int revents)
1655 {
1656 adns_state ads = (adns_state)w->data;
1657 update_now (EV_A);
1658
1659 if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
1660 if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
1661 }
1662
1663 // do not ever call adns_afterpoll
1664
1665Method 4: Do not use a prepare or check watcher because the module you
1666want to embed is too inflexible to support it. Instead, youc na override
1667their poll function. The drawback with this solution is that the main
1668loop is now no longer controllable by EV. The C<Glib::EV> module does
1669this.
1670
1671 static gint
1672 event_poll_func (GPollFD *fds, guint nfds, gint timeout)
1673 {
1674 int got_events = 0;
1675
1676 for (n = 0; n < nfds; ++n)
1677 // create/start io watcher that sets the relevant bits in fds[n] and increment got_events
1678
1679 if (timeout >= 0)
1680 // create/start timer
1681
1682 // poll
1683 ev_loop (EV_A_ 0);
1684
1685 // stop timer again
1686 if (timeout >= 0)
1687 ev_timer_stop (EV_A_ &to);
1688
1689 // stop io watchers again - their callbacks should have set
1690 for (n = 0; n < nfds; ++n)
1691 ev_io_stop (EV_A_ iow [n]);
1692
1693 return got_events;
1494 } 1694 }
1495 1695
1496 1696
1497=head2 C<ev_embed> - when one backend isn't enough... 1697=head2 C<ev_embed> - when one backend isn't enough...
1498 1698
1562 ev_embed_start (loop_hi, &embed); 1762 ev_embed_start (loop_hi, &embed);
1563 } 1763 }
1564 else 1764 else
1565 loop_lo = loop_hi; 1765 loop_lo = loop_hi;
1566 1766
1767=head3 Watcher-Specific Functions and Data Members
1768
1567=over 4 1769=over 4
1568 1770
1569=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) 1771=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
1570 1772
1571=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) 1773=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)
1597event loop blocks next and before C<ev_check> watchers are being called, 1799event loop blocks next and before C<ev_check> watchers are being called,
1598and only in the child after the fork. If whoever good citizen calling 1800and only in the child after the fork. If whoever good citizen calling
1599C<ev_default_fork> cheats and calls it in the wrong process, the fork 1801C<ev_default_fork> cheats and calls it in the wrong process, the fork
1600handlers will be invoked, too, of course. 1802handlers will be invoked, too, of course.
1601 1803
1804=head3 Watcher-Specific Functions and Data Members
1805
1602=over 4 1806=over 4
1603 1807
1604=item ev_fork_init (ev_signal *, callback) 1808=item ev_fork_init (ev_signal *, callback)
1605 1809
1606Initialises and configures the fork watcher - it has no parameters of any 1810Initialises and configures the fork watcher - it has no parameters of any
1702 1906
1703To use it, 1907To use it,
1704 1908
1705 #include <ev++.h> 1909 #include <ev++.h>
1706 1910
1707(it is not installed by default). This automatically includes F<ev.h> 1911This automatically includes F<ev.h> and puts all of its definitions (many
1708and puts all of its definitions (many of them macros) into the global 1912of them macros) into the global namespace. All C++ specific things are
1709namespace. All C++ specific things are put into the C<ev> namespace. 1913put into the C<ev> namespace. It should support all the same embedding
1914options as F<ev.h>, most notably C<EV_MULTIPLICITY>.
1710 1915
1711It should support all the same embedding options as F<ev.h>, most notably 1916Care has been taken to keep the overhead low. The only data member the C++
1712C<EV_MULTIPLICITY>. 1917classes add (compared to plain C-style watchers) is the event loop pointer
1918that the watcher is associated with (or no additional members at all if
1919you disable C<EV_MULTIPLICITY> when embedding libev).
1920
1921Currently, functions, and static and non-static member functions can be
1922used as callbacks. Other types should be easy to add as long as they only
1923need one additional pointer for context. If you need support for other
1924types of functors please contact the author (preferably after implementing
1925it).
1713 1926
1714Here is a list of things available in the C<ev> namespace: 1927Here is a list of things available in the C<ev> namespace:
1715 1928
1716=over 4 1929=over 4
1717 1930
1733 1946
1734All of those classes have these methods: 1947All of those classes have these methods:
1735 1948
1736=over 4 1949=over 4
1737 1950
1738=item ev::TYPE::TYPE (object *, object::method *) 1951=item ev::TYPE::TYPE ()
1739 1952
1740=item ev::TYPE::TYPE (object *, object::method *, struct ev_loop *) 1953=item ev::TYPE::TYPE (struct ev_loop *)
1741 1954
1742=item ev::TYPE::~TYPE 1955=item ev::TYPE::~TYPE
1743 1956
1744The constructor takes a pointer to an object and a method pointer to 1957The constructor (optionally) takes an event loop to associate the watcher
1745the event handler callback to call in this class. The constructor calls 1958with. If it is omitted, it will use C<EV_DEFAULT>.
1746C<ev_init> for you, which means you have to call the C<set> method 1959
1747before starting it. If you do not specify a loop then the constructor 1960The constructor calls C<ev_init> for you, which means you have to call the
1748automatically associates the default loop with this watcher. 1961C<set> method before starting it.
1962
1963It will not set a callback, however: You have to call the templated C<set>
1964method to set a callback before you can start the watcher.
1965
1966(The reason why you have to use a method is a limitation in C++ which does
1967not allow explicit template arguments for constructors).
1749 1968
1750The destructor automatically stops the watcher if it is active. 1969The destructor automatically stops the watcher if it is active.
1970
1971=item w->set<class, &class::method> (object *)
1972
1973This method sets the callback method to call. The method has to have a
1974signature of C<void (*)(ev_TYPE &, int)>, it receives the watcher as
1975first argument and the C<revents> as second. The object must be given as
1976parameter and is stored in the C<data> member of the watcher.
1977
1978This method synthesizes efficient thunking code to call your method from
1979the C callback that libev requires. If your compiler can inline your
1980callback (i.e. it is visible to it at the place of the C<set> call and
1981your compiler is good :), then the method will be fully inlined into the
1982thunking function, making it as fast as a direct C callback.
1983
1984Example: simple class declaration and watcher initialisation
1985
1986 struct myclass
1987 {
1988 void io_cb (ev::io &w, int revents) { }
1989 }
1990
1991 myclass obj;
1992 ev::io iow;
1993 iow.set <myclass, &myclass::io_cb> (&obj);
1994
1995=item w->set<function> (void *data = 0)
1996
1997Also sets a callback, but uses a static method or plain function as
1998callback. The optional C<data> argument will be stored in the watcher's
1999C<data> member and is free for you to use.
2000
2001The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
2002
2003See the method-C<set> above for more details.
2004
2005Example:
2006
2007 static void io_cb (ev::io &w, int revents) { }
2008 iow.set <io_cb> ();
1751 2009
1752=item w->set (struct ev_loop *) 2010=item w->set (struct ev_loop *)
1753 2011
1754Associates a different C<struct ev_loop> with this watcher. You can only 2012Associates a different C<struct ev_loop> with this watcher. You can only
1755do this when the watcher is inactive (and not pending either). 2013do this when the watcher is inactive (and not pending either).
1756 2014
1757=item w->set ([args]) 2015=item w->set ([args])
1758 2016
1759Basically the same as C<ev_TYPE_set>, with the same args. Must be 2017Basically the same as C<ev_TYPE_set>, with the same args. Must be
1760called at least once. Unlike the C counterpart, an active watcher gets 2018called at least once. Unlike the C counterpart, an active watcher gets
1761automatically stopped and restarted. 2019automatically stopped and restarted when reconfiguring it with this
2020method.
1762 2021
1763=item w->start () 2022=item w->start ()
1764 2023
1765Starts the watcher. Note that there is no C<loop> argument as the 2024Starts the watcher. Note that there is no C<loop> argument, as the
1766constructor already takes the loop. 2025constructor already stores the event loop.
1767 2026
1768=item w->stop () 2027=item w->stop ()
1769 2028
1770Stops the watcher if it is active. Again, no C<loop> argument. 2029Stops the watcher if it is active. Again, no C<loop> argument.
1771 2030
1772=item w->again () C<ev::timer>, C<ev::periodic> only 2031=item w->again () (C<ev::timer>, C<ev::periodic> only)
1773 2032
1774For C<ev::timer> and C<ev::periodic>, this invokes the corresponding 2033For C<ev::timer> and C<ev::periodic>, this invokes the corresponding
1775C<ev_TYPE_again> function. 2034C<ev_TYPE_again> function.
1776 2035
1777=item w->sweep () C<ev::embed> only 2036=item w->sweep () (C<ev::embed> only)
1778 2037
1779Invokes C<ev_embed_sweep>. 2038Invokes C<ev_embed_sweep>.
1780 2039
1781=item w->update () C<ev::stat> only 2040=item w->update () (C<ev::stat> only)
1782 2041
1783Invokes C<ev_stat_stat>. 2042Invokes C<ev_stat_stat>.
1784 2043
1785=back 2044=back
1786 2045
1796 2055
1797 myclass (); 2056 myclass ();
1798 } 2057 }
1799 2058
1800 myclass::myclass (int fd) 2059 myclass::myclass (int fd)
1801 : io (this, &myclass::io_cb),
1802 idle (this, &myclass::idle_cb)
1803 { 2060 {
2061 io .set <myclass, &myclass::io_cb > (this);
2062 idle.set <myclass, &myclass::idle_cb> (this);
2063
1804 io.start (fd, ev::READ); 2064 io.start (fd, ev::READ);
1805 } 2065 }
1806 2066
1807 2067
1808=head1 MACRO MAGIC 2068=head1 MACRO MAGIC
1809 2069
1810Libev can be compiled with a variety of options, the most fundemantal is 2070Libev can be compiled with a variety of options, the most fundamantal
1811C<EV_MULTIPLICITY>. This option determines wether (most) functions and 2071of which is C<EV_MULTIPLICITY>. This option determines whether (most)
1812callbacks have an initial C<struct ev_loop *> argument. 2072functions and callbacks have an initial C<struct ev_loop *> argument.
1813 2073
1814To make it easier to write programs that cope with either variant, the 2074To make it easier to write programs that cope with either variant, the
1815following macros are defined: 2075following macros are defined:
1816 2076
1817=over 4 2077=over 4
1850loop, if multiple loops are supported ("ev loop default"). 2110loop, if multiple loops are supported ("ev loop default").
1851 2111
1852=back 2112=back
1853 2113
1854Example: Declare and initialise a check watcher, utilising the above 2114Example: Declare and initialise a check watcher, utilising the above
1855macros so it will work regardless of wether multiple loops are supported 2115macros so it will work regardless of whether multiple loops are supported
1856or not. 2116or not.
1857 2117
1858 static void 2118 static void
1859 check_cb (EV_P_ ev_timer *w, int revents) 2119 check_cb (EV_P_ ev_timer *w, int revents)
1860 { 2120 {
2085will have the C<struct ev_loop *> as first argument, and you can create 2345will have the C<struct ev_loop *> as first argument, and you can create
2086additional independent event loops. Otherwise there will be no support 2346additional independent event loops. Otherwise there will be no support
2087for multiple event loops and there is no first event loop pointer 2347for multiple event loops and there is no first event loop pointer
2088argument. Instead, all functions act on the single default loop. 2348argument. Instead, all functions act on the single default loop.
2089 2349
2350=item EV_MINPRI
2351
2352=item EV_MAXPRI
2353
2354The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
2355C<EV_MAXPRI>, but otherwise there are no non-obvious limitations. You can
2356provide for more priorities by overriding those symbols (usually defined
2357to be C<-2> and C<2>, respectively).
2358
2359When doing priority-based operations, libev usually has to linearly search
2360all the priorities, so having many of them (hundreds) uses a lot of space
2361and time, so using the defaults of five priorities (-2 .. +2) is usually
2362fine.
2363
2364If your embedding app does not need any priorities, defining these both to
2365C<0> will save some memory and cpu.
2366
2090=item EV_PERIODIC_ENABLE 2367=item EV_PERIODIC_ENABLE
2091 2368
2092If undefined or defined to be C<1>, then periodic timers are supported. If 2369If undefined or defined to be C<1>, then periodic timers are supported. If
2370defined to be C<0>, then they are not. Disabling them saves a few kB of
2371code.
2372
2373=item EV_IDLE_ENABLE
2374
2375If undefined or defined to be C<1>, then idle watchers are supported. If
2093defined to be C<0>, then they are not. Disabling them saves a few kB of 2376defined to be C<0>, then they are not. Disabling them saves a few kB of
2094code. 2377code.
2095 2378
2096=item EV_EMBED_ENABLE 2379=item EV_EMBED_ENABLE
2097 2380
2190 2473
2191In this section the complexities of (many of) the algorithms used inside 2474In this section the complexities of (many of) the algorithms used inside
2192libev will be explained. For complexity discussions about backends see the 2475libev will be explained. For complexity discussions about backends see the
2193documentation for C<ev_default_init>. 2476documentation for C<ev_default_init>.
2194 2477
2478All of the following are about amortised time: If an array needs to be
2479extended, libev needs to realloc and move the whole array, but this
2480happens asymptotically never with higher number of elements, so O(1) might
2481mean it might do a lengthy realloc operation in rare cases, but on average
2482it is much faster and asymptotically approaches constant time.
2483
2195=over 4 2484=over 4
2196 2485
2197=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) 2486=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
2198 2487
2488This means that, when you have a watcher that triggers in one hour and
2489there are 100 watchers that would trigger before that then inserting will
2490have to skip those 100 watchers.
2491
2199=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers) 2492=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)
2200 2493
2494That means that for changing a timer costs less than removing/adding them
2495as only the relative motion in the event queue has to be paid for.
2496
2201=item Starting io/check/prepare/idle/signal/child watchers: O(1) 2497=item Starting io/check/prepare/idle/signal/child watchers: O(1)
2202 2498
2499These just add the watcher into an array or at the head of a list.
2203=item Stopping check/prepare/idle watchers: O(1) 2500=item Stopping check/prepare/idle watchers: O(1)
2204 2501
2205=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) 2502=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
2206 2503
2504These watchers are stored in lists then need to be walked to find the
2505correct watcher to remove. The lists are usually short (you don't usually
2506have many watchers waiting for the same fd or signal).
2507
2207=item Finding the next timer per loop iteration: O(1) 2508=item Finding the next timer per loop iteration: O(1)
2208 2509
2209=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) 2510=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2210 2511
2512A change means an I/O watcher gets started or stopped, which requires
2513libev to recalculate its status (and possibly tell the kernel).
2514
2211=item Activating one watcher: O(1) 2515=item Activating one watcher: O(1)
2212 2516
2517=item Priority handling: O(number_of_priorities)
2518
2519Priorities are implemented by allocating some space for each
2520priority. When doing priority-based operations, libev usually has to
2521linearly search all the priorities.
2522
2213=back 2523=back
2214 2524
2215 2525
2216=head1 AUTHOR 2526=head1 AUTHOR
2217 2527

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines