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

Comparing libev/ev.pod (file contents):
Revision 1.238 by root, Sat Apr 18 12:10:41 2009 UTC vs.
Revision 1.286 by root, Tue Mar 16 00:26:41 2010 UTC

98=head2 FEATURES 98=head2 FEATURES
99 99
100Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the 100Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
101BSD-specific C<kqueue> and the Solaris-specific event port mechanisms 101BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
102for file descriptor events (C<ev_io>), the Linux C<inotify> interface 102for file descriptor events (C<ev_io>), the Linux C<inotify> interface
103(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers 103(for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner
104with customised rescheduling (C<ev_periodic>), synchronous signals 104inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative
105(C<ev_signal>), process status change events (C<ev_child>), and event 105timers (C<ev_timer>), absolute timers with customised rescheduling
106watchers dealing with the event loop mechanism itself (C<ev_idle>, 106(C<ev_periodic>), synchronous signals (C<ev_signal>), process status
107C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as 107change events (C<ev_child>), and event watchers dealing with the event
108file watchers (C<ev_stat>) and even limited support for fork events 108loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and
109(C<ev_fork>). 109C<ev_check> watchers) as well as file watchers (C<ev_stat>) and even
110limited support for fork events (C<ev_fork>).
110 111
111It also is quite fast (see this 112It also is quite fast (see this
112L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent 113L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
113for example). 114for example).
114 115
117Libev is very configurable. In this manual the default (and most common) 118Libev is very configurable. In this manual the default (and most common)
118configuration will be described, which supports multiple event loops. For 119configuration will be described, which supports multiple event loops. For
119more info about various configuration options please have a look at 120more info about various configuration options please have a look at
120B<EMBED> section in this manual. If libev was configured without support 121B<EMBED> section in this manual. If libev was configured without support
121for multiple event loops, then all functions taking an initial argument of 122for multiple event loops, then all functions taking an initial argument of
122name C<loop> (which is always of type C<ev_loop *>) will not have 123name C<loop> (which is always of type C<struct ev_loop *>) will not have
123this argument. 124this argument.
124 125
125=head2 TIME REPRESENTATION 126=head2 TIME REPRESENTATION
126 127
127Libev represents time as a single floating point number, representing 128Libev represents time as a single floating point number, representing
362flag. 363flag.
363 364
364This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> 365This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
365environment variable. 366environment variable.
366 367
368=item C<EVFLAG_NOINOTIFY>
369
370When this flag is specified, then libev will not attempt to use the
371I<inotify> API for it's C<ev_stat> watchers. Apart from debugging and
372testing, this flag can be useful to conserve inotify file descriptors, as
373otherwise each loop using C<ev_stat> watchers consumes one inotify handle.
374
375=item C<EVFLAG_SIGNALFD>
376
377When this flag is specified, then libev will attempt to use the
378I<signalfd> API for it's C<ev_signal> (and C<ev_child>) watchers. This API
379delivers signals synchronously, which makes it both faster and might make
380it possible to get the queued signal data. It can also simplify signal
381handling with threads, as long as you properly block signals in your
382threads that are not interested in handling them.
383
384Signalfd will not be used by default as this changes your signal mask, and
385there are a lot of shoddy libraries and programs (glib's threadpool for
386example) that can't properly initialise their signal masks.
387
367=item C<EVBACKEND_SELECT> (value 1, portable select backend) 388=item C<EVBACKEND_SELECT> (value 1, portable select backend)
368 389
369This is your standard select(2) backend. Not I<completely> standard, as 390This is your standard select(2) backend. Not I<completely> standard, as
370libev tries to roll its own fd_set with no limits on the number of fds, 391libev tries to roll its own fd_set with no limits on the number of fds,
371but if that fails, expect a fairly low limit on the number of fds when 392but if that fails, expect a fairly low limit on the number of fds when
394 415
395This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and 416This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
396C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. 417C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
397 418
398=item C<EVBACKEND_EPOLL> (value 4, Linux) 419=item C<EVBACKEND_EPOLL> (value 4, Linux)
420
421Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9
422kernels).
399 423
400For few fds, this backend is a bit little slower than poll and select, 424For few fds, this backend is a bit little slower than poll and select,
401but it scales phenomenally better. While poll and select usually scale 425but it scales phenomenally better. While poll and select usually scale
402like O(total_fds) where n is the total number of fds (or the highest fd), 426like O(total_fds) where n is the total number of fds (or the highest fd),
403epoll scales either O(1) or O(active_fds). 427epoll scales either O(1) or O(active_fds).
518 542
519It is definitely not recommended to use this flag. 543It is definitely not recommended to use this flag.
520 544
521=back 545=back
522 546
523If one or more of these are or'ed into the flags value, then only these 547If one or more of the backend flags are or'ed into the flags value,
524backends will be tried (in the reverse order as listed here). If none are 548then only these backends will be tried (in the reverse order as listed
525specified, all backends in C<ev_recommended_backends ()> will be tried. 549here). If none are specified, all backends in C<ev_recommended_backends
550()> will be tried.
526 551
527Example: This is the most typical usage. 552Example: This is the most typical usage.
528 553
529 if (!ev_default_loop (0)) 554 if (!ev_default_loop (0))
530 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); 555 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
573as signal and child watchers) would need to be stopped manually. 598as signal and child watchers) would need to be stopped manually.
574 599
575In general it is not advisable to call this function except in the 600In general it is not advisable to call this function except in the
576rare occasion where you really need to free e.g. the signal handling 601rare occasion where you really need to free e.g. the signal handling
577pipe fds. If you need dynamically allocated loops it is better to use 602pipe fds. If you need dynamically allocated loops it is better to use
578C<ev_loop_new> and C<ev_loop_destroy>). 603C<ev_loop_new> and C<ev_loop_destroy>.
579 604
580=item ev_loop_destroy (loop) 605=item ev_loop_destroy (loop)
581 606
582Like C<ev_default_destroy>, but destroys an event loop created by an 607Like C<ev_default_destroy>, but destroys an event loop created by an
583earlier call to C<ev_loop_new>. 608earlier call to C<ev_loop_new>.
621 646
622This value can sometimes be useful as a generation counter of sorts (it 647This value can sometimes be useful as a generation counter of sorts (it
623"ticks" the number of loop iterations), as it roughly corresponds with 648"ticks" the number of loop iterations), as it roughly corresponds with
624C<ev_prepare> and C<ev_check> calls. 649C<ev_prepare> and C<ev_check> calls.
625 650
651=item unsigned int ev_loop_depth (loop)
652
653Returns the number of times C<ev_loop> was entered minus the number of
654times C<ev_loop> was exited, in other words, the recursion depth.
655
656Outside C<ev_loop>, this number is zero. In a callback, this number is
657C<1>, unless C<ev_loop> was invoked recursively (or from another thread),
658in which case it is higher.
659
660Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread
661etc.), doesn't count as exit.
662
626=item unsigned int ev_backend (loop) 663=item unsigned int ev_backend (loop)
627 664
628Returns one of the C<EVBACKEND_*> flags indicating the event backend in 665Returns one of the C<EVBACKEND_*> flags indicating the event backend in
629use. 666use.
630 667
675event loop time (see C<ev_now_update>). 712event loop time (see C<ev_now_update>).
676 713
677=item ev_loop (loop, int flags) 714=item ev_loop (loop, int flags)
678 715
679Finally, this is it, the event handler. This function usually is called 716Finally, this is it, the event handler. This function usually is called
680after you initialised all your watchers and you want to start handling 717after you have initialised all your watchers and you want to start
681events. 718handling events.
682 719
683If the flags argument is specified as C<0>, it will not return until 720If the flags argument is specified as C<0>, it will not return until
684either no event watchers are active anymore or C<ev_unloop> was called. 721either no event watchers are active anymore or C<ev_unloop> was called.
685 722
686Please note that an explicit C<ev_unloop> is usually better than 723Please note that an explicit C<ev_unloop> is usually better than
760 797
761Ref/unref can be used to add or remove a reference count on the event 798Ref/unref can be used to add or remove a reference count on the event
762loop: Every watcher keeps one reference, and as long as the reference 799loop: Every watcher keeps one reference, and as long as the reference
763count is nonzero, C<ev_loop> will not return on its own. 800count is nonzero, C<ev_loop> will not return on its own.
764 801
765If you have a watcher you never unregister that should not keep C<ev_loop> 802This is useful when you have a watcher that you never intend to
766from returning, call ev_unref() after starting, and ev_ref() before 803unregister, but that nevertheless should not keep C<ev_loop> from
804returning. In such a case, call C<ev_unref> after starting, and C<ev_ref>
767stopping it. 805before stopping it.
768 806
769As an example, libev itself uses this for its internal signal pipe: It 807As an example, libev itself uses this for its internal signal pipe: It
770is not visible to the libev user and should not keep C<ev_loop> from 808is not visible to the libev user and should not keep C<ev_loop> from
771exiting if no event watchers registered by it are active. It is also an 809exiting if no event watchers registered by it are active. It is also an
772excellent way to do this for generic recurring timers or from within 810excellent way to do this for generic recurring timers or from within
811 849
812By setting a higher I<io collect interval> you allow libev to spend more 850By setting a higher I<io collect interval> you allow libev to spend more
813time collecting I/O events, so you can handle more events per iteration, 851time collecting I/O events, so you can handle more events per iteration,
814at the cost of increasing latency. Timeouts (both C<ev_periodic> and 852at the cost of increasing latency. Timeouts (both C<ev_periodic> and
815C<ev_timer>) will be not affected. Setting this to a non-null value will 853C<ev_timer>) will be not affected. Setting this to a non-null value will
816introduce an additional C<ev_sleep ()> call into most loop iterations. 854introduce an additional C<ev_sleep ()> call into most loop iterations. The
855sleep time ensures that libev will not poll for I/O events more often then
856once per this interval, on average.
817 857
818Likewise, by setting a higher I<timeout collect interval> you allow libev 858Likewise, by setting a higher I<timeout collect interval> you allow libev
819to spend more time collecting timeouts, at the expense of increased 859to spend more time collecting timeouts, at the expense of increased
820latency/jitter/inexactness (the watcher callback will be called 860latency/jitter/inexactness (the watcher callback will be called
821later). C<ev_io> watchers will not be affected. Setting this to a non-null 861later). C<ev_io> watchers will not be affected. Setting this to a non-null
823 863
824Many (busy) programs can usually benefit by setting the I/O collect 864Many (busy) programs can usually benefit by setting the I/O collect
825interval to a value near C<0.1> or so, which is often enough for 865interval to a value near C<0.1> or so, which is often enough for
826interactive servers (of course not for games), likewise for timeouts. It 866interactive servers (of course not for games), likewise for timeouts. It
827usually doesn't make much sense to set it to a lower value than C<0.01>, 867usually doesn't make much sense to set it to a lower value than C<0.01>,
828as this approaches the timing granularity of most systems. 868as this approaches the timing granularity of most systems. Note that if
869you do transactions with the outside world and you can't increase the
870parallelity, then this setting will limit your transaction rate (if you
871need to poll once per transaction and the I/O collect interval is 0.01,
872then you can't do more than 100 transations per second).
829 873
830Setting the I<timeout collect interval> can improve the opportunity for 874Setting the I<timeout collect interval> can improve the opportunity for
831saving power, as the program will "bundle" timer callback invocations that 875saving power, as the program will "bundle" timer callback invocations that
832are "near" in time together, by delaying some, thus reducing the number of 876are "near" in time together, by delaying some, thus reducing the number of
833times the process sleeps and wakes up again. Another useful technique to 877times the process sleeps and wakes up again. Another useful technique to
834reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure 878reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure
835they fire on, say, one-second boundaries only. 879they fire on, say, one-second boundaries only.
880
881Example: we only need 0.1s timeout granularity, and we wish not to poll
882more often than 100 times per second:
883
884 ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1);
885 ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
886
887=item ev_invoke_pending (loop)
888
889This call will simply invoke all pending watchers while resetting their
890pending state. Normally, C<ev_loop> does this automatically when required,
891but when overriding the invoke callback this call comes handy.
892
893=item int ev_pending_count (loop)
894
895Returns the number of pending watchers - zero indicates that no watchers
896are pending.
897
898=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
899
900This overrides the invoke pending functionality of the loop: Instead of
901invoking all pending watchers when there are any, C<ev_loop> will call
902this callback instead. This is useful, for example, when you want to
903invoke the actual watchers inside another context (another thread etc.).
904
905If you want to reset the callback, use C<ev_invoke_pending> as new
906callback.
907
908=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))
909
910Sometimes you want to share the same loop between multiple threads. This
911can be done relatively simply by putting mutex_lock/unlock calls around
912each call to a libev function.
913
914However, C<ev_loop> can run an indefinite time, so it is not feasible to
915wait for it to return. One way around this is to wake up the loop via
916C<ev_unloop> and C<av_async_send>, another way is to set these I<release>
917and I<acquire> callbacks on the loop.
918
919When set, then C<release> will be called just before the thread is
920suspended waiting for new events, and C<acquire> is called just
921afterwards.
922
923Ideally, C<release> will just call your mutex_unlock function, and
924C<acquire> will just call the mutex_lock function again.
925
926While event loop modifications are allowed between invocations of
927C<release> and C<acquire> (that's their only purpose after all), no
928modifications done will affect the event loop, i.e. adding watchers will
929have no effect on the set of file descriptors being watched, or the time
930waited. Use an C<ev_async> watcher to wake up C<ev_loop> when you want it
931to take note of any changes you made.
932
933In theory, threads executing C<ev_loop> will be async-cancel safe between
934invocations of C<release> and C<acquire>.
935
936See also the locking example in the C<THREADS> section later in this
937document.
938
939=item ev_set_userdata (loop, void *data)
940
941=item ev_userdata (loop)
942
943Set and retrieve a single C<void *> associated with a loop. When
944C<ev_set_userdata> has never been called, then C<ev_userdata> returns
945C<0.>
946
947These two functions can be used to associate arbitrary data with a loop,
948and are intended solely for the C<invoke_pending_cb>, C<release> and
949C<acquire> callbacks described above, but of course can be (ab-)used for
950any other purpose as well.
836 951
837=item ev_loop_verify (loop) 952=item ev_loop_verify (loop)
838 953
839This function only does something when C<EV_VERIFY> support has been 954This function only does something when C<EV_VERIFY> support has been
840compiled in, which is the default for non-minimal builds. It tries to go 955compiled in, which is the default for non-minimal builds. It tries to go
1017 1132
1018 ev_io w; 1133 ev_io w;
1019 ev_init (&w, my_cb); 1134 ev_init (&w, my_cb);
1020 ev_io_set (&w, STDIN_FILENO, EV_READ); 1135 ev_io_set (&w, STDIN_FILENO, EV_READ);
1021 1136
1022=item C<ev_TYPE_set> (ev_TYPE *, [args]) 1137=item C<ev_TYPE_set> (ev_TYPE *watcher, [args])
1023 1138
1024This macro initialises the type-specific parts of a watcher. You need to 1139This macro initialises the type-specific parts of a watcher. You need to
1025call C<ev_init> at least once before you call this macro, but you can 1140call C<ev_init> at least once before you call this macro, but you can
1026call C<ev_TYPE_set> any number of times. You must not, however, call this 1141call C<ev_TYPE_set> any number of times. You must not, however, call this
1027macro on a watcher that is active (it can be pending, however, which is a 1142macro on a watcher that is active (it can be pending, however, which is a
1040 1155
1041Example: Initialise and set an C<ev_io> watcher in one step. 1156Example: Initialise and set an C<ev_io> watcher in one step.
1042 1157
1043 ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ); 1158 ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
1044 1159
1045=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher) 1160=item C<ev_TYPE_start> (loop, ev_TYPE *watcher)
1046 1161
1047Starts (activates) the given watcher. Only active watchers will receive 1162Starts (activates) the given watcher. Only active watchers will receive
1048events. If the watcher is already active nothing will happen. 1163events. If the watcher is already active nothing will happen.
1049 1164
1050Example: Start the C<ev_io> watcher that is being abused as example in this 1165Example: Start the C<ev_io> watcher that is being abused as example in this
1051whole section. 1166whole section.
1052 1167
1053 ev_io_start (EV_DEFAULT_UC, &w); 1168 ev_io_start (EV_DEFAULT_UC, &w);
1054 1169
1055=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher) 1170=item C<ev_TYPE_stop> (loop, ev_TYPE *watcher)
1056 1171
1057Stops the given watcher if active, and clears the pending status (whether 1172Stops the given watcher if active, and clears the pending status (whether
1058the watcher was active or not). 1173the watcher was active or not).
1059 1174
1060It is possible that stopped watchers are pending - for example, 1175It is possible that stopped watchers are pending - for example,
1085=item ev_cb_set (ev_TYPE *watcher, callback) 1200=item ev_cb_set (ev_TYPE *watcher, callback)
1086 1201
1087Change the callback. You can change the callback at virtually any time 1202Change the callback. You can change the callback at virtually any time
1088(modulo threads). 1203(modulo threads).
1089 1204
1090=item ev_set_priority (ev_TYPE *watcher, priority) 1205=item ev_set_priority (ev_TYPE *watcher, int priority)
1091 1206
1092=item int ev_priority (ev_TYPE *watcher) 1207=item int ev_priority (ev_TYPE *watcher)
1093 1208
1094Set and query the priority of the watcher. The priority is a small 1209Set and query the priority of the watcher. The priority is a small
1095integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI> 1210integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
1126returns its C<revents> bitset (as if its callback was invoked). If the 1241returns its C<revents> bitset (as if its callback was invoked). If the
1127watcher isn't pending it does nothing and returns C<0>. 1242watcher isn't pending it does nothing and returns C<0>.
1128 1243
1129Sometimes it can be useful to "poll" a watcher instead of waiting for its 1244Sometimes it can be useful to "poll" a watcher instead of waiting for its
1130callback to be invoked, which can be accomplished with this function. 1245callback to be invoked, which can be accomplished with this function.
1246
1247=item ev_feed_event (loop, ev_TYPE *watcher, int revents)
1248
1249Feeds the given event set into the event loop, as if the specified event
1250had happened for the specified watcher (which must be a pointer to an
1251initialised but not necessarily started event watcher). Obviously you must
1252not free the watcher as long as it has pending events.
1253
1254Stopping the watcher, letting libev invoke it, or calling
1255C<ev_clear_pending> will clear the pending event, even if the watcher was
1256not started in the first place.
1257
1258See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1259functions that do not need a watcher.
1131 1260
1132=back 1261=back
1133 1262
1134 1263
1135=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER 1264=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
1184 #include <stddef.h> 1313 #include <stddef.h>
1185 1314
1186 static void 1315 static void
1187 t1_cb (EV_P_ ev_timer *w, int revents) 1316 t1_cb (EV_P_ ev_timer *w, int revents)
1188 { 1317 {
1189 struct my_biggy big = (struct my_biggy * 1318 struct my_biggy big = (struct my_biggy *)
1190 (((char *)w) - offsetof (struct my_biggy, t1)); 1319 (((char *)w) - offsetof (struct my_biggy, t1));
1191 } 1320 }
1192 1321
1193 static void 1322 static void
1194 t2_cb (EV_P_ ev_timer *w, int revents) 1323 t2_cb (EV_P_ ev_timer *w, int revents)
1195 { 1324 {
1196 struct my_biggy big = (struct my_biggy * 1325 struct my_biggy big = (struct my_biggy *)
1197 (((char *)w) - offsetof (struct my_biggy, t2)); 1326 (((char *)w) - offsetof (struct my_biggy, t2));
1198 } 1327 }
1199 1328
1200=head2 WATCHER PRIORITY MODELS 1329=head2 WATCHER PRIORITY MODELS
1201 1330
1277 // with the default priority are receiving events. 1406 // with the default priority are receiving events.
1278 ev_idle_start (EV_A_ &idle); 1407 ev_idle_start (EV_A_ &idle);
1279 } 1408 }
1280 1409
1281 static void 1410 static void
1282 idle-cb (EV_P_ ev_idle *w, int revents) 1411 idle_cb (EV_P_ ev_idle *w, int revents)
1283 { 1412 {
1284 // actual processing 1413 // actual processing
1285 read (STDIN_FILENO, ...); 1414 read (STDIN_FILENO, ...);
1286 1415
1287 // have to start the I/O watcher again, as 1416 // have to start the I/O watcher again, as
1332descriptors to non-blocking mode is also usually a good idea (but not 1461descriptors to non-blocking mode is also usually a good idea (but not
1333required if you know what you are doing). 1462required if you know what you are doing).
1334 1463
1335If you cannot use non-blocking mode, then force the use of a 1464If you cannot use non-blocking mode, then force the use of a
1336known-to-be-good backend (at the time of this writing, this includes only 1465known-to-be-good backend (at the time of this writing, this includes only
1337C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). 1466C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1467descriptors for which non-blocking operation makes no sense (such as
1468files) - libev doesn't guarentee any specific behaviour in that case.
1338 1469
1339Another thing you have to watch out for is that it is quite easy to 1470Another thing you have to watch out for is that it is quite easy to
1340receive "spurious" readiness notifications, that is your callback might 1471receive "spurious" readiness notifications, that is your callback might
1341be called with C<EV_READ> but a subsequent C<read>(2) will actually block 1472be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1342because there is no data. Not only are some backends known to create a 1473because there is no data. Not only are some backends known to create a
1407 1538
1408So when you encounter spurious, unexplained daemon exits, make sure you 1539So when you encounter spurious, unexplained daemon exits, make sure you
1409ignore SIGPIPE (and maybe make sure you log the exit status of your daemon 1540ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
1410somewhere, as that would have given you a big clue). 1541somewhere, as that would have given you a big clue).
1411 1542
1543=head3 The special problem of accept()ing when you can't
1544
1545Many implementations of the POSIX C<accept> function (for example,
1546found in port-2004 Linux) have the peculiar behaviour of not removing a
1547connection from the pending queue in all error cases.
1548
1549For example, larger servers often run out of file descriptors (because
1550of resource limits), causing C<accept> to fail with C<ENFILE> but not
1551rejecting the connection, leading to libev signalling readiness on
1552the next iteration again (the connection still exists after all), and
1553typically causing the program to loop at 100% CPU usage.
1554
1555Unfortunately, the set of errors that cause this issue differs between
1556operating systems, there is usually little the app can do to remedy the
1557situation, and no known thread-safe method of removing the connection to
1558cope with overload is known (to me).
1559
1560One of the easiest ways to handle this situation is to just ignore it
1561- when the program encounters an overload, it will just loop until the
1562situation is over. While this is a form of busy waiting, no OS offers an
1563event-based way to handle this situation, so it's the best one can do.
1564
1565A better way to handle the situation is to log any errors other than
1566C<EAGAIN> and C<EWOULDBLOCK>, making sure not to flood the log with such
1567messages, and continue as usual, which at least gives the user an idea of
1568what could be wrong ("raise the ulimit!"). For extra points one could stop
1569the C<ev_io> watcher on the listening fd "for a while", which reduces CPU
1570usage.
1571
1572If your program is single-threaded, then you could also keep a dummy file
1573descriptor for overload situations (e.g. by opening F</dev/null>), and
1574when you run into C<ENFILE> or C<EMFILE>, close it, run C<accept>,
1575close that fd, and create a new dummy fd. This will gracefully refuse
1576clients under typical overload conditions.
1577
1578The last way to handle it is to simply log the error and C<exit>, as
1579is often done with C<malloc> failures, but this results in an easy
1580opportunity for a DoS attack.
1412 1581
1413=head3 Watcher-Specific Functions 1582=head3 Watcher-Specific Functions
1414 1583
1415=over 4 1584=over 4
1416 1585
1463year, it will still time out after (roughly) one hour. "Roughly" because 1632year, it will still time out after (roughly) one hour. "Roughly" because
1464detecting time jumps is hard, and some inaccuracies are unavoidable (the 1633detecting time jumps is hard, and some inaccuracies are unavoidable (the
1465monotonic clock option helps a lot here). 1634monotonic clock option helps a lot here).
1466 1635
1467The callback is guaranteed to be invoked only I<after> its timeout has 1636The callback is guaranteed to be invoked only I<after> its timeout has
1468passed. If multiple timers become ready during the same loop iteration 1637passed (not I<at>, so on systems with very low-resolution clocks this
1469then the ones with earlier time-out values are invoked before ones with 1638might introduce a small delay). If multiple timers become ready during the
1470later time-out values (but this is no longer true when a callback calls 1639same loop iteration then the ones with earlier time-out values are invoked
1471C<ev_loop> recursively). 1640before ones of the same priority with later time-out values (but this is
1641no longer true when a callback calls C<ev_loop> recursively).
1472 1642
1473=head3 Be smart about timeouts 1643=head3 Be smart about timeouts
1474 1644
1475Many real-world problems involve some kind of timeout, usually for error 1645Many real-world problems involve some kind of timeout, usually for error
1476recovery. A typical example is an HTTP request - if the other side hangs, 1646recovery. A typical example is an HTTP request - if the other side hangs,
1520C<after> argument to C<ev_timer_set>, and only ever use the C<repeat> 1690C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
1521member and C<ev_timer_again>. 1691member and C<ev_timer_again>.
1522 1692
1523At start: 1693At start:
1524 1694
1525 ev_timer_init (timer, callback); 1695 ev_init (timer, callback);
1526 timer->repeat = 60.; 1696 timer->repeat = 60.;
1527 ev_timer_again (loop, timer); 1697 ev_timer_again (loop, timer);
1528 1698
1529Each time there is some activity: 1699Each time there is some activity:
1530 1700
1592 1762
1593To start the timer, simply initialise the watcher and set C<last_activity> 1763To start the timer, simply initialise the watcher and set C<last_activity>
1594to the current time (meaning we just have some activity :), then call the 1764to the current time (meaning we just have some activity :), then call the
1595callback, which will "do the right thing" and start the timer: 1765callback, which will "do the right thing" and start the timer:
1596 1766
1597 ev_timer_init (timer, callback); 1767 ev_init (timer, callback);
1598 last_activity = ev_now (loop); 1768 last_activity = ev_now (loop);
1599 callback (loop, timer, EV_TIMEOUT); 1769 callback (loop, timer, EV_TIMEOUT);
1600 1770
1601And when there is some activity, simply store the current time in 1771And when there is some activity, simply store the current time in
1602C<last_activity>, no libev calls at all: 1772C<last_activity>, no libev calls at all:
1663 1833
1664If the event loop is suspended for a long time, you can also force an 1834If the event loop is suspended for a long time, you can also force an
1665update of the time returned by C<ev_now ()> by calling C<ev_now_update 1835update of the time returned by C<ev_now ()> by calling C<ev_now_update
1666()>. 1836()>.
1667 1837
1838=head3 The special problems of suspended animation
1839
1840When you leave the server world it is quite customary to hit machines that
1841can suspend/hibernate - what happens to the clocks during such a suspend?
1842
1843Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes
1844all processes, while the clocks (C<times>, C<CLOCK_MONOTONIC>) continue
1845to run until the system is suspended, but they will not advance while the
1846system is suspended. That means, on resume, it will be as if the program
1847was frozen for a few seconds, but the suspend time will not be counted
1848towards C<ev_timer> when a monotonic clock source is used. The real time
1849clock advanced as expected, but if it is used as sole clocksource, then a
1850long suspend would be detected as a time jump by libev, and timers would
1851be adjusted accordingly.
1852
1853I would not be surprised to see different behaviour in different between
1854operating systems, OS versions or even different hardware.
1855
1856The other form of suspend (job control, or sending a SIGSTOP) will see a
1857time jump in the monotonic clocks and the realtime clock. If the program
1858is suspended for a very long time, and monotonic clock sources are in use,
1859then you can expect C<ev_timer>s to expire as the full suspension time
1860will be counted towards the timers. When no monotonic clock source is in
1861use, then libev will again assume a timejump and adjust accordingly.
1862
1863It might be beneficial for this latter case to call C<ev_suspend>
1864and C<ev_resume> in code that handles C<SIGTSTP>, to at least get
1865deterministic behaviour in this case (you can do nothing against
1866C<SIGSTOP>).
1867
1668=head3 Watcher-Specific Functions and Data Members 1868=head3 Watcher-Specific Functions and Data Members
1669 1869
1670=over 4 1870=over 4
1671 1871
1672=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 1872=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
1697If the timer is repeating, either start it if necessary (with the 1897If the timer is repeating, either start it if necessary (with the
1698C<repeat> value), or reset the running timer to the C<repeat> value. 1898C<repeat> value), or reset the running timer to the C<repeat> value.
1699 1899
1700This sounds a bit complicated, see L<Be smart about timeouts>, above, for a 1900This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1701usage example. 1901usage example.
1902
1903=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
1904
1905Returns the remaining time until a timer fires. If the timer is active,
1906then this time is relative to the current event loop time, otherwise it's
1907the timeout value currently configured.
1908
1909That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
1910C<5>. When the timer is started and one second passes, C<ev_timer_remaining>
1911will return C<4>. When the timer expires and is restarted, it will return
1912roughly C<7> (likely slightly less as callback invocation takes some time,
1913too), and so on.
1702 1914
1703=item ev_tstamp repeat [read-write] 1915=item ev_tstamp repeat [read-write]
1704 1916
1705The current C<repeat> value. Will be used each time the watcher times out 1917The current C<repeat> value. Will be used each time the watcher times out
1706or C<ev_timer_again> is called, and determines the next timeout (if any), 1918or C<ev_timer_again> is called, and determines the next timeout (if any),
1942Signal watchers will trigger an event when the process receives a specific 2154Signal watchers will trigger an event when the process receives a specific
1943signal one or more times. Even though signals are very asynchronous, libev 2155signal one or more times. Even though signals are very asynchronous, libev
1944will try it's best to deliver signals synchronously, i.e. as part of the 2156will try it's best to deliver signals synchronously, i.e. as part of the
1945normal event processing, like any other event. 2157normal event processing, like any other event.
1946 2158
1947If you want signals asynchronously, just use C<sigaction> as you would 2159If you want signals to be delivered truly asynchronously, just use
1948do without libev and forget about sharing the signal. You can even use 2160C<sigaction> as you would do without libev and forget about sharing
1949C<ev_async> from a signal handler to synchronously wake up an event loop. 2161the signal. You can even use C<ev_async> from a signal handler to
2162synchronously wake up an event loop.
1950 2163
1951You can configure as many watchers as you like per signal. Only when the 2164You can configure as many watchers as you like for the same signal, but
2165only within the same loop, i.e. you can watch for C<SIGINT> in your
2166default loop and for C<SIGIO> in another loop, but you cannot watch for
2167C<SIGINT> in both the default loop and another loop at the same time. At
2168the moment, C<SIGCHLD> is permanently tied to the default loop.
2169
1952first watcher gets started will libev actually register a signal handler 2170When the first watcher gets started will libev actually register something
1953with the kernel (thus it coexists with your own signal handlers as long as 2171with the kernel (thus it coexists with your own signal handlers as long as
1954you don't register any with libev for the same signal). Similarly, when 2172you don't register any with libev for the same signal).
1955the last signal watcher for a signal is stopped, libev will reset the
1956signal handler to SIG_DFL (regardless of what it was set to before).
1957 2173
1958If possible and supported, libev will install its handlers with 2174If possible and supported, libev will install its handlers with
1959C<SA_RESTART> behaviour enabled, so system calls should not be unduly 2175C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
1960interrupted. If you have a problem with system calls getting interrupted by 2176not be unduly interrupted. If you have a problem with system calls getting
1961signals you can block all signals in an C<ev_check> watcher and unblock 2177interrupted by signals you can block all signals in an C<ev_check> watcher
1962them in an C<ev_prepare> watcher. 2178and unblock them in an C<ev_prepare> watcher.
2179
2180=head3 The special problem of inheritance over fork/execve/pthread_create
2181
2182Both the signal mask (C<sigprocmask>) and the signal disposition
2183(C<sigaction>) are unspecified after starting a signal watcher (and after
2184stopping it again), that is, libev might or might not block the signal,
2185and might or might not set or restore the installed signal handler.
2186
2187While this does not matter for the signal disposition (libev never
2188sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
2189C<execve>), this matters for the signal mask: many programs do not expect
2190certain signals to be blocked.
2191
2192This means that before calling C<exec> (from the child) you should reset
2193the signal mask to whatever "default" you expect (all clear is a good
2194choice usually).
2195
2196The simplest way to ensure that the signal mask is reset in the child is
2197to install a fork handler with C<pthread_atfork> that resets it. That will
2198catch fork calls done by libraries (such as the libc) as well.
2199
2200In current versions of libev, the signal will not be blocked indefinitely
2201unless you use the C<signalfd> API (C<EV_SIGNALFD>). While this reduces
2202the window of opportunity for problems, it will not go away, as libev
2203I<has> to modify the signal mask, at least temporarily.
2204
2205So I can't stress this enough: I<If you do not reset your signal mask when
2206you expect it to be empty, you have a race condition in your code>. This
2207is not a libev-specific thing, this is true for most event libraries.
1963 2208
1964=head3 Watcher-Specific Functions and Data Members 2209=head3 Watcher-Specific Functions and Data Members
1965 2210
1966=over 4 2211=over 4
1967 2212
1999some child status changes (most typically when a child of yours dies or 2244some child status changes (most typically when a child of yours dies or
2000exits). It is permissible to install a child watcher I<after> the child 2245exits). It is permissible to install a child watcher I<after> the child
2001has been forked (which implies it might have already exited), as long 2246has been forked (which implies it might have already exited), as long
2002as the event loop isn't entered (or is continued from a watcher), i.e., 2247as the event loop isn't entered (or is continued from a watcher), i.e.,
2003forking and then immediately registering a watcher for the child is fine, 2248forking and then immediately registering a watcher for the child is fine,
2004but forking and registering a watcher a few event loop iterations later is 2249but forking and registering a watcher a few event loop iterations later or
2005not. 2250in the next callback invocation is not.
2006 2251
2007Only the default event loop is capable of handling signals, and therefore 2252Only the default event loop is capable of handling signals, and therefore
2008you can only register child watchers in the default event loop. 2253you can only register child watchers in the default event loop.
2009 2254
2255Due to some design glitches inside libev, child watchers will always be
2256handled at maximum priority (their priority is set to C<EV_MAXPRI> by
2257libev)
2258
2010=head3 Process Interaction 2259=head3 Process Interaction
2011 2260
2012Libev grabs C<SIGCHLD> as soon as the default event loop is 2261Libev grabs C<SIGCHLD> as soon as the default event loop is
2013initialised. This is necessary to guarantee proper behaviour even if 2262initialised. This is necessary to guarantee proper behaviour even if the
2014the first child watcher is started after the child exits. The occurrence 2263first child watcher is started after the child exits. The occurrence
2015of C<SIGCHLD> is recorded asynchronously, but child reaping is done 2264of C<SIGCHLD> is recorded asynchronously, but child reaping is done
2016synchronously as part of the event loop processing. Libev always reaps all 2265synchronously as part of the event loop processing. Libev always reaps all
2017children, even ones not watched. 2266children, even ones not watched.
2018 2267
2019=head3 Overriding the Built-In Processing 2268=head3 Overriding the Built-In Processing
2029=head3 Stopping the Child Watcher 2278=head3 Stopping the Child Watcher
2030 2279
2031Currently, the child watcher never gets stopped, even when the 2280Currently, the child watcher never gets stopped, even when the
2032child terminates, so normally one needs to stop the watcher in the 2281child terminates, so normally one needs to stop the watcher in the
2033callback. Future versions of libev might stop the watcher automatically 2282callback. Future versions of libev might stop the watcher automatically
2034when a child exit is detected. 2283when a child exit is detected (calling C<ev_child_stop> twice is not a
2284problem).
2035 2285
2036=head3 Watcher-Specific Functions and Data Members 2286=head3 Watcher-Specific Functions and Data Members
2037 2287
2038=over 4 2288=over 4
2039 2289
2365 // no longer anything immediate to do. 2615 // no longer anything immediate to do.
2366 } 2616 }
2367 2617
2368 ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 2618 ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2369 ev_idle_init (idle_watcher, idle_cb); 2619 ev_idle_init (idle_watcher, idle_cb);
2370 ev_idle_start (loop, idle_cb); 2620 ev_idle_start (loop, idle_watcher);
2371 2621
2372 2622
2373=head2 C<ev_prepare> and C<ev_check> - customise your event loop! 2623=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2374 2624
2375Prepare and check watchers are usually (but not always) used in pairs: 2625Prepare and check watchers are usually (but not always) used in pairs:
2468 struct pollfd fds [nfd]; 2718 struct pollfd fds [nfd];
2469 // actual code will need to loop here and realloc etc. 2719 // actual code will need to loop here and realloc etc.
2470 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); 2720 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
2471 2721
2472 /* the callback is illegal, but won't be called as we stop during check */ 2722 /* the callback is illegal, but won't be called as we stop during check */
2473 ev_timer_init (&tw, 0, timeout * 1e-3); 2723 ev_timer_init (&tw, 0, timeout * 1e-3, 0.);
2474 ev_timer_start (loop, &tw); 2724 ev_timer_start (loop, &tw);
2475 2725
2476 // create one ev_io per pollfd 2726 // create one ev_io per pollfd
2477 for (int i = 0; i < nfd; ++i) 2727 for (int i = 0; i < nfd; ++i)
2478 { 2728 {
2779=head3 Queueing 3029=head3 Queueing
2780 3030
2781C<ev_async> does not support queueing of data in any way. The reason 3031C<ev_async> does not support queueing of data in any way. The reason
2782is that the author does not know of a simple (or any) algorithm for a 3032is that the author does not know of a simple (or any) algorithm for a
2783multiple-writer-single-reader queue that works in all cases and doesn't 3033multiple-writer-single-reader queue that works in all cases and doesn't
2784need elaborate support such as pthreads. 3034need elaborate support such as pthreads or unportable memory access
3035semantics.
2785 3036
2786That means that if you want to queue data, you have to provide your own 3037That means that if you want to queue data, you have to provide your own
2787queue. But at least I can tell you how to implement locking around your 3038queue. But at least I can tell you how to implement locking around your
2788queue: 3039queue:
2789 3040
2947 /* doh, nothing entered */; 3198 /* doh, nothing entered */;
2948 } 3199 }
2949 3200
2950 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 3201 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2951 3202
2952=item ev_feed_event (struct ev_loop *, watcher *, int revents)
2953
2954Feeds the given event set into the event loop, as if the specified event
2955had happened for the specified watcher (which must be a pointer to an
2956initialised but not necessarily started event watcher).
2957
2958=item ev_feed_fd_event (struct ev_loop *, int fd, int revents) 3203=item ev_feed_fd_event (loop, int fd, int revents)
2959 3204
2960Feed an event on the given fd, as if a file descriptor backend detected 3205Feed an event on the given fd, as if a file descriptor backend detected
2961the given events it. 3206the given events it.
2962 3207
2963=item ev_feed_signal_event (struct ev_loop *loop, int signum) 3208=item ev_feed_signal_event (loop, int signum)
2964 3209
2965Feed an event as if the given signal occurred (C<loop> must be the default 3210Feed an event as if the given signal occurred (C<loop> must be the default
2966loop!). 3211loop!).
2967 3212
2968=back 3213=back
3048 3293
3049=over 4 3294=over 4
3050 3295
3051=item ev::TYPE::TYPE () 3296=item ev::TYPE::TYPE ()
3052 3297
3053=item ev::TYPE::TYPE (struct ev_loop *) 3298=item ev::TYPE::TYPE (loop)
3054 3299
3055=item ev::TYPE::~TYPE 3300=item ev::TYPE::~TYPE
3056 3301
3057The constructor (optionally) takes an event loop to associate the watcher 3302The constructor (optionally) takes an event loop to associate the watcher
3058with. If it is omitted, it will use C<EV_DEFAULT>. 3303with. If it is omitted, it will use C<EV_DEFAULT>.
3135Example: Use a plain function as callback. 3380Example: Use a plain function as callback.
3136 3381
3137 static void io_cb (ev::io &w, int revents) { } 3382 static void io_cb (ev::io &w, int revents) { }
3138 iow.set <io_cb> (); 3383 iow.set <io_cb> ();
3139 3384
3140=item w->set (struct ev_loop *) 3385=item w->set (loop)
3141 3386
3142Associates a different C<struct ev_loop> with this watcher. You can only 3387Associates a different C<struct ev_loop> with this watcher. You can only
3143do this when the watcher is inactive (and not pending either). 3388do this when the watcher is inactive (and not pending either).
3144 3389
3145=item w->set ([arguments]) 3390=item w->set ([arguments])
3242=item Ocaml 3487=item Ocaml
3243 3488
3244Erkki Seppala has written Ocaml bindings for libev, to be found at 3489Erkki Seppala has written Ocaml bindings for libev, to be found at
3245L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. 3490L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
3246 3491
3492=item Lua
3493
3494Brian Maher has written a partial interface to libev for lua (at the
3495time of this writing, only C<ev_io> and C<ev_timer>), to be found at
3496L<http://github.com/brimworks/lua-ev>.
3497
3247=back 3498=back
3248 3499
3249 3500
3250=head1 MACRO MAGIC 3501=head1 MACRO MAGIC
3251 3502
3404 libev.m4 3655 libev.m4
3405 3656
3406=head2 PREPROCESSOR SYMBOLS/MACROS 3657=head2 PREPROCESSOR SYMBOLS/MACROS
3407 3658
3408Libev can be configured via a variety of preprocessor symbols you have to 3659Libev can be configured via a variety of preprocessor symbols you have to
3409define before including any of its files. The default in the absence of 3660define before including (or compiling) any of its files. The default in
3410autoconf is documented for every option. 3661the absence of autoconf is documented for every option.
3662
3663Symbols marked with "(h)" do not change the ABI, and can have different
3664values when compiling libev vs. including F<ev.h>, so it is permissible
3665to redefine them before including F<ev.h> without breakign compatibility
3666to a compiled library. All other symbols change the ABI, which means all
3667users of libev and the libev code itself must be compiled with compatible
3668settings.
3411 3669
3412=over 4 3670=over 4
3413 3671
3414=item EV_STANDALONE 3672=item EV_STANDALONE (h)
3415 3673
3416Must always be C<1> if you do not use autoconf configuration, which 3674Must always be C<1> if you do not use autoconf configuration, which
3417keeps libev from including F<config.h>, and it also defines dummy 3675keeps libev from including F<config.h>, and it also defines dummy
3418implementations for some libevent functions (such as logging, which is not 3676implementations for some libevent functions (such as logging, which is not
3419supported). It will also not define any of the structs usually found in 3677supported). It will also not define any of the structs usually found in
3420F<event.h> that are not directly supported by the libev core alone. 3678F<event.h> that are not directly supported by the libev core alone.
3421 3679
3422In stanbdalone mode, libev will still try to automatically deduce the 3680In standalone mode, libev will still try to automatically deduce the
3423configuration, but has to be more conservative. 3681configuration, but has to be more conservative.
3424 3682
3425=item EV_USE_MONOTONIC 3683=item EV_USE_MONOTONIC
3426 3684
3427If defined to be C<1>, libev will try to detect the availability of the 3685If defined to be C<1>, libev will try to detect the availability of the
3492be used is the winsock select). This means that it will call 3750be used is the winsock select). This means that it will call
3493C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, 3751C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
3494it is assumed that all these functions actually work on fds, even 3752it is assumed that all these functions actually work on fds, even
3495on win32. Should not be defined on non-win32 platforms. 3753on win32. Should not be defined on non-win32 platforms.
3496 3754
3497=item EV_FD_TO_WIN32_HANDLE 3755=item EV_FD_TO_WIN32_HANDLE(fd)
3498 3756
3499If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map 3757If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
3500file descriptors to socket handles. When not defining this symbol (the 3758file descriptors to socket handles. When not defining this symbol (the
3501default), then libev will call C<_get_osfhandle>, which is usually 3759default), then libev will call C<_get_osfhandle>, which is usually
3502correct. In some cases, programs use their own file descriptor management, 3760correct. In some cases, programs use their own file descriptor management,
3503in which case they can provide this function to map fds to socket handles. 3761in which case they can provide this function to map fds to socket handles.
3762
3763=item EV_WIN32_HANDLE_TO_FD(handle)
3764
3765If C<EV_SELECT_IS_WINSOCKET> then libev maps handles to file descriptors
3766using the standard C<_open_osfhandle> function. For programs implementing
3767their own fd to handle mapping, overwriting this function makes it easier
3768to do so. This can be done by defining this macro to an appropriate value.
3769
3770=item EV_WIN32_CLOSE_FD(fd)
3771
3772If programs implement their own fd to handle mapping on win32, then this
3773macro can be used to override the C<close> function, useful to unregister
3774file descriptors again. Note that the replacement function has to close
3775the underlying OS handle.
3504 3776
3505=item EV_USE_POLL 3777=item EV_USE_POLL
3506 3778
3507If defined to be C<1>, libev will compile in support for the C<poll>(2) 3779If defined to be C<1>, libev will compile in support for the C<poll>(2)
3508backend. Otherwise it will be enabled on non-win32 platforms. It 3780backend. Otherwise it will be enabled on non-win32 platforms. It
3555as well as for signal and thread safety in C<ev_async> watchers. 3827as well as for signal and thread safety in C<ev_async> watchers.
3556 3828
3557In the absence of this define, libev will use C<sig_atomic_t volatile> 3829In the absence of this define, libev will use C<sig_atomic_t volatile>
3558(from F<signal.h>), which is usually good enough on most platforms. 3830(from F<signal.h>), which is usually good enough on most platforms.
3559 3831
3560=item EV_H 3832=item EV_H (h)
3561 3833
3562The name of the F<ev.h> header file used to include it. The default if 3834The name of the F<ev.h> header file used to include it. The default if
3563undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be 3835undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
3564used to virtually rename the F<ev.h> header file in case of conflicts. 3836used to virtually rename the F<ev.h> header file in case of conflicts.
3565 3837
3566=item EV_CONFIG_H 3838=item EV_CONFIG_H (h)
3567 3839
3568If C<EV_STANDALONE> isn't C<1>, this variable can be used to override 3840If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
3569F<ev.c>'s idea of where to find the F<config.h> file, similarly to 3841F<ev.c>'s idea of where to find the F<config.h> file, similarly to
3570C<EV_H>, above. 3842C<EV_H>, above.
3571 3843
3572=item EV_EVENT_H 3844=item EV_EVENT_H (h)
3573 3845
3574Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea 3846Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
3575of how the F<event.h> header can be found, the default is C<"event.h">. 3847of how the F<event.h> header can be found, the default is C<"event.h">.
3576 3848
3577=item EV_PROTOTYPES 3849=item EV_PROTOTYPES (h)
3578 3850
3579If defined to be C<0>, then F<ev.h> will not define any function 3851If defined to be C<0>, then F<ev.h> will not define any function
3580prototypes, but still define all the structs and other symbols. This is 3852prototypes, but still define all the structs and other symbols. This is
3581occasionally useful if you want to provide your own wrapper functions 3853occasionally useful if you want to provide your own wrapper functions
3582around libev functions. 3854around libev functions.
3604fine. 3876fine.
3605 3877
3606If your embedding application does not need any priorities, defining these 3878If your embedding application does not need any priorities, defining these
3607both to C<0> will save some memory and CPU. 3879both to C<0> will save some memory and CPU.
3608 3880
3609=item EV_PERIODIC_ENABLE 3881=item EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE,
3882EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE,
3883EV_ASYNC_ENABLE, EV_CHILD_ENABLE.
3610 3884
3611If undefined or defined to be C<1>, then periodic timers are supported. If 3885If undefined or defined to be C<1> (and the platform supports it), then
3612defined to be C<0>, then they are not. Disabling them saves a few kB of 3886the respective watcher type is supported. If defined to be C<0>, then it
3613code. 3887is not. Disabling watcher types mainly saves codesize.
3614 3888
3615=item EV_IDLE_ENABLE 3889=item EV_FEATURES
3616
3617If undefined or defined to be C<1>, then idle watchers are supported. If
3618defined to be C<0>, then they are not. Disabling them saves a few kB of
3619code.
3620
3621=item EV_EMBED_ENABLE
3622
3623If undefined or defined to be C<1>, then embed watchers are supported. If
3624defined to be C<0>, then they are not. Embed watchers rely on most other
3625watcher types, which therefore must not be disabled.
3626
3627=item EV_STAT_ENABLE
3628
3629If undefined or defined to be C<1>, then stat watchers are supported. If
3630defined to be C<0>, then they are not.
3631
3632=item EV_FORK_ENABLE
3633
3634If undefined or defined to be C<1>, then fork watchers are supported. If
3635defined to be C<0>, then they are not.
3636
3637=item EV_ASYNC_ENABLE
3638
3639If undefined or defined to be C<1>, then async watchers are supported. If
3640defined to be C<0>, then they are not.
3641
3642=item EV_MINIMAL
3643 3890
3644If you need to shave off some kilobytes of code at the expense of some 3891If you need to shave off some kilobytes of code at the expense of some
3645speed, define this symbol to C<1>. Currently this is used to override some 3892speed (but with the full API), you can define this symbol to request
3646inlining decisions, saves roughly 30% code size on amd64. It also selects a 3893certain subsets of functionality. The default is to enable all features
3647much smaller 2-heap for timer management over the default 4-heap. 3894that can be enabled on the platform.
3895
3896Note that using autoconf will usually override most of the features, so
3897using this symbol makes sense mostly when embedding libev.
3898
3899A typical way to use this symbol is to define it to C<0> (or to a bitset
3900with some broad features you want) and then selectively re-enable
3901additional parts you want, for example if you want everything minimal,
3902but multiple event loop support, async and child watchers and the poll
3903backend, use this:
3904
3905 #define EV_FEATURES 0
3906 #define EV_MULTIPLICITY 1
3907 #define EV_USE_POLL 1
3908 #define EV_CHILD_ENABLE 1
3909 #define EV_ASYNC_ENABLE 1
3910
3911The actual value is a bitset, it can be a combination of the following
3912values:
3913
3914=over 4
3915
3916=item C<1> - faster/larger code
3917
3918Use larger code to speed up some operations.
3919
3920Currently this is used to override some inlining decisions (enlarging the roughly
392130% code size on amd64.
3922
3923When optimising for size, use of compiler flags such as C<-Os> with
3924gcc recommended, as well as C<-DNDEBUG>, as libev contains a number of
3925assertions.
3926
3927=item C<2> - faster/larger data structures
3928
3929Replaces the small 2-heap for timer management by a faster 4-heap, larger
3930hash table sizes and so on. This will usually further increase codesize
3931and can additionally have an effect on the size of data structures at
3932runtime.
3933
3934=item C<4> - full API configuration
3935
3936This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
3937enables multiplicity (C<EV_MULTIPLICITY>=1).
3938
3939It also enables a lot of the "lesser used" core API functions. See C<ev.h>
3940for details on which parts of the API are still available without this
3941feature, and do not complain if this subset changes over time.
3942
3943=item C<8> - enable all optional watcher types
3944
3945Enables all optional watcher types. If you want to selectively enable
3946only some watcher types other than I/O and timers (e.g. prepare,
3947embed, async, child...) you can enable them manually by defining
3948C<EV_watchertype_ENABLE> to C<1> instead.
3949
3950=item C<16> - enable all backends
3951
3952This enables all backends - without this feature, you need to enable at
3953least one backend manually (C<EV_USE_SELECT> is a good choice).
3954
3955=item C<32> - enable OS-specific "helper" APIs
3956
3957Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by
3958default.
3959
3960=back
3961
3962Compiling with C<gcc -Os -DEV_STANDALONE -DEV_USE_EPOLL=1 -DEV_FEATURES=0>
3963reduces the compiled size of libev from 24.7Kb to 6.5Kb on my GNU/Linux
3964amd64 system, while still giving you I/O watchers, timers and monotonic
3965clock support.
3966
3967With an intelligent-enough linker (gcc+binutils are intelligent enough
3968when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
3969your program might be left out as well - a binary starting a timer and an
3970I/O watcher then might come out at only 5Kb.
3971
3972=item EV_AVOID_STDIO
3973
3974If this is set to C<1> at compiletime, then libev will avoid using stdio
3975functions (printf, scanf, perror etc.). This will increase the codesize
3976somewhat, but if your program doesn't otherwise depend on stdio and your
3977libc allows it, this avoids linking in the stdio library which is quite
3978big.
3979
3980Note that error messages might become less precise when this option is
3981enabled.
3982
3983=item EV_NSIG
3984
3985The highest supported signal number, +1 (or, the number of
3986signals): Normally, libev tries to deduce the maximum number of signals
3987automatically, but sometimes this fails, in which case it can be
3988specified. Also, using a lower number than detected (C<32> should be
3989good for about any system in existance) can save some memory, as libev
3990statically allocates some 12-24 bytes per signal number.
3648 3991
3649=item EV_PID_HASHSIZE 3992=item EV_PID_HASHSIZE
3650 3993
3651C<ev_child> watchers use a small hash table to distribute workload by 3994C<ev_child> watchers use a small hash table to distribute workload by
3652pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more 3995pid. The default size is C<16> (or C<1> with C<EV_FEATURES> disabled),
3653than enough. If you need to manage thousands of children you might want to 3996usually more than enough. If you need to manage thousands of children you
3654increase this value (I<must> be a power of two). 3997might want to increase this value (I<must> be a power of two).
3655 3998
3656=item EV_INOTIFY_HASHSIZE 3999=item EV_INOTIFY_HASHSIZE
3657 4000
3658C<ev_stat> watchers use a small hash table to distribute workload by 4001C<ev_stat> watchers use a small hash table to distribute workload by
3659inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>), 4002inotify watch id. The default size is C<16> (or C<1> with C<EV_FEATURES>
3660usually more than enough. If you need to manage thousands of C<ev_stat> 4003disabled), usually more than enough. If you need to manage thousands of
3661watchers you might want to increase this value (I<must> be a power of 4004C<ev_stat> watchers you might want to increase this value (I<must> be a
3662two). 4005power of two).
3663 4006
3664=item EV_USE_4HEAP 4007=item EV_USE_4HEAP
3665 4008
3666Heaps are not very cache-efficient. To improve the cache-efficiency of the 4009Heaps are not very cache-efficient. To improve the cache-efficiency of the
3667timer and periodics heaps, libev uses a 4-heap when this symbol is defined 4010timer and periodics heaps, libev uses a 4-heap when this symbol is defined
3668to C<1>. The 4-heap uses more complicated (longer) code but has noticeably 4011to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
3669faster performance with many (thousands) of watchers. 4012faster performance with many (thousands) of watchers.
3670 4013
3671The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> 4014The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3672(disabled). 4015will be C<0>.
3673 4016
3674=item EV_HEAP_CACHE_AT 4017=item EV_HEAP_CACHE_AT
3675 4018
3676Heaps are not very cache-efficient. To improve the cache-efficiency of the 4019Heaps are not very cache-efficient. To improve the cache-efficiency of the
3677timer and periodics heaps, libev can cache the timestamp (I<at>) within 4020timer and periodics heaps, libev can cache the timestamp (I<at>) within
3678the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>), 4021the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
3679which uses 8-12 bytes more per watcher and a few hundred bytes more code, 4022which uses 8-12 bytes more per watcher and a few hundred bytes more code,
3680but avoids random read accesses on heap changes. This improves performance 4023but avoids random read accesses on heap changes. This improves performance
3681noticeably with many (hundreds) of watchers. 4024noticeably with many (hundreds) of watchers.
3682 4025
3683The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> 4026The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3684(disabled). 4027will be C<0>.
3685 4028
3686=item EV_VERIFY 4029=item EV_VERIFY
3687 4030
3688Controls how much internal verification (see C<ev_loop_verify ()>) will 4031Controls how much internal verification (see C<ev_loop_verify ()>) will
3689be done: If set to C<0>, no internal verification code will be compiled 4032be done: If set to C<0>, no internal verification code will be compiled
3691called. If set to C<2>, then the internal verification code will be 4034called. If set to C<2>, then the internal verification code will be
3692called once per loop, which can slow down libev. If set to C<3>, then the 4035called once per loop, which can slow down libev. If set to C<3>, then the
3693verification code will be called very frequently, which will slow down 4036verification code will be called very frequently, which will slow down
3694libev considerably. 4037libev considerably.
3695 4038
3696The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be 4039The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3697C<0>. 4040will be C<0>.
3698 4041
3699=item EV_COMMON 4042=item EV_COMMON
3700 4043
3701By default, all watchers have a C<void *data> member. By redefining 4044By default, all watchers have a C<void *data> member. By redefining
3702this macro to a something else you can include more and other types of 4045this macro to a something else you can include more and other types of
3760file. 4103file.
3761 4104
3762The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file 4105The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
3763that everybody includes and which overrides some configure choices: 4106that everybody includes and which overrides some configure choices:
3764 4107
3765 #define EV_MINIMAL 1 4108 #define EV_FEATURES 0
3766 #define EV_USE_POLL 0 4109 #define EV_USE_SELECT 1
3767 #define EV_MULTIPLICITY 0
3768 #define EV_PERIODIC_ENABLE 0
3769 #define EV_STAT_ENABLE 0
3770 #define EV_FORK_ENABLE 0
3771 #define EV_CONFIG_H <config.h> 4110 #define EV_CONFIG_H <config.h>
3772 #define EV_MINPRI 0
3773 #define EV_MAXPRI 0
3774 4111
3775 #include "ev++.h" 4112 #include "ev++.h"
3776 4113
3777And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: 4114And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
3778 4115
3838default loop and triggering an C<ev_async> watcher from the default loop 4175default loop and triggering an C<ev_async> watcher from the default loop
3839watcher callback into the event loop interested in the signal. 4176watcher callback into the event loop interested in the signal.
3840 4177
3841=back 4178=back
3842 4179
4180=head4 THREAD LOCKING EXAMPLE
4181
4182Here is a fictitious example of how to run an event loop in a different
4183thread than where callbacks are being invoked and watchers are
4184created/added/removed.
4185
4186For a real-world example, see the C<EV::Loop::Async> perl module,
4187which uses exactly this technique (which is suited for many high-level
4188languages).
4189
4190The example uses a pthread mutex to protect the loop data, a condition
4191variable to wait for callback invocations, an async watcher to notify the
4192event loop thread and an unspecified mechanism to wake up the main thread.
4193
4194First, you need to associate some data with the event loop:
4195
4196 typedef struct {
4197 mutex_t lock; /* global loop lock */
4198 ev_async async_w;
4199 thread_t tid;
4200 cond_t invoke_cv;
4201 } userdata;
4202
4203 void prepare_loop (EV_P)
4204 {
4205 // for simplicity, we use a static userdata struct.
4206 static userdata u;
4207
4208 ev_async_init (&u->async_w, async_cb);
4209 ev_async_start (EV_A_ &u->async_w);
4210
4211 pthread_mutex_init (&u->lock, 0);
4212 pthread_cond_init (&u->invoke_cv, 0);
4213
4214 // now associate this with the loop
4215 ev_set_userdata (EV_A_ u);
4216 ev_set_invoke_pending_cb (EV_A_ l_invoke);
4217 ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4218
4219 // then create the thread running ev_loop
4220 pthread_create (&u->tid, 0, l_run, EV_A);
4221 }
4222
4223The callback for the C<ev_async> watcher does nothing: the watcher is used
4224solely to wake up the event loop so it takes notice of any new watchers
4225that might have been added:
4226
4227 static void
4228 async_cb (EV_P_ ev_async *w, int revents)
4229 {
4230 // just used for the side effects
4231 }
4232
4233The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
4234protecting the loop data, respectively.
4235
4236 static void
4237 l_release (EV_P)
4238 {
4239 userdata *u = ev_userdata (EV_A);
4240 pthread_mutex_unlock (&u->lock);
4241 }
4242
4243 static void
4244 l_acquire (EV_P)
4245 {
4246 userdata *u = ev_userdata (EV_A);
4247 pthread_mutex_lock (&u->lock);
4248 }
4249
4250The event loop thread first acquires the mutex, and then jumps straight
4251into C<ev_loop>:
4252
4253 void *
4254 l_run (void *thr_arg)
4255 {
4256 struct ev_loop *loop = (struct ev_loop *)thr_arg;
4257
4258 l_acquire (EV_A);
4259 pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4260 ev_loop (EV_A_ 0);
4261 l_release (EV_A);
4262
4263 return 0;
4264 }
4265
4266Instead of invoking all pending watchers, the C<l_invoke> callback will
4267signal the main thread via some unspecified mechanism (signals? pipe
4268writes? C<Async::Interrupt>?) and then waits until all pending watchers
4269have been called (in a while loop because a) spurious wakeups are possible
4270and b) skipping inter-thread-communication when there are no pending
4271watchers is very beneficial):
4272
4273 static void
4274 l_invoke (EV_P)
4275 {
4276 userdata *u = ev_userdata (EV_A);
4277
4278 while (ev_pending_count (EV_A))
4279 {
4280 wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4281 pthread_cond_wait (&u->invoke_cv, &u->lock);
4282 }
4283 }
4284
4285Now, whenever the main thread gets told to invoke pending watchers, it
4286will grab the lock, call C<ev_invoke_pending> and then signal the loop
4287thread to continue:
4288
4289 static void
4290 real_invoke_pending (EV_P)
4291 {
4292 userdata *u = ev_userdata (EV_A);
4293
4294 pthread_mutex_lock (&u->lock);
4295 ev_invoke_pending (EV_A);
4296 pthread_cond_signal (&u->invoke_cv);
4297 pthread_mutex_unlock (&u->lock);
4298 }
4299
4300Whenever you want to start/stop a watcher or do other modifications to an
4301event loop, you will now have to lock:
4302
4303 ev_timer timeout_watcher;
4304 userdata *u = ev_userdata (EV_A);
4305
4306 ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4307
4308 pthread_mutex_lock (&u->lock);
4309 ev_timer_start (EV_A_ &timeout_watcher);
4310 ev_async_send (EV_A_ &u->async_w);
4311 pthread_mutex_unlock (&u->lock);
4312
4313Note that sending the C<ev_async> watcher is required because otherwise
4314an event loop currently blocking in the kernel will have no knowledge
4315about the newly added timer. By waking up the loop it will pick up any new
4316watchers in the next event loop iteration.
4317
3843=head3 COROUTINES 4318=head3 COROUTINES
3844 4319
3845Libev is very accommodating to coroutines ("cooperative threads"): 4320Libev is very accommodating to coroutines ("cooperative threads"):
3846libev fully supports nesting calls to its functions from different 4321libev fully supports nesting calls to its functions from different
3847coroutines (e.g. you can call C<ev_loop> on the same loop from two 4322coroutines (e.g. you can call C<ev_loop> on the same loop from two
3848different coroutines, and switch freely between both coroutines running the 4323different coroutines, and switch freely between both coroutines running
3849loop, as long as you don't confuse yourself). The only exception is that 4324the loop, as long as you don't confuse yourself). The only exception is
3850you must not do this from C<ev_periodic> reschedule callbacks. 4325that you must not do this from C<ev_periodic> reschedule callbacks.
3851 4326
3852Care has been taken to ensure that libev does not keep local state inside 4327Care has been taken to ensure that libev does not keep local state inside
3853C<ev_loop>, and other calls do not usually allow for coroutine switches as 4328C<ev_loop>, and other calls do not usually allow for coroutine switches as
3854they do not call any callbacks. 4329they do not call any callbacks.
3855 4330
3932way (note also that glib is the slowest event library known to man). 4407way (note also that glib is the slowest event library known to man).
3933 4408
3934There is no supported compilation method available on windows except 4409There is no supported compilation method available on windows except
3935embedding it into other applications. 4410embedding it into other applications.
3936 4411
4412Sensible signal handling is officially unsupported by Microsoft - libev
4413tries its best, but under most conditions, signals will simply not work.
4414
3937Not a libev limitation but worth mentioning: windows apparently doesn't 4415Not a libev limitation but worth mentioning: windows apparently doesn't
3938accept large writes: instead of resulting in a partial write, windows will 4416accept large writes: instead of resulting in a partial write, windows will
3939either accept everything or return C<ENOBUFS> if the buffer is too large, 4417either accept everything or return C<ENOBUFS> if the buffer is too large,
3940so make sure you only write small amounts into your sockets (less than a 4418so make sure you only write small amounts into your sockets (less than a
3941megabyte seems safe, but this apparently depends on the amount of memory 4419megabyte seems safe, but this apparently depends on the amount of memory
3945the abysmal performance of winsockets, using a large number of sockets 4423the abysmal performance of winsockets, using a large number of sockets
3946is not recommended (and not reasonable). If your program needs to use 4424is not recommended (and not reasonable). If your program needs to use
3947more than a hundred or so sockets, then likely it needs to use a totally 4425more than a hundred or so sockets, then likely it needs to use a totally
3948different implementation for windows, as libev offers the POSIX readiness 4426different implementation for windows, as libev offers the POSIX readiness
3949notification model, which cannot be implemented efficiently on windows 4427notification model, which cannot be implemented efficiently on windows
3950(Microsoft monopoly games). 4428(due to Microsoft monopoly games).
3951 4429
3952A typical way to use libev under windows is to embed it (see the embedding 4430A typical way to use libev under windows is to embed it (see the embedding
3953section for details) and use the following F<evwrap.h> header file instead 4431section for details) and use the following F<evwrap.h> header file instead
3954of F<ev.h>: 4432of F<ev.h>:
3955 4433
3991 4469
3992Early versions of winsocket's select only supported waiting for a maximum 4470Early versions of winsocket's select only supported waiting for a maximum
3993of C<64> handles (probably owning to the fact that all windows kernels 4471of C<64> handles (probably owning to the fact that all windows kernels
3994can only wait for C<64> things at the same time internally; Microsoft 4472can only wait for C<64> things at the same time internally; Microsoft
3995recommends spawning a chain of threads and wait for 63 handles and the 4473recommends spawning a chain of threads and wait for 63 handles and the
3996previous thread in each. Great). 4474previous thread in each. Sounds great!).
3997 4475
3998Newer versions support more handles, but you need to define C<FD_SETSIZE> 4476Newer versions support more handles, but you need to define C<FD_SETSIZE>
3999to some high number (e.g. C<2048>) before compiling the winsocket select 4477to some high number (e.g. C<2048>) before compiling the winsocket select
4000call (which might be in libev or elsewhere, for example, perl does its own 4478call (which might be in libev or elsewhere, for example, perl and many
4001select emulation on windows). 4479other interpreters do their own select emulation on windows).
4002 4480
4003Another limit is the number of file descriptors in the Microsoft runtime 4481Another limit is the number of file descriptors in the Microsoft runtime
4004libraries, which by default is C<64> (there must be a hidden I<64> fetish 4482libraries, which by default is C<64> (there must be a hidden I<64>
4005or something like this inside Microsoft). You can increase this by calling 4483fetish or something like this inside Microsoft). You can increase this
4006C<_setmaxstdio>, which can increase this limit to C<2048> (another 4484by calling C<_setmaxstdio>, which can increase this limit to C<2048>
4007arbitrary limit), but is broken in many versions of the Microsoft runtime 4485(another arbitrary limit), but is broken in many versions of the Microsoft
4008libraries.
4009
4010This might get you to about C<512> or C<2048> sockets (depending on 4486runtime libraries. This might get you to about C<512> or C<2048> sockets
4011windows version and/or the phase of the moon). To get more, you need to 4487(depending on windows version and/or the phase of the moon). To get more,
4012wrap all I/O functions and provide your own fd management, but the cost of 4488you need to wrap all I/O functions and provide your own fd management, but
4013calling select (O(n²)) will likely make this unworkable. 4489the cost of calling select (O(n²)) will likely make this unworkable.
4014 4490
4015=back 4491=back
4016 4492
4017=head2 PORTABILITY REQUIREMENTS 4493=head2 PORTABILITY REQUIREMENTS
4018 4494
4061=item C<double> must hold a time value in seconds with enough accuracy 4537=item C<double> must hold a time value in seconds with enough accuracy
4062 4538
4063The type C<double> is used to represent timestamps. It is required to 4539The type C<double> is used to represent timestamps. It is required to
4064have at least 51 bits of mantissa (and 9 bits of exponent), which is good 4540have at least 51 bits of mantissa (and 9 bits of exponent), which is good
4065enough for at least into the year 4000. This requirement is fulfilled by 4541enough for at least into the year 4000. This requirement is fulfilled by
4066implementations implementing IEEE 754 (basically all existing ones). 4542implementations implementing IEEE 754, which is basically all existing
4543ones. With IEEE 754 doubles, you get microsecond accuracy until at least
45442200.
4067 4545
4068=back 4546=back
4069 4547
4070If you know of other additional requirements drop me a note. 4548If you know of other additional requirements drop me a note.
4071 4549

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines