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.253 by root, Tue Jul 14 18:33:48 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 ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
868
869This overrides the invoke pending functionality of the loop: Instead of
870invoking all pending watchers when there are any, C<ev_loop> will call
871this callback instead. This is useful, for example, when you want to
872invoke the actual watchers inside another context (another thread etc.).
873
874If you want to reset the callback, use C<ev_invoke_pending> as new
875callback.
876
877=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))
878
879Sometimes you want to share the same loop between multiple threads. This
880can be done relatively simply by putting mutex_lock/unlock calls around
881each call to a libev function.
882
883However, C<ev_loop> can run an indefinite time, so it is not feasible to
884wait for it to return. One way around this is to wake up the loop via
885C<ev_unloop> and C<av_async_send>, another way is to set these I<release>
886and I<acquire> callbacks on the loop.
887
888When set, then C<release> will be called just before the thread is
889suspended waiting for new events, and C<acquire> is called just
890afterwards.
891
892Ideally, C<release> will just call your mutex_unlock function, and
893C<acquire> will just call the mutex_lock function again.
894
895=item ev_set_userdata (loop, void *data)
896
897=item ev_userdata (loop)
898
899Set and retrieve a single C<void *> associated with a loop. When
900C<ev_set_userdata> has never been called, then C<ev_userdata> returns
901C<0.>
902
903These two functions can be used to associate arbitrary data with a loop,
904and are intended solely for the C<invoke_pending_cb>, C<release> and
905C<acquire> callbacks described above, but of course can be (ab-)used for
906any other purpose as well.
824 907
825=item ev_loop_verify (loop) 908=item ev_loop_verify (loop)
826 909
827This function only does something when C<EV_VERIFY> support has been 910This 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 911compiled 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> 1166integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
1084(default: C<-2>). Pending watchers with higher priority will be invoked 1167(default: C<-2>). Pending watchers with higher priority will be invoked
1085before watchers with lower priority, but priority will not keep watchers 1168before watchers with lower priority, but priority will not keep watchers
1086from being executed (except for C<ev_idle> watchers). 1169from being executed (except for C<ev_idle> watchers).
1087 1170
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 1171If you need to suppress invocation when higher priority events are pending
1094you need to look at C<ev_idle> watchers, which provide this functionality. 1172you need to look at C<ev_idle> watchers, which provide this functionality.
1095 1173
1096You I<must not> change the priority of a watcher as long as it is active or 1174You I<must not> change the priority of a watcher as long as it is active or
1097pending. 1175pending.
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 1176
1102Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is 1177Setting 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 1178fine, as long as you do not mind that the priority value you query might
1104or might not have been clamped to the valid range. 1179or might not have been clamped to the valid range.
1180
1181The default priority used by watchers when no priority has been set is
1182always C<0>, which is supposed to not be too high and not be too low :).
1183
1184See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1185priorities.
1105 1186
1106=item ev_invoke (loop, ev_TYPE *watcher, int revents) 1187=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1107 1188
1108Invoke the C<watcher> with the given C<loop> and C<revents>. Neither 1189Invoke 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 1190C<loop> nor C<revents> need to be valid as long as the watcher callback
1174 #include <stddef.h> 1255 #include <stddef.h>
1175 1256
1176 static void 1257 static void
1177 t1_cb (EV_P_ ev_timer *w, int revents) 1258 t1_cb (EV_P_ ev_timer *w, int revents)
1178 { 1259 {
1179 struct my_biggy big = (struct my_biggy * 1260 struct my_biggy big = (struct my_biggy *)
1180 (((char *)w) - offsetof (struct my_biggy, t1)); 1261 (((char *)w) - offsetof (struct my_biggy, t1));
1181 } 1262 }
1182 1263
1183 static void 1264 static void
1184 t2_cb (EV_P_ ev_timer *w, int revents) 1265 t2_cb (EV_P_ ev_timer *w, int revents)
1185 { 1266 {
1186 struct my_biggy big = (struct my_biggy * 1267 struct my_biggy big = (struct my_biggy *)
1187 (((char *)w) - offsetof (struct my_biggy, t2)); 1268 (((char *)w) - offsetof (struct my_biggy, t2));
1188 } 1269 }
1270
1271=head2 WATCHER PRIORITY MODELS
1272
1273Many event loops support I<watcher priorities>, which are usually small
1274integers that influence the ordering of event callback invocation
1275between watchers in some way, all else being equal.
1276
1277In libev, Watcher priorities can be set using C<ev_set_priority>. See its
1278description for the more technical details such as the actual priority
1279range.
1280
1281There are two common ways how these these priorities are being interpreted
1282by event loops:
1283
1284In the more common lock-out model, higher priorities "lock out" invocation
1285of lower priority watchers, which means as long as higher priority
1286watchers receive events, lower priority watchers are not being invoked.
1287
1288The less common only-for-ordering model uses priorities solely to order
1289callback invocation within a single event loop iteration: Higher priority
1290watchers are invoked before lower priority ones, but they all get invoked
1291before polling for new events.
1292
1293Libev uses the second (only-for-ordering) model for all its watchers
1294except for idle watchers (which use the lock-out model).
1295
1296The rationale behind this is that implementing the lock-out model for
1297watchers is not well supported by most kernel interfaces, and most event
1298libraries will just poll for the same events again and again as long as
1299their callbacks have not been executed, which is very inefficient in the
1300common case of one high-priority watcher locking out a mass of lower
1301priority ones.
1302
1303Static (ordering) priorities are most useful when you have two or more
1304watchers handling the same resource: a typical usage example is having an
1305C<ev_io> watcher to receive data, and an associated C<ev_timer> to handle
1306timeouts. Under load, data might be received while the program handles
1307other jobs, but since timers normally get invoked first, the timeout
1308handler will be executed before checking for data. In that case, giving
1309the timer a lower priority than the I/O watcher ensures that I/O will be
1310handled first even under adverse conditions (which is usually, but not
1311always, what you want).
1312
1313Since idle watchers use the "lock-out" model, meaning that idle watchers
1314will only be executed when no same or higher priority watchers have
1315received events, they can be used to implement the "lock-out" model when
1316required.
1317
1318For example, to emulate how many other event libraries handle priorities,
1319you can associate an C<ev_idle> watcher to each such watcher, and in
1320the normal watcher callback, you just start the idle watcher. The real
1321processing is done in the idle watcher callback. This causes libev to
1322continously poll and process kernel event data for the watcher, but when
1323the lock-out case is known to be rare (which in turn is rare :), this is
1324workable.
1325
1326Usually, however, the lock-out model implemented that way will perform
1327miserably under the type of load it was designed to handle. In that case,
1328it might be preferable to stop the real watcher before starting the
1329idle watcher, so the kernel will not have to process the event in case
1330the actual processing will be delayed for considerable time.
1331
1332Here is an example of an I/O watcher that should run at a strictly lower
1333priority than the default, and which should only process data when no
1334other events are pending:
1335
1336 ev_idle idle; // actual processing watcher
1337 ev_io io; // actual event watcher
1338
1339 static void
1340 io_cb (EV_P_ ev_io *w, int revents)
1341 {
1342 // stop the I/O watcher, we received the event, but
1343 // are not yet ready to handle it.
1344 ev_io_stop (EV_A_ w);
1345
1346 // start the idle watcher to ahndle the actual event.
1347 // it will not be executed as long as other watchers
1348 // with the default priority are receiving events.
1349 ev_idle_start (EV_A_ &idle);
1350 }
1351
1352 static void
1353 idle_cb (EV_P_ ev_idle *w, int revents)
1354 {
1355 // actual processing
1356 read (STDIN_FILENO, ...);
1357
1358 // have to start the I/O watcher again, as
1359 // we have handled the event
1360 ev_io_start (EV_P_ &io);
1361 }
1362
1363 // initialisation
1364 ev_idle_init (&idle, idle_cb);
1365 ev_io_init (&io, io_cb, STDIN_FILENO, EV_READ);
1366 ev_io_start (EV_DEFAULT_ &io);
1367
1368In the "real" world, it might also be beneficial to start a timer, so that
1369low-priority connections can not be locked out forever under load. This
1370enables your program to keep a lower latency for important connections
1371during short periods of high load, while not completely locking out less
1372important ones.
1189 1373
1190 1374
1191=head1 WATCHER TYPES 1375=head1 WATCHER TYPES
1192 1376
1193This section describes each watcher in detail, but will not repeat 1377This section describes each watcher in detail, but will not repeat
1219descriptors to non-blocking mode is also usually a good idea (but not 1403descriptors to non-blocking mode is also usually a good idea (but not
1220required if you know what you are doing). 1404required if you know what you are doing).
1221 1405
1222If you cannot use non-blocking mode, then force the use of a 1406If 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 1407known-to-be-good backend (at the time of this writing, this includes only
1224C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). 1408C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1409descriptors for which non-blocking operation makes no sense (such as
1410files) - libev doesn't guarentee any specific behaviour in that case.
1225 1411
1226Another thing you have to watch out for is that it is quite easy to 1412Another thing you have to watch out for is that it is quite easy to
1227receive "spurious" readiness notifications, that is your callback might 1413receive "spurious" readiness notifications, that is your callback might
1228be called with C<EV_READ> but a subsequent C<read>(2) will actually block 1414be 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 1415because 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 1536year, it will still time out after (roughly) one hour. "Roughly" because
1351detecting time jumps is hard, and some inaccuracies are unavoidable (the 1537detecting time jumps is hard, and some inaccuracies are unavoidable (the
1352monotonic clock option helps a lot here). 1538monotonic clock option helps a lot here).
1353 1539
1354The callback is guaranteed to be invoked only I<after> its timeout has 1540The callback is guaranteed to be invoked only I<after> its timeout has
1355passed. If multiple timers become ready during the same loop iteration 1541passed (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 1542might 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 1543same loop iteration then the ones with earlier time-out values are invoked
1358C<ev_loop> recursively). 1544before ones of the same priority with later time-out values (but this is
1545no longer true when a callback calls C<ev_loop> recursively).
1359 1546
1360=head3 Be smart about timeouts 1547=head3 Be smart about timeouts
1361 1548
1362Many real-world problems involve some kind of timeout, usually for error 1549Many real-world problems involve some kind of timeout, usually for error
1363recovery. A typical example is an HTTP request - if the other side hangs, 1550recovery. 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> 1594C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
1408member and C<ev_timer_again>. 1595member and C<ev_timer_again>.
1409 1596
1410At start: 1597At start:
1411 1598
1412 ev_timer_init (timer, callback); 1599 ev_init (timer, callback);
1413 timer->repeat = 60.; 1600 timer->repeat = 60.;
1414 ev_timer_again (loop, timer); 1601 ev_timer_again (loop, timer);
1415 1602
1416Each time there is some activity: 1603Each time there is some activity:
1417 1604
1479 1666
1480To start the timer, simply initialise the watcher and set C<last_activity> 1667To 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 1668to the current time (meaning we just have some activity :), then call the
1482callback, which will "do the right thing" and start the timer: 1669callback, which will "do the right thing" and start the timer:
1483 1670
1484 ev_timer_init (timer, callback); 1671 ev_init (timer, callback);
1485 last_activity = ev_now (loop); 1672 last_activity = ev_now (loop);
1486 callback (loop, timer, EV_TIMEOUT); 1673 callback (loop, timer, EV_TIMEOUT);
1487 1674
1488And when there is some activity, simply store the current time in 1675And when there is some activity, simply store the current time in
1489C<last_activity>, no libev calls at all: 1676C<last_activity>, no libev calls at all:
1582If the timer is started but non-repeating, stop it (as if it timed out). 1769If the timer is started but non-repeating, stop it (as if it timed out).
1583 1770
1584If the timer is repeating, either start it if necessary (with the 1771If the timer is repeating, either start it if necessary (with the
1585C<repeat> value), or reset the running timer to the C<repeat> value. 1772C<repeat> value), or reset the running timer to the C<repeat> value.
1586 1773
1587This sounds a bit complicated, see "Be smart about timeouts", above, for a 1774This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1588usage example. 1775usage example.
1589 1776
1590=item ev_tstamp repeat [read-write] 1777=item ev_tstamp repeat [read-write]
1591 1778
1592The current C<repeat> value. Will be used each time the watcher times out 1779The current C<repeat> value. Will be used each time the watcher times out
1886some child status changes (most typically when a child of yours dies or 2073some 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 2074exits). It is permissible to install a child watcher I<after> the child
1888has been forked (which implies it might have already exited), as long 2075has 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., 2076as 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, 2077forking and then immediately registering a watcher for the child is fine,
1891but forking and registering a watcher a few event loop iterations later is 2078but forking and registering a watcher a few event loop iterations later or
1892not. 2079in the next callback invocation is not.
1893 2080
1894Only the default event loop is capable of handling signals, and therefore 2081Only the default event loop is capable of handling signals, and therefore
1895you can only register child watchers in the default event loop. 2082you can only register child watchers in the default event loop.
2083
2084Due to some design glitches inside libev, child watchers will always be
2085handled at maximum priority (their priority is set to C<EV_MAXPRI> by
2086libev)
1896 2087
1897=head3 Process Interaction 2088=head3 Process Interaction
1898 2089
1899Libev grabs C<SIGCHLD> as soon as the default event loop is 2090Libev grabs C<SIGCHLD> as soon as the default event loop is
1900initialised. This is necessary to guarantee proper behaviour even if 2091initialised. This is necessary to guarantee proper behaviour even if
2252 // no longer anything immediate to do. 2443 // no longer anything immediate to do.
2253 } 2444 }
2254 2445
2255 ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 2446 ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2256 ev_idle_init (idle_watcher, idle_cb); 2447 ev_idle_init (idle_watcher, idle_cb);
2257 ev_idle_start (loop, idle_cb); 2448 ev_idle_start (loop, idle_watcher);
2258 2449
2259 2450
2260=head2 C<ev_prepare> and C<ev_check> - customise your event loop! 2451=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2261 2452
2262Prepare and check watchers are usually (but not always) used in pairs: 2453Prepare and check watchers are usually (but not always) used in pairs:
2355 struct pollfd fds [nfd]; 2546 struct pollfd fds [nfd];
2356 // actual code will need to loop here and realloc etc. 2547 // actual code will need to loop here and realloc etc.
2357 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); 2548 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
2358 2549
2359 /* the callback is illegal, but won't be called as we stop during check */ 2550 /* the callback is illegal, but won't be called as we stop during check */
2360 ev_timer_init (&tw, 0, timeout * 1e-3); 2551 ev_timer_init (&tw, 0, timeout * 1e-3, 0.);
2361 ev_timer_start (loop, &tw); 2552 ev_timer_start (loop, &tw);
2362 2553
2363 // create one ev_io per pollfd 2554 // create one ev_io per pollfd
2364 for (int i = 0; i < nfd; ++i) 2555 for (int i = 0; i < nfd; ++i)
2365 { 2556 {
2595event loop blocks next and before C<ev_check> watchers are being called, 2786event 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 2787and 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 2788C<ev_default_fork> cheats and calls it in the wrong process, the fork
2598handlers will be invoked, too, of course. 2789handlers will be invoked, too, of course.
2599 2790
2791=head3 The special problem of life after fork - how is it possible?
2792
2793Most uses of C<fork()> consist of forking, then some simple calls to ste
2794up/change the process environment, followed by a call to C<exec()>. This
2795sequence should be handled by libev without any problems.
2796
2797This changes when the application actually wants to do event handling
2798in the child, or both parent in child, in effect "continuing" after the
2799fork.
2800
2801The default mode of operation (for libev, with application help to detect
2802forks) is to duplicate all the state in the child, as would be expected
2803when I<either> the parent I<or> the child process continues.
2804
2805When both processes want to continue using libev, then this is usually the
2806wrong result. In that case, usually one process (typically the parent) is
2807supposed to continue with all watchers in place as before, while the other
2808process typically wants to start fresh, i.e. without any active watchers.
2809
2810The cleanest and most efficient way to achieve that with libev is to
2811simply create a new event loop, which of course will be "empty", and
2812use that for new watchers. This has the advantage of not touching more
2813memory than necessary, and thus avoiding the copy-on-write, and the
2814disadvantage of having to use multiple event loops (which do not support
2815signal watchers).
2816
2817When this is not possible, or you want to use the default loop for
2818other reasons, then in the process that wants to start "fresh", call
2819C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying
2820the default loop will "orphan" (not stop) all registered watchers, so you
2821have to be careful not to execute code that modifies those watchers. Note
2822also that in that case, you have to re-register any signal watchers.
2823
2600=head3 Watcher-Specific Functions and Data Members 2824=head3 Watcher-Specific Functions and Data Members
2601 2825
2602=over 4 2826=over 4
2603 2827
2604=item ev_fork_init (ev_signal *, callback) 2828=item ev_fork_init (ev_signal *, callback)
3494defined to be C<0>, then they are not. 3718defined to be C<0>, then they are not.
3495 3719
3496=item EV_MINIMAL 3720=item EV_MINIMAL
3497 3721
3498If you need to shave off some kilobytes of code at the expense of some 3722If 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 3723speed (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 3724is used to override some inlining decisions, saves roughly 30% code size
3501much smaller 2-heap for timer management over the default 4-heap. 3725on amd64. It also selects a much smaller 2-heap for timer management over
3726the default 4-heap.
3727
3728You can save even more by disabling watcher types you do not need
3729and setting C<EV_MAXPRI> == C<EV_MINPRI>. Also, disabling C<assert>
3730(C<-DNDEBUG>) will usually reduce code size a lot.
3731
3732Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to
3733provide a bare-bones event library. See C<ev.h> for details on what parts
3734of the API are still available, and do not complain if this subset changes
3735over time.
3502 3736
3503=item EV_PID_HASHSIZE 3737=item EV_PID_HASHSIZE
3504 3738
3505C<ev_child> watchers use a small hash table to distribute workload by 3739C<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 3740pid. 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 3926default loop and triggering an C<ev_async> watcher from the default loop
3693watcher callback into the event loop interested in the signal. 3927watcher callback into the event loop interested in the signal.
3694 3928
3695=back 3929=back
3696 3930
3931=head4 THREAD LOCKING EXAMPLE
3932
3697=head3 COROUTINES 3933=head3 COROUTINES
3698 3934
3699Libev is very accommodating to coroutines ("cooperative threads"): 3935Libev is very accommodating to coroutines ("cooperative threads"):
3700libev fully supports nesting calls to its functions from different 3936libev fully supports nesting calls to its functions from different
3701coroutines (e.g. you can call C<ev_loop> on the same loop from two 3937coroutines (e.g. you can call C<ev_loop> on the same loop from two
3786way (note also that glib is the slowest event library known to man). 4022way (note also that glib is the slowest event library known to man).
3787 4023
3788There is no supported compilation method available on windows except 4024There is no supported compilation method available on windows except
3789embedding it into other applications. 4025embedding it into other applications.
3790 4026
4027Sensible signal handling is officially unsupported by Microsoft - libev
4028tries its best, but under most conditions, signals will simply not work.
4029
3791Not a libev limitation but worth mentioning: windows apparently doesn't 4030Not a libev limitation but worth mentioning: windows apparently doesn't
3792accept large writes: instead of resulting in a partial write, windows will 4031accept large writes: instead of resulting in a partial write, windows will
3793either accept everything or return C<ENOBUFS> if the buffer is too large, 4032either 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 4033so 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 4034megabyte seems safe, but this apparently depends on the amount of memory
3799the abysmal performance of winsockets, using a large number of sockets 4038the abysmal performance of winsockets, using a large number of sockets
3800is not recommended (and not reasonable). If your program needs to use 4039is 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 4040more than a hundred or so sockets, then likely it needs to use a totally
3802different implementation for windows, as libev offers the POSIX readiness 4041different implementation for windows, as libev offers the POSIX readiness
3803notification model, which cannot be implemented efficiently on windows 4042notification model, which cannot be implemented efficiently on windows
3804(Microsoft monopoly games). 4043(due to Microsoft monopoly games).
3805 4044
3806A typical way to use libev under windows is to embed it (see the embedding 4045A 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 4046section for details) and use the following F<evwrap.h> header file instead
3808of F<ev.h>: 4047of F<ev.h>:
3809 4048
3845 4084
3846Early versions of winsocket's select only supported waiting for a maximum 4085Early versions of winsocket's select only supported waiting for a maximum
3847of C<64> handles (probably owning to the fact that all windows kernels 4086of 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 4087can 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 4088recommends spawning a chain of threads and wait for 63 handles and the
3850previous thread in each. Great). 4089previous thread in each. Sounds great!).
3851 4090
3852Newer versions support more handles, but you need to define C<FD_SETSIZE> 4091Newer 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 4092to 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 4093call (which might be in libev or elsewhere, for example, perl and many
3855select emulation on windows). 4094other interpreters do their own select emulation on windows).
3856 4095
3857Another limit is the number of file descriptors in the Microsoft runtime 4096Another 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 4097libraries, 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 4098fetish or something like this inside Microsoft). You can increase this
3860C<_setmaxstdio>, which can increase this limit to C<2048> (another 4099by calling C<_setmaxstdio>, which can increase this limit to C<2048>
3861arbitrary limit), but is broken in many versions of the Microsoft runtime 4100(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 4101runtime 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 4102(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 4103you need to wrap all I/O functions and provide your own fd management, but
3867calling select (O(n²)) will likely make this unworkable. 4104the cost of calling select (O(n²)) will likely make this unworkable.
3868 4105
3869=back 4106=back
3870 4107
3871=head2 PORTABILITY REQUIREMENTS 4108=head2 PORTABILITY REQUIREMENTS
3872 4109
3915=item C<double> must hold a time value in seconds with enough accuracy 4152=item C<double> must hold a time value in seconds with enough accuracy
3916 4153
3917The type C<double> is used to represent timestamps. It is required to 4154The 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 4155have 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 4156enough for at least into the year 4000. This requirement is fulfilled by
3920implementations implementing IEEE 754 (basically all existing ones). 4157implementations implementing IEEE 754, which is basically all existing
4158ones. With IEEE 754 doubles, you get microsecond accuracy until at least
41592200.
3921 4160
3922=back 4161=back
3923 4162
3924If you know of other additional requirements drop me a note. 4163If you know of other additional requirements drop me a note.
3925 4164
3993involves iterating over all running async watchers or all signal numbers. 4232involves iterating over all running async watchers or all signal numbers.
3994 4233
3995=back 4234=back
3996 4235
3997 4236
4237=head1 GLOSSARY
4238
4239=over 4
4240
4241=item active
4242
4243A watcher is active as long as it has been started (has been attached to
4244an event loop) but not yet stopped (disassociated from the event loop).
4245
4246=item application
4247
4248In this document, an application is whatever is using libev.
4249
4250=item callback
4251
4252The address of a function that is called when some event has been
4253detected. Callbacks are being passed the event loop, the watcher that
4254received the event, and the actual event bitset.
4255
4256=item callback invocation
4257
4258The act of calling the callback associated with a watcher.
4259
4260=item event
4261
4262A change of state of some external event, such as data now being available
4263for reading on a file descriptor, time having passed or simply not having
4264any other events happening anymore.
4265
4266In libev, events are represented as single bits (such as C<EV_READ> or
4267C<EV_TIMEOUT>).
4268
4269=item event library
4270
4271A software package implementing an event model and loop.
4272
4273=item event loop
4274
4275An entity that handles and processes external events and converts them
4276into callback invocations.
4277
4278=item event model
4279
4280The model used to describe how an event loop handles and processes
4281watchers and events.
4282
4283=item pending
4284
4285A watcher is pending as soon as the corresponding event has been detected,
4286and stops being pending as soon as the watcher will be invoked or its
4287pending status is explicitly cleared by the application.
4288
4289A watcher can be pending, but not active. Stopping a watcher also clears
4290its pending status.
4291
4292=item real time
4293
4294The physical time that is observed. It is apparently strictly monotonic :)
4295
4296=item wall-clock time
4297
4298The time and date as shown on clocks. Unlike real time, it can actually
4299be wrong and jump forwards and backwards, e.g. when the you adjust your
4300clock.
4301
4302=item watcher
4303
4304A data structure that describes interest in certain events. Watchers need
4305to be started (attached to an event loop) before they can receive events.
4306
4307=item watcher invocation
4308
4309The act of calling the callback associated with a watcher.
4310
4311=back
4312
3998=head1 AUTHOR 4313=head1 AUTHOR
3999 4314
4000Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson. 4315Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.
4001 4316

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines