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

Comparing libev/ev.pod (file contents):
Revision 1.223 by root, Sun Dec 14 21:58:08 2008 UTC vs.
Revision 1.259 by root, Sun Jul 19 01:36:34 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);
860
861=item ev_invoke_pending (loop)
862
863This call will simply invoke all pending watchers while resetting their
864pending state. Normally, C<ev_loop> does this automatically when required,
865but when overriding the invoke callback this call comes handy.
866
867=item int ev_pending_count (loop)
868
869Returns the number of pending watchers - zero indicates that no watchers
870are pending.
871
872=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
873
874This overrides the invoke pending functionality of the loop: Instead of
875invoking all pending watchers when there are any, C<ev_loop> will call
876this callback instead. This is useful, for example, when you want to
877invoke the actual watchers inside another context (another thread etc.).
878
879If you want to reset the callback, use C<ev_invoke_pending> as new
880callback.
881
882=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))
883
884Sometimes you want to share the same loop between multiple threads. This
885can be done relatively simply by putting mutex_lock/unlock calls around
886each call to a libev function.
887
888However, C<ev_loop> can run an indefinite time, so it is not feasible to
889wait for it to return. One way around this is to wake up the loop via
890C<ev_unloop> and C<av_async_send>, another way is to set these I<release>
891and I<acquire> callbacks on the loop.
892
893When set, then C<release> will be called just before the thread is
894suspended waiting for new events, and C<acquire> is called just
895afterwards.
896
897Ideally, C<release> will just call your mutex_unlock function, and
898C<acquire> will just call the mutex_lock function again.
899
900While event loop modifications are allowed between invocations of
901C<release> and C<acquire> (that's their only purpose after all), no
902modifications done will affect the event loop, i.e. adding watchers will
903have no effect on the set of file descriptors being watched, or the time
904waited. USe an C<ev_async> watcher to wake up C<ev_loop> when you want it
905to take note of any changes you made.
906
907In theory, threads executing C<ev_loop> will be async-cancel safe between
908invocations of C<release> and C<acquire>.
909
910See also the locking example in the C<THREADS> section later in this
911document.
912
913=item ev_set_userdata (loop, void *data)
914
915=item ev_userdata (loop)
916
917Set and retrieve a single C<void *> associated with a loop. When
918C<ev_set_userdata> has never been called, then C<ev_userdata> returns
919C<0.>
920
921These two functions can be used to associate arbitrary data with a loop,
922and are intended solely for the C<invoke_pending_cb>, C<release> and
923C<acquire> callbacks described above, but of course can be (ab-)used for
924any other purpose as well.
796 925
797=item ev_loop_verify (loop) 926=item ev_loop_verify (loop)
798 927
799This function only does something when C<EV_VERIFY> support has been 928This 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 929compiled in, which is the default for non-minimal builds. It tries to go
926 1055
927=item C<EV_ASYNC> 1056=item C<EV_ASYNC>
928 1057
929The given async watcher has been asynchronously notified (see C<ev_async>). 1058The given async watcher has been asynchronously notified (see C<ev_async>).
930 1059
1060=item C<EV_CUSTOM>
1061
1062Not ever sent (or otherwise used) by libev itself, but can be freely used
1063by libev users to signal watchers (e.g. via C<ev_feed_event>).
1064
931=item C<EV_ERROR> 1065=item C<EV_ERROR>
932 1066
933An unspecified error has occurred, the watcher has been stopped. This might 1067An unspecified error has occurred, the watcher has been stopped. This might
934happen because the watcher could not be properly started because libev 1068happen 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 1069ran 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> 1184integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
1051(default: C<-2>). Pending watchers with higher priority will be invoked 1185(default: C<-2>). Pending watchers with higher priority will be invoked
1052before watchers with lower priority, but priority will not keep watchers 1186before watchers with lower priority, but priority will not keep watchers
1053from being executed (except for C<ev_idle> watchers). 1187from being executed (except for C<ev_idle> watchers).
1054 1188
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 1189If you need to suppress invocation when higher priority events are pending
1061you need to look at C<ev_idle> watchers, which provide this functionality. 1190you need to look at C<ev_idle> watchers, which provide this functionality.
1062 1191
1063You I<must not> change the priority of a watcher as long as it is active or 1192You I<must not> change the priority of a watcher as long as it is active or
1064pending. 1193pending.
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 1194
1069Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is 1195Setting 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 1196fine, as long as you do not mind that the priority value you query might
1071or might not have been clamped to the valid range. 1197or might not have been clamped to the valid range.
1198
1199The default priority used by watchers when no priority has been set is
1200always C<0>, which is supposed to not be too high and not be too low :).
1201
1202See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1203priorities.
1072 1204
1073=item ev_invoke (loop, ev_TYPE *watcher, int revents) 1205=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1074 1206
1075Invoke the C<watcher> with the given C<loop> and C<revents>. Neither 1207Invoke 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 1208C<loop> nor C<revents> need to be valid as long as the watcher callback
1141 #include <stddef.h> 1273 #include <stddef.h>
1142 1274
1143 static void 1275 static void
1144 t1_cb (EV_P_ ev_timer *w, int revents) 1276 t1_cb (EV_P_ ev_timer *w, int revents)
1145 { 1277 {
1146 struct my_biggy big = (struct my_biggy * 1278 struct my_biggy big = (struct my_biggy *)
1147 (((char *)w) - offsetof (struct my_biggy, t1)); 1279 (((char *)w) - offsetof (struct my_biggy, t1));
1148 } 1280 }
1149 1281
1150 static void 1282 static void
1151 t2_cb (EV_P_ ev_timer *w, int revents) 1283 t2_cb (EV_P_ ev_timer *w, int revents)
1152 { 1284 {
1153 struct my_biggy big = (struct my_biggy * 1285 struct my_biggy big = (struct my_biggy *)
1154 (((char *)w) - offsetof (struct my_biggy, t2)); 1286 (((char *)w) - offsetof (struct my_biggy, t2));
1155 } 1287 }
1288
1289=head2 WATCHER PRIORITY MODELS
1290
1291Many event loops support I<watcher priorities>, which are usually small
1292integers that influence the ordering of event callback invocation
1293between watchers in some way, all else being equal.
1294
1295In libev, Watcher priorities can be set using C<ev_set_priority>. See its
1296description for the more technical details such as the actual priority
1297range.
1298
1299There are two common ways how these these priorities are being interpreted
1300by event loops:
1301
1302In the more common lock-out model, higher priorities "lock out" invocation
1303of lower priority watchers, which means as long as higher priority
1304watchers receive events, lower priority watchers are not being invoked.
1305
1306The less common only-for-ordering model uses priorities solely to order
1307callback invocation within a single event loop iteration: Higher priority
1308watchers are invoked before lower priority ones, but they all get invoked
1309before polling for new events.
1310
1311Libev uses the second (only-for-ordering) model for all its watchers
1312except for idle watchers (which use the lock-out model).
1313
1314The rationale behind this is that implementing the lock-out model for
1315watchers is not well supported by most kernel interfaces, and most event
1316libraries will just poll for the same events again and again as long as
1317their callbacks have not been executed, which is very inefficient in the
1318common case of one high-priority watcher locking out a mass of lower
1319priority ones.
1320
1321Static (ordering) priorities are most useful when you have two or more
1322watchers handling the same resource: a typical usage example is having an
1323C<ev_io> watcher to receive data, and an associated C<ev_timer> to handle
1324timeouts. Under load, data might be received while the program handles
1325other jobs, but since timers normally get invoked first, the timeout
1326handler will be executed before checking for data. In that case, giving
1327the timer a lower priority than the I/O watcher ensures that I/O will be
1328handled first even under adverse conditions (which is usually, but not
1329always, what you want).
1330
1331Since idle watchers use the "lock-out" model, meaning that idle watchers
1332will only be executed when no same or higher priority watchers have
1333received events, they can be used to implement the "lock-out" model when
1334required.
1335
1336For example, to emulate how many other event libraries handle priorities,
1337you can associate an C<ev_idle> watcher to each such watcher, and in
1338the normal watcher callback, you just start the idle watcher. The real
1339processing is done in the idle watcher callback. This causes libev to
1340continously poll and process kernel event data for the watcher, but when
1341the lock-out case is known to be rare (which in turn is rare :), this is
1342workable.
1343
1344Usually, however, the lock-out model implemented that way will perform
1345miserably under the type of load it was designed to handle. In that case,
1346it might be preferable to stop the real watcher before starting the
1347idle watcher, so the kernel will not have to process the event in case
1348the actual processing will be delayed for considerable time.
1349
1350Here is an example of an I/O watcher that should run at a strictly lower
1351priority than the default, and which should only process data when no
1352other events are pending:
1353
1354 ev_idle idle; // actual processing watcher
1355 ev_io io; // actual event watcher
1356
1357 static void
1358 io_cb (EV_P_ ev_io *w, int revents)
1359 {
1360 // stop the I/O watcher, we received the event, but
1361 // are not yet ready to handle it.
1362 ev_io_stop (EV_A_ w);
1363
1364 // start the idle watcher to ahndle the actual event.
1365 // it will not be executed as long as other watchers
1366 // with the default priority are receiving events.
1367 ev_idle_start (EV_A_ &idle);
1368 }
1369
1370 static void
1371 idle_cb (EV_P_ ev_idle *w, int revents)
1372 {
1373 // actual processing
1374 read (STDIN_FILENO, ...);
1375
1376 // have to start the I/O watcher again, as
1377 // we have handled the event
1378 ev_io_start (EV_P_ &io);
1379 }
1380
1381 // initialisation
1382 ev_idle_init (&idle, idle_cb);
1383 ev_io_init (&io, io_cb, STDIN_FILENO, EV_READ);
1384 ev_io_start (EV_DEFAULT_ &io);
1385
1386In the "real" world, it might also be beneficial to start a timer, so that
1387low-priority connections can not be locked out forever under load. This
1388enables your program to keep a lower latency for important connections
1389during short periods of high load, while not completely locking out less
1390important ones.
1156 1391
1157 1392
1158=head1 WATCHER TYPES 1393=head1 WATCHER TYPES
1159 1394
1160This section describes each watcher in detail, but will not repeat 1395This section describes each watcher in detail, but will not repeat
1186descriptors to non-blocking mode is also usually a good idea (but not 1421descriptors to non-blocking mode is also usually a good idea (but not
1187required if you know what you are doing). 1422required if you know what you are doing).
1188 1423
1189If you cannot use non-blocking mode, then force the use of a 1424If 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 1425known-to-be-good backend (at the time of this writing, this includes only
1191C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). 1426C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1427descriptors for which non-blocking operation makes no sense (such as
1428files) - libev doesn't guarentee any specific behaviour in that case.
1192 1429
1193Another thing you have to watch out for is that it is quite easy to 1430Another thing you have to watch out for is that it is quite easy to
1194receive "spurious" readiness notifications, that is your callback might 1431receive "spurious" readiness notifications, that is your callback might
1195be called with C<EV_READ> but a subsequent C<read>(2) will actually block 1432be 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 1433because 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 1554year, it will still time out after (roughly) one hour. "Roughly" because
1318detecting time jumps is hard, and some inaccuracies are unavoidable (the 1555detecting time jumps is hard, and some inaccuracies are unavoidable (the
1319monotonic clock option helps a lot here). 1556monotonic clock option helps a lot here).
1320 1557
1321The callback is guaranteed to be invoked only I<after> its timeout has 1558The callback is guaranteed to be invoked only I<after> its timeout has
1322passed, but if multiple timers become ready during the same loop iteration 1559passed (not I<at>, so on systems with very low-resolution clocks this
1323then order of execution is undefined. 1560might introduce a small delay). If multiple timers become ready during the
1561same loop iteration then the ones with earlier time-out values are invoked
1562before ones of the same priority with later time-out values (but this is
1563no longer true when a callback calls C<ev_loop> recursively).
1324 1564
1325=head3 Be smart about timeouts 1565=head3 Be smart about timeouts
1326 1566
1327Many real-world problems involve some kind of timeout, usually for error 1567Many real-world problems involve some kind of timeout, usually for error
1328recovery. A typical example is an HTTP request - if the other side hangs, 1568recovery. 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> 1612C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
1373member and C<ev_timer_again>. 1613member and C<ev_timer_again>.
1374 1614
1375At start: 1615At start:
1376 1616
1377 ev_timer_init (timer, callback); 1617 ev_init (timer, callback);
1378 timer->repeat = 60.; 1618 timer->repeat = 60.;
1379 ev_timer_again (loop, timer); 1619 ev_timer_again (loop, timer);
1380 1620
1381Each time there is some activity: 1621Each time there is some activity:
1382 1622
1444 1684
1445To start the timer, simply initialise the watcher and set C<last_activity> 1685To 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 1686to the current time (meaning we just have some activity :), then call the
1447callback, which will "do the right thing" and start the timer: 1687callback, which will "do the right thing" and start the timer:
1448 1688
1449 ev_timer_init (timer, callback); 1689 ev_init (timer, callback);
1450 last_activity = ev_now (loop); 1690 last_activity = ev_now (loop);
1451 callback (loop, timer, EV_TIMEOUT); 1691 callback (loop, timer, EV_TIMEOUT);
1452 1692
1453And when there is some activity, simply store the current time in 1693And when there is some activity, simply store the current time in
1454C<last_activity>, no libev calls at all: 1694C<last_activity>, no libev calls at all:
1515 1755
1516If the event loop is suspended for a long time, you can also force an 1756If the event loop is suspended for a long time, you can also force an
1517update of the time returned by C<ev_now ()> by calling C<ev_now_update 1757update of the time returned by C<ev_now ()> by calling C<ev_now_update
1518()>. 1758()>.
1519 1759
1760=head3 The special problems of suspended animation
1761
1762When you leave the server world it is quite customary to hit machines that
1763can suspend/hibernate - what happens to the clocks during such a suspend?
1764
1765Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes
1766all processes, while the clocks (C<times>, C<CLOCK_MONOTONIC>) continue
1767to run until the system is suspended, but they will not advance while the
1768system is suspended. That means, on resume, it will be as if the program
1769was frozen for a few seconds, but the suspend time will not be counted
1770towards C<ev_timer> when a monotonic clock source is used. The real time
1771clock advanced as expected, but if it is used as sole clocksource, then a
1772long suspend would be detected as a time jump by libev, and timers would
1773be adjusted accordingly.
1774
1775I would not be surprised to see different behaviour in different between
1776operating systems, OS versions or even different hardware.
1777
1778The other form of suspend (job control, or sending a SIGSTOP) will see a
1779time jump in the monotonic clocks and the realtime clock. If the program
1780is suspended for a very long time, and monotonic clock sources are in use,
1781then you can expect C<ev_timer>s to expire as the full suspension time
1782will be counted towards the timers. When no monotonic clock source is in
1783use, then libev will again assume a timejump and adjust accordingly.
1784
1785It might be beneficial for this latter case to call C<ev_suspend>
1786and C<ev_resume> in code that handles C<SIGTSTP>, to at least get
1787deterministic behaviour in this case (you can do nothing against
1788C<SIGSTOP>).
1789
1520=head3 Watcher-Specific Functions and Data Members 1790=head3 Watcher-Specific Functions and Data Members
1521 1791
1522=over 4 1792=over 4
1523 1793
1524=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 1794=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
1547If the timer is started but non-repeating, stop it (as if it timed out). 1817If the timer is started but non-repeating, stop it (as if it timed out).
1548 1818
1549If the timer is repeating, either start it if necessary (with the 1819If the timer is repeating, either start it if necessary (with the
1550C<repeat> value), or reset the running timer to the C<repeat> value. 1820C<repeat> value), or reset the running timer to the C<repeat> value.
1551 1821
1552This sounds a bit complicated, see "Be smart about timeouts", above, for a 1822This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1553usage example. 1823usage example.
1824
1825=item ev_timer_remaining (loop, ev_timer *)
1826
1827Returns the remaining time until a timer fires. If the timer is active,
1828then this time is relative to the current event loop time, otherwise it's
1829the timeout value currently configured.
1830
1831That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
1832C<5>. When the timer is started and one second passes, C<ev_timer_remain>
1833will return C<4>. When the timer expires and is restarted, it will return
1834roughly C<7> (likely slightly less as callback invocation takes some time,
1835too), and so on.
1554 1836
1555=item ev_tstamp repeat [read-write] 1837=item ev_tstamp repeat [read-write]
1556 1838
1557The current C<repeat> value. Will be used each time the watcher times out 1839The current C<repeat> value. Will be used each time the watcher times out
1558or C<ev_timer_again> is called, and determines the next timeout (if any), 1840or C<ev_timer_again> is called, and determines the next timeout (if any),
1596=head2 C<ev_periodic> - to cron or not to cron? 1878=head2 C<ev_periodic> - to cron or not to cron?
1597 1879
1598Periodic watchers are also timers of a kind, but they are very versatile 1880Periodic watchers are also timers of a kind, but they are very versatile
1599(and unfortunately a bit complex). 1881(and unfortunately a bit complex).
1600 1882
1601Unlike C<ev_timer>'s, they are not based on real time (or relative time) 1883Unlike C<ev_timer>, periodic watchers are not based on real time (or
1602but on wall clock time (absolute time). You can tell a periodic watcher 1884relative time, the physical time that passes) but on wall clock time
1603to trigger after some specific point in time. For example, if you tell a 1885(absolute time, the thing you can read on your calender or clock). The
1604periodic watcher to trigger in 10 seconds (by specifying e.g. C<ev_now () 1886difference is that wall clock time can run faster or slower than real
1605+ 10.>, that is, an absolute time not a delay) and then reset your system 1887time, and time jumps are not uncommon (e.g. when you adjust your
1606clock to January of the previous year, then it will take more than year 1888wrist-watch).
1607to trigger the event (unlike an C<ev_timer>, which would still trigger
1608roughly 10 seconds later as it uses a relative timeout).
1609 1889
1890You can tell a periodic watcher to trigger after some specific point
1891in time: for example, if you tell a periodic watcher to trigger "in 10
1892seconds" (by specifying e.g. C<ev_now () + 10.>, that is, an absolute time
1893not a delay) and then reset your system clock to January of the previous
1894year, then it will take a year or more to trigger the event (unlike an
1895C<ev_timer>, which would still trigger roughly 10 seconds after starting
1896it, as it uses a relative timeout).
1897
1610C<ev_periodic>s can also be used to implement vastly more complex timers, 1898C<ev_periodic> watchers can also be used to implement vastly more complex
1611such as triggering an event on each "midnight, local time", or other 1899timers, such as triggering an event on each "midnight, local time", or
1612complicated rules. 1900other complicated rules. This cannot be done with C<ev_timer> watchers, as
1901those cannot react to time jumps.
1613 1902
1614As with timers, the callback is guaranteed to be invoked only when the 1903As with timers, the callback is guaranteed to be invoked only when the
1615time (C<at>) has passed, but if multiple periodic timers become ready 1904point in time where it is supposed to trigger has passed. If multiple
1616during the same loop iteration, then order of execution is undefined. 1905timers become ready during the same loop iteration then the ones with
1906earlier time-out values are invoked before ones with later time-out values
1907(but this is no longer true when a callback calls C<ev_loop> recursively).
1617 1908
1618=head3 Watcher-Specific Functions and Data Members 1909=head3 Watcher-Specific Functions and Data Members
1619 1910
1620=over 4 1911=over 4
1621 1912
1622=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb) 1913=item ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1623 1914
1624=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb) 1915=item ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1625 1916
1626Lots of arguments, lets sort it out... There are basically three modes of 1917Lots of arguments, let's sort it out... There are basically three modes of
1627operation, and we will explain them from simplest to most complex: 1918operation, and we will explain them from simplest to most complex:
1628 1919
1629=over 4 1920=over 4
1630 1921
1631=item * absolute timer (at = time, interval = reschedule_cb = 0) 1922=item * absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0)
1632 1923
1633In this configuration the watcher triggers an event after the wall clock 1924In this configuration the watcher triggers an event after the wall clock
1634time C<at> has passed. It will not repeat and will not adjust when a time 1925time C<offset> has passed. It will not repeat and will not adjust when a
1635jump occurs, that is, if it is to be run at January 1st 2011 then it will 1926time jump occurs, that is, if it is to be run at January 1st 2011 then it
1636only run when the system clock reaches or surpasses this time. 1927will be stopped and invoked when the system clock reaches or surpasses
1928this point in time.
1637 1929
1638=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) 1930=item * repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0)
1639 1931
1640In this mode the watcher will always be scheduled to time out at the next 1932In this mode the watcher will always be scheduled to time out at the next
1641C<at + N * interval> time (for some integer N, which can also be negative) 1933C<offset + N * interval> time (for some integer N, which can also be
1642and then repeat, regardless of any time jumps. 1934negative) and then repeat, regardless of any time jumps. The C<offset>
1935argument is merely an offset into the C<interval> periods.
1643 1936
1644This can be used to create timers that do not drift with respect to the 1937This can be used to create timers that do not drift with respect to the
1645system clock, for example, here is a C<ev_periodic> that triggers each 1938system clock, for example, here is an C<ev_periodic> that triggers each
1646hour, on the hour: 1939hour, on the hour (with respect to UTC):
1647 1940
1648 ev_periodic_set (&periodic, 0., 3600., 0); 1941 ev_periodic_set (&periodic, 0., 3600., 0);
1649 1942
1650This doesn't mean there will always be 3600 seconds in between triggers, 1943This doesn't mean there will always be 3600 seconds in between triggers,
1651but only that the callback will be called when the system time shows a 1944but only that the callback will be called when the system time shows a
1652full hour (UTC), or more correctly, when the system time is evenly divisible 1945full hour (UTC), or more correctly, when the system time is evenly divisible
1653by 3600. 1946by 3600.
1654 1947
1655Another way to think about it (for the mathematically inclined) is that 1948Another way to think about it (for the mathematically inclined) is that
1656C<ev_periodic> will try to run the callback in this mode at the next possible 1949C<ev_periodic> will try to run the callback in this mode at the next possible
1657time where C<time = at (mod interval)>, regardless of any time jumps. 1950time where C<time = offset (mod interval)>, regardless of any time jumps.
1658 1951
1659For numerical stability it is preferable that the C<at> value is near 1952For numerical stability it is preferable that the C<offset> value is near
1660C<ev_now ()> (the current time), but there is no range requirement for 1953C<ev_now ()> (the current time), but there is no range requirement for
1661this value, and in fact is often specified as zero. 1954this value, and in fact is often specified as zero.
1662 1955
1663Note also that there is an upper limit to how often a timer can fire (CPU 1956Note also that there is an upper limit to how often a timer can fire (CPU
1664speed for example), so if C<interval> is very small then timing stability 1957speed for example), so if C<interval> is very small then timing stability
1665will of course deteriorate. Libev itself tries to be exact to be about one 1958will of course deteriorate. Libev itself tries to be exact to be about one
1666millisecond (if the OS supports it and the machine is fast enough). 1959millisecond (if the OS supports it and the machine is fast enough).
1667 1960
1668=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback) 1961=item * manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback)
1669 1962
1670In this mode the values for C<interval> and C<at> are both being 1963In this mode the values for C<interval> and C<offset> are both being
1671ignored. Instead, each time the periodic watcher gets scheduled, the 1964ignored. Instead, each time the periodic watcher gets scheduled, the
1672reschedule callback will be called with the watcher as first, and the 1965reschedule callback will be called with the watcher as first, and the
1673current time as second argument. 1966current time as second argument.
1674 1967
1675NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, 1968NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, ever,
1676ever, or make ANY event loop modifications whatsoever>. 1969or make ANY other event loop modifications whatsoever, unless explicitly
1970allowed by documentation here>.
1677 1971
1678If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop 1972If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop
1679it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the 1973it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the
1680only event loop modification you are allowed to do). 1974only event loop modification you are allowed to do).
1681 1975
1711a different time than the last time it was called (e.g. in a crond like 2005a different time than the last time it was called (e.g. in a crond like
1712program when the crontabs have changed). 2006program when the crontabs have changed).
1713 2007
1714=item ev_tstamp ev_periodic_at (ev_periodic *) 2008=item ev_tstamp ev_periodic_at (ev_periodic *)
1715 2009
1716When active, returns the absolute time that the watcher is supposed to 2010When active, returns the absolute time that the watcher is supposed
1717trigger next. 2011to trigger next. This is not the same as the C<offset> argument to
2012C<ev_periodic_set>, but indeed works even in interval and manual
2013rescheduling modes.
1718 2014
1719=item ev_tstamp offset [read-write] 2015=item ev_tstamp offset [read-write]
1720 2016
1721When repeating, this contains the offset value, otherwise this is the 2017When repeating, this contains the offset value, otherwise this is the
1722absolute point in time (the C<at> value passed to C<ev_periodic_set>). 2018absolute point in time (the C<offset> value passed to C<ev_periodic_set>,
2019although libev might modify this value for better numerical stability).
1723 2020
1724Can be modified any time, but changes only take effect when the periodic 2021Can be modified any time, but changes only take effect when the periodic
1725timer fires or C<ev_periodic_again> is being called. 2022timer fires or C<ev_periodic_again> is being called.
1726 2023
1727=item ev_tstamp interval [read-write] 2024=item ev_tstamp interval [read-write]
1779Signal watchers will trigger an event when the process receives a specific 2076Signal watchers will trigger an event when the process receives a specific
1780signal one or more times. Even though signals are very asynchronous, libev 2077signal one or more times. Even though signals are very asynchronous, libev
1781will try it's best to deliver signals synchronously, i.e. as part of the 2078will try it's best to deliver signals synchronously, i.e. as part of the
1782normal event processing, like any other event. 2079normal event processing, like any other event.
1783 2080
2081Note that only the default loop supports registering signal watchers
2082currently.
2083
1784If you want signals asynchronously, just use C<sigaction> as you would 2084If you want signals asynchronously, just use C<sigaction> as you would
1785do without libev and forget about sharing the signal. You can even use 2085do without libev and forget about sharing the signal. You can even use
1786C<ev_async> from a signal handler to synchronously wake up an event loop. 2086C<ev_async> from a signal handler to synchronously wake up an event loop.
1787 2087
1788You can configure as many watchers as you like per signal. Only when the 2088You can configure as many watchers as you like per signal. Only when the
1789first watcher gets started will libev actually register a signal handler 2089first watcher gets started will libev actually register something with
1790with the kernel (thus it coexists with your own signal handlers as long as 2090the kernel (thus it coexists with your own signal handlers as long as you
1791you don't register any with libev for the same signal). Similarly, when 2091don't register any with libev for the same signal).
1792the last signal watcher for a signal is stopped, libev will reset the 2092
1793signal handler to SIG_DFL (regardless of what it was set to before). 2093Both the signal mask state (C<sigprocmask>) and the signal handler state
2094(C<sigaction>) are unspecified after starting a signal watcher (and after
2095sotpping it again), that is, libev might or might not block the signal,
2096and might or might not set or restore the installed signal handler.
1794 2097
1795If possible and supported, libev will install its handlers with 2098If possible and supported, libev will install its handlers with
1796C<SA_RESTART> behaviour enabled, so system calls should not be unduly 2099C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
1797interrupted. If you have a problem with system calls getting interrupted by 2100not be unduly interrupted. If you have a problem with system calls getting
1798signals you can block all signals in an C<ev_check> watcher and unblock 2101interrupted by signals you can block all signals in an C<ev_check> watcher
1799them in an C<ev_prepare> watcher. 2102and unblock them in an C<ev_prepare> watcher.
1800 2103
1801=head3 Watcher-Specific Functions and Data Members 2104=head3 Watcher-Specific Functions and Data Members
1802 2105
1803=over 4 2106=over 4
1804 2107
1836some child status changes (most typically when a child of yours dies or 2139some child status changes (most typically when a child of yours dies or
1837exits). It is permissible to install a child watcher I<after> the child 2140exits). It is permissible to install a child watcher I<after> the child
1838has been forked (which implies it might have already exited), as long 2141has been forked (which implies it might have already exited), as long
1839as the event loop isn't entered (or is continued from a watcher), i.e., 2142as the event loop isn't entered (or is continued from a watcher), i.e.,
1840forking and then immediately registering a watcher for the child is fine, 2143forking and then immediately registering a watcher for the child is fine,
1841but forking and registering a watcher a few event loop iterations later is 2144but forking and registering a watcher a few event loop iterations later or
1842not. 2145in the next callback invocation is not.
1843 2146
1844Only the default event loop is capable of handling signals, and therefore 2147Only the default event loop is capable of handling signals, and therefore
1845you can only register child watchers in the default event loop. 2148you can only register child watchers in the default event loop.
1846 2149
2150Due to some design glitches inside libev, child watchers will always be
2151handled at maximum priority (their priority is set to C<EV_MAXPRI> by
2152libev)
2153
1847=head3 Process Interaction 2154=head3 Process Interaction
1848 2155
1849Libev grabs C<SIGCHLD> as soon as the default event loop is 2156Libev grabs C<SIGCHLD> as soon as the default event loop is
1850initialised. This is necessary to guarantee proper behaviour even if 2157initialised. This is necessary to guarantee proper behaviour even if the
1851the first child watcher is started after the child exits. The occurrence 2158first child watcher is started after the child exits. The occurrence
1852of C<SIGCHLD> is recorded asynchronously, but child reaping is done 2159of C<SIGCHLD> is recorded asynchronously, but child reaping is done
1853synchronously as part of the event loop processing. Libev always reaps all 2160synchronously as part of the event loop processing. Libev always reaps all
1854children, even ones not watched. 2161children, even ones not watched.
1855 2162
1856=head3 Overriding the Built-In Processing 2163=head3 Overriding the Built-In Processing
1866=head3 Stopping the Child Watcher 2173=head3 Stopping the Child Watcher
1867 2174
1868Currently, the child watcher never gets stopped, even when the 2175Currently, the child watcher never gets stopped, even when the
1869child terminates, so normally one needs to stop the watcher in the 2176child terminates, so normally one needs to stop the watcher in the
1870callback. Future versions of libev might stop the watcher automatically 2177callback. Future versions of libev might stop the watcher automatically
1871when a child exit is detected. 2178when a child exit is detected (calling C<ev_child_stop> twice is not a
2179problem).
1872 2180
1873=head3 Watcher-Specific Functions and Data Members 2181=head3 Watcher-Specific Functions and Data Members
1874 2182
1875=over 4 2183=over 4
1876 2184
2179 2487
2180=head3 Watcher-Specific Functions and Data Members 2488=head3 Watcher-Specific Functions and Data Members
2181 2489
2182=over 4 2490=over 4
2183 2491
2184=item ev_idle_init (ev_signal *, callback) 2492=item ev_idle_init (ev_idle *, callback)
2185 2493
2186Initialises and configures the idle watcher - it has no parameters of any 2494Initialises and configures the idle watcher - it has no parameters of any
2187kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, 2495kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
2188believe me. 2496believe me.
2189 2497
2202 // no longer anything immediate to do. 2510 // no longer anything immediate to do.
2203 } 2511 }
2204 2512
2205 ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 2513 ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2206 ev_idle_init (idle_watcher, idle_cb); 2514 ev_idle_init (idle_watcher, idle_cb);
2207 ev_idle_start (loop, idle_cb); 2515 ev_idle_start (loop, idle_watcher);
2208 2516
2209 2517
2210=head2 C<ev_prepare> and C<ev_check> - customise your event loop! 2518=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2211 2519
2212Prepare and check watchers are usually (but not always) used in pairs: 2520Prepare and check watchers are usually (but not always) used in pairs:
2305 struct pollfd fds [nfd]; 2613 struct pollfd fds [nfd];
2306 // actual code will need to loop here and realloc etc. 2614 // actual code will need to loop here and realloc etc.
2307 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); 2615 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
2308 2616
2309 /* the callback is illegal, but won't be called as we stop during check */ 2617 /* the callback is illegal, but won't be called as we stop during check */
2310 ev_timer_init (&tw, 0, timeout * 1e-3); 2618 ev_timer_init (&tw, 0, timeout * 1e-3, 0.);
2311 ev_timer_start (loop, &tw); 2619 ev_timer_start (loop, &tw);
2312 2620
2313 // create one ev_io per pollfd 2621 // create one ev_io per pollfd
2314 for (int i = 0; i < nfd; ++i) 2622 for (int i = 0; i < nfd; ++i)
2315 { 2623 {
2545event loop blocks next and before C<ev_check> watchers are being called, 2853event loop blocks next and before C<ev_check> watchers are being called,
2546and only in the child after the fork. If whoever good citizen calling 2854and only in the child after the fork. If whoever good citizen calling
2547C<ev_default_fork> cheats and calls it in the wrong process, the fork 2855C<ev_default_fork> cheats and calls it in the wrong process, the fork
2548handlers will be invoked, too, of course. 2856handlers will be invoked, too, of course.
2549 2857
2858=head3 The special problem of life after fork - how is it possible?
2859
2860Most uses of C<fork()> consist of forking, then some simple calls to ste
2861up/change the process environment, followed by a call to C<exec()>. This
2862sequence should be handled by libev without any problems.
2863
2864This changes when the application actually wants to do event handling
2865in the child, or both parent in child, in effect "continuing" after the
2866fork.
2867
2868The default mode of operation (for libev, with application help to detect
2869forks) is to duplicate all the state in the child, as would be expected
2870when I<either> the parent I<or> the child process continues.
2871
2872When both processes want to continue using libev, then this is usually the
2873wrong result. In that case, usually one process (typically the parent) is
2874supposed to continue with all watchers in place as before, while the other
2875process typically wants to start fresh, i.e. without any active watchers.
2876
2877The cleanest and most efficient way to achieve that with libev is to
2878simply create a new event loop, which of course will be "empty", and
2879use that for new watchers. This has the advantage of not touching more
2880memory than necessary, and thus avoiding the copy-on-write, and the
2881disadvantage of having to use multiple event loops (which do not support
2882signal watchers).
2883
2884When this is not possible, or you want to use the default loop for
2885other reasons, then in the process that wants to start "fresh", call
2886C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying
2887the default loop will "orphan" (not stop) all registered watchers, so you
2888have to be careful not to execute code that modifies those watchers. Note
2889also that in that case, you have to re-register any signal watchers.
2890
2550=head3 Watcher-Specific Functions and Data Members 2891=head3 Watcher-Specific Functions and Data Members
2551 2892
2552=over 4 2893=over 4
2553 2894
2554=item ev_fork_init (ev_signal *, callback) 2895=item ev_fork_init (ev_signal *, callback)
2682an C<EV_ASYNC> event on the watcher into the event loop. Unlike 3023an C<EV_ASYNC> event on the watcher into the event loop. Unlike
2683C<ev_feed_event>, this call is safe to do from other threads, signal or 3024C<ev_feed_event>, this call is safe to do from other threads, signal or
2684similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding 3025similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding
2685section below on what exactly this means). 3026section below on what exactly this means).
2686 3027
3028Note that, as with other watchers in libev, multiple events might get
3029compressed into a single callback invocation (another way to look at this
3030is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,
3031reset when the event loop detects that).
3032
2687This call incurs the overhead of a system call only once per loop iteration, 3033This call incurs the overhead of a system call only once per event loop
2688so while the overhead might be noticeable, it doesn't apply to repeated 3034iteration, so while the overhead might be noticeable, it doesn't apply to
2689calls to C<ev_async_send>. 3035repeated calls to C<ev_async_send> for the same event loop.
2690 3036
2691=item bool = ev_async_pending (ev_async *) 3037=item bool = ev_async_pending (ev_async *)
2692 3038
2693Returns a non-zero value when C<ev_async_send> has been called on the 3039Returns a non-zero value when C<ev_async_send> has been called on the
2694watcher but the event has not yet been processed (or even noted) by the 3040watcher but the event has not yet been processed (or even noted) by the
2697C<ev_async_send> sets a flag in the watcher and wakes up the loop. When 3043C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
2698the loop iterates next and checks for the watcher to have become active, 3044the loop iterates next and checks for the watcher to have become active,
2699it will reset the flag again. C<ev_async_pending> can be used to very 3045it will reset the flag again. C<ev_async_pending> can be used to very
2700quickly check whether invoking the loop might be a good idea. 3046quickly check whether invoking the loop might be a good idea.
2701 3047
2702Not that this does I<not> check whether the watcher itself is pending, only 3048Not that this does I<not> check whether the watcher itself is pending,
2703whether it has been requested to make this watcher pending. 3049only whether it has been requested to make this watcher pending: there
3050is a time window between the event loop checking and resetting the async
3051notification, and the callback being invoked.
2704 3052
2705=back 3053=back
2706 3054
2707 3055
2708=head1 OTHER FUNCTIONS 3056=head1 OTHER FUNCTIONS
3012L<http://software.schmorp.de/pkg/EV>. 3360L<http://software.schmorp.de/pkg/EV>.
3013 3361
3014=item Python 3362=item Python
3015 3363
3016Python bindings can be found at L<http://code.google.com/p/pyev/>. It 3364Python bindings can be found at L<http://code.google.com/p/pyev/>. It
3017seems to be quite complete and well-documented. Note, however, that the 3365seems to be quite complete and well-documented.
3018patch they require for libev is outright dangerous as it breaks the ABI
3019for everybody else, and therefore, should never be applied in an installed
3020libev (if python requires an incompatible ABI then it needs to embed
3021libev).
3022 3366
3023=item Ruby 3367=item Ruby
3024 3368
3025Tony Arcieri has written a ruby extension that offers access to a subset 3369Tony Arcieri has written a ruby extension that offers access to a subset
3026of the libev API and adds file handle abstractions, asynchronous DNS and 3370of the libev API and adds file handle abstractions, asynchronous DNS and
3027more on top of it. It can be found via gem servers. Its homepage is at 3371more on top of it. It can be found via gem servers. Its homepage is at
3028L<http://rev.rubyforge.org/>. 3372L<http://rev.rubyforge.org/>.
3029 3373
3030Roger Pack reports that using the link order C<-lws2_32 -lmsvcrt-ruby-190> 3374Roger Pack reports that using the link order C<-lws2_32 -lmsvcrt-ruby-190>
3031makes rev work even on mingw. 3375makes rev work even on mingw.
3376
3377=item Haskell
3378
3379A haskell binding to libev is available at
3380L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
3032 3381
3033=item D 3382=item D
3034 3383
3035Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to 3384Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
3036be found at L<http://proj.llucax.com.ar/wiki/evd>. 3385be found at L<http://proj.llucax.com.ar/wiki/evd>.
3229function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>. 3578function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>.
3230 3579
3231=item EV_USE_REALTIME 3580=item EV_USE_REALTIME
3232 3581
3233If defined to be C<1>, libev will try to detect the availability of the 3582If defined to be C<1>, libev will try to detect the availability of the
3234real-time clock option at compile time (and assume its availability at 3583real-time clock option at compile time (and assume its availability
3235runtime if successful). Otherwise no use of the real-time clock option will 3584at runtime if successful). Otherwise no use of the real-time clock
3236be attempted. This effectively replaces C<gettimeofday> by C<clock_get 3585option will be attempted. This effectively replaces C<gettimeofday>
3237(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the 3586by C<clock_get (CLOCK_REALTIME, ...)> and will not normally affect
3238note about libraries in the description of C<EV_USE_MONOTONIC>, though. 3587correctness. See the note about libraries in the description of
3588C<EV_USE_MONOTONIC>, though. Defaults to the opposite value of
3589C<EV_USE_CLOCK_SYSCALL>.
3239 3590
3240=item EV_USE_CLOCK_SYSCALL 3591=item EV_USE_CLOCK_SYSCALL
3241 3592
3242If defined to be C<1>, libev will try to use a direct syscall instead 3593If defined to be C<1>, libev will try to use a direct syscall instead
3243of calling the system-provided C<clock_gettime> function. This option 3594of calling the system-provided C<clock_gettime> function. This option
3434defined to be C<0>, then they are not. 3785defined to be C<0>, then they are not.
3435 3786
3436=item EV_MINIMAL 3787=item EV_MINIMAL
3437 3788
3438If you need to shave off some kilobytes of code at the expense of some 3789If you need to shave off some kilobytes of code at the expense of some
3439speed, define this symbol to C<1>. Currently this is used to override some 3790speed (but with the full API), define this symbol to C<1>. Currently this
3440inlining decisions, saves roughly 30% code size on amd64. It also selects a 3791is used to override some inlining decisions, saves roughly 30% code size
3441much smaller 2-heap for timer management over the default 4-heap. 3792on amd64. It also selects a much smaller 2-heap for timer management over
3793the default 4-heap.
3794
3795You can save even more by disabling watcher types you do not need
3796and setting C<EV_MAXPRI> == C<EV_MINPRI>. Also, disabling C<assert>
3797(C<-DNDEBUG>) will usually reduce code size a lot.
3798
3799Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to
3800provide a bare-bones event library. See C<ev.h> for details on what parts
3801of the API are still available, and do not complain if this subset changes
3802over time.
3442 3803
3443=item EV_PID_HASHSIZE 3804=item EV_PID_HASHSIZE
3444 3805
3445C<ev_child> watchers use a small hash table to distribute workload by 3806C<ev_child> watchers use a small hash table to distribute workload by
3446pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more 3807pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
3632default loop and triggering an C<ev_async> watcher from the default loop 3993default loop and triggering an C<ev_async> watcher from the default loop
3633watcher callback into the event loop interested in the signal. 3994watcher callback into the event loop interested in the signal.
3634 3995
3635=back 3996=back
3636 3997
3998=head4 THREAD LOCKING EXAMPLE
3999
4000Here is a fictitious example of how to run an event loop in a different
4001thread than where callbacks are being invoked and watchers are
4002created/added/removed.
4003
4004For a real-world example, see the C<EV::Loop::Async> perl module,
4005which uses exactly this technique (which is suited for many high-level
4006languages).
4007
4008The example uses a pthread mutex to protect the loop data, a condition
4009variable to wait for callback invocations, an async watcher to notify the
4010event loop thread and an unspecified mechanism to wake up the main thread.
4011
4012First, you need to associate some data with the event loop:
4013
4014 typedef struct {
4015 mutex_t lock; /* global loop lock */
4016 ev_async async_w;
4017 thread_t tid;
4018 cond_t invoke_cv;
4019 } userdata;
4020
4021 void prepare_loop (EV_P)
4022 {
4023 // for simplicity, we use a static userdata struct.
4024 static userdata u;
4025
4026 ev_async_init (&u->async_w, async_cb);
4027 ev_async_start (EV_A_ &u->async_w);
4028
4029 pthread_mutex_init (&u->lock, 0);
4030 pthread_cond_init (&u->invoke_cv, 0);
4031
4032 // now associate this with the loop
4033 ev_set_userdata (EV_A_ u);
4034 ev_set_invoke_pending_cb (EV_A_ l_invoke);
4035 ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4036
4037 // then create the thread running ev_loop
4038 pthread_create (&u->tid, 0, l_run, EV_A);
4039 }
4040
4041The callback for the C<ev_async> watcher does nothing: the watcher is used
4042solely to wake up the event loop so it takes notice of any new watchers
4043that might have been added:
4044
4045 static void
4046 async_cb (EV_P_ ev_async *w, int revents)
4047 {
4048 // just used for the side effects
4049 }
4050
4051The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
4052protecting the loop data, respectively.
4053
4054 static void
4055 l_release (EV_P)
4056 {
4057 userdata *u = ev_userdata (EV_A);
4058 pthread_mutex_unlock (&u->lock);
4059 }
4060
4061 static void
4062 l_acquire (EV_P)
4063 {
4064 userdata *u = ev_userdata (EV_A);
4065 pthread_mutex_lock (&u->lock);
4066 }
4067
4068The event loop thread first acquires the mutex, and then jumps straight
4069into C<ev_loop>:
4070
4071 void *
4072 l_run (void *thr_arg)
4073 {
4074 struct ev_loop *loop = (struct ev_loop *)thr_arg;
4075
4076 l_acquire (EV_A);
4077 pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4078 ev_loop (EV_A_ 0);
4079 l_release (EV_A);
4080
4081 return 0;
4082 }
4083
4084Instead of invoking all pending watchers, the C<l_invoke> callback will
4085signal the main thread via some unspecified mechanism (signals? pipe
4086writes? C<Async::Interrupt>?) and then waits until all pending watchers
4087have been called (in a while loop because a) spurious wakeups are possible
4088and b) skipping inter-thread-communication when there are no pending
4089watchers is very beneficial):
4090
4091 static void
4092 l_invoke (EV_P)
4093 {
4094 userdata *u = ev_userdata (EV_A);
4095
4096 while (ev_pending_count (EV_A))
4097 {
4098 wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4099 pthread_cond_wait (&u->invoke_cv, &u->lock);
4100 }
4101 }
4102
4103Now, whenever the main thread gets told to invoke pending watchers, it
4104will grab the lock, call C<ev_invoke_pending> and then signal the loop
4105thread to continue:
4106
4107 static void
4108 real_invoke_pending (EV_P)
4109 {
4110 userdata *u = ev_userdata (EV_A);
4111
4112 pthread_mutex_lock (&u->lock);
4113 ev_invoke_pending (EV_A);
4114 pthread_cond_signal (&u->invoke_cv);
4115 pthread_mutex_unlock (&u->lock);
4116 }
4117
4118Whenever you want to start/stop a watcher or do other modifications to an
4119event loop, you will now have to lock:
4120
4121 ev_timer timeout_watcher;
4122 userdata *u = ev_userdata (EV_A);
4123
4124 ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4125
4126 pthread_mutex_lock (&u->lock);
4127 ev_timer_start (EV_A_ &timeout_watcher);
4128 ev_async_send (EV_A_ &u->async_w);
4129 pthread_mutex_unlock (&u->lock);
4130
4131Note that sending the C<ev_async> watcher is required because otherwise
4132an event loop currently blocking in the kernel will have no knowledge
4133about the newly added timer. By waking up the loop it will pick up any new
4134watchers in the next event loop iteration.
4135
3637=head3 COROUTINES 4136=head3 COROUTINES
3638 4137
3639Libev is very accommodating to coroutines ("cooperative threads"): 4138Libev is very accommodating to coroutines ("cooperative threads"):
3640libev fully supports nesting calls to its functions from different 4139libev fully supports nesting calls to its functions from different
3641coroutines (e.g. you can call C<ev_loop> on the same loop from two 4140coroutines (e.g. you can call C<ev_loop> on the same loop from two
3642different coroutines, and switch freely between both coroutines running the 4141different coroutines, and switch freely between both coroutines running
3643loop, as long as you don't confuse yourself). The only exception is that 4142the loop, as long as you don't confuse yourself). The only exception is
3644you must not do this from C<ev_periodic> reschedule callbacks. 4143that you must not do this from C<ev_periodic> reschedule callbacks.
3645 4144
3646Care has been taken to ensure that libev does not keep local state inside 4145Care has been taken to ensure that libev does not keep local state inside
3647C<ev_loop>, and other calls do not usually allow for coroutine switches as 4146C<ev_loop>, and other calls do not usually allow for coroutine switches as
3648they do not call any callbacks. 4147they do not call any callbacks.
3649 4148
3726way (note also that glib is the slowest event library known to man). 4225way (note also that glib is the slowest event library known to man).
3727 4226
3728There is no supported compilation method available on windows except 4227There is no supported compilation method available on windows except
3729embedding it into other applications. 4228embedding it into other applications.
3730 4229
4230Sensible signal handling is officially unsupported by Microsoft - libev
4231tries its best, but under most conditions, signals will simply not work.
4232
3731Not a libev limitation but worth mentioning: windows apparently doesn't 4233Not a libev limitation but worth mentioning: windows apparently doesn't
3732accept large writes: instead of resulting in a partial write, windows will 4234accept large writes: instead of resulting in a partial write, windows will
3733either accept everything or return C<ENOBUFS> if the buffer is too large, 4235either accept everything or return C<ENOBUFS> if the buffer is too large,
3734so make sure you only write small amounts into your sockets (less than a 4236so make sure you only write small amounts into your sockets (less than a
3735megabyte seems safe, but this apparently depends on the amount of memory 4237megabyte seems safe, but this apparently depends on the amount of memory
3739the abysmal performance of winsockets, using a large number of sockets 4241the abysmal performance of winsockets, using a large number of sockets
3740is not recommended (and not reasonable). If your program needs to use 4242is not recommended (and not reasonable). If your program needs to use
3741more than a hundred or so sockets, then likely it needs to use a totally 4243more than a hundred or so sockets, then likely it needs to use a totally
3742different implementation for windows, as libev offers the POSIX readiness 4244different implementation for windows, as libev offers the POSIX readiness
3743notification model, which cannot be implemented efficiently on windows 4245notification model, which cannot be implemented efficiently on windows
3744(Microsoft monopoly games). 4246(due to Microsoft monopoly games).
3745 4247
3746A typical way to use libev under windows is to embed it (see the embedding 4248A typical way to use libev under windows is to embed it (see the embedding
3747section for details) and use the following F<evwrap.h> header file instead 4249section for details) and use the following F<evwrap.h> header file instead
3748of F<ev.h>: 4250of F<ev.h>:
3749 4251
3785 4287
3786Early versions of winsocket's select only supported waiting for a maximum 4288Early versions of winsocket's select only supported waiting for a maximum
3787of C<64> handles (probably owning to the fact that all windows kernels 4289of C<64> handles (probably owning to the fact that all windows kernels
3788can only wait for C<64> things at the same time internally; Microsoft 4290can only wait for C<64> things at the same time internally; Microsoft
3789recommends spawning a chain of threads and wait for 63 handles and the 4291recommends spawning a chain of threads and wait for 63 handles and the
3790previous thread in each. Great). 4292previous thread in each. Sounds great!).
3791 4293
3792Newer versions support more handles, but you need to define C<FD_SETSIZE> 4294Newer versions support more handles, but you need to define C<FD_SETSIZE>
3793to some high number (e.g. C<2048>) before compiling the winsocket select 4295to some high number (e.g. C<2048>) before compiling the winsocket select
3794call (which might be in libev or elsewhere, for example, perl does its own 4296call (which might be in libev or elsewhere, for example, perl and many
3795select emulation on windows). 4297other interpreters do their own select emulation on windows).
3796 4298
3797Another limit is the number of file descriptors in the Microsoft runtime 4299Another limit is the number of file descriptors in the Microsoft runtime
3798libraries, which by default is C<64> (there must be a hidden I<64> fetish 4300libraries, which by default is C<64> (there must be a hidden I<64>
3799or something like this inside Microsoft). You can increase this by calling 4301fetish or something like this inside Microsoft). You can increase this
3800C<_setmaxstdio>, which can increase this limit to C<2048> (another 4302by calling C<_setmaxstdio>, which can increase this limit to C<2048>
3801arbitrary limit), but is broken in many versions of the Microsoft runtime 4303(another arbitrary limit), but is broken in many versions of the Microsoft
3802libraries.
3803
3804This might get you to about C<512> or C<2048> sockets (depending on 4304runtime libraries. This might get you to about C<512> or C<2048> sockets
3805windows version and/or the phase of the moon). To get more, you need to 4305(depending on windows version and/or the phase of the moon). To get more,
3806wrap all I/O functions and provide your own fd management, but the cost of 4306you need to wrap all I/O functions and provide your own fd management, but
3807calling select (O(n²)) will likely make this unworkable. 4307the cost of calling select (O(n²)) will likely make this unworkable.
3808 4308
3809=back 4309=back
3810 4310
3811=head2 PORTABILITY REQUIREMENTS 4311=head2 PORTABILITY REQUIREMENTS
3812 4312
3855=item C<double> must hold a time value in seconds with enough accuracy 4355=item C<double> must hold a time value in seconds with enough accuracy
3856 4356
3857The type C<double> is used to represent timestamps. It is required to 4357The type C<double> is used to represent timestamps. It is required to
3858have at least 51 bits of mantissa (and 9 bits of exponent), which is good 4358have at least 51 bits of mantissa (and 9 bits of exponent), which is good
3859enough for at least into the year 4000. This requirement is fulfilled by 4359enough for at least into the year 4000. This requirement is fulfilled by
3860implementations implementing IEEE 754 (basically all existing ones). 4360implementations implementing IEEE 754, which is basically all existing
4361ones. With IEEE 754 doubles, you get microsecond accuracy until at least
43622200.
3861 4363
3862=back 4364=back
3863 4365
3864If you know of other additional requirements drop me a note. 4366If you know of other additional requirements drop me a note.
3865 4367
3933involves iterating over all running async watchers or all signal numbers. 4435involves iterating over all running async watchers or all signal numbers.
3934 4436
3935=back 4437=back
3936 4438
3937 4439
4440=head1 GLOSSARY
4441
4442=over 4
4443
4444=item active
4445
4446A watcher is active as long as it has been started (has been attached to
4447an event loop) but not yet stopped (disassociated from the event loop).
4448
4449=item application
4450
4451In this document, an application is whatever is using libev.
4452
4453=item callback
4454
4455The address of a function that is called when some event has been
4456detected. Callbacks are being passed the event loop, the watcher that
4457received the event, and the actual event bitset.
4458
4459=item callback invocation
4460
4461The act of calling the callback associated with a watcher.
4462
4463=item event
4464
4465A change of state of some external event, such as data now being available
4466for reading on a file descriptor, time having passed or simply not having
4467any other events happening anymore.
4468
4469In libev, events are represented as single bits (such as C<EV_READ> or
4470C<EV_TIMEOUT>).
4471
4472=item event library
4473
4474A software package implementing an event model and loop.
4475
4476=item event loop
4477
4478An entity that handles and processes external events and converts them
4479into callback invocations.
4480
4481=item event model
4482
4483The model used to describe how an event loop handles and processes
4484watchers and events.
4485
4486=item pending
4487
4488A watcher is pending as soon as the corresponding event has been detected,
4489and stops being pending as soon as the watcher will be invoked or its
4490pending status is explicitly cleared by the application.
4491
4492A watcher can be pending, but not active. Stopping a watcher also clears
4493its pending status.
4494
4495=item real time
4496
4497The physical time that is observed. It is apparently strictly monotonic :)
4498
4499=item wall-clock time
4500
4501The time and date as shown on clocks. Unlike real time, it can actually
4502be wrong and jump forwards and backwards, e.g. when the you adjust your
4503clock.
4504
4505=item watcher
4506
4507A data structure that describes interest in certain events. Watchers need
4508to be started (attached to an event loop) before they can receive events.
4509
4510=item watcher invocation
4511
4512The act of calling the callback associated with a watcher.
4513
4514=back
4515
3938=head1 AUTHOR 4516=head1 AUTHOR
3939 4517
3940Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson. 4518Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.
3941 4519

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines