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

Comparing libev/ev.pod (file contents):
Revision 1.57 by root, Wed Nov 28 11:27:29 2007 UTC vs.
Revision 1.78 by root, Sun Dec 9 19:42:57 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
63details of the event, and then hand it over to libev by I<starting> the 67details of the event, and then hand it over to libev by I<starting> the
64watcher. 68watcher.
65 69
66=head1 FEATURES 70=head1 FEATURES
67 71
68Libev supports C<select>, C<poll>, the linux-specific C<epoll>, the 72Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
69bsd-specific C<kqueue> and the solaris-specific event port mechanisms 73BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
70for file descriptor events (C<ev_io>), relative timers (C<ev_timer>), 74for file descriptor events (C<ev_io>), the Linux C<inotify> interface
75(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers
71absolute timers with customised rescheduling (C<ev_periodic>), synchronous 76with customised rescheduling (C<ev_periodic>), synchronous signals
72signals (C<ev_signal>), process status change events (C<ev_child>), and 77(C<ev_signal>), process status change events (C<ev_child>), and event
73event watchers dealing with the event loop mechanism itself (C<ev_idle>, 78watchers dealing with the event loop mechanism itself (C<ev_idle>,
74C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as 79C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as
75file watchers (C<ev_stat>) and even limited support for fork events 80file watchers (C<ev_stat>) and even limited support for fork events
76(C<ev_fork>). 81(C<ev_fork>).
77 82
78It also is quite fast (see this 83It also is quite fast (see this
162C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for 167C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for
163recommended ones. 168recommended ones.
164 169
165See the description of C<ev_embed> watchers for more info. 170See the description of C<ev_embed> watchers for more info.
166 171
167=item ev_set_allocator (void *(*cb)(void *ptr, size_t size)) 172=item ev_set_allocator (void *(*cb)(void *ptr, long size))
168 173
169Sets the allocation function to use (the prototype and semantics are 174Sets the allocation function to use (the prototype is similar - the
170identical to the realloc C function). It is used to allocate and free 175semantics is identical - to the realloc C function). It is used to
171memory (no surprises here). If it returns zero when memory needs to be 176allocate and free memory (no surprises here). If it returns zero when
172allocated, the library might abort or take some potentially destructive 177memory needs to be allocated, the library might abort or take some
173action. The default is your system realloc function. 178potentially destructive action. The default is your system realloc
179function.
174 180
175You could override this function in high-availability programs to, say, 181You could override this function in high-availability programs to, say,
176free some memory if it cannot allocate memory, to use a special allocator, 182free some memory if it cannot allocate memory, to use a special allocator,
177or even to sleep a while and retry until some memory is available. 183or even to sleep a while and retry until some memory is available.
178 184
264C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will 270C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
265override the flags completely if it is found in the environment. This is 271override the flags completely if it is found in the environment. This is
266useful to try out specific backends to test their performance, or to work 272useful to try out specific backends to test their performance, or to work
267around bugs. 273around bugs.
268 274
275=item C<EVFLAG_FORKCHECK>
276
277Instead of calling C<ev_default_fork> or C<ev_loop_fork> manually after
278a fork, you can also make libev check for a fork in each iteration by
279enabling this flag.
280
281This works by calling C<getpid ()> on every iteration of the loop,
282and thus this might slow down your event loop if you do a lot of loop
283iterations and little real work, but is usually not noticeable (on my
284Linux system for example, C<getpid> is actually a simple 5-insn sequence
285without a syscall and thus I<very> fast, but my Linux system also has
286C<pthread_atfork> which is even faster).
287
288The big advantage of this flag is that you can forget about fork (and
289forget about forgetting to tell libev about forking) when you use this
290flag.
291
292This flag setting cannot be overriden or specified in the C<LIBEV_FLAGS>
293environment variable.
294
269=item C<EVBACKEND_SELECT> (value 1, portable select backend) 295=item C<EVBACKEND_SELECT> (value 1, portable select backend)
270 296
271This is your standard select(2) backend. Not I<completely> standard, as 297This is your standard select(2) backend. Not I<completely> standard, as
272libev tries to roll its own fd_set with no limits on the number of fds, 298libev tries to roll its own fd_set with no limits on the number of fds,
273but if that fails, expect a fairly low limit on the number of fds when 299but if that fails, expect a fairly low limit on the number of fds when
408 434
409Like C<ev_default_fork>, but acts on an event loop created by 435Like C<ev_default_fork>, but acts on an event loop created by
410C<ev_loop_new>. Yes, you have to call this on every allocated event loop 436C<ev_loop_new>. Yes, you have to call this on every allocated event loop
411after fork, and how you do this is entirely your own problem. 437after fork, and how you do this is entirely your own problem.
412 438
439=item unsigned int ev_loop_count (loop)
440
441Returns the count of loop iterations for the loop, which is identical to
442the number of times libev did poll for new events. It starts at C<0> and
443happily wraps around with enough iterations.
444
445This value can sometimes be useful as a generation counter of sorts (it
446"ticks" the number of loop iterations), as it roughly corresponds with
447C<ev_prepare> and C<ev_check> calls.
448
413=item unsigned int ev_backend (loop) 449=item unsigned int ev_backend (loop)
414 450
415Returns one of the C<EVBACKEND_*> flags indicating the event backend in 451Returns one of the C<EVBACKEND_*> flags indicating the event backend in
416use. 452use.
417 453
450libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is 486libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is
451usually a better approach for this kind of thing. 487usually a better approach for this kind of thing.
452 488
453Here are the gory details of what C<ev_loop> does: 489Here are the gory details of what C<ev_loop> does:
454 490
491 - Before the first iteration, call any pending watchers.
455 * If there are no active watchers (reference count is zero), return. 492 * If there are no active watchers (reference count is zero), return.
456 - Queue prepare watchers and then call all outstanding watchers. 493 - Queue all prepare watchers and then call all outstanding watchers.
457 - If we have been forked, recreate the kernel state. 494 - If we have been forked, recreate the kernel state.
458 - Update the kernel state with all outstanding changes. 495 - Update the kernel state with all outstanding changes.
459 - Update the "event loop time". 496 - Update the "event loop time".
460 - Calculate for how long to block. 497 - Calculate for how long to block.
461 - Block the process, waiting for any events. 498 - Block the process, waiting for any events.
700=item bool ev_is_pending (ev_TYPE *watcher) 737=item bool ev_is_pending (ev_TYPE *watcher)
701 738
702Returns a true value iff the watcher is pending, (i.e. it has outstanding 739Returns a true value iff the watcher is pending, (i.e. it has outstanding
703events but its callback has not yet been invoked). As long as a watcher 740events but its callback has not yet been invoked). As long as a watcher
704is pending (but not active) you must not call an init function on it (but 741is pending (but not active) you must not call an init function on it (but
705C<ev_TYPE_set> is safe) and you must make sure the watcher is available to 742C<ev_TYPE_set> is safe), you must not change its priority, and you must
706libev (e.g. you cnanot C<free ()> it). 743make sure the watcher is available to libev (e.g. you cannot C<free ()>
744it).
707 745
708=item callback ev_cb (ev_TYPE *watcher) 746=item callback ev_cb (ev_TYPE *watcher)
709 747
710Returns the callback currently set on the watcher. 748Returns the callback currently set on the watcher.
711 749
712=item ev_cb_set (ev_TYPE *watcher, callback) 750=item ev_cb_set (ev_TYPE *watcher, callback)
713 751
714Change the callback. You can change the callback at virtually any time 752Change the callback. You can change the callback at virtually any time
715(modulo threads). 753(modulo threads).
754
755=item ev_set_priority (ev_TYPE *watcher, priority)
756
757=item int ev_priority (ev_TYPE *watcher)
758
759Set and query the priority of the watcher. The priority is a small
760integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
761(default: C<-2>). Pending watchers with higher priority will be invoked
762before watchers with lower priority, but priority will not keep watchers
763from being executed (except for C<ev_idle> watchers).
764
765This means that priorities are I<only> used for ordering callback
766invocation after new events have been received. This is useful, for
767example, to reduce latency after idling, or more often, to bind two
768watchers on the same event and make sure one is called first.
769
770If you need to suppress invocation when higher priority events are pending
771you need to look at C<ev_idle> watchers, which provide this functionality.
772
773You I<must not> change the priority of a watcher as long as it is active or
774pending.
775
776The default priority used by watchers when no priority has been set is
777always C<0>, which is supposed to not be too high and not be too low :).
778
779Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
780fine, as long as you do not mind that the priority value you query might
781or might not have been adjusted to be within valid range.
782
783=item ev_invoke (loop, ev_TYPE *watcher, int revents)
784
785Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
786C<loop> nor C<revents> need to be valid as long as the watcher callback
787can deal with that fact.
788
789=item int ev_clear_pending (loop, ev_TYPE *watcher)
790
791If the watcher is pending, this function returns clears its pending status
792and returns its C<revents> bitset (as if its callback was invoked). If the
793watcher isn't pending it does nothing and returns C<0>.
716 794
717=back 795=back
718 796
719 797
720=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER 798=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
826it is best to always use non-blocking I/O: An extra C<read>(2) returning 904it is best to always use non-blocking I/O: An extra C<read>(2) returning
827C<EAGAIN> is far preferable to a program hanging until some data arrives. 905C<EAGAIN> is far preferable to a program hanging until some data arrives.
828 906
829If you cannot run the fd in non-blocking mode (for example you should not 907If you cannot run the fd in non-blocking mode (for example you should not
830play around with an Xlib connection), then you have to seperately re-test 908play around with an Xlib connection), then you have to seperately re-test
831wether a file descriptor is really ready with a known-to-be good interface 909whether a file descriptor is really ready with a known-to-be good interface
832such as poll (fortunately in our Xlib example, Xlib already does this on 910such as poll (fortunately in our Xlib example, Xlib already does this on
833its own, so its quite safe to use). 911its own, so its quite safe to use).
834 912
835=over 4 913=over 4
836 914
914=item ev_timer_again (loop) 992=item ev_timer_again (loop)
915 993
916This will act as if the timer timed out and restart it again if it is 994This will act as if the timer timed out and restart it again if it is
917repeating. The exact semantics are: 995repeating. The exact semantics are:
918 996
997If the timer is pending, its pending status is cleared.
998
919If the timer is started but nonrepeating, stop it. 999If the timer is started but nonrepeating, stop it (as if it timed out).
920 1000
921If the timer is repeating, either start it if necessary (with the repeat 1001If the timer is repeating, either start it if necessary (with the
922value), or reset the running timer to the repeat value. 1002C<repeat> value), or reset the running timer to the C<repeat> value.
923 1003
924This sounds a bit complicated, but here is a useful and typical 1004This sounds a bit complicated, but here is a useful and typical
925example: Imagine you have a tcp connection and you want a so-called 1005example: Imagine you have a tcp connection and you want a so-called idle
926idle timeout, that is, you want to be called when there have been, 1006timeout, that is, you want to be called when there have been, say, 60
927say, 60 seconds of inactivity on the socket. The easiest way to do 1007seconds of inactivity on the socket. The easiest way to do this is to
928this is to configure an C<ev_timer> with C<after>=C<repeat>=C<60> and calling 1008configure an C<ev_timer> with a C<repeat> value of C<60> and then call
929C<ev_timer_again> each time you successfully read or write some data. If 1009C<ev_timer_again> each time you successfully read or write some data. If
930you go into an idle state where you do not expect data to travel on the 1010you go into an idle state where you do not expect data to travel on the
931socket, you can stop the timer, and again will automatically restart it if 1011socket, you can C<ev_timer_stop> the timer, and C<ev_timer_again> will
932need be. 1012automatically restart it if need be.
933 1013
934You can also ignore the C<after> value and C<ev_timer_start> altogether 1014That means you can ignore the C<after> value and C<ev_timer_start>
935and only ever use the C<repeat> value: 1015altogether and only ever use the C<repeat> value and C<ev_timer_again>:
936 1016
937 ev_timer_init (timer, callback, 0., 5.); 1017 ev_timer_init (timer, callback, 0., 5.);
938 ev_timer_again (loop, timer); 1018 ev_timer_again (loop, timer);
939 ... 1019 ...
940 timer->again = 17.; 1020 timer->again = 17.;
941 ev_timer_again (loop, timer); 1021 ev_timer_again (loop, timer);
942 ... 1022 ...
943 timer->again = 10.; 1023 timer->again = 10.;
944 ev_timer_again (loop, timer); 1024 ev_timer_again (loop, timer);
945 1025
946This is more efficient then stopping/starting the timer eahc time you want 1026This is more slightly efficient then stopping/starting the timer each time
947to modify its timeout value. 1027you want to modify its timeout value.
948 1028
949=item ev_tstamp repeat [read-write] 1029=item ev_tstamp repeat [read-write]
950 1030
951The current C<repeat> value. Will be used each time the watcher times out 1031The current C<repeat> value. Will be used each time the watcher times out
952or C<ev_timer_again> is called and determines the next timeout (if any), 1032or C<ev_timer_again> is called and determines the next timeout (if any),
994but on wallclock time (absolute time). You can tell a periodic watcher 1074but on wallclock time (absolute time). You can tell a periodic watcher
995to trigger "at" some specific point in time. For example, if you tell a 1075to trigger "at" some specific point in time. For example, if you tell a
996periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now () 1076periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()
997+ 10.>) and then reset your system clock to the last year, then it will 1077+ 10.>) and then reset your system clock to the last year, then it will
998take a year to trigger the event (unlike an C<ev_timer>, which would trigger 1078take a year to trigger the event (unlike an C<ev_timer>, which would trigger
999roughly 10 seconds later and of course not if you reset your system time 1079roughly 10 seconds later).
1000again).
1001 1080
1002They can also be used to implement vastly more complex timers, such as 1081They can also be used to implement vastly more complex timers, such as
1003triggering an event on eahc midnight, local time. 1082triggering an event on each midnight, local time or other, complicated,
1083rules.
1004 1084
1005As with timers, the callback is guarenteed to be invoked only when the 1085As with timers, the callback is guarenteed to be invoked only when the
1006time (C<at>) has been passed, but if multiple periodic timers become ready 1086time (C<at>) has been passed, but if multiple periodic timers become ready
1007during the same loop iteration then order of execution is undefined. 1087during the same loop iteration then order of execution is undefined.
1008 1088
1015Lots of arguments, lets sort it out... There are basically three modes of 1095Lots of arguments, lets sort it out... There are basically three modes of
1016operation, and we will explain them from simplest to complex: 1096operation, and we will explain them from simplest to complex:
1017 1097
1018=over 4 1098=over 4
1019 1099
1020=item * absolute timer (interval = reschedule_cb = 0) 1100=item * absolute timer (at = time, interval = reschedule_cb = 0)
1021 1101
1022In this configuration the watcher triggers an event at the wallclock time 1102In this configuration the watcher triggers an event at the wallclock time
1023C<at> and doesn't repeat. It will not adjust when a time jump occurs, 1103C<at> and doesn't repeat. It will not adjust when a time jump occurs,
1024that is, if it is to be run at January 1st 2011 then it will run when the 1104that is, if it is to be run at January 1st 2011 then it will run when the
1025system time reaches or surpasses this time. 1105system time reaches or surpasses this time.
1026 1106
1027=item * non-repeating interval timer (interval > 0, reschedule_cb = 0) 1107=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1028 1108
1029In this mode the watcher will always be scheduled to time out at the next 1109In this mode the watcher will always be scheduled to time out at the next
1030C<at + N * interval> time (for some integer N) and then repeat, regardless 1110C<at + N * interval> time (for some integer N, which can also be negative)
1031of any time jumps. 1111and then repeat, regardless of any time jumps.
1032 1112
1033This can be used to create timers that do not drift with respect to system 1113This can be used to create timers that do not drift with respect to system
1034time: 1114time:
1035 1115
1036 ev_periodic_set (&periodic, 0., 3600., 0); 1116 ev_periodic_set (&periodic, 0., 3600., 0);
1042 1122
1043Another way to think about it (for the mathematically inclined) is that 1123Another way to think about it (for the mathematically inclined) is that
1044C<ev_periodic> will try to run the callback in this mode at the next possible 1124C<ev_periodic> will try to run the callback in this mode at the next possible
1045time where C<time = at (mod interval)>, regardless of any time jumps. 1125time where C<time = at (mod interval)>, regardless of any time jumps.
1046 1126
1127For numerical stability it is preferable that the C<at> value is near
1128C<ev_now ()> (the current time), but there is no range requirement for
1129this value.
1130
1047=item * manual reschedule mode (reschedule_cb = callback) 1131=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)
1048 1132
1049In this mode the values for C<interval> and C<at> are both being 1133In this mode the values for C<interval> and C<at> are both being
1050ignored. Instead, each time the periodic watcher gets scheduled, the 1134ignored. Instead, each time the periodic watcher gets scheduled, the
1051reschedule callback will be called with the watcher as first, and the 1135reschedule callback will be called with the watcher as first, and the
1052current time as second argument. 1136current time as second argument.
1053 1137
1054NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, 1138NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,
1055ever, or make any event loop modifications>. If you need to stop it, 1139ever, or make any event loop modifications>. If you need to stop it,
1056return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by 1140return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by
1057starting a prepare watcher). 1141starting an C<ev_prepare> watcher, which is legal).
1058 1142
1059Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w, 1143Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
1060ev_tstamp now)>, e.g.: 1144ev_tstamp now)>, e.g.:
1061 1145
1062 static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) 1146 static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
1084 1168
1085Simply stops and restarts the periodic watcher again. This is only useful 1169Simply stops and restarts the periodic watcher again. This is only useful
1086when you changed some parameters or the reschedule callback would return 1170when you changed some parameters or the reschedule callback would return
1087a different time than the last time it was called (e.g. in a crond like 1171a different time than the last time it was called (e.g. in a crond like
1088program when the crontabs have changed). 1172program when the crontabs have changed).
1173
1174=item ev_tstamp offset [read-write]
1175
1176When repeating, this contains the offset value, otherwise this is the
1177absolute point in time (the C<at> value passed to C<ev_periodic_set>).
1178
1179Can be modified any time, but changes only take effect when the periodic
1180timer fires or C<ev_periodic_again> is being called.
1089 1181
1090=item ev_tstamp interval [read-write] 1182=item ev_tstamp interval [read-write]
1091 1183
1092The current interval value. Can be modified any time, but changes only 1184The current interval value. Can be modified any time, but changes only
1093take effect when the periodic timer fires or C<ev_periodic_again> is being 1185take effect when the periodic timer fires or C<ev_periodic_again> is being
1220The path does not need to exist: changing from "path exists" to "path does 1312The path does not need to exist: changing from "path exists" to "path does
1221not exist" is a status change like any other. The condition "path does 1313not exist" is a status change like any other. The condition "path does
1222not exist" is signified by the C<st_nlink> field being zero (which is 1314not exist" is signified by the C<st_nlink> field being zero (which is
1223otherwise always forced to be at least one) and all the other fields of 1315otherwise always forced to be at least one) and all the other fields of
1224the stat buffer having unspecified contents. 1316the stat buffer having unspecified contents.
1317
1318The path I<should> be absolute and I<must not> end in a slash. If it is
1319relative and your working directory changes, the behaviour is undefined.
1225 1320
1226Since there is no standard to do this, the portable implementation simply 1321Since there is no standard to do this, the portable implementation simply
1227calls C<stat (2)> regularly on the path to see if it changed somehow. You 1322calls C<stat (2)> regularly on the path to see if it changed somehow. You
1228can specify a recommended polling interval for this case. If you specify 1323can specify a recommended polling interval for this case. If you specify
1229a polling interval of C<0> (highly recommended!) then a I<suitable, 1324a polling interval of C<0> (highly recommended!) then a I<suitable,
1314 ev_stat_start (loop, &passwd); 1409 ev_stat_start (loop, &passwd);
1315 1410
1316 1411
1317=head2 C<ev_idle> - when you've got nothing better to do... 1412=head2 C<ev_idle> - when you've got nothing better to do...
1318 1413
1319Idle watchers trigger events when there are no other events are pending 1414Idle watchers trigger events when no other events of the same or higher
1320(prepare, check and other idle watchers do not count). That is, as long 1415priority are pending (prepare, check and other idle watchers do not
1321as your process is busy handling sockets or timeouts (or even signals, 1416count).
1322imagine) it will not be triggered. But when your process is idle all idle 1417
1323watchers are being called again and again, once per event loop iteration - 1418That is, as long as your process is busy handling sockets or timeouts
1419(or even signals, imagine) of the same or higher priority it will not be
1420triggered. But when your process is idle (or only lower-priority watchers
1421are pending), the idle watchers are being called once per event loop
1324until stopped, that is, or your process receives more events and becomes 1422iteration - until stopped, that is, or your process receives more events
1325busy. 1423and becomes busy again with higher priority stuff.
1326 1424
1327The most noteworthy effect is that as long as any idle watchers are 1425The most noteworthy effect is that as long as any idle watchers are
1328active, the process will not block when waiting for new events. 1426active, the process will not block when waiting for new events.
1329 1427
1330Apart from keeping your process non-blocking (which is a useful 1428Apart from keeping your process non-blocking (which is a useful
1396with priority higher than or equal to the event loop and one coroutine 1494with priority higher than or equal to the event loop and one coroutine
1397of lower priority, but only once, using idle watchers to keep the event 1495of lower priority, but only once, using idle watchers to keep the event
1398loop from blocking if lower-priority coroutines are active, thus mapping 1496loop from blocking if lower-priority coroutines are active, thus mapping
1399low-priority coroutines to idle/background tasks). 1497low-priority coroutines to idle/background tasks).
1400 1498
1499It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
1500priority, to ensure that they are being run before any other watchers
1501after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,
1502too) should not activate ("feed") events into libev. While libev fully
1503supports this, they will be called before other C<ev_check> watchers did
1504their job. As C<ev_check> watchers are often used to embed other event
1505loops those other event loops might be in an unusable state until their
1506C<ev_check> watcher ran (always remind yourself to coexist peacefully with
1507others).
1508
1401=over 4 1509=over 4
1402 1510
1403=item ev_prepare_init (ev_prepare *, callback) 1511=item ev_prepare_init (ev_prepare *, callback)
1404 1512
1405=item ev_check_init (ev_check *, callback) 1513=item ev_check_init (ev_check *, callback)
1408parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> 1516parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1409macros, but using them is utterly, utterly and completely pointless. 1517macros, but using them is utterly, utterly and completely pointless.
1410 1518
1411=back 1519=back
1412 1520
1413Example: To include a library such as adns, you would add IO watchers 1521There are a number of principal ways to embed other event loops or modules
1414and a timeout watcher in a prepare handler, as required by libadns, and 1522into libev. Here are some ideas on how to include libadns into libev
1523(there is a Perl module named C<EV::ADNS> that does this, which you could
1524use for an actually working example. Another Perl module named C<EV::Glib>
1525embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV
1526into the Glib event loop).
1527
1528Method 1: Add IO watchers and a timeout watcher in a prepare handler,
1415in a check watcher, destroy them and call into libadns. What follows is 1529and in a check watcher, destroy them and call into libadns. What follows
1416pseudo-code only of course: 1530is pseudo-code only of course. This requires you to either use a low
1531priority for the check watcher or use C<ev_clear_pending> explicitly, as
1532the callbacks for the IO/timeout watchers might not have been called yet.
1417 1533
1418 static ev_io iow [nfd]; 1534 static ev_io iow [nfd];
1419 static ev_timer tw; 1535 static ev_timer tw;
1420 1536
1421 static void 1537 static void
1422 io_cb (ev_loop *loop, ev_io *w, int revents) 1538 io_cb (ev_loop *loop, ev_io *w, int revents)
1423 { 1539 {
1424 // set the relevant poll flags
1425 // could also call adns_processreadable etc. here
1426 struct pollfd *fd = (struct pollfd *)w->data;
1427 if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1428 if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1429 } 1540 }
1430 1541
1431 // create io watchers for each fd and a timer before blocking 1542 // create io watchers for each fd and a timer before blocking
1432 static void 1543 static void
1433 adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) 1544 adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
1434 { 1545 {
1435 int timeout = 3600000;truct pollfd fds [nfd]; 1546 int timeout = 3600000;
1547 struct pollfd fds [nfd];
1436 // actual code will need to loop here and realloc etc. 1548 // actual code will need to loop here and realloc etc.
1437 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); 1549 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1438 1550
1439 /* the callback is illegal, but won't be called as we stop during check */ 1551 /* the callback is illegal, but won't be called as we stop during check */
1440 ev_timer_init (&tw, 0, timeout * 1e-3); 1552 ev_timer_init (&tw, 0, timeout * 1e-3);
1441 ev_timer_start (loop, &tw); 1553 ev_timer_start (loop, &tw);
1442 1554
1443 // create on ev_io per pollfd 1555 // create one ev_io per pollfd
1444 for (int i = 0; i < nfd; ++i) 1556 for (int i = 0; i < nfd; ++i)
1445 { 1557 {
1446 ev_io_init (iow + i, io_cb, fds [i].fd, 1558 ev_io_init (iow + i, io_cb, fds [i].fd,
1447 ((fds [i].events & POLLIN ? EV_READ : 0) 1559 ((fds [i].events & POLLIN ? EV_READ : 0)
1448 | (fds [i].events & POLLOUT ? EV_WRITE : 0))); 1560 | (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1449 1561
1450 fds [i].revents = 0; 1562 fds [i].revents = 0;
1451 iow [i].data = fds + i;
1452 ev_io_start (loop, iow + i); 1563 ev_io_start (loop, iow + i);
1453 } 1564 }
1454 } 1565 }
1455 1566
1456 // stop all watchers after blocking 1567 // stop all watchers after blocking
1458 adns_check_cb (ev_loop *loop, ev_check *w, int revents) 1569 adns_check_cb (ev_loop *loop, ev_check *w, int revents)
1459 { 1570 {
1460 ev_timer_stop (loop, &tw); 1571 ev_timer_stop (loop, &tw);
1461 1572
1462 for (int i = 0; i < nfd; ++i) 1573 for (int i = 0; i < nfd; ++i)
1574 {
1575 // set the relevant poll flags
1576 // could also call adns_processreadable etc. here
1577 struct pollfd *fd = fds + i;
1578 int revents = ev_clear_pending (iow + i);
1579 if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1580 if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1581
1582 // now stop the watcher
1463 ev_io_stop (loop, iow + i); 1583 ev_io_stop (loop, iow + i);
1584 }
1464 1585
1465 adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); 1586 adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
1587 }
1588
1589Method 2: This would be just like method 1, but you run C<adns_afterpoll>
1590in the prepare watcher and would dispose of the check watcher.
1591
1592Method 3: If the module to be embedded supports explicit event
1593notification (adns does), you can also make use of the actual watcher
1594callbacks, and only destroy/create the watchers in the prepare watcher.
1595
1596 static void
1597 timer_cb (EV_P_ ev_timer *w, int revents)
1598 {
1599 adns_state ads = (adns_state)w->data;
1600 update_now (EV_A);
1601
1602 adns_processtimeouts (ads, &tv_now);
1603 }
1604
1605 static void
1606 io_cb (EV_P_ ev_io *w, int revents)
1607 {
1608 adns_state ads = (adns_state)w->data;
1609 update_now (EV_A);
1610
1611 if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
1612 if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
1613 }
1614
1615 // do not ever call adns_afterpoll
1616
1617Method 4: Do not use a prepare or check watcher because the module you
1618want to embed is too inflexible to support it. Instead, youc na override
1619their poll function. The drawback with this solution is that the main
1620loop is now no longer controllable by EV. The C<Glib::EV> module does
1621this.
1622
1623 static gint
1624 event_poll_func (GPollFD *fds, guint nfds, gint timeout)
1625 {
1626 int got_events = 0;
1627
1628 for (n = 0; n < nfds; ++n)
1629 // create/start io watcher that sets the relevant bits in fds[n] and increment got_events
1630
1631 if (timeout >= 0)
1632 // create/start timer
1633
1634 // poll
1635 ev_loop (EV_A_ 0);
1636
1637 // stop timer again
1638 if (timeout >= 0)
1639 ev_timer_stop (EV_A_ &to);
1640
1641 // stop io watchers again - their callbacks should have set
1642 for (n = 0; n < nfds; ++n)
1643 ev_io_stop (EV_A_ iow [n]);
1644
1645 return got_events;
1466 } 1646 }
1467 1647
1468 1648
1469=head2 C<ev_embed> - when one backend isn't enough... 1649=head2 C<ev_embed> - when one backend isn't enough...
1470 1650
1674 1854
1675To use it, 1855To use it,
1676 1856
1677 #include <ev++.h> 1857 #include <ev++.h>
1678 1858
1679(it is not installed by default). This automatically includes F<ev.h> 1859This automatically includes F<ev.h> and puts all of its definitions (many
1680and puts all of its definitions (many of them macros) into the global 1860of them macros) into the global namespace. All C++ specific things are
1681namespace. All C++ specific things are put into the C<ev> namespace. 1861put into the C<ev> namespace. It should support all the same embedding
1862options as F<ev.h>, most notably C<EV_MULTIPLICITY>.
1682 1863
1683It should support all the same embedding options as F<ev.h>, most notably 1864Care has been taken to keep the overhead low. The only data member the C++
1684C<EV_MULTIPLICITY>. 1865classes add (compared to plain C-style watchers) is the event loop pointer
1866that the watcher is associated with (or no additional members at all if
1867you disable C<EV_MULTIPLICITY> when embedding libev).
1868
1869Currently, functions, and static and non-static member functions can be
1870used as callbacks. Other types should be easy to add as long as they only
1871need one additional pointer for context. If you need support for other
1872types of functors please contact the author (preferably after implementing
1873it).
1685 1874
1686Here is a list of things available in the C<ev> namespace: 1875Here is a list of things available in the C<ev> namespace:
1687 1876
1688=over 4 1877=over 4
1689 1878
1705 1894
1706All of those classes have these methods: 1895All of those classes have these methods:
1707 1896
1708=over 4 1897=over 4
1709 1898
1710=item ev::TYPE::TYPE (object *, object::method *) 1899=item ev::TYPE::TYPE ()
1711 1900
1712=item ev::TYPE::TYPE (object *, object::method *, struct ev_loop *) 1901=item ev::TYPE::TYPE (struct ev_loop *)
1713 1902
1714=item ev::TYPE::~TYPE 1903=item ev::TYPE::~TYPE
1715 1904
1716The constructor takes a pointer to an object and a method pointer to 1905The constructor (optionally) takes an event loop to associate the watcher
1717the event handler callback to call in this class. The constructor calls 1906with. If it is omitted, it will use C<EV_DEFAULT>.
1718C<ev_init> for you, which means you have to call the C<set> method 1907
1719before starting it. If you do not specify a loop then the constructor 1908The constructor calls C<ev_init> for you, which means you have to call the
1720automatically associates the default loop with this watcher. 1909C<set> method before starting it.
1910
1911It will not set a callback, however: You have to call the templated C<set>
1912method to set a callback before you can start the watcher.
1913
1914(The reason why you have to use a method is a limitation in C++ which does
1915not allow explicit template arguments for constructors).
1721 1916
1722The destructor automatically stops the watcher if it is active. 1917The destructor automatically stops the watcher if it is active.
1918
1919=item w->set<class, &class::method> (object *)
1920
1921This method sets the callback method to call. The method has to have a
1922signature of C<void (*)(ev_TYPE &, int)>, it receives the watcher as
1923first argument and the C<revents> as second. The object must be given as
1924parameter and is stored in the C<data> member of the watcher.
1925
1926This method synthesizes efficient thunking code to call your method from
1927the C callback that libev requires. If your compiler can inline your
1928callback (i.e. it is visible to it at the place of the C<set> call and
1929your compiler is good :), then the method will be fully inlined into the
1930thunking function, making it as fast as a direct C callback.
1931
1932Example: simple class declaration and watcher initialisation
1933
1934 struct myclass
1935 {
1936 void io_cb (ev::io &w, int revents) { }
1937 }
1938
1939 myclass obj;
1940 ev::io iow;
1941 iow.set <myclass, &myclass::io_cb> (&obj);
1942
1943=item w->set<function> (void *data = 0)
1944
1945Also sets a callback, but uses a static method or plain function as
1946callback. The optional C<data> argument will be stored in the watcher's
1947C<data> member and is free for you to use.
1948
1949The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
1950
1951See the method-C<set> above for more details.
1952
1953Example:
1954
1955 static void io_cb (ev::io &w, int revents) { }
1956 iow.set <io_cb> ();
1723 1957
1724=item w->set (struct ev_loop *) 1958=item w->set (struct ev_loop *)
1725 1959
1726Associates a different C<struct ev_loop> with this watcher. You can only 1960Associates a different C<struct ev_loop> with this watcher. You can only
1727do this when the watcher is inactive (and not pending either). 1961do this when the watcher is inactive (and not pending either).
1728 1962
1729=item w->set ([args]) 1963=item w->set ([args])
1730 1964
1731Basically the same as C<ev_TYPE_set>, with the same args. Must be 1965Basically the same as C<ev_TYPE_set>, with the same args. Must be
1732called at least once. Unlike the C counterpart, an active watcher gets 1966called at least once. Unlike the C counterpart, an active watcher gets
1733automatically stopped and restarted. 1967automatically stopped and restarted when reconfiguring it with this
1968method.
1734 1969
1735=item w->start () 1970=item w->start ()
1736 1971
1737Starts the watcher. Note that there is no C<loop> argument as the 1972Starts the watcher. Note that there is no C<loop> argument, as the
1738constructor already takes the loop. 1973constructor already stores the event loop.
1739 1974
1740=item w->stop () 1975=item w->stop ()
1741 1976
1742Stops the watcher if it is active. Again, no C<loop> argument. 1977Stops the watcher if it is active. Again, no C<loop> argument.
1743 1978
1768 2003
1769 myclass (); 2004 myclass ();
1770 } 2005 }
1771 2006
1772 myclass::myclass (int fd) 2007 myclass::myclass (int fd)
1773 : io (this, &myclass::io_cb),
1774 idle (this, &myclass::idle_cb)
1775 { 2008 {
2009 io .set <myclass, &myclass::io_cb > (this);
2010 idle.set <myclass, &myclass::idle_cb> (this);
2011
1776 io.start (fd, ev::READ); 2012 io.start (fd, ev::READ);
1777 } 2013 }
1778 2014
1779 2015
1780=head1 MACRO MAGIC 2016=head1 MACRO MAGIC
1781 2017
1782Libev can be compiled with a variety of options, the most fundemantal is 2018Libev can be compiled with a variety of options, the most fundemantal is
1783C<EV_MULTIPLICITY>. This option determines wether (most) functions and 2019C<EV_MULTIPLICITY>. This option determines whether (most) functions and
1784callbacks have an initial C<struct ev_loop *> argument. 2020callbacks have an initial C<struct ev_loop *> argument.
1785 2021
1786To make it easier to write programs that cope with either variant, the 2022To make it easier to write programs that cope with either variant, the
1787following macros are defined: 2023following macros are defined:
1788 2024
1821Similar to the other two macros, this gives you the value of the default 2057Similar to the other two macros, this gives you the value of the default
1822loop, if multiple loops are supported ("ev loop default"). 2058loop, if multiple loops are supported ("ev loop default").
1823 2059
1824=back 2060=back
1825 2061
1826Example: Declare and initialise a check watcher, working regardless of 2062Example: Declare and initialise a check watcher, utilising the above
1827wether multiple loops are supported or not. 2063macros so it will work regardless of whether multiple loops are supported
2064or not.
1828 2065
1829 static void 2066 static void
1830 check_cb (EV_P_ ev_timer *w, int revents) 2067 check_cb (EV_P_ ev_timer *w, int revents)
1831 { 2068 {
1832 ev_check_stop (EV_A_ w); 2069 ev_check_stop (EV_A_ w);
1834 2071
1835 ev_check check; 2072 ev_check check;
1836 ev_check_init (&check, check_cb); 2073 ev_check_init (&check, check_cb);
1837 ev_check_start (EV_DEFAULT_ &check); 2074 ev_check_start (EV_DEFAULT_ &check);
1838 ev_loop (EV_DEFAULT_ 0); 2075 ev_loop (EV_DEFAULT_ 0);
1839
1840 2076
1841=head1 EMBEDDING 2077=head1 EMBEDDING
1842 2078
1843Libev can (and often is) directly embedded into host 2079Libev can (and often is) directly embedded into host
1844applications. Examples of applications that embed it include the Deliantra 2080applications. Examples of applications that embed it include the Deliantra
1884 ev_vars.h 2120 ev_vars.h
1885 ev_wrap.h 2121 ev_wrap.h
1886 2122
1887 ev_win32.c required on win32 platforms only 2123 ev_win32.c required on win32 platforms only
1888 2124
1889 ev_select.c only when select backend is enabled (which is by default) 2125 ev_select.c only when select backend is enabled (which is enabled by default)
1890 ev_poll.c only when poll backend is enabled (disabled by default) 2126 ev_poll.c only when poll backend is enabled (disabled by default)
1891 ev_epoll.c only when the epoll backend is enabled (disabled by default) 2127 ev_epoll.c only when the epoll backend is enabled (disabled by default)
1892 ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 2128 ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
1893 ev_port.c only when the solaris port backend is enabled (disabled by default) 2129 ev_port.c only when the solaris port backend is enabled (disabled by default)
1894 2130
2057will have the C<struct ev_loop *> as first argument, and you can create 2293will have the C<struct ev_loop *> as first argument, and you can create
2058additional independent event loops. Otherwise there will be no support 2294additional independent event loops. Otherwise there will be no support
2059for multiple event loops and there is no first event loop pointer 2295for multiple event loops and there is no first event loop pointer
2060argument. Instead, all functions act on the single default loop. 2296argument. Instead, all functions act on the single default loop.
2061 2297
2298=item EV_MINPRI
2299
2300=item EV_MAXPRI
2301
2302The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
2303C<EV_MAXPRI>, but otherwise there are no non-obvious limitations. You can
2304provide for more priorities by overriding those symbols (usually defined
2305to be C<-2> and C<2>, respectively).
2306
2307When doing priority-based operations, libev usually has to linearly search
2308all the priorities, so having many of them (hundreds) uses a lot of space
2309and time, so using the defaults of five priorities (-2 .. +2) is usually
2310fine.
2311
2312If your embedding app does not need any priorities, defining these both to
2313C<0> will save some memory and cpu.
2314
2062=item EV_PERIODIC_ENABLE 2315=item EV_PERIODIC_ENABLE
2063 2316
2064If undefined or defined to be C<1>, then periodic timers are supported. If 2317If undefined or defined to be C<1>, then periodic timers are supported. If
2318defined to be C<0>, then they are not. Disabling them saves a few kB of
2319code.
2320
2321=item EV_IDLE_ENABLE
2322
2323If undefined or defined to be C<1>, then idle watchers are supported. If
2065defined to be C<0>, then they are not. Disabling them saves a few kB of 2324defined to be C<0>, then they are not. Disabling them saves a few kB of
2066code. 2325code.
2067 2326
2068=item EV_EMBED_ENABLE 2327=item EV_EMBED_ENABLE
2069 2328
2136interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file 2395interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file
2137will be compiled. It is pretty complex because it provides its own header 2396will be compiled. It is pretty complex because it provides its own header
2138file. 2397file.
2139 2398
2140The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file 2399The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
2141that everybody includes and which overrides some autoconf choices: 2400that everybody includes and which overrides some configure choices:
2142 2401
2402 #define EV_MINIMAL 1
2143 #define EV_USE_POLL 0 2403 #define EV_USE_POLL 0
2144 #define EV_MULTIPLICITY 0 2404 #define EV_MULTIPLICITY 0
2145 #define EV_PERIODICS 0 2405 #define EV_PERIODIC_ENABLE 0
2406 #define EV_STAT_ENABLE 0
2407 #define EV_FORK_ENABLE 0
2146 #define EV_CONFIG_H <config.h> 2408 #define EV_CONFIG_H <config.h>
2409 #define EV_MINPRI 0
2410 #define EV_MAXPRI 0
2147 2411
2148 #include "ev++.h" 2412 #include "ev++.h"
2149 2413
2150And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: 2414And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
2151 2415
2157 2421
2158In this section the complexities of (many of) the algorithms used inside 2422In this section the complexities of (many of) the algorithms used inside
2159libev will be explained. For complexity discussions about backends see the 2423libev will be explained. For complexity discussions about backends see the
2160documentation for C<ev_default_init>. 2424documentation for C<ev_default_init>.
2161 2425
2426All of the following are about amortised time: If an array needs to be
2427extended, libev needs to realloc and move the whole array, but this
2428happens asymptotically never with higher number of elements, so O(1) might
2429mean it might do a lengthy realloc operation in rare cases, but on average
2430it is much faster and asymptotically approaches constant time.
2431
2162=over 4 2432=over 4
2163 2433
2164=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) 2434=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
2165 2435
2436This means that, when you have a watcher that triggers in one hour and
2437there are 100 watchers that would trigger before that then inserting will
2438have to skip those 100 watchers.
2439
2166=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers) 2440=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)
2167 2441
2442That means that for changing a timer costs less than removing/adding them
2443as only the relative motion in the event queue has to be paid for.
2444
2168=item Starting io/check/prepare/idle/signal/child watchers: O(1) 2445=item Starting io/check/prepare/idle/signal/child watchers: O(1)
2169 2446
2447These just add the watcher into an array or at the head of a list.
2170=item Stopping check/prepare/idle watchers: O(1) 2448=item Stopping check/prepare/idle watchers: O(1)
2171 2449
2172=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) 2450=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
2173 2451
2452These watchers are stored in lists then need to be walked to find the
2453correct watcher to remove. The lists are usually short (you don't usually
2454have many watchers waiting for the same fd or signal).
2455
2174=item Finding the next timer per loop iteration: O(1) 2456=item Finding the next timer per loop iteration: O(1)
2175 2457
2176=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) 2458=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2177 2459
2460A change means an I/O watcher gets started or stopped, which requires
2461libev to recalculate its status (and possibly tell the kernel).
2462
2178=item Activating one watcher: O(1) 2463=item Activating one watcher: O(1)
2179 2464
2465=item Priority handling: O(number_of_priorities)
2466
2467Priorities are implemented by allocating some space for each
2468priority. When doing priority-based operations, libev usually has to
2469linearly search all the priorities.
2470
2180=back 2471=back
2181 2472
2182 2473
2183=head1 AUTHOR 2474=head1 AUTHOR
2184 2475

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines