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

Comparing libev/ev.pod (file contents):
Revision 1.59 by root, Wed Nov 28 17:32:24 2007 UTC vs.
Revision 1.81 by root, Wed Dec 12 04:53:58 2007 UTC

47 47
48 return 0; 48 return 0;
49 } 49 }
50 50
51=head1 DESCRIPTION 51=head1 DESCRIPTION
52
53The newest version of this document is also available as a html-formatted
54web page you might find easier to navigate when reading it for the first
55time: L<http://cvs.schmorp.de/libev/ev.html>.
52 56
53Libev is an event loop: you register interest in certain events (such as a 57Libev is an event loop: you register interest in certain events (such as a
54file descriptor being readable or a timeout occuring), and it will manage 58file descriptor being readable or a timeout occuring), and it will manage
55these event sources and provide your program with events. 59these event sources and provide your program with events.
56 60
113 117
114=item int ev_version_major () 118=item int ev_version_major ()
115 119
116=item int ev_version_minor () 120=item int ev_version_minor ()
117 121
118You can find out the major and minor version numbers of the library 122You can find out the major and minor ABI version numbers of the library
119you linked against by calling the functions C<ev_version_major> and 123you linked against by calling the functions C<ev_version_major> and
120C<ev_version_minor>. If you want, you can compare against the global 124C<ev_version_minor>. If you want, you can compare against the global
121symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the 125symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the
122version of the library your program was compiled against. 126version of the library your program was compiled against.
123 127
128These version numbers refer to the ABI version of the library, not the
129release version.
130
124Usually, it's a good idea to terminate if the major versions mismatch, 131Usually, it's a good idea to terminate if the major versions mismatch,
125as this indicates an incompatible change. Minor versions are usually 132as this indicates an incompatible change. Minor versions are usually
126compatible to older versions, so a larger minor version alone is usually 133compatible to older versions, so a larger minor version alone is usually
127not a problem. 134not a problem.
128 135
129Example: Make sure we haven't accidentally been linked against the wrong 136Example: Make sure we haven't accidentally been linked against the wrong
130version. 137version.
266C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will 273C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
267override the flags completely if it is found in the environment. This is 274override the flags completely if it is found in the environment. This is
268useful to try out specific backends to test their performance, or to work 275useful to try out specific backends to test their performance, or to work
269around bugs. 276around bugs.
270 277
278=item C<EVFLAG_FORKCHECK>
279
280Instead of calling C<ev_default_fork> or C<ev_loop_fork> manually after
281a fork, you can also make libev check for a fork in each iteration by
282enabling this flag.
283
284This works by calling C<getpid ()> on every iteration of the loop,
285and thus this might slow down your event loop if you do a lot of loop
286iterations and little real work, but is usually not noticeable (on my
287Linux system for example, C<getpid> is actually a simple 5-insn sequence
288without a syscall and thus I<very> fast, but my Linux system also has
289C<pthread_atfork> which is even faster).
290
291The big advantage of this flag is that you can forget about fork (and
292forget about forgetting to tell libev about forking) when you use this
293flag.
294
295This flag setting cannot be overriden or specified in the C<LIBEV_FLAGS>
296environment variable.
297
271=item C<EVBACKEND_SELECT> (value 1, portable select backend) 298=item C<EVBACKEND_SELECT> (value 1, portable select backend)
272 299
273This is your standard select(2) backend. Not I<completely> standard, as 300This is your standard select(2) backend. Not I<completely> standard, as
274libev tries to roll its own fd_set with no limits on the number of fds, 301libev tries to roll its own fd_set with no limits on the number of fds,
275but if that fails, expect a fairly low limit on the number of fds when 302but if that fails, expect a fairly low limit on the number of fds when
410 437
411Like C<ev_default_fork>, but acts on an event loop created by 438Like C<ev_default_fork>, but acts on an event loop created by
412C<ev_loop_new>. Yes, you have to call this on every allocated event loop 439C<ev_loop_new>. Yes, you have to call this on every allocated event loop
413after fork, and how you do this is entirely your own problem. 440after fork, and how you do this is entirely your own problem.
414 441
442=item unsigned int ev_loop_count (loop)
443
444Returns the count of loop iterations for the loop, which is identical to
445the number of times libev did poll for new events. It starts at C<0> and
446happily wraps around with enough iterations.
447
448This value can sometimes be useful as a generation counter of sorts (it
449"ticks" the number of loop iterations), as it roughly corresponds with
450C<ev_prepare> and C<ev_check> calls.
451
415=item unsigned int ev_backend (loop) 452=item unsigned int ev_backend (loop)
416 453
417Returns one of the C<EVBACKEND_*> flags indicating the event backend in 454Returns one of the C<EVBACKEND_*> flags indicating the event backend in
418use. 455use.
419 456
452libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is 489libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is
453usually a better approach for this kind of thing. 490usually a better approach for this kind of thing.
454 491
455Here are the gory details of what C<ev_loop> does: 492Here are the gory details of what C<ev_loop> does:
456 493
494 - Before the first iteration, call any pending watchers.
457 * If there are no active watchers (reference count is zero), return. 495 * If there are no active watchers (reference count is zero), return.
458 - Queue prepare watchers and then call all outstanding watchers. 496 - Queue all prepare watchers and then call all outstanding watchers.
459 - If we have been forked, recreate the kernel state. 497 - If we have been forked, recreate the kernel state.
460 - Update the kernel state with all outstanding changes. 498 - Update the kernel state with all outstanding changes.
461 - Update the "event loop time". 499 - Update the "event loop time".
462 - Calculate for how long to block. 500 - Calculate for how long to block.
463 - Block the process, waiting for any events. 501 - Block the process, waiting for any events.
702=item bool ev_is_pending (ev_TYPE *watcher) 740=item bool ev_is_pending (ev_TYPE *watcher)
703 741
704Returns a true value iff the watcher is pending, (i.e. it has outstanding 742Returns a true value iff the watcher is pending, (i.e. it has outstanding
705events but its callback has not yet been invoked). As long as a watcher 743events but its callback has not yet been invoked). As long as a watcher
706is pending (but not active) you must not call an init function on it (but 744is pending (but not active) you must not call an init function on it (but
707C<ev_TYPE_set> is safe) and you must make sure the watcher is available to 745C<ev_TYPE_set> is safe), you must not change its priority, and you must
708libev (e.g. you cnanot C<free ()> it). 746make sure the watcher is available to libev (e.g. you cannot C<free ()>
747it).
709 748
710=item callback ev_cb (ev_TYPE *watcher) 749=item callback ev_cb (ev_TYPE *watcher)
711 750
712Returns the callback currently set on the watcher. 751Returns the callback currently set on the watcher.
713 752
714=item ev_cb_set (ev_TYPE *watcher, callback) 753=item ev_cb_set (ev_TYPE *watcher, callback)
715 754
716Change the callback. You can change the callback at virtually any time 755Change the callback. You can change the callback at virtually any time
717(modulo threads). 756(modulo threads).
757
758=item ev_set_priority (ev_TYPE *watcher, priority)
759
760=item int ev_priority (ev_TYPE *watcher)
761
762Set and query the priority of the watcher. The priority is a small
763integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
764(default: C<-2>). Pending watchers with higher priority will be invoked
765before watchers with lower priority, but priority will not keep watchers
766from being executed (except for C<ev_idle> watchers).
767
768This means that priorities are I<only> used for ordering callback
769invocation after new events have been received. This is useful, for
770example, to reduce latency after idling, or more often, to bind two
771watchers on the same event and make sure one is called first.
772
773If you need to suppress invocation when higher priority events are pending
774you need to look at C<ev_idle> watchers, which provide this functionality.
775
776You I<must not> change the priority of a watcher as long as it is active or
777pending.
778
779The default priority used by watchers when no priority has been set is
780always C<0>, which is supposed to not be too high and not be too low :).
781
782Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
783fine, as long as you do not mind that the priority value you query might
784or might not have been adjusted to be within valid range.
785
786=item ev_invoke (loop, ev_TYPE *watcher, int revents)
787
788Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
789C<loop> nor C<revents> need to be valid as long as the watcher callback
790can deal with that fact.
791
792=item int ev_clear_pending (loop, ev_TYPE *watcher)
793
794If the watcher is pending, this function returns clears its pending status
795and returns its C<revents> bitset (as if its callback was invoked). If the
796watcher isn't pending it does nothing and returns C<0>.
718 797
719=back 798=back
720 799
721 800
722=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER 801=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
828it is best to always use non-blocking I/O: An extra C<read>(2) returning 907it is best to always use non-blocking I/O: An extra C<read>(2) returning
829C<EAGAIN> is far preferable to a program hanging until some data arrives. 908C<EAGAIN> is far preferable to a program hanging until some data arrives.
830 909
831If you cannot run the fd in non-blocking mode (for example you should not 910If you cannot run the fd in non-blocking mode (for example you should not
832play around with an Xlib connection), then you have to seperately re-test 911play around with an Xlib connection), then you have to seperately re-test
833wether a file descriptor is really ready with a known-to-be good interface 912whether a file descriptor is really ready with a known-to-be good interface
834such as poll (fortunately in our Xlib example, Xlib already does this on 913such as poll (fortunately in our Xlib example, Xlib already does this on
835its own, so its quite safe to use). 914its own, so its quite safe to use).
915
916=head3 The special problem of disappearing file descriptors
917
918Some backends (e.g kqueue, epoll) need to be told about closing a file
919descriptor (either by calling C<close> explicitly or by any other means,
920such as C<dup>). The reason is that you register interest in some file
921descriptor, but when it goes away, the operating system will silently drop
922this interest. If another file descriptor with the same number then is
923registered with libev, there is no efficient way to see that this is, in
924fact, a different file descriptor.
925
926To avoid having to explicitly tell libev about such cases, libev follows
927the following policy: Each time C<ev_io_set> is being called, libev
928will assume that this is potentially a new file descriptor, otherwise
929it is assumed that the file descriptor stays the same. That means that
930you I<have> to call C<ev_io_set> (or C<ev_io_init>) when you change the
931descriptor even if the file descriptor number itself did not change.
932
933This is how one would do it normally anyway, the important point is that
934the libev application should not optimise around libev but should leave
935optimisations to libev.
936
836 937
837=over 4 938=over 4
838 939
839=item ev_io_init (ev_io *, callback, int fd, int events) 940=item ev_io_init (ev_io *, callback, int fd, int events)
840 941
916=item ev_timer_again (loop) 1017=item ev_timer_again (loop)
917 1018
918This will act as if the timer timed out and restart it again if it is 1019This will act as if the timer timed out and restart it again if it is
919repeating. The exact semantics are: 1020repeating. The exact semantics are:
920 1021
1022If the timer is pending, its pending status is cleared.
1023
921If the timer is started but nonrepeating, stop it. 1024If the timer is started but nonrepeating, stop it (as if it timed out).
922 1025
923If the timer is repeating, either start it if necessary (with the repeat 1026If the timer is repeating, either start it if necessary (with the
924value), or reset the running timer to the repeat value. 1027C<repeat> value), or reset the running timer to the C<repeat> value.
925 1028
926This sounds a bit complicated, but here is a useful and typical 1029This sounds a bit complicated, but here is a useful and typical
927example: Imagine you have a tcp connection and you want a so-called 1030example: Imagine you have a tcp connection and you want a so-called idle
928idle timeout, that is, you want to be called when there have been, 1031timeout, that is, you want to be called when there have been, say, 60
929say, 60 seconds of inactivity on the socket. The easiest way to do 1032seconds of inactivity on the socket. The easiest way to do this is to
930this is to configure an C<ev_timer> with C<after>=C<repeat>=C<60> and calling 1033configure an C<ev_timer> with a C<repeat> value of C<60> and then call
931C<ev_timer_again> each time you successfully read or write some data. If 1034C<ev_timer_again> each time you successfully read or write some data. If
932you go into an idle state where you do not expect data to travel on the 1035you go into an idle state where you do not expect data to travel on the
933socket, you can stop the timer, and again will automatically restart it if 1036socket, you can C<ev_timer_stop> the timer, and C<ev_timer_again> will
934need be. 1037automatically restart it if need be.
935 1038
936You can also ignore the C<after> value and C<ev_timer_start> altogether 1039That means you can ignore the C<after> value and C<ev_timer_start>
937and only ever use the C<repeat> value: 1040altogether and only ever use the C<repeat> value and C<ev_timer_again>:
938 1041
939 ev_timer_init (timer, callback, 0., 5.); 1042 ev_timer_init (timer, callback, 0., 5.);
940 ev_timer_again (loop, timer); 1043 ev_timer_again (loop, timer);
941 ... 1044 ...
942 timer->again = 17.; 1045 timer->again = 17.;
943 ev_timer_again (loop, timer); 1046 ev_timer_again (loop, timer);
944 ... 1047 ...
945 timer->again = 10.; 1048 timer->again = 10.;
946 ev_timer_again (loop, timer); 1049 ev_timer_again (loop, timer);
947 1050
948This is more efficient then stopping/starting the timer eahc time you want 1051This is more slightly efficient then stopping/starting the timer each time
949to modify its timeout value. 1052you want to modify its timeout value.
950 1053
951=item ev_tstamp repeat [read-write] 1054=item ev_tstamp repeat [read-write]
952 1055
953The current C<repeat> value. Will be used each time the watcher times out 1056The current C<repeat> value. Will be used each time the watcher times out
954or C<ev_timer_again> is called and determines the next timeout (if any), 1057or C<ev_timer_again> is called and determines the next timeout (if any),
996but on wallclock time (absolute time). You can tell a periodic watcher 1099but on wallclock time (absolute time). You can tell a periodic watcher
997to trigger "at" some specific point in time. For example, if you tell a 1100to trigger "at" some specific point in time. For example, if you tell a
998periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now () 1101periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()
999+ 10.>) and then reset your system clock to the last year, then it will 1102+ 10.>) and then reset your system clock to the last year, then it will
1000take a year to trigger the event (unlike an C<ev_timer>, which would trigger 1103take a year to trigger the event (unlike an C<ev_timer>, which would trigger
1001roughly 10 seconds later and of course not if you reset your system time 1104roughly 10 seconds later).
1002again).
1003 1105
1004They can also be used to implement vastly more complex timers, such as 1106They can also be used to implement vastly more complex timers, such as
1005triggering an event on eahc midnight, local time. 1107triggering an event on each midnight, local time or other, complicated,
1108rules.
1006 1109
1007As with timers, the callback is guarenteed to be invoked only when the 1110As with timers, the callback is guarenteed to be invoked only when the
1008time (C<at>) has been passed, but if multiple periodic timers become ready 1111time (C<at>) has been passed, but if multiple periodic timers become ready
1009during the same loop iteration then order of execution is undefined. 1112during the same loop iteration then order of execution is undefined.
1010 1113
1017Lots of arguments, lets sort it out... There are basically three modes of 1120Lots of arguments, lets sort it out... There are basically three modes of
1018operation, and we will explain them from simplest to complex: 1121operation, and we will explain them from simplest to complex:
1019 1122
1020=over 4 1123=over 4
1021 1124
1022=item * absolute timer (interval = reschedule_cb = 0) 1125=item * absolute timer (at = time, interval = reschedule_cb = 0)
1023 1126
1024In this configuration the watcher triggers an event at the wallclock time 1127In this configuration the watcher triggers an event at the wallclock time
1025C<at> and doesn't repeat. It will not adjust when a time jump occurs, 1128C<at> and doesn't repeat. It will not adjust when a time jump occurs,
1026that is, if it is to be run at January 1st 2011 then it will run when the 1129that is, if it is to be run at January 1st 2011 then it will run when the
1027system time reaches or surpasses this time. 1130system time reaches or surpasses this time.
1028 1131
1029=item * non-repeating interval timer (interval > 0, reschedule_cb = 0) 1132=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1030 1133
1031In this mode the watcher will always be scheduled to time out at the next 1134In this mode the watcher will always be scheduled to time out at the next
1032C<at + N * interval> time (for some integer N) and then repeat, regardless 1135C<at + N * interval> time (for some integer N, which can also be negative)
1033of any time jumps. 1136and then repeat, regardless of any time jumps.
1034 1137
1035This can be used to create timers that do not drift with respect to system 1138This can be used to create timers that do not drift with respect to system
1036time: 1139time:
1037 1140
1038 ev_periodic_set (&periodic, 0., 3600., 0); 1141 ev_periodic_set (&periodic, 0., 3600., 0);
1044 1147
1045Another way to think about it (for the mathematically inclined) is that 1148Another way to think about it (for the mathematically inclined) is that
1046C<ev_periodic> will try to run the callback in this mode at the next possible 1149C<ev_periodic> will try to run the callback in this mode at the next possible
1047time where C<time = at (mod interval)>, regardless of any time jumps. 1150time where C<time = at (mod interval)>, regardless of any time jumps.
1048 1151
1152For numerical stability it is preferable that the C<at> value is near
1153C<ev_now ()> (the current time), but there is no range requirement for
1154this value.
1155
1049=item * manual reschedule mode (reschedule_cb = callback) 1156=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)
1050 1157
1051In this mode the values for C<interval> and C<at> are both being 1158In this mode the values for C<interval> and C<at> are both being
1052ignored. Instead, each time the periodic watcher gets scheduled, the 1159ignored. Instead, each time the periodic watcher gets scheduled, the
1053reschedule callback will be called with the watcher as first, and the 1160reschedule callback will be called with the watcher as first, and the
1054current time as second argument. 1161current time as second argument.
1055 1162
1056NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, 1163NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,
1057ever, or make any event loop modifications>. If you need to stop it, 1164ever, or make any event loop modifications>. If you need to stop it,
1058return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by 1165return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by
1059starting a prepare watcher). 1166starting an C<ev_prepare> watcher, which is legal).
1060 1167
1061Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w, 1168Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
1062ev_tstamp now)>, e.g.: 1169ev_tstamp now)>, e.g.:
1063 1170
1064 static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) 1171 static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
1086 1193
1087Simply stops and restarts the periodic watcher again. This is only useful 1194Simply stops and restarts the periodic watcher again. This is only useful
1088when you changed some parameters or the reschedule callback would return 1195when you changed some parameters or the reschedule callback would return
1089a different time than the last time it was called (e.g. in a crond like 1196a different time than the last time it was called (e.g. in a crond like
1090program when the crontabs have changed). 1197program when the crontabs have changed).
1198
1199=item ev_tstamp offset [read-write]
1200
1201When repeating, this contains the offset value, otherwise this is the
1202absolute point in time (the C<at> value passed to C<ev_periodic_set>).
1203
1204Can be modified any time, but changes only take effect when the periodic
1205timer fires or C<ev_periodic_again> is being called.
1091 1206
1092=item ev_tstamp interval [read-write] 1207=item ev_tstamp interval [read-write]
1093 1208
1094The current interval value. Can be modified any time, but changes only 1209The current interval value. Can be modified any time, but changes only
1095take effect when the periodic timer fires or C<ev_periodic_again> is being 1210take effect when the periodic timer fires or C<ev_periodic_again> is being
1222The path does not need to exist: changing from "path exists" to "path does 1337The path does not need to exist: changing from "path exists" to "path does
1223not exist" is a status change like any other. The condition "path does 1338not exist" is a status change like any other. The condition "path does
1224not exist" is signified by the C<st_nlink> field being zero (which is 1339not exist" is signified by the C<st_nlink> field being zero (which is
1225otherwise always forced to be at least one) and all the other fields of 1340otherwise always forced to be at least one) and all the other fields of
1226the stat buffer having unspecified contents. 1341the stat buffer having unspecified contents.
1342
1343The path I<should> be absolute and I<must not> end in a slash. If it is
1344relative and your working directory changes, the behaviour is undefined.
1227 1345
1228Since there is no standard to do this, the portable implementation simply 1346Since there is no standard to do this, the portable implementation simply
1229calls C<stat (2)> regularly on the path to see if it changed somehow. You 1347calls C<stat (2)> regularly on the path to see if it changed somehow. You
1230can specify a recommended polling interval for this case. If you specify 1348can specify a recommended polling interval for this case. If you specify
1231a polling interval of C<0> (highly recommended!) then a I<suitable, 1349a polling interval of C<0> (highly recommended!) then a I<suitable,
1316 ev_stat_start (loop, &passwd); 1434 ev_stat_start (loop, &passwd);
1317 1435
1318 1436
1319=head2 C<ev_idle> - when you've got nothing better to do... 1437=head2 C<ev_idle> - when you've got nothing better to do...
1320 1438
1321Idle watchers trigger events when there are no other events are pending 1439Idle watchers trigger events when no other events of the same or higher
1322(prepare, check and other idle watchers do not count). That is, as long 1440priority are pending (prepare, check and other idle watchers do not
1323as your process is busy handling sockets or timeouts (or even signals, 1441count).
1324imagine) it will not be triggered. But when your process is idle all idle 1442
1325watchers are being called again and again, once per event loop iteration - 1443That is, as long as your process is busy handling sockets or timeouts
1444(or even signals, imagine) of the same or higher priority it will not be
1445triggered. But when your process is idle (or only lower-priority watchers
1446are pending), the idle watchers are being called once per event loop
1326until stopped, that is, or your process receives more events and becomes 1447iteration - until stopped, that is, or your process receives more events
1327busy. 1448and becomes busy again with higher priority stuff.
1328 1449
1329The most noteworthy effect is that as long as any idle watchers are 1450The most noteworthy effect is that as long as any idle watchers are
1330active, the process will not block when waiting for new events. 1451active, the process will not block when waiting for new events.
1331 1452
1332Apart from keeping your process non-blocking (which is a useful 1453Apart from keeping your process non-blocking (which is a useful
1398with priority higher than or equal to the event loop and one coroutine 1519with priority higher than or equal to the event loop and one coroutine
1399of lower priority, but only once, using idle watchers to keep the event 1520of lower priority, but only once, using idle watchers to keep the event
1400loop from blocking if lower-priority coroutines are active, thus mapping 1521loop from blocking if lower-priority coroutines are active, thus mapping
1401low-priority coroutines to idle/background tasks). 1522low-priority coroutines to idle/background tasks).
1402 1523
1524It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
1525priority, to ensure that they are being run before any other watchers
1526after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,
1527too) should not activate ("feed") events into libev. While libev fully
1528supports this, they will be called before other C<ev_check> watchers did
1529their job. As C<ev_check> watchers are often used to embed other event
1530loops those other event loops might be in an unusable state until their
1531C<ev_check> watcher ran (always remind yourself to coexist peacefully with
1532others).
1533
1403=over 4 1534=over 4
1404 1535
1405=item ev_prepare_init (ev_prepare *, callback) 1536=item ev_prepare_init (ev_prepare *, callback)
1406 1537
1407=item ev_check_init (ev_check *, callback) 1538=item ev_check_init (ev_check *, callback)
1410parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> 1541parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1411macros, but using them is utterly, utterly and completely pointless. 1542macros, but using them is utterly, utterly and completely pointless.
1412 1543
1413=back 1544=back
1414 1545
1415Example: To include a library such as adns, you would add IO watchers 1546There are a number of principal ways to embed other event loops or modules
1416and a timeout watcher in a prepare handler, as required by libadns, and 1547into libev. Here are some ideas on how to include libadns into libev
1548(there is a Perl module named C<EV::ADNS> that does this, which you could
1549use for an actually working example. Another Perl module named C<EV::Glib>
1550embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV
1551into the Glib event loop).
1552
1553Method 1: Add IO watchers and a timeout watcher in a prepare handler,
1417in a check watcher, destroy them and call into libadns. What follows is 1554and in a check watcher, destroy them and call into libadns. What follows
1418pseudo-code only of course: 1555is pseudo-code only of course. This requires you to either use a low
1556priority for the check watcher or use C<ev_clear_pending> explicitly, as
1557the callbacks for the IO/timeout watchers might not have been called yet.
1419 1558
1420 static ev_io iow [nfd]; 1559 static ev_io iow [nfd];
1421 static ev_timer tw; 1560 static ev_timer tw;
1422 1561
1423 static void 1562 static void
1424 io_cb (ev_loop *loop, ev_io *w, int revents) 1563 io_cb (ev_loop *loop, ev_io *w, int revents)
1425 { 1564 {
1426 // set the relevant poll flags
1427 // could also call adns_processreadable etc. here
1428 struct pollfd *fd = (struct pollfd *)w->data;
1429 if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1430 if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1431 } 1565 }
1432 1566
1433 // create io watchers for each fd and a timer before blocking 1567 // create io watchers for each fd and a timer before blocking
1434 static void 1568 static void
1435 adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) 1569 adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
1436 { 1570 {
1437 int timeout = 3600000;truct pollfd fds [nfd]; 1571 int timeout = 3600000;
1572 struct pollfd fds [nfd];
1438 // actual code will need to loop here and realloc etc. 1573 // actual code will need to loop here and realloc etc.
1439 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); 1574 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1440 1575
1441 /* the callback is illegal, but won't be called as we stop during check */ 1576 /* the callback is illegal, but won't be called as we stop during check */
1442 ev_timer_init (&tw, 0, timeout * 1e-3); 1577 ev_timer_init (&tw, 0, timeout * 1e-3);
1443 ev_timer_start (loop, &tw); 1578 ev_timer_start (loop, &tw);
1444 1579
1445 // create on ev_io per pollfd 1580 // create one ev_io per pollfd
1446 for (int i = 0; i < nfd; ++i) 1581 for (int i = 0; i < nfd; ++i)
1447 { 1582 {
1448 ev_io_init (iow + i, io_cb, fds [i].fd, 1583 ev_io_init (iow + i, io_cb, fds [i].fd,
1449 ((fds [i].events & POLLIN ? EV_READ : 0) 1584 ((fds [i].events & POLLIN ? EV_READ : 0)
1450 | (fds [i].events & POLLOUT ? EV_WRITE : 0))); 1585 | (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1451 1586
1452 fds [i].revents = 0; 1587 fds [i].revents = 0;
1453 iow [i].data = fds + i;
1454 ev_io_start (loop, iow + i); 1588 ev_io_start (loop, iow + i);
1455 } 1589 }
1456 } 1590 }
1457 1591
1458 // stop all watchers after blocking 1592 // stop all watchers after blocking
1460 adns_check_cb (ev_loop *loop, ev_check *w, int revents) 1594 adns_check_cb (ev_loop *loop, ev_check *w, int revents)
1461 { 1595 {
1462 ev_timer_stop (loop, &tw); 1596 ev_timer_stop (loop, &tw);
1463 1597
1464 for (int i = 0; i < nfd; ++i) 1598 for (int i = 0; i < nfd; ++i)
1599 {
1600 // set the relevant poll flags
1601 // could also call adns_processreadable etc. here
1602 struct pollfd *fd = fds + i;
1603 int revents = ev_clear_pending (iow + i);
1604 if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1605 if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1606
1607 // now stop the watcher
1465 ev_io_stop (loop, iow + i); 1608 ev_io_stop (loop, iow + i);
1609 }
1466 1610
1467 adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); 1611 adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
1612 }
1613
1614Method 2: This would be just like method 1, but you run C<adns_afterpoll>
1615in the prepare watcher and would dispose of the check watcher.
1616
1617Method 3: If the module to be embedded supports explicit event
1618notification (adns does), you can also make use of the actual watcher
1619callbacks, and only destroy/create the watchers in the prepare watcher.
1620
1621 static void
1622 timer_cb (EV_P_ ev_timer *w, int revents)
1623 {
1624 adns_state ads = (adns_state)w->data;
1625 update_now (EV_A);
1626
1627 adns_processtimeouts (ads, &tv_now);
1628 }
1629
1630 static void
1631 io_cb (EV_P_ ev_io *w, int revents)
1632 {
1633 adns_state ads = (adns_state)w->data;
1634 update_now (EV_A);
1635
1636 if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
1637 if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
1638 }
1639
1640 // do not ever call adns_afterpoll
1641
1642Method 4: Do not use a prepare or check watcher because the module you
1643want to embed is too inflexible to support it. Instead, youc na override
1644their poll function. The drawback with this solution is that the main
1645loop is now no longer controllable by EV. The C<Glib::EV> module does
1646this.
1647
1648 static gint
1649 event_poll_func (GPollFD *fds, guint nfds, gint timeout)
1650 {
1651 int got_events = 0;
1652
1653 for (n = 0; n < nfds; ++n)
1654 // create/start io watcher that sets the relevant bits in fds[n] and increment got_events
1655
1656 if (timeout >= 0)
1657 // create/start timer
1658
1659 // poll
1660 ev_loop (EV_A_ 0);
1661
1662 // stop timer again
1663 if (timeout >= 0)
1664 ev_timer_stop (EV_A_ &to);
1665
1666 // stop io watchers again - their callbacks should have set
1667 for (n = 0; n < nfds; ++n)
1668 ev_io_stop (EV_A_ iow [n]);
1669
1670 return got_events;
1468 } 1671 }
1469 1672
1470 1673
1471=head2 C<ev_embed> - when one backend isn't enough... 1674=head2 C<ev_embed> - when one backend isn't enough...
1472 1675
1676 1879
1677To use it, 1880To use it,
1678 1881
1679 #include <ev++.h> 1882 #include <ev++.h>
1680 1883
1681(it is not installed by default). This automatically includes F<ev.h> 1884This automatically includes F<ev.h> and puts all of its definitions (many
1682and puts all of its definitions (many of them macros) into the global 1885of them macros) into the global namespace. All C++ specific things are
1683namespace. All C++ specific things are put into the C<ev> namespace. 1886put into the C<ev> namespace. It should support all the same embedding
1887options as F<ev.h>, most notably C<EV_MULTIPLICITY>.
1684 1888
1685It should support all the same embedding options as F<ev.h>, most notably 1889Care has been taken to keep the overhead low. The only data member the C++
1686C<EV_MULTIPLICITY>. 1890classes add (compared to plain C-style watchers) is the event loop pointer
1891that the watcher is associated with (or no additional members at all if
1892you disable C<EV_MULTIPLICITY> when embedding libev).
1893
1894Currently, functions, and static and non-static member functions can be
1895used as callbacks. Other types should be easy to add as long as they only
1896need one additional pointer for context. If you need support for other
1897types of functors please contact the author (preferably after implementing
1898it).
1687 1899
1688Here is a list of things available in the C<ev> namespace: 1900Here is a list of things available in the C<ev> namespace:
1689 1901
1690=over 4 1902=over 4
1691 1903
1707 1919
1708All of those classes have these methods: 1920All of those classes have these methods:
1709 1921
1710=over 4 1922=over 4
1711 1923
1712=item ev::TYPE::TYPE (object *, object::method *) 1924=item ev::TYPE::TYPE ()
1713 1925
1714=item ev::TYPE::TYPE (object *, object::method *, struct ev_loop *) 1926=item ev::TYPE::TYPE (struct ev_loop *)
1715 1927
1716=item ev::TYPE::~TYPE 1928=item ev::TYPE::~TYPE
1717 1929
1718The constructor takes a pointer to an object and a method pointer to 1930The constructor (optionally) takes an event loop to associate the watcher
1719the event handler callback to call in this class. The constructor calls 1931with. If it is omitted, it will use C<EV_DEFAULT>.
1720C<ev_init> for you, which means you have to call the C<set> method 1932
1721before starting it. If you do not specify a loop then the constructor 1933The constructor calls C<ev_init> for you, which means you have to call the
1722automatically associates the default loop with this watcher. 1934C<set> method before starting it.
1935
1936It will not set a callback, however: You have to call the templated C<set>
1937method to set a callback before you can start the watcher.
1938
1939(The reason why you have to use a method is a limitation in C++ which does
1940not allow explicit template arguments for constructors).
1723 1941
1724The destructor automatically stops the watcher if it is active. 1942The destructor automatically stops the watcher if it is active.
1943
1944=item w->set<class, &class::method> (object *)
1945
1946This method sets the callback method to call. The method has to have a
1947signature of C<void (*)(ev_TYPE &, int)>, it receives the watcher as
1948first argument and the C<revents> as second. The object must be given as
1949parameter and is stored in the C<data> member of the watcher.
1950
1951This method synthesizes efficient thunking code to call your method from
1952the C callback that libev requires. If your compiler can inline your
1953callback (i.e. it is visible to it at the place of the C<set> call and
1954your compiler is good :), then the method will be fully inlined into the
1955thunking function, making it as fast as a direct C callback.
1956
1957Example: simple class declaration and watcher initialisation
1958
1959 struct myclass
1960 {
1961 void io_cb (ev::io &w, int revents) { }
1962 }
1963
1964 myclass obj;
1965 ev::io iow;
1966 iow.set <myclass, &myclass::io_cb> (&obj);
1967
1968=item w->set<function> (void *data = 0)
1969
1970Also sets a callback, but uses a static method or plain function as
1971callback. The optional C<data> argument will be stored in the watcher's
1972C<data> member and is free for you to use.
1973
1974The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
1975
1976See the method-C<set> above for more details.
1977
1978Example:
1979
1980 static void io_cb (ev::io &w, int revents) { }
1981 iow.set <io_cb> ();
1725 1982
1726=item w->set (struct ev_loop *) 1983=item w->set (struct ev_loop *)
1727 1984
1728Associates a different C<struct ev_loop> with this watcher. You can only 1985Associates a different C<struct ev_loop> with this watcher. You can only
1729do this when the watcher is inactive (and not pending either). 1986do this when the watcher is inactive (and not pending either).
1730 1987
1731=item w->set ([args]) 1988=item w->set ([args])
1732 1989
1733Basically the same as C<ev_TYPE_set>, with the same args. Must be 1990Basically the same as C<ev_TYPE_set>, with the same args. Must be
1734called at least once. Unlike the C counterpart, an active watcher gets 1991called at least once. Unlike the C counterpart, an active watcher gets
1735automatically stopped and restarted. 1992automatically stopped and restarted when reconfiguring it with this
1993method.
1736 1994
1737=item w->start () 1995=item w->start ()
1738 1996
1739Starts the watcher. Note that there is no C<loop> argument as the 1997Starts the watcher. Note that there is no C<loop> argument, as the
1740constructor already takes the loop. 1998constructor already stores the event loop.
1741 1999
1742=item w->stop () 2000=item w->stop ()
1743 2001
1744Stops the watcher if it is active. Again, no C<loop> argument. 2002Stops the watcher if it is active. Again, no C<loop> argument.
1745 2003
1770 2028
1771 myclass (); 2029 myclass ();
1772 } 2030 }
1773 2031
1774 myclass::myclass (int fd) 2032 myclass::myclass (int fd)
1775 : io (this, &myclass::io_cb),
1776 idle (this, &myclass::idle_cb)
1777 { 2033 {
2034 io .set <myclass, &myclass::io_cb > (this);
2035 idle.set <myclass, &myclass::idle_cb> (this);
2036
1778 io.start (fd, ev::READ); 2037 io.start (fd, ev::READ);
1779 } 2038 }
1780 2039
1781 2040
1782=head1 MACRO MAGIC 2041=head1 MACRO MAGIC
1783 2042
1784Libev can be compiled with a variety of options, the most fundemantal is 2043Libev can be compiled with a variety of options, the most fundemantal is
1785C<EV_MULTIPLICITY>. This option determines wether (most) functions and 2044C<EV_MULTIPLICITY>. This option determines whether (most) functions and
1786callbacks have an initial C<struct ev_loop *> argument. 2045callbacks have an initial C<struct ev_loop *> argument.
1787 2046
1788To make it easier to write programs that cope with either variant, the 2047To make it easier to write programs that cope with either variant, the
1789following macros are defined: 2048following macros are defined:
1790 2049
1823Similar to the other two macros, this gives you the value of the default 2082Similar to the other two macros, this gives you the value of the default
1824loop, if multiple loops are supported ("ev loop default"). 2083loop, if multiple loops are supported ("ev loop default").
1825 2084
1826=back 2085=back
1827 2086
1828Example: Declare and initialise a check watcher, working regardless of 2087Example: Declare and initialise a check watcher, utilising the above
1829wether multiple loops are supported or not. 2088macros so it will work regardless of whether multiple loops are supported
2089or not.
1830 2090
1831 static void 2091 static void
1832 check_cb (EV_P_ ev_timer *w, int revents) 2092 check_cb (EV_P_ ev_timer *w, int revents)
1833 { 2093 {
1834 ev_check_stop (EV_A_ w); 2094 ev_check_stop (EV_A_ w);
1836 2096
1837 ev_check check; 2097 ev_check check;
1838 ev_check_init (&check, check_cb); 2098 ev_check_init (&check, check_cb);
1839 ev_check_start (EV_DEFAULT_ &check); 2099 ev_check_start (EV_DEFAULT_ &check);
1840 ev_loop (EV_DEFAULT_ 0); 2100 ev_loop (EV_DEFAULT_ 0);
1841
1842 2101
1843=head1 EMBEDDING 2102=head1 EMBEDDING
1844 2103
1845Libev can (and often is) directly embedded into host 2104Libev can (and often is) directly embedded into host
1846applications. Examples of applications that embed it include the Deliantra 2105applications. Examples of applications that embed it include the Deliantra
1886 ev_vars.h 2145 ev_vars.h
1887 ev_wrap.h 2146 ev_wrap.h
1888 2147
1889 ev_win32.c required on win32 platforms only 2148 ev_win32.c required on win32 platforms only
1890 2149
1891 ev_select.c only when select backend is enabled (which is by default) 2150 ev_select.c only when select backend is enabled (which is enabled by default)
1892 ev_poll.c only when poll backend is enabled (disabled by default) 2151 ev_poll.c only when poll backend is enabled (disabled by default)
1893 ev_epoll.c only when the epoll backend is enabled (disabled by default) 2152 ev_epoll.c only when the epoll backend is enabled (disabled by default)
1894 ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 2153 ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
1895 ev_port.c only when the solaris port backend is enabled (disabled by default) 2154 ev_port.c only when the solaris port backend is enabled (disabled by default)
1896 2155
2059will have the C<struct ev_loop *> as first argument, and you can create 2318will have the C<struct ev_loop *> as first argument, and you can create
2060additional independent event loops. Otherwise there will be no support 2319additional independent event loops. Otherwise there will be no support
2061for multiple event loops and there is no first event loop pointer 2320for multiple event loops and there is no first event loop pointer
2062argument. Instead, all functions act on the single default loop. 2321argument. Instead, all functions act on the single default loop.
2063 2322
2323=item EV_MINPRI
2324
2325=item EV_MAXPRI
2326
2327The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
2328C<EV_MAXPRI>, but otherwise there are no non-obvious limitations. You can
2329provide for more priorities by overriding those symbols (usually defined
2330to be C<-2> and C<2>, respectively).
2331
2332When doing priority-based operations, libev usually has to linearly search
2333all the priorities, so having many of them (hundreds) uses a lot of space
2334and time, so using the defaults of five priorities (-2 .. +2) is usually
2335fine.
2336
2337If your embedding app does not need any priorities, defining these both to
2338C<0> will save some memory and cpu.
2339
2064=item EV_PERIODIC_ENABLE 2340=item EV_PERIODIC_ENABLE
2065 2341
2066If undefined or defined to be C<1>, then periodic timers are supported. If 2342If undefined or defined to be C<1>, then periodic timers are supported. If
2343defined to be C<0>, then they are not. Disabling them saves a few kB of
2344code.
2345
2346=item EV_IDLE_ENABLE
2347
2348If undefined or defined to be C<1>, then idle watchers are supported. If
2067defined to be C<0>, then they are not. Disabling them saves a few kB of 2349defined to be C<0>, then they are not. Disabling them saves a few kB of
2068code. 2350code.
2069 2351
2070=item EV_EMBED_ENABLE 2352=item EV_EMBED_ENABLE
2071 2353
2138interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file 2420interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file
2139will be compiled. It is pretty complex because it provides its own header 2421will be compiled. It is pretty complex because it provides its own header
2140file. 2422file.
2141 2423
2142The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file 2424The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
2143that everybody includes and which overrides some autoconf choices: 2425that everybody includes and which overrides some configure choices:
2144 2426
2427 #define EV_MINIMAL 1
2145 #define EV_USE_POLL 0 2428 #define EV_USE_POLL 0
2146 #define EV_MULTIPLICITY 0 2429 #define EV_MULTIPLICITY 0
2147 #define EV_PERIODICS 0 2430 #define EV_PERIODIC_ENABLE 0
2431 #define EV_STAT_ENABLE 0
2432 #define EV_FORK_ENABLE 0
2148 #define EV_CONFIG_H <config.h> 2433 #define EV_CONFIG_H <config.h>
2434 #define EV_MINPRI 0
2435 #define EV_MAXPRI 0
2149 2436
2150 #include "ev++.h" 2437 #include "ev++.h"
2151 2438
2152And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: 2439And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
2153 2440
2159 2446
2160In this section the complexities of (many of) the algorithms used inside 2447In this section the complexities of (many of) the algorithms used inside
2161libev will be explained. For complexity discussions about backends see the 2448libev will be explained. For complexity discussions about backends see the
2162documentation for C<ev_default_init>. 2449documentation for C<ev_default_init>.
2163 2450
2451All of the following are about amortised time: If an array needs to be
2452extended, libev needs to realloc and move the whole array, but this
2453happens asymptotically never with higher number of elements, so O(1) might
2454mean it might do a lengthy realloc operation in rare cases, but on average
2455it is much faster and asymptotically approaches constant time.
2456
2164=over 4 2457=over 4
2165 2458
2166=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) 2459=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
2167 2460
2461This means that, when you have a watcher that triggers in one hour and
2462there are 100 watchers that would trigger before that then inserting will
2463have to skip those 100 watchers.
2464
2168=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers) 2465=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)
2169 2466
2467That means that for changing a timer costs less than removing/adding them
2468as only the relative motion in the event queue has to be paid for.
2469
2170=item Starting io/check/prepare/idle/signal/child watchers: O(1) 2470=item Starting io/check/prepare/idle/signal/child watchers: O(1)
2171 2471
2472These just add the watcher into an array or at the head of a list.
2172=item Stopping check/prepare/idle watchers: O(1) 2473=item Stopping check/prepare/idle watchers: O(1)
2173 2474
2174=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) 2475=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
2175 2476
2477These watchers are stored in lists then need to be walked to find the
2478correct watcher to remove. The lists are usually short (you don't usually
2479have many watchers waiting for the same fd or signal).
2480
2176=item Finding the next timer per loop iteration: O(1) 2481=item Finding the next timer per loop iteration: O(1)
2177 2482
2178=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) 2483=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2179 2484
2485A change means an I/O watcher gets started or stopped, which requires
2486libev to recalculate its status (and possibly tell the kernel).
2487
2180=item Activating one watcher: O(1) 2488=item Activating one watcher: O(1)
2181 2489
2490=item Priority handling: O(number_of_priorities)
2491
2492Priorities are implemented by allocating some space for each
2493priority. When doing priority-based operations, libev usually has to
2494linearly search all the priorities.
2495
2182=back 2496=back
2183 2497
2184 2498
2185=head1 AUTHOR 2499=head1 AUTHOR
2186 2500

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines