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

Comparing libev/ev.pod (file contents):
Revision 1.231 by root, Wed Apr 15 19:35:53 2009 UTC vs.
Revision 1.258 by root, Wed Jul 15 16:58:53 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.
638 662
639=item ev_suspend (loop) 663=item ev_suspend (loop)
640 664
641=item ev_resume (loop) 665=item ev_resume (loop)
642 666
799 823
800By 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
801time 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,
802at the cost of increasing latency. Timeouts (both C<ev_periodic> and 826at the cost of increasing latency. Timeouts (both C<ev_periodic> and
803C<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
804introduce 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.
805 831
806Likewise, by setting a higher I<timeout collect interval> you allow libev 832Likewise, by setting a higher I<timeout collect interval> you allow libev
807to spend more time collecting timeouts, at the expense of increased 833to spend more time collecting timeouts, at the expense of increased
808latency/jitter/inexactness (the watcher callback will be called 834latency/jitter/inexactness (the watcher callback will be called
809later). 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
811 837
812Many (busy) programs can usually benefit by setting the I/O collect 838Many (busy) programs can usually benefit by setting the I/O collect
813interval 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
814interactive servers (of course not for games), likewise for timeouts. It 840interactive servers (of course not for games), likewise for timeouts. It
815usually 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>,
816as 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).
817 847
818Setting the I<timeout collect interval> can improve the opportunity for 848Setting the I<timeout collect interval> can improve the opportunity for
819saving power, as the program will "bundle" timer callback invocations that 849saving power, as the program will "bundle" timer callback invocations that
820are "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
821times the process sleeps and wakes up again. Another useful technique to 851times the process sleeps and wakes up again. Another useful technique to
822reduce 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
823they 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.
824 925
825=item ev_loop_verify (loop) 926=item ev_loop_verify (loop)
826 927
827This function only does something when C<EV_VERIFY> support has been 928This function only does something when C<EV_VERIFY> support has been
828compiled 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
1083integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI> 1184integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
1084(default: C<-2>). Pending watchers with higher priority will be invoked 1185(default: C<-2>). Pending watchers with higher priority will be invoked
1085before watchers with lower priority, but priority will not keep watchers 1186before watchers with lower priority, but priority will not keep watchers
1086from being executed (except for C<ev_idle> watchers). 1187from being executed (except for C<ev_idle> watchers).
1087 1188
1088This means that priorities are I<only> used for ordering callback
1089invocation after new events have been received. This is useful, for
1090example, to reduce latency after idling, or more often, to bind two
1091watchers on the same event and make sure one is called first.
1092
1093If you need to suppress invocation when higher priority events are pending 1189If you need to suppress invocation when higher priority events are pending
1094you 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.
1095 1191
1096You 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
1097pending. 1193pending.
1098
1099The default priority used by watchers when no priority has been set is
1100always C<0>, which is supposed to not be too high and not be too low :).
1101 1194
1102Setting 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
1103fine, 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
1104or 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.
1105 1204
1106=item ev_invoke (loop, ev_TYPE *watcher, int revents) 1205=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1107 1206
1108Invoke 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
1109C<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
1174 #include <stddef.h> 1273 #include <stddef.h>
1175 1274
1176 static void 1275 static void
1177 t1_cb (EV_P_ ev_timer *w, int revents) 1276 t1_cb (EV_P_ ev_timer *w, int revents)
1178 { 1277 {
1179 struct my_biggy big = (struct my_biggy * 1278 struct my_biggy big = (struct my_biggy *)
1180 (((char *)w) - offsetof (struct my_biggy, t1)); 1279 (((char *)w) - offsetof (struct my_biggy, t1));
1181 } 1280 }
1182 1281
1183 static void 1282 static void
1184 t2_cb (EV_P_ ev_timer *w, int revents) 1283 t2_cb (EV_P_ ev_timer *w, int revents)
1185 { 1284 {
1186 struct my_biggy big = (struct my_biggy * 1285 struct my_biggy big = (struct my_biggy *)
1187 (((char *)w) - offsetof (struct my_biggy, t2)); 1286 (((char *)w) - offsetof (struct my_biggy, t2));
1188 } 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.
1189 1391
1190 1392
1191=head1 WATCHER TYPES 1393=head1 WATCHER TYPES
1192 1394
1193This section describes each watcher in detail, but will not repeat 1395This section describes each watcher in detail, but will not repeat
1219descriptors 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
1220required if you know what you are doing). 1422required if you know what you are doing).
1221 1423
1222If 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
1223known-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
1224C<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.
1225 1429
1226Another 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
1227receive "spurious" readiness notifications, that is your callback might 1431receive "spurious" readiness notifications, that is your callback might
1228be 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
1229because 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
1350year, it will still time out after (roughly) one hour. "Roughly" because 1554year, it will still time out after (roughly) one hour. "Roughly" because
1351detecting time jumps is hard, and some inaccuracies are unavoidable (the 1555detecting time jumps is hard, and some inaccuracies are unavoidable (the
1352monotonic clock option helps a lot here). 1556monotonic clock option helps a lot here).
1353 1557
1354The 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
1355passed. If multiple timers become ready during the same loop iteration 1559passed (not I<at>, so on systems with very low-resolution clocks this
1356then the ones with earlier time-out values are invoked before ones with 1560might introduce a small delay). If multiple timers become ready during the
1357later time-out values (but this is no longer true when a callback calls 1561same loop iteration then the ones with earlier time-out values are invoked
1358C<ev_loop> recursively). 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).
1359 1564
1360=head3 Be smart about timeouts 1565=head3 Be smart about timeouts
1361 1566
1362Many real-world problems involve some kind of timeout, usually for error 1567Many real-world problems involve some kind of timeout, usually for error
1363recovery. 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,
1407C<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>
1408member and C<ev_timer_again>. 1613member and C<ev_timer_again>.
1409 1614
1410At start: 1615At start:
1411 1616
1412 ev_timer_init (timer, callback); 1617 ev_init (timer, callback);
1413 timer->repeat = 60.; 1618 timer->repeat = 60.;
1414 ev_timer_again (loop, timer); 1619 ev_timer_again (loop, timer);
1415 1620
1416Each time there is some activity: 1621Each time there is some activity:
1417 1622
1479 1684
1480To 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>
1481to 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
1482callback, which will "do the right thing" and start the timer: 1687callback, which will "do the right thing" and start the timer:
1483 1688
1484 ev_timer_init (timer, callback); 1689 ev_init (timer, callback);
1485 last_activity = ev_now (loop); 1690 last_activity = ev_now (loop);
1486 callback (loop, timer, EV_TIMEOUT); 1691 callback (loop, timer, EV_TIMEOUT);
1487 1692
1488And when there is some activity, simply store the current time in 1693And when there is some activity, simply store the current time in
1489C<last_activity>, no libev calls at all: 1694C<last_activity>, no libev calls at all:
1550 1755
1551If 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
1552update 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
1553()>. 1758()>.
1554 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
1555=head3 Watcher-Specific Functions and Data Members 1790=head3 Watcher-Specific Functions and Data Members
1556 1791
1557=over 4 1792=over 4
1558 1793
1559=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)
1582If 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).
1583 1818
1584If the timer is repeating, either start it if necessary (with the 1819If the timer is repeating, either start it if necessary (with the
1585C<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.
1586 1821
1587This 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
1588usage 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.
1589 1836
1590=item ev_tstamp repeat [read-write] 1837=item ev_tstamp repeat [read-write]
1591 1838
1592The 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
1593or 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),
1886some child status changes (most typically when a child of yours dies or 2133some child status changes (most typically when a child of yours dies or
1887exits). It is permissible to install a child watcher I<after> the child 2134exits). It is permissible to install a child watcher I<after> the child
1888has been forked (which implies it might have already exited), as long 2135has been forked (which implies it might have already exited), as long
1889as the event loop isn't entered (or is continued from a watcher), i.e., 2136as the event loop isn't entered (or is continued from a watcher), i.e.,
1890forking and then immediately registering a watcher for the child is fine, 2137forking and then immediately registering a watcher for the child is fine,
1891but forking and registering a watcher a few event loop iterations later is 2138but forking and registering a watcher a few event loop iterations later or
1892not. 2139in the next callback invocation is not.
1893 2140
1894Only the default event loop is capable of handling signals, and therefore 2141Only the default event loop is capable of handling signals, and therefore
1895you can only register child watchers in the default event loop. 2142you can only register child watchers in the default event loop.
2143
2144Due to some design glitches inside libev, child watchers will always be
2145handled at maximum priority (their priority is set to C<EV_MAXPRI> by
2146libev)
1896 2147
1897=head3 Process Interaction 2148=head3 Process Interaction
1898 2149
1899Libev grabs C<SIGCHLD> as soon as the default event loop is 2150Libev grabs C<SIGCHLD> as soon as the default event loop is
1900initialised. This is necessary to guarantee proper behaviour even if 2151initialised. This is necessary to guarantee proper behaviour even if
2252 // no longer anything immediate to do. 2503 // no longer anything immediate to do.
2253 } 2504 }
2254 2505
2255 ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 2506 ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2256 ev_idle_init (idle_watcher, idle_cb); 2507 ev_idle_init (idle_watcher, idle_cb);
2257 ev_idle_start (loop, idle_cb); 2508 ev_idle_start (loop, idle_watcher);
2258 2509
2259 2510
2260=head2 C<ev_prepare> and C<ev_check> - customise your event loop! 2511=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2261 2512
2262Prepare and check watchers are usually (but not always) used in pairs: 2513Prepare and check watchers are usually (but not always) used in pairs:
2355 struct pollfd fds [nfd]; 2606 struct pollfd fds [nfd];
2356 // actual code will need to loop here and realloc etc. 2607 // actual code will need to loop here and realloc etc.
2357 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); 2608 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
2358 2609
2359 /* the callback is illegal, but won't be called as we stop during check */ 2610 /* the callback is illegal, but won't be called as we stop during check */
2360 ev_timer_init (&tw, 0, timeout * 1e-3); 2611 ev_timer_init (&tw, 0, timeout * 1e-3, 0.);
2361 ev_timer_start (loop, &tw); 2612 ev_timer_start (loop, &tw);
2362 2613
2363 // create one ev_io per pollfd 2614 // create one ev_io per pollfd
2364 for (int i = 0; i < nfd; ++i) 2615 for (int i = 0; i < nfd; ++i)
2365 { 2616 {
2595event loop blocks next and before C<ev_check> watchers are being called, 2846event loop blocks next and before C<ev_check> watchers are being called,
2596and only in the child after the fork. If whoever good citizen calling 2847and only in the child after the fork. If whoever good citizen calling
2597C<ev_default_fork> cheats and calls it in the wrong process, the fork 2848C<ev_default_fork> cheats and calls it in the wrong process, the fork
2598handlers will be invoked, too, of course. 2849handlers will be invoked, too, of course.
2599 2850
2851=head3 The special problem of life after fork - how is it possible?
2852
2853Most uses of C<fork()> consist of forking, then some simple calls to ste
2854up/change the process environment, followed by a call to C<exec()>. This
2855sequence should be handled by libev without any problems.
2856
2857This changes when the application actually wants to do event handling
2858in the child, or both parent in child, in effect "continuing" after the
2859fork.
2860
2861The default mode of operation (for libev, with application help to detect
2862forks) is to duplicate all the state in the child, as would be expected
2863when I<either> the parent I<or> the child process continues.
2864
2865When both processes want to continue using libev, then this is usually the
2866wrong result. In that case, usually one process (typically the parent) is
2867supposed to continue with all watchers in place as before, while the other
2868process typically wants to start fresh, i.e. without any active watchers.
2869
2870The cleanest and most efficient way to achieve that with libev is to
2871simply create a new event loop, which of course will be "empty", and
2872use that for new watchers. This has the advantage of not touching more
2873memory than necessary, and thus avoiding the copy-on-write, and the
2874disadvantage of having to use multiple event loops (which do not support
2875signal watchers).
2876
2877When this is not possible, or you want to use the default loop for
2878other reasons, then in the process that wants to start "fresh", call
2879C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying
2880the default loop will "orphan" (not stop) all registered watchers, so you
2881have to be careful not to execute code that modifies those watchers. Note
2882also that in that case, you have to re-register any signal watchers.
2883
2600=head3 Watcher-Specific Functions and Data Members 2884=head3 Watcher-Specific Functions and Data Members
2601 2885
2602=over 4 2886=over 4
2603 2887
2604=item ev_fork_init (ev_signal *, callback) 2888=item ev_fork_init (ev_signal *, callback)
3494defined to be C<0>, then they are not. 3778defined to be C<0>, then they are not.
3495 3779
3496=item EV_MINIMAL 3780=item EV_MINIMAL
3497 3781
3498If you need to shave off some kilobytes of code at the expense of some 3782If you need to shave off some kilobytes of code at the expense of some
3499speed, define this symbol to C<1>. Currently this is used to override some 3783speed (but with the full API), define this symbol to C<1>. Currently this
3500inlining decisions, saves roughly 30% code size on amd64. It also selects a 3784is used to override some inlining decisions, saves roughly 30% code size
3501much smaller 2-heap for timer management over the default 4-heap. 3785on amd64. It also selects a much smaller 2-heap for timer management over
3786the default 4-heap.
3787
3788You can save even more by disabling watcher types you do not need
3789and setting C<EV_MAXPRI> == C<EV_MINPRI>. Also, disabling C<assert>
3790(C<-DNDEBUG>) will usually reduce code size a lot.
3791
3792Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to
3793provide a bare-bones event library. See C<ev.h> for details on what parts
3794of the API are still available, and do not complain if this subset changes
3795over time.
3502 3796
3503=item EV_PID_HASHSIZE 3797=item EV_PID_HASHSIZE
3504 3798
3505C<ev_child> watchers use a small hash table to distribute workload by 3799C<ev_child> watchers use a small hash table to distribute workload by
3506pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more 3800pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
3692default loop and triggering an C<ev_async> watcher from the default loop 3986default loop and triggering an C<ev_async> watcher from the default loop
3693watcher callback into the event loop interested in the signal. 3987watcher callback into the event loop interested in the signal.
3694 3988
3695=back 3989=back
3696 3990
3991=head4 THREAD LOCKING EXAMPLE
3992
3993Here is a fictitious example of how to run an event loop in a different
3994thread than where callbacks are being invoked and watchers are
3995created/added/removed.
3996
3997For a real-world example, see the C<EV::Loop::Async> perl module,
3998which uses exactly this technique (which is suited for many high-level
3999languages).
4000
4001The example uses a pthread mutex to protect the loop data, a condition
4002variable to wait for callback invocations, an async watcher to notify the
4003event loop thread and an unspecified mechanism to wake up the main thread.
4004
4005First, you need to associate some data with the event loop:
4006
4007 typedef struct {
4008 mutex_t lock; /* global loop lock */
4009 ev_async async_w;
4010 thread_t tid;
4011 cond_t invoke_cv;
4012 } userdata;
4013
4014 void prepare_loop (EV_P)
4015 {
4016 // for simplicity, we use a static userdata struct.
4017 static userdata u;
4018
4019 ev_async_init (&u->async_w, async_cb);
4020 ev_async_start (EV_A_ &u->async_w);
4021
4022 pthread_mutex_init (&u->lock, 0);
4023 pthread_cond_init (&u->invoke_cv, 0);
4024
4025 // now associate this with the loop
4026 ev_set_userdata (EV_A_ u);
4027 ev_set_invoke_pending_cb (EV_A_ l_invoke);
4028 ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4029
4030 // then create the thread running ev_loop
4031 pthread_create (&u->tid, 0, l_run, EV_A);
4032 }
4033
4034The callback for the C<ev_async> watcher does nothing: the watcher is used
4035solely to wake up the event loop so it takes notice of any new watchers
4036that might have been added:
4037
4038 static void
4039 async_cb (EV_P_ ev_async *w, int revents)
4040 {
4041 // just used for the side effects
4042 }
4043
4044The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
4045protecting the loop data, respectively.
4046
4047 static void
4048 l_release (EV_P)
4049 {
4050 userdata *u = ev_userdata (EV_A);
4051 pthread_mutex_unlock (&u->lock);
4052 }
4053
4054 static void
4055 l_acquire (EV_P)
4056 {
4057 userdata *u = ev_userdata (EV_A);
4058 pthread_mutex_lock (&u->lock);
4059 }
4060
4061The event loop thread first acquires the mutex, and then jumps straight
4062into C<ev_loop>:
4063
4064 void *
4065 l_run (void *thr_arg)
4066 {
4067 struct ev_loop *loop = (struct ev_loop *)thr_arg;
4068
4069 l_acquire (EV_A);
4070 pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4071 ev_loop (EV_A_ 0);
4072 l_release (EV_A);
4073
4074 return 0;
4075 }
4076
4077Instead of invoking all pending watchers, the C<l_invoke> callback will
4078signal the main thread via some unspecified mechanism (signals? pipe
4079writes? C<Async::Interrupt>?) and then waits until all pending watchers
4080have been called (in a while loop because a) spurious wakeups are possible
4081and b) skipping inter-thread-communication when there are no pending
4082watchers is very beneficial):
4083
4084 static void
4085 l_invoke (EV_P)
4086 {
4087 userdata *u = ev_userdata (EV_A);
4088
4089 while (ev_pending_count (EV_A))
4090 {
4091 wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4092 pthread_cond_wait (&u->invoke_cv, &u->lock);
4093 }
4094 }
4095
4096Now, whenever the main thread gets told to invoke pending watchers, it
4097will grab the lock, call C<ev_invoke_pending> and then signal the loop
4098thread to continue:
4099
4100 static void
4101 real_invoke_pending (EV_P)
4102 {
4103 userdata *u = ev_userdata (EV_A);
4104
4105 pthread_mutex_lock (&u->lock);
4106 ev_invoke_pending (EV_A);
4107 pthread_cond_signal (&u->invoke_cv);
4108 pthread_mutex_unlock (&u->lock);
4109 }
4110
4111Whenever you want to start/stop a watcher or do other modifications to an
4112event loop, you will now have to lock:
4113
4114 ev_timer timeout_watcher;
4115 userdata *u = ev_userdata (EV_A);
4116
4117 ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4118
4119 pthread_mutex_lock (&u->lock);
4120 ev_timer_start (EV_A_ &timeout_watcher);
4121 ev_async_send (EV_A_ &u->async_w);
4122 pthread_mutex_unlock (&u->lock);
4123
4124Note that sending the C<ev_async> watcher is required because otherwise
4125an event loop currently blocking in the kernel will have no knowledge
4126about the newly added timer. By waking up the loop it will pick up any new
4127watchers in the next event loop iteration.
4128
3697=head3 COROUTINES 4129=head3 COROUTINES
3698 4130
3699Libev is very accommodating to coroutines ("cooperative threads"): 4131Libev is very accommodating to coroutines ("cooperative threads"):
3700libev fully supports nesting calls to its functions from different 4132libev fully supports nesting calls to its functions from different
3701coroutines (e.g. you can call C<ev_loop> on the same loop from two 4133coroutines (e.g. you can call C<ev_loop> on the same loop from two
3702different coroutines, and switch freely between both coroutines running the 4134different coroutines, and switch freely between both coroutines running
3703loop, as long as you don't confuse yourself). The only exception is that 4135the loop, as long as you don't confuse yourself). The only exception is
3704you must not do this from C<ev_periodic> reschedule callbacks. 4136that you must not do this from C<ev_periodic> reschedule callbacks.
3705 4137
3706Care has been taken to ensure that libev does not keep local state inside 4138Care has been taken to ensure that libev does not keep local state inside
3707C<ev_loop>, and other calls do not usually allow for coroutine switches as 4139C<ev_loop>, and other calls do not usually allow for coroutine switches as
3708they do not call any callbacks. 4140they do not call any callbacks.
3709 4141
3786way (note also that glib is the slowest event library known to man). 4218way (note also that glib is the slowest event library known to man).
3787 4219
3788There is no supported compilation method available on windows except 4220There is no supported compilation method available on windows except
3789embedding it into other applications. 4221embedding it into other applications.
3790 4222
4223Sensible signal handling is officially unsupported by Microsoft - libev
4224tries its best, but under most conditions, signals will simply not work.
4225
3791Not a libev limitation but worth mentioning: windows apparently doesn't 4226Not a libev limitation but worth mentioning: windows apparently doesn't
3792accept large writes: instead of resulting in a partial write, windows will 4227accept large writes: instead of resulting in a partial write, windows will
3793either accept everything or return C<ENOBUFS> if the buffer is too large, 4228either accept everything or return C<ENOBUFS> if the buffer is too large,
3794so make sure you only write small amounts into your sockets (less than a 4229so make sure you only write small amounts into your sockets (less than a
3795megabyte seems safe, but this apparently depends on the amount of memory 4230megabyte seems safe, but this apparently depends on the amount of memory
3799the abysmal performance of winsockets, using a large number of sockets 4234the abysmal performance of winsockets, using a large number of sockets
3800is not recommended (and not reasonable). If your program needs to use 4235is not recommended (and not reasonable). If your program needs to use
3801more than a hundred or so sockets, then likely it needs to use a totally 4236more than a hundred or so sockets, then likely it needs to use a totally
3802different implementation for windows, as libev offers the POSIX readiness 4237different implementation for windows, as libev offers the POSIX readiness
3803notification model, which cannot be implemented efficiently on windows 4238notification model, which cannot be implemented efficiently on windows
3804(Microsoft monopoly games). 4239(due to Microsoft monopoly games).
3805 4240
3806A typical way to use libev under windows is to embed it (see the embedding 4241A typical way to use libev under windows is to embed it (see the embedding
3807section for details) and use the following F<evwrap.h> header file instead 4242section for details) and use the following F<evwrap.h> header file instead
3808of F<ev.h>: 4243of F<ev.h>:
3809 4244
3845 4280
3846Early versions of winsocket's select only supported waiting for a maximum 4281Early versions of winsocket's select only supported waiting for a maximum
3847of C<64> handles (probably owning to the fact that all windows kernels 4282of C<64> handles (probably owning to the fact that all windows kernels
3848can only wait for C<64> things at the same time internally; Microsoft 4283can only wait for C<64> things at the same time internally; Microsoft
3849recommends spawning a chain of threads and wait for 63 handles and the 4284recommends spawning a chain of threads and wait for 63 handles and the
3850previous thread in each. Great). 4285previous thread in each. Sounds great!).
3851 4286
3852Newer versions support more handles, but you need to define C<FD_SETSIZE> 4287Newer versions support more handles, but you need to define C<FD_SETSIZE>
3853to some high number (e.g. C<2048>) before compiling the winsocket select 4288to some high number (e.g. C<2048>) before compiling the winsocket select
3854call (which might be in libev or elsewhere, for example, perl does its own 4289call (which might be in libev or elsewhere, for example, perl and many
3855select emulation on windows). 4290other interpreters do their own select emulation on windows).
3856 4291
3857Another limit is the number of file descriptors in the Microsoft runtime 4292Another limit is the number of file descriptors in the Microsoft runtime
3858libraries, which by default is C<64> (there must be a hidden I<64> fetish 4293libraries, which by default is C<64> (there must be a hidden I<64>
3859or something like this inside Microsoft). You can increase this by calling 4294fetish or something like this inside Microsoft). You can increase this
3860C<_setmaxstdio>, which can increase this limit to C<2048> (another 4295by calling C<_setmaxstdio>, which can increase this limit to C<2048>
3861arbitrary limit), but is broken in many versions of the Microsoft runtime 4296(another arbitrary limit), but is broken in many versions of the Microsoft
3862libraries.
3863
3864This might get you to about C<512> or C<2048> sockets (depending on 4297runtime libraries. This might get you to about C<512> or C<2048> sockets
3865windows version and/or the phase of the moon). To get more, you need to 4298(depending on windows version and/or the phase of the moon). To get more,
3866wrap all I/O functions and provide your own fd management, but the cost of 4299you need to wrap all I/O functions and provide your own fd management, but
3867calling select (O(n²)) will likely make this unworkable. 4300the cost of calling select (O(n²)) will likely make this unworkable.
3868 4301
3869=back 4302=back
3870 4303
3871=head2 PORTABILITY REQUIREMENTS 4304=head2 PORTABILITY REQUIREMENTS
3872 4305
3915=item C<double> must hold a time value in seconds with enough accuracy 4348=item C<double> must hold a time value in seconds with enough accuracy
3916 4349
3917The type C<double> is used to represent timestamps. It is required to 4350The type C<double> is used to represent timestamps. It is required to
3918have at least 51 bits of mantissa (and 9 bits of exponent), which is good 4351have at least 51 bits of mantissa (and 9 bits of exponent), which is good
3919enough for at least into the year 4000. This requirement is fulfilled by 4352enough for at least into the year 4000. This requirement is fulfilled by
3920implementations implementing IEEE 754 (basically all existing ones). 4353implementations implementing IEEE 754, which is basically all existing
4354ones. With IEEE 754 doubles, you get microsecond accuracy until at least
43552200.
3921 4356
3922=back 4357=back
3923 4358
3924If you know of other additional requirements drop me a note. 4359If you know of other additional requirements drop me a note.
3925 4360
3993involves iterating over all running async watchers or all signal numbers. 4428involves iterating over all running async watchers or all signal numbers.
3994 4429
3995=back 4430=back
3996 4431
3997 4432
4433=head1 GLOSSARY
4434
4435=over 4
4436
4437=item active
4438
4439A watcher is active as long as it has been started (has been attached to
4440an event loop) but not yet stopped (disassociated from the event loop).
4441
4442=item application
4443
4444In this document, an application is whatever is using libev.
4445
4446=item callback
4447
4448The address of a function that is called when some event has been
4449detected. Callbacks are being passed the event loop, the watcher that
4450received the event, and the actual event bitset.
4451
4452=item callback invocation
4453
4454The act of calling the callback associated with a watcher.
4455
4456=item event
4457
4458A change of state of some external event, such as data now being available
4459for reading on a file descriptor, time having passed or simply not having
4460any other events happening anymore.
4461
4462In libev, events are represented as single bits (such as C<EV_READ> or
4463C<EV_TIMEOUT>).
4464
4465=item event library
4466
4467A software package implementing an event model and loop.
4468
4469=item event loop
4470
4471An entity that handles and processes external events and converts them
4472into callback invocations.
4473
4474=item event model
4475
4476The model used to describe how an event loop handles and processes
4477watchers and events.
4478
4479=item pending
4480
4481A watcher is pending as soon as the corresponding event has been detected,
4482and stops being pending as soon as the watcher will be invoked or its
4483pending status is explicitly cleared by the application.
4484
4485A watcher can be pending, but not active. Stopping a watcher also clears
4486its pending status.
4487
4488=item real time
4489
4490The physical time that is observed. It is apparently strictly monotonic :)
4491
4492=item wall-clock time
4493
4494The time and date as shown on clocks. Unlike real time, it can actually
4495be wrong and jump forwards and backwards, e.g. when the you adjust your
4496clock.
4497
4498=item watcher
4499
4500A data structure that describes interest in certain events. Watchers need
4501to be started (attached to an event loop) before they can receive events.
4502
4503=item watcher invocation
4504
4505The act of calling the callback associated with a watcher.
4506
4507=back
4508
3998=head1 AUTHOR 4509=head1 AUTHOR
3999 4510
4000Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson. 4511Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.
4001 4512

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines