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

Comparing libev/ev.pod (file contents):
Revision 1.228 by root, Sat Mar 28 08:22:30 2009 UTC vs.
Revision 1.249 by root, Wed Jul 8 04:29:31 2009 UTC

62 62
63 // unloop was called, so exit 63 // unloop was called, so exit
64 return 0; 64 return 0;
65 } 65 }
66 66
67=head1 DESCRIPTION 67=head1 ABOUT THIS DOCUMENT
68
69This document documents the libev software package.
68 70
69The newest version of this document is also available as an html-formatted 71The newest version of this document is also available as an html-formatted
70web page you might find easier to navigate when reading it for the first 72web page you might find easier to navigate when reading it for the first
71time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>. 73time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>.
74
75While this document tries to be as complete as possible in documenting
76libev, its usage and the rationale behind its design, it is not a tutorial
77on event-based programming, nor will it introduce event-based programming
78with libev.
79
80Familarity with event based programming techniques in general is assumed
81throughout this document.
82
83=head1 ABOUT LIBEV
72 84
73Libev is an event loop: you register interest in certain events (such as a 85Libev is an event loop: you register interest in certain events (such as a
74file descriptor being readable or a timeout occurring), and it will manage 86file descriptor being readable or a timeout occurring), and it will manage
75these event sources and provide your program with events. 87these event sources and provide your program with events.
76 88
110name C<loop> (which is always of type C<ev_loop *>) will not have 122name C<loop> (which is always of type C<ev_loop *>) will not have
111this argument. 123this argument.
112 124
113=head2 TIME REPRESENTATION 125=head2 TIME REPRESENTATION
114 126
115Libev represents time as a single floating point number, representing the 127Libev represents time as a single floating point number, representing
116(fractional) number of seconds since the (POSIX) epoch (somewhere near 128the (fractional) number of seconds since the (POSIX) epoch (somewhere
117the beginning of 1970, details are complicated, don't ask). This type is 129near the beginning of 1970, details are complicated, don't ask). This
118called C<ev_tstamp>, which is what you should use too. It usually aliases 130type is called C<ev_tstamp>, which is what you should use too. It usually
119to the C<double> type in C, and when you need to do any calculations on 131aliases to the C<double> type in C. When you need to do any calculations
120it, you should treat it as some floating point value. Unlike the name 132on it, you should treat it as some floating point value. Unlike the name
121component C<stamp> might indicate, it is also used for time differences 133component C<stamp> might indicate, it is also used for time differences
122throughout libev. 134throughout libev.
123 135
124=head1 ERROR HANDLING 136=head1 ERROR HANDLING
125 137
609 621
610This value can sometimes be useful as a generation counter of sorts (it 622This value can sometimes be useful as a generation counter of sorts (it
611"ticks" the number of loop iterations), as it roughly corresponds with 623"ticks" the number of loop iterations), as it roughly corresponds with
612C<ev_prepare> and C<ev_check> calls. 624C<ev_prepare> and C<ev_check> calls.
613 625
626=item unsigned int ev_loop_depth (loop)
627
628Returns the number of times C<ev_loop> was entered minus the number of
629times C<ev_loop> was exited, in other words, the recursion depth.
630
631Outside C<ev_loop>, this number is zero. In a callback, this number is
632C<1>, unless C<ev_loop> was invoked recursively (or from another thread),
633in which case it is higher.
634
635Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread
636etc.), doesn't count as exit.
637
614=item unsigned int ev_backend (loop) 638=item unsigned int ev_backend (loop)
615 639
616Returns one of the C<EVBACKEND_*> flags indicating the event backend in 640Returns one of the C<EVBACKEND_*> flags indicating the event backend in
617use. 641use.
618 642
632 656
633This function is rarely useful, but when some event callback runs for a 657This function is rarely useful, but when some event callback runs for a
634very long time without entering the event loop, updating libev's idea of 658very long time without entering the event loop, updating libev's idea of
635the current time is a good idea. 659the current time is a good idea.
636 660
637See also "The special problem of time updates" in the C<ev_timer> section. 661See also L<The special problem of time updates> in the C<ev_timer> section.
662
663=item ev_suspend (loop)
664
665=item ev_resume (loop)
666
667These two functions suspend and resume a loop, for use when the loop is
668not used for a while and timeouts should not be processed.
669
670A typical use case would be an interactive program such as a game: When
671the user presses C<^Z> to suspend the game and resumes it an hour later it
672would be best to handle timeouts as if no time had actually passed while
673the program was suspended. This can be achieved by calling C<ev_suspend>
674in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling
675C<ev_resume> directly afterwards to resume timer processing.
676
677Effectively, all C<ev_timer> watchers will be delayed by the time spend
678between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers
679will be rescheduled (that is, they will lose any events that would have
680occured while suspended).
681
682After calling C<ev_suspend> you B<must not> call I<any> function on the
683given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>
684without a previous call to C<ev_suspend>.
685
686Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
687event loop time (see C<ev_now_update>).
638 688
639=item ev_loop (loop, int flags) 689=item ev_loop (loop, int flags)
640 690
641Finally, this is it, the event handler. This function usually is called 691Finally, this is it, the event handler. This function usually is called
642after you initialised all your watchers and you want to start handling 692after you initialised all your watchers and you want to start handling
726 776
727If you have a watcher you never unregister that should not keep C<ev_loop> 777If you have a watcher you never unregister that should not keep C<ev_loop>
728from returning, call ev_unref() after starting, and ev_ref() before 778from returning, call ev_unref() after starting, and ev_ref() before
729stopping it. 779stopping it.
730 780
731As an example, libev itself uses this for its internal signal pipe: It is 781As an example, libev itself uses this for its internal signal pipe: It
732not visible to the libev user and should not keep C<ev_loop> from exiting 782is not visible to the libev user and should not keep C<ev_loop> from
733if no event watchers registered by it are active. It is also an excellent 783exiting if no event watchers registered by it are active. It is also an
734way to do this for generic recurring timers or from within third-party 784excellent way to do this for generic recurring timers or from within
735libraries. Just remember to I<unref after start> and I<ref before stop> 785third-party libraries. Just remember to I<unref after start> and I<ref
736(but only if the watcher wasn't active before, or was active before, 786before stop> (but only if the watcher wasn't active before, or was active
737respectively). 787before, respectively. Note also that libev might stop watchers itself
788(e.g. non-repeating timers) in which case you have to C<ev_ref>
789in the callback).
738 790
739Example: Create a signal watcher, but keep it from keeping C<ev_loop> 791Example: Create a signal watcher, but keep it from keeping C<ev_loop>
740running when nothing else is active. 792running when nothing else is active.
741 793
742 ev_signal exitsig; 794 ev_signal exitsig;
771 823
772By setting a higher I<io collect interval> you allow libev to spend more 824By setting a higher I<io collect interval> you allow libev to spend more
773time collecting I/O events, so you can handle more events per iteration, 825time collecting I/O events, so you can handle more events per iteration,
774at the cost of increasing latency. Timeouts (both C<ev_periodic> and 826at the cost of increasing latency. Timeouts (both C<ev_periodic> and
775C<ev_timer>) will be not affected. Setting this to a non-null value will 827C<ev_timer>) will be not affected. Setting this to a non-null value will
776introduce an additional C<ev_sleep ()> call into most loop iterations. 828introduce an additional C<ev_sleep ()> call into most loop iterations. The
829sleep time ensures that libev will not poll for I/O events more often then
830once per this interval, on average.
777 831
778Likewise, by setting a higher I<timeout collect interval> you allow libev 832Likewise, by setting a higher I<timeout collect interval> you allow libev
779to spend more time collecting timeouts, at the expense of increased 833to spend more time collecting timeouts, at the expense of increased
780latency/jitter/inexactness (the watcher callback will be called 834latency/jitter/inexactness (the watcher callback will be called
781later). C<ev_io> watchers will not be affected. Setting this to a non-null 835later). C<ev_io> watchers will not be affected. Setting this to a non-null
783 837
784Many (busy) programs can usually benefit by setting the I/O collect 838Many (busy) programs can usually benefit by setting the I/O collect
785interval to a value near C<0.1> or so, which is often enough for 839interval to a value near C<0.1> or so, which is often enough for
786interactive servers (of course not for games), likewise for timeouts. It 840interactive servers (of course not for games), likewise for timeouts. It
787usually doesn't make much sense to set it to a lower value than C<0.01>, 841usually doesn't make much sense to set it to a lower value than C<0.01>,
788as this approaches the timing granularity of most systems. 842as this approaches the timing granularity of most systems. Note that if
843you do transactions with the outside world and you can't increase the
844parallelity, then this setting will limit your transaction rate (if you
845need to poll once per transaction and the I/O collect interval is 0.01,
846then you can't do more than 100 transations per second).
789 847
790Setting the I<timeout collect interval> can improve the opportunity for 848Setting the I<timeout collect interval> can improve the opportunity for
791saving power, as the program will "bundle" timer callback invocations that 849saving power, as the program will "bundle" timer callback invocations that
792are "near" in time together, by delaying some, thus reducing the number of 850are "near" in time together, by delaying some, thus reducing the number of
793times the process sleeps and wakes up again. Another useful technique to 851times the process sleeps and wakes up again. Another useful technique to
794reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure 852reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure
795they fire on, say, one-second boundaries only. 853they fire on, say, one-second boundaries only.
854
855Example: we only need 0.1s timeout granularity, and we wish not to poll
856more often than 100 times per second:
857
858 ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1);
859 ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
796 860
797=item ev_loop_verify (loop) 861=item ev_loop_verify (loop)
798 862
799This function only does something when C<EV_VERIFY> support has been 863This function only does something when C<EV_VERIFY> support has been
800compiled in, which is the default for non-minimal builds. It tries to go 864compiled in, which is the default for non-minimal builds. It tries to go
926 990
927=item C<EV_ASYNC> 991=item C<EV_ASYNC>
928 992
929The given async watcher has been asynchronously notified (see C<ev_async>). 993The given async watcher has been asynchronously notified (see C<ev_async>).
930 994
995=item C<EV_CUSTOM>
996
997Not ever sent (or otherwise used) by libev itself, but can be freely used
998by libev users to signal watchers (e.g. via C<ev_feed_event>).
999
931=item C<EV_ERROR> 1000=item C<EV_ERROR>
932 1001
933An unspecified error has occurred, the watcher has been stopped. This might 1002An unspecified error has occurred, the watcher has been stopped. This might
934happen because the watcher could not be properly started because libev 1003happen because the watcher could not be properly started because libev
935ran out of memory, a file descriptor was found to be closed or any other 1004ran out of memory, a file descriptor was found to be closed or any other
1050integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI> 1119integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
1051(default: C<-2>). Pending watchers with higher priority will be invoked 1120(default: C<-2>). Pending watchers with higher priority will be invoked
1052before watchers with lower priority, but priority will not keep watchers 1121before watchers with lower priority, but priority will not keep watchers
1053from being executed (except for C<ev_idle> watchers). 1122from being executed (except for C<ev_idle> watchers).
1054 1123
1055This means that priorities are I<only> used for ordering callback
1056invocation after new events have been received. This is useful, for
1057example, to reduce latency after idling, or more often, to bind two
1058watchers on the same event and make sure one is called first.
1059
1060If you need to suppress invocation when higher priority events are pending 1124If you need to suppress invocation when higher priority events are pending
1061you need to look at C<ev_idle> watchers, which provide this functionality. 1125you need to look at C<ev_idle> watchers, which provide this functionality.
1062 1126
1063You I<must not> change the priority of a watcher as long as it is active or 1127You I<must not> change the priority of a watcher as long as it is active or
1064pending. 1128pending.
1065
1066The default priority used by watchers when no priority has been set is
1067always C<0>, which is supposed to not be too high and not be too low :).
1068 1129
1069Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is 1130Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
1070fine, as long as you do not mind that the priority value you query might 1131fine, as long as you do not mind that the priority value you query might
1071or might not have been clamped to the valid range. 1132or might not have been clamped to the valid range.
1133
1134The default priority used by watchers when no priority has been set is
1135always C<0>, which is supposed to not be too high and not be too low :).
1136
1137See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1138priorities.
1072 1139
1073=item ev_invoke (loop, ev_TYPE *watcher, int revents) 1140=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1074 1141
1075Invoke the C<watcher> with the given C<loop> and C<revents>. Neither 1142Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
1076C<loop> nor C<revents> need to be valid as long as the watcher callback 1143C<loop> nor C<revents> need to be valid as long as the watcher callback
1141 #include <stddef.h> 1208 #include <stddef.h>
1142 1209
1143 static void 1210 static void
1144 t1_cb (EV_P_ ev_timer *w, int revents) 1211 t1_cb (EV_P_ ev_timer *w, int revents)
1145 { 1212 {
1146 struct my_biggy big = (struct my_biggy * 1213 struct my_biggy big = (struct my_biggy *)
1147 (((char *)w) - offsetof (struct my_biggy, t1)); 1214 (((char *)w) - offsetof (struct my_biggy, t1));
1148 } 1215 }
1149 1216
1150 static void 1217 static void
1151 t2_cb (EV_P_ ev_timer *w, int revents) 1218 t2_cb (EV_P_ ev_timer *w, int revents)
1152 { 1219 {
1153 struct my_biggy big = (struct my_biggy * 1220 struct my_biggy big = (struct my_biggy *)
1154 (((char *)w) - offsetof (struct my_biggy, t2)); 1221 (((char *)w) - offsetof (struct my_biggy, t2));
1155 } 1222 }
1223
1224=head2 WATCHER PRIORITY MODELS
1225
1226Many event loops support I<watcher priorities>, which are usually small
1227integers that influence the ordering of event callback invocation
1228between watchers in some way, all else being equal.
1229
1230In libev, Watcher priorities can be set using C<ev_set_priority>. See its
1231description for the more technical details such as the actual priority
1232range.
1233
1234There are two common ways how these these priorities are being interpreted
1235by event loops:
1236
1237In the more common lock-out model, higher priorities "lock out" invocation
1238of lower priority watchers, which means as long as higher priority
1239watchers receive events, lower priority watchers are not being invoked.
1240
1241The less common only-for-ordering model uses priorities solely to order
1242callback invocation within a single event loop iteration: Higher priority
1243watchers are invoked before lower priority ones, but they all get invoked
1244before polling for new events.
1245
1246Libev uses the second (only-for-ordering) model for all its watchers
1247except for idle watchers (which use the lock-out model).
1248
1249The rationale behind this is that implementing the lock-out model for
1250watchers is not well supported by most kernel interfaces, and most event
1251libraries will just poll for the same events again and again as long as
1252their callbacks have not been executed, which is very inefficient in the
1253common case of one high-priority watcher locking out a mass of lower
1254priority ones.
1255
1256Static (ordering) priorities are most useful when you have two or more
1257watchers handling the same resource: a typical usage example is having an
1258C<ev_io> watcher to receive data, and an associated C<ev_timer> to handle
1259timeouts. Under load, data might be received while the program handles
1260other jobs, but since timers normally get invoked first, the timeout
1261handler will be executed before checking for data. In that case, giving
1262the timer a lower priority than the I/O watcher ensures that I/O will be
1263handled first even under adverse conditions (which is usually, but not
1264always, what you want).
1265
1266Since idle watchers use the "lock-out" model, meaning that idle watchers
1267will only be executed when no same or higher priority watchers have
1268received events, they can be used to implement the "lock-out" model when
1269required.
1270
1271For example, to emulate how many other event libraries handle priorities,
1272you can associate an C<ev_idle> watcher to each such watcher, and in
1273the normal watcher callback, you just start the idle watcher. The real
1274processing is done in the idle watcher callback. This causes libev to
1275continously poll and process kernel event data for the watcher, but when
1276the lock-out case is known to be rare (which in turn is rare :), this is
1277workable.
1278
1279Usually, however, the lock-out model implemented that way will perform
1280miserably under the type of load it was designed to handle. In that case,
1281it might be preferable to stop the real watcher before starting the
1282idle watcher, so the kernel will not have to process the event in case
1283the actual processing will be delayed for considerable time.
1284
1285Here is an example of an I/O watcher that should run at a strictly lower
1286priority than the default, and which should only process data when no
1287other events are pending:
1288
1289 ev_idle idle; // actual processing watcher
1290 ev_io io; // actual event watcher
1291
1292 static void
1293 io_cb (EV_P_ ev_io *w, int revents)
1294 {
1295 // stop the I/O watcher, we received the event, but
1296 // are not yet ready to handle it.
1297 ev_io_stop (EV_A_ w);
1298
1299 // start the idle watcher to ahndle the actual event.
1300 // it will not be executed as long as other watchers
1301 // with the default priority are receiving events.
1302 ev_idle_start (EV_A_ &idle);
1303 }
1304
1305 static void
1306 idle_cb (EV_P_ ev_idle *w, int revents)
1307 {
1308 // actual processing
1309 read (STDIN_FILENO, ...);
1310
1311 // have to start the I/O watcher again, as
1312 // we have handled the event
1313 ev_io_start (EV_P_ &io);
1314 }
1315
1316 // initialisation
1317 ev_idle_init (&idle, idle_cb);
1318 ev_io_init (&io, io_cb, STDIN_FILENO, EV_READ);
1319 ev_io_start (EV_DEFAULT_ &io);
1320
1321In the "real" world, it might also be beneficial to start a timer, so that
1322low-priority connections can not be locked out forever under load. This
1323enables your program to keep a lower latency for important connections
1324during short periods of high load, while not completely locking out less
1325important ones.
1156 1326
1157 1327
1158=head1 WATCHER TYPES 1328=head1 WATCHER TYPES
1159 1329
1160This section describes each watcher in detail, but will not repeat 1330This section describes each watcher in detail, but will not repeat
1186descriptors to non-blocking mode is also usually a good idea (but not 1356descriptors to non-blocking mode is also usually a good idea (but not
1187required if you know what you are doing). 1357required if you know what you are doing).
1188 1358
1189If you cannot use non-blocking mode, then force the use of a 1359If you cannot use non-blocking mode, then force the use of a
1190known-to-be-good backend (at the time of this writing, this includes only 1360known-to-be-good backend (at the time of this writing, this includes only
1191C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). 1361C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1362descriptors for which non-blocking operation makes no sense (such as
1363files) - libev doesn't guarentee any specific behaviour in that case.
1192 1364
1193Another thing you have to watch out for is that it is quite easy to 1365Another thing you have to watch out for is that it is quite easy to
1194receive "spurious" readiness notifications, that is your callback might 1366receive "spurious" readiness notifications, that is your callback might
1195be called with C<EV_READ> but a subsequent C<read>(2) will actually block 1367be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1196because there is no data. Not only are some backends known to create a 1368because there is no data. Not only are some backends known to create a
1317year, it will still time out after (roughly) one hour. "Roughly" because 1489year, it will still time out after (roughly) one hour. "Roughly" because
1318detecting time jumps is hard, and some inaccuracies are unavoidable (the 1490detecting time jumps is hard, and some inaccuracies are unavoidable (the
1319monotonic clock option helps a lot here). 1491monotonic clock option helps a lot here).
1320 1492
1321The callback is guaranteed to be invoked only I<after> its timeout has 1493The callback is guaranteed to be invoked only I<after> its timeout has
1322passed, but if multiple timers become ready during the same loop iteration 1494passed (not I<at>, so on systems with very low-resolution clocks this
1323then order of execution is undefined. 1495might introduce a small delay). If multiple timers become ready during the
1496same loop iteration then the ones with earlier time-out values are invoked
1497before ones of the same priority with later time-out values (but this is
1498no longer true when a callback calls C<ev_loop> recursively).
1324 1499
1325=head3 Be smart about timeouts 1500=head3 Be smart about timeouts
1326 1501
1327Many real-world problems involve some kind of timeout, usually for error 1502Many real-world problems involve some kind of timeout, usually for error
1328recovery. A typical example is an HTTP request - if the other side hangs, 1503recovery. A typical example is an HTTP request - if the other side hangs,
1372C<after> argument to C<ev_timer_set>, and only ever use the C<repeat> 1547C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
1373member and C<ev_timer_again>. 1548member and C<ev_timer_again>.
1374 1549
1375At start: 1550At start:
1376 1551
1377 ev_timer_init (timer, callback); 1552 ev_init (timer, callback);
1378 timer->repeat = 60.; 1553 timer->repeat = 60.;
1379 ev_timer_again (loop, timer); 1554 ev_timer_again (loop, timer);
1380 1555
1381Each time there is some activity: 1556Each time there is some activity:
1382 1557
1444 1619
1445To start the timer, simply initialise the watcher and set C<last_activity> 1620To start the timer, simply initialise the watcher and set C<last_activity>
1446to the current time (meaning we just have some activity :), then call the 1621to the current time (meaning we just have some activity :), then call the
1447callback, which will "do the right thing" and start the timer: 1622callback, which will "do the right thing" and start the timer:
1448 1623
1449 ev_timer_init (timer, callback); 1624 ev_init (timer, callback);
1450 last_activity = ev_now (loop); 1625 last_activity = ev_now (loop);
1451 callback (loop, timer, EV_TIMEOUT); 1626 callback (loop, timer, EV_TIMEOUT);
1452 1627
1453And when there is some activity, simply store the current time in 1628And when there is some activity, simply store the current time in
1454C<last_activity>, no libev calls at all: 1629C<last_activity>, no libev calls at all:
1547If the timer is started but non-repeating, stop it (as if it timed out). 1722If the timer is started but non-repeating, stop it (as if it timed out).
1548 1723
1549If the timer is repeating, either start it if necessary (with the 1724If the timer is repeating, either start it if necessary (with the
1550C<repeat> value), or reset the running timer to the C<repeat> value. 1725C<repeat> value), or reset the running timer to the C<repeat> value.
1551 1726
1552This sounds a bit complicated, see "Be smart about timeouts", above, for a 1727This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1553usage example. 1728usage example.
1554 1729
1555=item ev_tstamp repeat [read-write] 1730=item ev_tstamp repeat [read-write]
1556 1731
1557The current C<repeat> value. Will be used each time the watcher times out 1732The current C<repeat> value. Will be used each time the watcher times out
1617timers, such as triggering an event on each "midnight, local time", or 1792timers, such as triggering an event on each "midnight, local time", or
1618other complicated rules. This cannot be done with C<ev_timer> watchers, as 1793other complicated rules. This cannot be done with C<ev_timer> watchers, as
1619those cannot react to time jumps. 1794those cannot react to time jumps.
1620 1795
1621As with timers, the callback is guaranteed to be invoked only when the 1796As with timers, the callback is guaranteed to be invoked only when the
1622point in time where it is supposed to trigger has passed, but if multiple 1797point in time where it is supposed to trigger has passed. If multiple
1623periodic timers become ready during the same loop iteration, then order of 1798timers become ready during the same loop iteration then the ones with
1624execution is undefined. 1799earlier time-out values are invoked before ones with later time-out values
1800(but this is no longer true when a callback calls C<ev_loop> recursively).
1625 1801
1626=head3 Watcher-Specific Functions and Data Members 1802=head3 Watcher-Specific Functions and Data Members
1627 1803
1628=over 4 1804=over 4
1629 1805
1850some child status changes (most typically when a child of yours dies or 2026some child status changes (most typically when a child of yours dies or
1851exits). It is permissible to install a child watcher I<after> the child 2027exits). It is permissible to install a child watcher I<after> the child
1852has been forked (which implies it might have already exited), as long 2028has been forked (which implies it might have already exited), as long
1853as the event loop isn't entered (or is continued from a watcher), i.e., 2029as the event loop isn't entered (or is continued from a watcher), i.e.,
1854forking and then immediately registering a watcher for the child is fine, 2030forking and then immediately registering a watcher for the child is fine,
1855but forking and registering a watcher a few event loop iterations later is 2031but forking and registering a watcher a few event loop iterations later or
1856not. 2032in the next callback invocation is not.
1857 2033
1858Only the default event loop is capable of handling signals, and therefore 2034Only the default event loop is capable of handling signals, and therefore
1859you can only register child watchers in the default event loop. 2035you can only register child watchers in the default event loop.
2036
2037Due to some design glitches inside libev, child watchers will always be
2038handled at maximum priority (their priority is set to C<EV_MAXPRI> by
2039libev)
1860 2040
1861=head3 Process Interaction 2041=head3 Process Interaction
1862 2042
1863Libev grabs C<SIGCHLD> as soon as the default event loop is 2043Libev grabs C<SIGCHLD> as soon as the default event loop is
1864initialised. This is necessary to guarantee proper behaviour even if 2044initialised. This is necessary to guarantee proper behaviour even if
2216 // no longer anything immediate to do. 2396 // no longer anything immediate to do.
2217 } 2397 }
2218 2398
2219 ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 2399 ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2220 ev_idle_init (idle_watcher, idle_cb); 2400 ev_idle_init (idle_watcher, idle_cb);
2221 ev_idle_start (loop, idle_cb); 2401 ev_idle_start (loop, idle_watcher);
2222 2402
2223 2403
2224=head2 C<ev_prepare> and C<ev_check> - customise your event loop! 2404=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2225 2405
2226Prepare and check watchers are usually (but not always) used in pairs: 2406Prepare and check watchers are usually (but not always) used in pairs:
2319 struct pollfd fds [nfd]; 2499 struct pollfd fds [nfd];
2320 // actual code will need to loop here and realloc etc. 2500 // actual code will need to loop here and realloc etc.
2321 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); 2501 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
2322 2502
2323 /* the callback is illegal, but won't be called as we stop during check */ 2503 /* the callback is illegal, but won't be called as we stop during check */
2324 ev_timer_init (&tw, 0, timeout * 1e-3); 2504 ev_timer_init (&tw, 0, timeout * 1e-3, 0.);
2325 ev_timer_start (loop, &tw); 2505 ev_timer_start (loop, &tw);
2326 2506
2327 // create one ev_io per pollfd 2507 // create one ev_io per pollfd
2328 for (int i = 0; i < nfd; ++i) 2508 for (int i = 0; i < nfd; ++i)
2329 { 2509 {
2559event loop blocks next and before C<ev_check> watchers are being called, 2739event loop blocks next and before C<ev_check> watchers are being called,
2560and only in the child after the fork. If whoever good citizen calling 2740and only in the child after the fork. If whoever good citizen calling
2561C<ev_default_fork> cheats and calls it in the wrong process, the fork 2741C<ev_default_fork> cheats and calls it in the wrong process, the fork
2562handlers will be invoked, too, of course. 2742handlers will be invoked, too, of course.
2563 2743
2744=head3 The special problem of life after fork - how is it possible?
2745
2746Most uses of C<fork()> consist of forking, then some simple calls to ste
2747up/change the process environment, followed by a call to C<exec()>. This
2748sequence should be handled by libev without any problems.
2749
2750This changes when the application actually wants to do event handling
2751in the child, or both parent in child, in effect "continuing" after the
2752fork.
2753
2754The default mode of operation (for libev, with application help to detect
2755forks) is to duplicate all the state in the child, as would be expected
2756when I<either> the parent I<or> the child process continues.
2757
2758When both processes want to continue using libev, then this is usually the
2759wrong result. In that case, usually one process (typically the parent) is
2760supposed to continue with all watchers in place as before, while the other
2761process typically wants to start fresh, i.e. without any active watchers.
2762
2763The cleanest and most efficient way to achieve that with libev is to
2764simply create a new event loop, which of course will be "empty", and
2765use that for new watchers. This has the advantage of not touching more
2766memory than necessary, and thus avoiding the copy-on-write, and the
2767disadvantage of having to use multiple event loops (which do not support
2768signal watchers).
2769
2770When this is not possible, or you want to use the default loop for
2771other reasons, then in the process that wants to start "fresh", call
2772C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying
2773the default loop will "orphan" (not stop) all registered watchers, so you
2774have to be careful not to execute code that modifies those watchers. Note
2775also that in that case, you have to re-register any signal watchers.
2776
2564=head3 Watcher-Specific Functions and Data Members 2777=head3 Watcher-Specific Functions and Data Members
2565 2778
2566=over 4 2779=over 4
2567 2780
2568=item ev_fork_init (ev_signal *, callback) 2781=item ev_fork_init (ev_signal *, callback)
3750way (note also that glib is the slowest event library known to man). 3963way (note also that glib is the slowest event library known to man).
3751 3964
3752There is no supported compilation method available on windows except 3965There is no supported compilation method available on windows except
3753embedding it into other applications. 3966embedding it into other applications.
3754 3967
3968Sensible signal handling is officially unsupported by Microsoft - libev
3969tries its best, but under most conditions, signals will simply not work.
3970
3755Not a libev limitation but worth mentioning: windows apparently doesn't 3971Not a libev limitation but worth mentioning: windows apparently doesn't
3756accept large writes: instead of resulting in a partial write, windows will 3972accept large writes: instead of resulting in a partial write, windows will
3757either accept everything or return C<ENOBUFS> if the buffer is too large, 3973either accept everything or return C<ENOBUFS> if the buffer is too large,
3758so make sure you only write small amounts into your sockets (less than a 3974so make sure you only write small amounts into your sockets (less than a
3759megabyte seems safe, but this apparently depends on the amount of memory 3975megabyte seems safe, but this apparently depends on the amount of memory
3763the abysmal performance of winsockets, using a large number of sockets 3979the abysmal performance of winsockets, using a large number of sockets
3764is not recommended (and not reasonable). If your program needs to use 3980is not recommended (and not reasonable). If your program needs to use
3765more than a hundred or so sockets, then likely it needs to use a totally 3981more than a hundred or so sockets, then likely it needs to use a totally
3766different implementation for windows, as libev offers the POSIX readiness 3982different implementation for windows, as libev offers the POSIX readiness
3767notification model, which cannot be implemented efficiently on windows 3983notification model, which cannot be implemented efficiently on windows
3768(Microsoft monopoly games). 3984(due to Microsoft monopoly games).
3769 3985
3770A typical way to use libev under windows is to embed it (see the embedding 3986A typical way to use libev under windows is to embed it (see the embedding
3771section for details) and use the following F<evwrap.h> header file instead 3987section for details) and use the following F<evwrap.h> header file instead
3772of F<ev.h>: 3988of F<ev.h>:
3773 3989
3809 4025
3810Early versions of winsocket's select only supported waiting for a maximum 4026Early versions of winsocket's select only supported waiting for a maximum
3811of C<64> handles (probably owning to the fact that all windows kernels 4027of C<64> handles (probably owning to the fact that all windows kernels
3812can only wait for C<64> things at the same time internally; Microsoft 4028can only wait for C<64> things at the same time internally; Microsoft
3813recommends spawning a chain of threads and wait for 63 handles and the 4029recommends spawning a chain of threads and wait for 63 handles and the
3814previous thread in each. Great). 4030previous thread in each. Sounds great!).
3815 4031
3816Newer versions support more handles, but you need to define C<FD_SETSIZE> 4032Newer versions support more handles, but you need to define C<FD_SETSIZE>
3817to some high number (e.g. C<2048>) before compiling the winsocket select 4033to some high number (e.g. C<2048>) before compiling the winsocket select
3818call (which might be in libev or elsewhere, for example, perl does its own 4034call (which might be in libev or elsewhere, for example, perl and many
3819select emulation on windows). 4035other interpreters do their own select emulation on windows).
3820 4036
3821Another limit is the number of file descriptors in the Microsoft runtime 4037Another limit is the number of file descriptors in the Microsoft runtime
3822libraries, which by default is C<64> (there must be a hidden I<64> fetish 4038libraries, which by default is C<64> (there must be a hidden I<64>
3823or something like this inside Microsoft). You can increase this by calling 4039fetish or something like this inside Microsoft). You can increase this
3824C<_setmaxstdio>, which can increase this limit to C<2048> (another 4040by calling C<_setmaxstdio>, which can increase this limit to C<2048>
3825arbitrary limit), but is broken in many versions of the Microsoft runtime 4041(another arbitrary limit), but is broken in many versions of the Microsoft
3826libraries.
3827
3828This might get you to about C<512> or C<2048> sockets (depending on 4042runtime libraries. This might get you to about C<512> or C<2048> sockets
3829windows version and/or the phase of the moon). To get more, you need to 4043(depending on windows version and/or the phase of the moon). To get more,
3830wrap all I/O functions and provide your own fd management, but the cost of 4044you need to wrap all I/O functions and provide your own fd management, but
3831calling select (O(n²)) will likely make this unworkable. 4045the cost of calling select (O(n²)) will likely make this unworkable.
3832 4046
3833=back 4047=back
3834 4048
3835=head2 PORTABILITY REQUIREMENTS 4049=head2 PORTABILITY REQUIREMENTS
3836 4050
3879=item C<double> must hold a time value in seconds with enough accuracy 4093=item C<double> must hold a time value in seconds with enough accuracy
3880 4094
3881The type C<double> is used to represent timestamps. It is required to 4095The type C<double> is used to represent timestamps. It is required to
3882have at least 51 bits of mantissa (and 9 bits of exponent), which is good 4096have at least 51 bits of mantissa (and 9 bits of exponent), which is good
3883enough for at least into the year 4000. This requirement is fulfilled by 4097enough for at least into the year 4000. This requirement is fulfilled by
3884implementations implementing IEEE 754 (basically all existing ones). 4098implementations implementing IEEE 754, which is basically all existing
4099ones. With IEEE 754 doubles, you get microsecond accuracy until at least
41002200.
3885 4101
3886=back 4102=back
3887 4103
3888If you know of other additional requirements drop me a note. 4104If you know of other additional requirements drop me a note.
3889 4105
3957involves iterating over all running async watchers or all signal numbers. 4173involves iterating over all running async watchers or all signal numbers.
3958 4174
3959=back 4175=back
3960 4176
3961 4177
4178=head1 GLOSSARY
4179
4180=over 4
4181
4182=item active
4183
4184A watcher is active as long as it has been started (has been attached to
4185an event loop) but not yet stopped (disassociated from the event loop).
4186
4187=item application
4188
4189In this document, an application is whatever is using libev.
4190
4191=item callback
4192
4193The address of a function that is called when some event has been
4194detected. Callbacks are being passed the event loop, the watcher that
4195received the event, and the actual event bitset.
4196
4197=item callback invocation
4198
4199The act of calling the callback associated with a watcher.
4200
4201=item event
4202
4203A change of state of some external event, such as data now being available
4204for reading on a file descriptor, time having passed or simply not having
4205any other events happening anymore.
4206
4207In libev, events are represented as single bits (such as C<EV_READ> or
4208C<EV_TIMEOUT>).
4209
4210=item event library
4211
4212A software package implementing an event model and loop.
4213
4214=item event loop
4215
4216An entity that handles and processes external events and converts them
4217into callback invocations.
4218
4219=item event model
4220
4221The model used to describe how an event loop handles and processes
4222watchers and events.
4223
4224=item pending
4225
4226A watcher is pending as soon as the corresponding event has been detected,
4227and stops being pending as soon as the watcher will be invoked or its
4228pending status is explicitly cleared by the application.
4229
4230A watcher can be pending, but not active. Stopping a watcher also clears
4231its pending status.
4232
4233=item real time
4234
4235The physical time that is observed. It is apparently strictly monotonic :)
4236
4237=item wall-clock time
4238
4239The time and date as shown on clocks. Unlike real time, it can actually
4240be wrong and jump forwards and backwards, e.g. when the you adjust your
4241clock.
4242
4243=item watcher
4244
4245A data structure that describes interest in certain events. Watchers need
4246to be started (attached to an event loop) before they can receive events.
4247
4248=item watcher invocation
4249
4250The act of calling the callback associated with a watcher.
4251
4252=back
4253
3962=head1 AUTHOR 4254=head1 AUTHOR
3963 4255
3964Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson. 4256Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.
3965 4257

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines