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

Comparing libev/ev.pod (file contents):
Revision 1.109 by root, Mon Dec 24 13:19:12 2007 UTC vs.
Revision 1.130 by root, Wed Feb 6 18:34:24 2008 UTC

260flags. If that is troubling you, check C<ev_backend ()> afterwards). 260flags. If that is troubling you, check C<ev_backend ()> afterwards).
261 261
262If you don't know what event loop to use, use the one returned from this 262If you don't know what event loop to use, use the one returned from this
263function. 263function.
264 264
265The default loop is the only loop that can handle C<ev_signal> and
266C<ev_child> watchers, and to do this, it always registers a handler
267for C<SIGCHLD>. If this is a problem for your app you can either
268create a dynamic loop with C<ev_loop_new> that doesn't do that, or you
269can simply overwrite the C<SIGCHLD> signal handler I<after> calling
270C<ev_default_init>.
271
265The flags argument can be used to specify special behaviour or specific 272The flags argument can be used to specify special behaviour or specific
266backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>). 273backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).
267 274
268The following flags are supported: 275The following flags are supported:
269 276
403While this backend scales well, it requires one system call per active 410While this backend scales well, it requires one system call per active
404file descriptor per loop iteration. For small and medium numbers of file 411file descriptor per loop iteration. For small and medium numbers of file
405descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend 412descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
406might perform better. 413might perform better.
407 414
415On the positive side, ignoring the spurious readyness notifications, this
416backend actually performed to specification in all tests and is fully
417embeddable, which is a rare feat among the OS-specific backends.
418
408=item C<EVBACKEND_ALL> 419=item C<EVBACKEND_ALL>
409 420
410Try all backends (even potentially broken ones that wouldn't be tried 421Try all backends (even potentially broken ones that wouldn't be tried
411with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as 422with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
412C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>. 423C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
414It is definitely not recommended to use this flag. 425It is definitely not recommended to use this flag.
415 426
416=back 427=back
417 428
418If one or more of these are ored into the flags value, then only these 429If one or more of these are ored into the flags value, then only these
419backends will be tried (in the reverse order as given here). If none are 430backends will be tried (in the reverse order as listed here). If none are
420specified, most compiled-in backend will be tried, usually in reverse 431specified, all backends in C<ev_recommended_backends ()> will be tried.
421order of their flag values :)
422 432
423The most typical usage is like this: 433The most typical usage is like this:
424 434
425 if (!ev_default_loop (0)) 435 if (!ev_default_loop (0))
426 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); 436 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
473Like C<ev_default_destroy>, but destroys an event loop created by an 483Like C<ev_default_destroy>, but destroys an event loop created by an
474earlier call to C<ev_loop_new>. 484earlier call to C<ev_loop_new>.
475 485
476=item ev_default_fork () 486=item ev_default_fork ()
477 487
488This function sets a flag that causes subsequent C<ev_loop> iterations
478This function reinitialises the kernel state for backends that have 489to reinitialise the kernel state for backends that have one. Despite the
479one. Despite the name, you can call it anytime, but it makes most sense 490name, you can call it anytime, but it makes most sense after forking, in
480after forking, in either the parent or child process (or both, but that 491the child process (or both child and parent, but that again makes little
481again makes little sense). 492sense). You I<must> call it in the child before using any of the libev
493functions, and it will only take effect at the next C<ev_loop> iteration.
482 494
483You I<must> call this function in the child process after forking if and 495On the other hand, you only need to call this function in the child
484only if you want to use the event library in both processes. If you just 496process if and only if you want to use the event library in the child. If
485fork+exec, you don't have to call it. 497you just fork+exec, you don't have to call it at all.
486 498
487The function itself is quite fast and it's usually not a problem to call 499The function itself is quite fast and it's usually not a problem to call
488it just in case after a fork. To make this easy, the function will fit in 500it just in case after a fork. To make this easy, the function will fit in
489quite nicely into a call to C<pthread_atfork>: 501quite nicely into a call to C<pthread_atfork>:
490 502
491 pthread_atfork (0, 0, ev_default_fork); 503 pthread_atfork (0, 0, ev_default_fork);
492
493At the moment, C<EVBACKEND_SELECT> and C<EVBACKEND_POLL> are safe to use
494without calling this function, so if you force one of those backends you
495do not need to care.
496 504
497=item ev_loop_fork (loop) 505=item ev_loop_fork (loop)
498 506
499Like C<ev_default_fork>, but acts on an event loop created by 507Like C<ev_default_fork>, but acts on an event loop created by
500C<ev_loop_new>. Yes, you have to call this on every allocated event loop 508C<ev_loop_new>. Yes, you have to call this on every allocated event loop
551usually a better approach for this kind of thing. 559usually a better approach for this kind of thing.
552 560
553Here are the gory details of what C<ev_loop> does: 561Here are the gory details of what C<ev_loop> does:
554 562
555 - Before the first iteration, call any pending watchers. 563 - Before the first iteration, call any pending watchers.
556 * If there are no active watchers (reference count is zero), return. 564 * If EVFLAG_FORKCHECK was used, check for a fork.
557 - Queue all prepare watchers and then call all outstanding watchers. 565 - If a fork was detected, queue and call all fork watchers.
566 - Queue and call all prepare watchers.
558 - If we have been forked, recreate the kernel state. 567 - If we have been forked, recreate the kernel state.
559 - Update the kernel state with all outstanding changes. 568 - Update the kernel state with all outstanding changes.
560 - Update the "event loop time". 569 - Update the "event loop time".
561 - Calculate for how long to block. 570 - Calculate for how long to sleep or block, if at all
571 (active idle watchers, EVLOOP_NONBLOCK or not having
572 any active watchers at all will result in not sleeping).
573 - Sleep if the I/O and timer collect interval say so.
562 - Block the process, waiting for any events. 574 - Block the process, waiting for any events.
563 - Queue all outstanding I/O (fd) events. 575 - Queue all outstanding I/O (fd) events.
564 - Update the "event loop time" and do time jump handling. 576 - Update the "event loop time" and do time jump handling.
565 - Queue all outstanding timers. 577 - Queue all outstanding timers.
566 - Queue all outstanding periodics. 578 - Queue all outstanding periodics.
567 - If no events are pending now, queue all idle watchers. 579 - If no events are pending now, queue all idle watchers.
568 - Queue all check watchers. 580 - Queue all check watchers.
569 - Call all queued watchers in reverse order (i.e. check watchers first). 581 - Call all queued watchers in reverse order (i.e. check watchers first).
570 Signals and child watchers are implemented as I/O watchers, and will 582 Signals and child watchers are implemented as I/O watchers, and will
571 be handled here by queueing them when their watcher gets executed. 583 be handled here by queueing them when their watcher gets executed.
572 - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK 584 - If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
573 were used, return, otherwise continue with step *. 585 were used, or there are no active watchers, return, otherwise
586 continue with step *.
574 587
575Example: Queue some jobs and then loop until no events are outsanding 588Example: Queue some jobs and then loop until no events are outstanding
576anymore. 589anymore.
577 590
578 ... queue jobs here, make sure they register event watchers as long 591 ... queue jobs here, make sure they register event watchers as long
579 ... as they still have work to do (even an idle watcher will do..) 592 ... as they still have work to do (even an idle watcher will do..)
580 ev_loop (my_loop, 0); 593 ev_loop (my_loop, 0);
584 597
585Can be used to make a call to C<ev_loop> return early (but only after it 598Can be used to make a call to C<ev_loop> return early (but only after it
586has processed all outstanding events). The C<how> argument must be either 599has processed all outstanding events). The C<how> argument must be either
587C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or 600C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or
588C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. 601C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.
602
603This "unloop state" will be cleared when entering C<ev_loop> again.
589 604
590=item ev_ref (loop) 605=item ev_ref (loop)
591 606
592=item ev_unref (loop) 607=item ev_unref (loop)
593 608
598returning, ev_unref() after starting, and ev_ref() before stopping it. For 613returning, ev_unref() after starting, and ev_ref() before stopping it. For
599example, libev itself uses this for its internal signal pipe: It is not 614example, libev itself uses this for its internal signal pipe: It is not
600visible to the libev user and should not keep C<ev_loop> from exiting if 615visible to the libev user and should not keep C<ev_loop> from exiting if
601no event watchers registered by it are active. It is also an excellent 616no event watchers registered by it are active. It is also an excellent
602way to do this for generic recurring timers or from within third-party 617way to do this for generic recurring timers or from within third-party
603libraries. Just remember to I<unref after start> and I<ref before stop>. 618libraries. Just remember to I<unref after start> and I<ref before stop>
619(but only if the watcher wasn't active before, or was active before,
620respectively).
604 621
605Example: Create a signal watcher, but keep it from keeping C<ev_loop> 622Example: Create a signal watcher, but keep it from keeping C<ev_loop>
606running when nothing else is active. 623running when nothing else is active.
607 624
608 struct ev_signal exitsig; 625 struct ev_signal exitsig;
756 773
757=item C<EV_FORK> 774=item C<EV_FORK>
758 775
759The event loop has been resumed in the child process after fork (see 776The event loop has been resumed in the child process after fork (see
760C<ev_fork>). 777C<ev_fork>).
778
779=item C<EV_ASYNC>
780
781The given async watcher has been asynchronously notified (see C<ev_async>).
761 782
762=item C<EV_ERROR> 783=item C<EV_ERROR>
763 784
764An unspecified error has occured, the watcher has been stopped. This might 785An unspecified error has occured, the watcher has been stopped. This might
765happen because the watcher could not be properly started because libev 786happen because the watcher could not be properly started because libev
1067=item int events [read-only] 1088=item int events [read-only]
1068 1089
1069The events being watched. 1090The events being watched.
1070 1091
1071=back 1092=back
1093
1094=head3 Examples
1072 1095
1073Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well 1096Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
1074readable, but only once. Since it is likely line-buffered, you could 1097readable, but only once. Since it is likely line-buffered, you could
1075attempt to read a whole line in the callback. 1098attempt to read a whole line in the callback.
1076 1099
1174or C<ev_timer_again> is called and determines the next timeout (if any), 1197or C<ev_timer_again> is called and determines the next timeout (if any),
1175which is also when any modifications are taken into account. 1198which is also when any modifications are taken into account.
1176 1199
1177=back 1200=back
1178 1201
1202=head3 Examples
1203
1179Example: Create a timer that fires after 60 seconds. 1204Example: Create a timer that fires after 60 seconds.
1180 1205
1181 static void 1206 static void
1182 one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1207 one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
1183 { 1208 {
1340When active, contains the absolute time that the watcher is supposed to 1365When active, contains the absolute time that the watcher is supposed to
1341trigger next. 1366trigger next.
1342 1367
1343=back 1368=back
1344 1369
1370=head3 Examples
1371
1345Example: Call a callback every hour, or, more precisely, whenever the 1372Example: Call a callback every hour, or, more precisely, whenever the
1346system clock is divisible by 3600. The callback invocation times have 1373system clock is divisible by 3600. The callback invocation times have
1347potentially a lot of jittering, but good long-term stability. 1374potentially a lot of jittering, but good long-term stability.
1348 1375
1349 static void 1376 static void
1415 1442
1416=head3 Watcher-Specific Functions and Data Members 1443=head3 Watcher-Specific Functions and Data Members
1417 1444
1418=over 4 1445=over 4
1419 1446
1420=item ev_child_init (ev_child *, callback, int pid) 1447=item ev_child_init (ev_child *, callback, int pid, int trace)
1421 1448
1422=item ev_child_set (ev_child *, int pid) 1449=item ev_child_set (ev_child *, int pid, int trace)
1423 1450
1424Configures the watcher to wait for status changes of process C<pid> (or 1451Configures the watcher to wait for status changes of process C<pid> (or
1425I<any> process if C<pid> is specified as C<0>). The callback can look 1452I<any> process if C<pid> is specified as C<0>). The callback can look
1426at the C<rstatus> member of the C<ev_child> watcher structure to see 1453at the C<rstatus> member of the C<ev_child> watcher structure to see
1427the status word (use the macros from C<sys/wait.h> and see your systems 1454the status word (use the macros from C<sys/wait.h> and see your systems
1428C<waitpid> documentation). The C<rpid> member contains the pid of the 1455C<waitpid> documentation). The C<rpid> member contains the pid of the
1429process causing the status change. 1456process causing the status change. C<trace> must be either C<0> (only
1457activate the watcher when the process terminates) or C<1> (additionally
1458activate the watcher when the process is stopped or continued).
1430 1459
1431=item int pid [read-only] 1460=item int pid [read-only]
1432 1461
1433The process id this watcher watches out for, or C<0>, meaning any process id. 1462The process id this watcher watches out for, or C<0>, meaning any process id.
1434 1463
1440 1469
1441The process exit/trace status caused by C<rpid> (see your systems 1470The process exit/trace status caused by C<rpid> (see your systems
1442C<waitpid> and C<sys/wait.h> documentation for details). 1471C<waitpid> and C<sys/wait.h> documentation for details).
1443 1472
1444=back 1473=back
1474
1475=head3 Examples
1445 1476
1446Example: Try to exit cleanly on SIGINT and SIGTERM. 1477Example: Try to exit cleanly on SIGINT and SIGTERM.
1447 1478
1448 static void 1479 static void
1449 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) 1480 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1658kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, 1689kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1659believe me. 1690believe me.
1660 1691
1661=back 1692=back
1662 1693
1694=head3 Examples
1695
1663Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the 1696Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1664callback, free it. Also, use no error checking, as usual. 1697callback, free it. Also, use no error checking, as usual.
1665 1698
1666 static void 1699 static void
1667 idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) 1700 idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1668 { 1701 {
1669 free (w); 1702 free (w);
1670 // now do something you wanted to do when the program has 1703 // now do something you wanted to do when the program has
1671 // no longer asnything immediate to do. 1704 // no longer anything immediate to do.
1672 } 1705 }
1673 1706
1674 struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); 1707 struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));
1675 ev_idle_init (idle_watcher, idle_cb); 1708 ev_idle_init (idle_watcher, idle_cb);
1676 ev_idle_start (loop, idle_cb); 1709 ev_idle_start (loop, idle_cb);
1738parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> 1771parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1739macros, but using them is utterly, utterly and completely pointless. 1772macros, but using them is utterly, utterly and completely pointless.
1740 1773
1741=back 1774=back
1742 1775
1776=head3 Examples
1777
1743There are a number of principal ways to embed other event loops or modules 1778There are a number of principal ways to embed other event loops or modules
1744into libev. Here are some ideas on how to include libadns into libev 1779into libev. Here are some ideas on how to include libadns into libev
1745(there is a Perl module named C<EV::ADNS> that does this, which you could 1780(there is a Perl module named C<EV::ADNS> that does this, which you could
1746use for an actually working example. Another Perl module named C<EV::Glib> 1781use for an actually working example. Another Perl module named C<EV::Glib>
1747embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV 1782embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV
1915portable one. 1950portable one.
1916 1951
1917So when you want to use this feature you will always have to be prepared 1952So when you want to use this feature you will always have to be prepared
1918that you cannot get an embeddable loop. The recommended way to get around 1953that you cannot get an embeddable loop. The recommended way to get around
1919this is to have a separate variables for your embeddable loop, try to 1954this is to have a separate variables for your embeddable loop, try to
1920create it, and if that fails, use the normal loop for everything: 1955create it, and if that fails, use the normal loop for everything.
1956
1957=head3 Watcher-Specific Functions and Data Members
1958
1959=over 4
1960
1961=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
1962
1963=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)
1964
1965Configures the watcher to embed the given loop, which must be
1966embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
1967invoked automatically, otherwise it is the responsibility of the callback
1968to invoke it (it will continue to be called until the sweep has been done,
1969if you do not want thta, you need to temporarily stop the embed watcher).
1970
1971=item ev_embed_sweep (loop, ev_embed *)
1972
1973Make a single, non-blocking sweep over the embedded loop. This works
1974similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1975apropriate way for embedded loops.
1976
1977=item struct ev_loop *other [read-only]
1978
1979The embedded event loop.
1980
1981=back
1982
1983=head3 Examples
1984
1985Example: Try to get an embeddable event loop and embed it into the default
1986event loop. If that is not possible, use the default loop. The default
1987loop is stored in C<loop_hi>, while the mebeddable loop is stored in
1988C<loop_lo> (which is C<loop_hi> in the acse no embeddable loop can be
1989used).
1921 1990
1922 struct ev_loop *loop_hi = ev_default_init (0); 1991 struct ev_loop *loop_hi = ev_default_init (0);
1923 struct ev_loop *loop_lo = 0; 1992 struct ev_loop *loop_lo = 0;
1924 struct ev_embed embed; 1993 struct ev_embed embed;
1925 1994
1936 ev_embed_start (loop_hi, &embed); 2005 ev_embed_start (loop_hi, &embed);
1937 } 2006 }
1938 else 2007 else
1939 loop_lo = loop_hi; 2008 loop_lo = loop_hi;
1940 2009
1941=head3 Watcher-Specific Functions and Data Members 2010Example: Check if kqueue is available but not recommended and create
2011a kqueue backend for use with sockets (which usually work with any
2012kqueue implementation). Store the kqueue/socket-only event loop in
2013C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
1942 2014
1943=over 4 2015 struct ev_loop *loop = ev_default_init (0);
2016 struct ev_loop *loop_socket = 0;
2017 struct ev_embed embed;
2018
2019 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2020 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2021 {
2022 ev_embed_init (&embed, 0, loop_socket);
2023 ev_embed_start (loop, &embed);
2024 }
1944 2025
1945=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) 2026 if (!loop_socket)
2027 loop_socket = loop;
1946 2028
1947=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) 2029 // now use loop_socket for all sockets, and loop for everything else
1948
1949Configures the watcher to embed the given loop, which must be
1950embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
1951invoked automatically, otherwise it is the responsibility of the callback
1952to invoke it (it will continue to be called until the sweep has been done,
1953if you do not want thta, you need to temporarily stop the embed watcher).
1954
1955=item ev_embed_sweep (loop, ev_embed *)
1956
1957Make a single, non-blocking sweep over the embedded loop. This works
1958similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1959apropriate way for embedded loops.
1960
1961=item struct ev_loop *other [read-only]
1962
1963The embedded event loop.
1964
1965=back
1966 2030
1967 2031
1968=head2 C<ev_fork> - the audacity to resume the event loop after a fork 2032=head2 C<ev_fork> - the audacity to resume the event loop after a fork
1969 2033
1970Fork watchers are called when a C<fork ()> was detected (usually because 2034Fork watchers are called when a C<fork ()> was detected (usually because
1986believe me. 2050believe me.
1987 2051
1988=back 2052=back
1989 2053
1990 2054
2055=head2 C<ev_async> - how to wake up another event loop
2056
2057In general, you cannot use an C<ev_loop> from multiple threads or other
2058asynchronous sources such as signal handlers (as opposed to multiple event
2059loops - those are of course safe to use in different threads).
2060
2061Sometimes, however, you need to wake up another event loop you do not
2062control, for example because it belongs to another thread. This is what
2063C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you
2064can signal it by calling C<ev_async_send>, which is thread- and signal
2065safe.
2066
2067This functionality is very similar to C<ev_signal> watchers, as signals,
2068too, are asynchronous in nature, and signals, too, will be compressed
2069(i.e. the number of callback invocations may be less than the number of
2070C<ev_async_sent> calls).
2071
2072Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
2073just the default loop.
2074
2075=head3 Queueing
2076
2077C<ev_async> does not support queueing of data in any way. The reason
2078is that the author does not know of a simple (or any) algorithm for a
2079multiple-writer-single-reader queue that works in all cases and doesn't
2080need elaborate support such as pthreads.
2081
2082That means that if you want to queue data, you have to provide your own
2083queue. But at least I can tell you would implement locking around your
2084queue:
2085
2086=over 4
2087
2088=item queueing from a signal handler context
2089
2090To implement race-free queueing, you simply add to the queue in the signal
2091handler but you block the signal handler in the watcher callback. Here is an example that does that for
2092some fictitiuous SIGUSR1 handler:
2093
2094 static ev_async mysig;
2095
2096 static void
2097 sigusr1_handler (void)
2098 {
2099 sometype data;
2100
2101 // no locking etc.
2102 queue_put (data);
2103 ev_async_send (DEFAULT_ &mysig);
2104 }
2105
2106 static void
2107 mysig_cb (EV_P_ ev_async *w, int revents)
2108 {
2109 sometype data;
2110 sigset_t block, prev;
2111
2112 sigemptyset (&block);
2113 sigaddset (&block, SIGUSR1);
2114 sigprocmask (SIG_BLOCK, &block, &prev);
2115
2116 while (queue_get (&data))
2117 process (data);
2118
2119 if (sigismember (&prev, SIGUSR1)
2120 sigprocmask (SIG_UNBLOCK, &block, 0);
2121 }
2122
2123(Note: pthreads in theory requires you to use C<pthread_setmask>
2124instead of C<sigprocmask> when you use threads, but libev doesn't do it
2125either...).
2126
2127=item queueing from a thread context
2128
2129The strategy for threads is different, as you cannot (easily) block
2130threads but you can easily preempt them, so to queue safely you need to
2131employ a traditional mutex lock, such as in this pthread example:
2132
2133 static ev_async mysig;
2134 static pthread_mutex_t mymutex = PTHREAD_MUTEX_INITIALIZER;
2135
2136 static void
2137 otherthread (void)
2138 {
2139 // only need to lock the actual queueing operation
2140 pthread_mutex_lock (&mymutex);
2141 queue_put (data);
2142 pthread_mutex_unlock (&mymutex);
2143
2144 ev_async_send (DEFAULT_ &mysig);
2145 }
2146
2147 static void
2148 mysig_cb (EV_P_ ev_async *w, int revents)
2149 {
2150 pthread_mutex_lock (&mymutex);
2151
2152 while (queue_get (&data))
2153 process (data);
2154
2155 pthread_mutex_unlock (&mymutex);
2156 }
2157
2158=back
2159
2160
2161=head3 Watcher-Specific Functions and Data Members
2162
2163=over 4
2164
2165=item ev_async_init (ev_async *, callback)
2166
2167Initialises and configures the async watcher - it has no parameters of any
2168kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless,
2169believe me.
2170
2171=item ev_async_send (loop, ev_async *)
2172
2173Sends/signals/activates the given C<ev_async> watcher, that is, feeds
2174an C<EV_ASYNC> event on the watcher into the event loop. Unlike
2175C<ev_feed_event>, this call is safe to do in other threads, signal or
2176similar contexts (see the dicusssion of C<EV_ATOMIC_T> in the embedding
2177section below on what exactly this means).
2178
2179This call incurs the overhead of a syscall only once per loop iteration,
2180so while the overhead might be noticable, it doesn't apply to repeated
2181calls to C<ev_async_send>.
2182
2183=back
2184
2185
1991=head1 OTHER FUNCTIONS 2186=head1 OTHER FUNCTIONS
1992 2187
1993There are some other functions of possible interest. Described. Here. Now. 2188There are some other functions of possible interest. Described. Here. Now.
1994 2189
1995=over 4 2190=over 4
2222Example: Define a class with an IO and idle watcher, start one of them in 2417Example: Define a class with an IO and idle watcher, start one of them in
2223the constructor. 2418the constructor.
2224 2419
2225 class myclass 2420 class myclass
2226 { 2421 {
2227 ev_io io; void io_cb (ev::io &w, int revents); 2422 ev::io io; void io_cb (ev::io &w, int revents);
2228 ev_idle idle void idle_cb (ev::idle &w, int revents); 2423 ev:idle idle void idle_cb (ev::idle &w, int revents);
2229 2424
2230 myclass (); 2425 myclass (int fd)
2231 }
2232
2233 myclass::myclass (int fd)
2234 { 2426 {
2235 io .set <myclass, &myclass::io_cb > (this); 2427 io .set <myclass, &myclass::io_cb > (this);
2236 idle.set <myclass, &myclass::idle_cb> (this); 2428 idle.set <myclass, &myclass::idle_cb> (this);
2237 2429
2238 io.start (fd, ev::READ); 2430 io.start (fd, ev::READ);
2431 }
2239 } 2432 };
2240 2433
2241 2434
2242=head1 MACRO MAGIC 2435=head1 MACRO MAGIC
2243 2436
2244Libev can be compiled with a variety of options, the most fundamantal 2437Libev can be compiled with a variety of options, the most fundamantal
2449wants osf handles on win32 (this is the case when the select to 2642wants osf handles on win32 (this is the case when the select to
2450be used is the winsock select). This means that it will call 2643be used is the winsock select). This means that it will call
2451C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, 2644C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
2452it is assumed that all these functions actually work on fds, even 2645it is assumed that all these functions actually work on fds, even
2453on win32. Should not be defined on non-win32 platforms. 2646on win32. Should not be defined on non-win32 platforms.
2647
2648=item EV_FD_TO_WIN32_HANDLE
2649
2650If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
2651file descriptors to socket handles. When not defining this symbol (the
2652default), then libev will call C<_get_osfhandle>, which is usually
2653correct. In some cases, programs use their own file descriptor management,
2654in which case they can provide this function to map fds to socket handles.
2454 2655
2455=item EV_USE_POLL 2656=item EV_USE_POLL
2456 2657
2457If defined to be C<1>, libev will compile in support for the C<poll>(2) 2658If defined to be C<1>, libev will compile in support for the C<poll>(2)
2458backend. Otherwise it will be enabled on non-win32 platforms. It 2659backend. Otherwise it will be enabled on non-win32 platforms. It
2492 2693
2493If defined to be C<1>, libev will compile in support for the Linux inotify 2694If defined to be C<1>, libev will compile in support for the Linux inotify
2494interface to speed up C<ev_stat> watchers. Its actual availability will 2695interface to speed up C<ev_stat> watchers. Its actual availability will
2495be detected at runtime. 2696be detected at runtime.
2496 2697
2698=item EV_ATOMIC_T
2699
2700Libev requires an integer type (suitable for storing C<0> or C<1>) whose
2701access is atomic with respect to other threads or signal contexts. No such
2702type is easily found in the C language, so you can provide your own type
2703that you know is safe for your purposes. It is used both for signal handler "locking"
2704as well as for signal and thread safety in C<ev_async> watchers.
2705
2706In the absense of this define, libev will use C<sig_atomic_t volatile>
2707(from F<signal.h>), which is usually good enough on most platforms.
2708
2497=item EV_H 2709=item EV_H
2498 2710
2499The name of the F<ev.h> header file used to include it. The default if 2711The name of the F<ev.h> header file used to include it. The default if
2500undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This 2712undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
2501can be used to virtually rename the F<ev.h> header file in case of conflicts. 2713used to virtually rename the F<ev.h> header file in case of conflicts.
2502 2714
2503=item EV_CONFIG_H 2715=item EV_CONFIG_H
2504 2716
2505If C<EV_STANDALONE> isn't C<1>, this variable can be used to override 2717If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
2506F<ev.c>'s idea of where to find the F<config.h> file, similarly to 2718F<ev.c>'s idea of where to find the F<config.h> file, similarly to
2507C<EV_H>, above. 2719C<EV_H>, above.
2508 2720
2509=item EV_EVENT_H 2721=item EV_EVENT_H
2510 2722
2511Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea 2723Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
2512of how the F<event.h> header can be found. 2724of how the F<event.h> header can be found, the default is C<"event.h">.
2513 2725
2514=item EV_PROTOTYPES 2726=item EV_PROTOTYPES
2515 2727
2516If defined to be C<0>, then F<ev.h> will not define any function 2728If defined to be C<0>, then F<ev.h> will not define any function
2517prototypes, but still define all the structs and other symbols. This is 2729prototypes, but still define all the structs and other symbols. This is
2566defined to be C<0>, then they are not. 2778defined to be C<0>, then they are not.
2567 2779
2568=item EV_FORK_ENABLE 2780=item EV_FORK_ENABLE
2569 2781
2570If undefined or defined to be C<1>, then fork watchers are supported. If 2782If undefined or defined to be C<1>, then fork watchers are supported. If
2783defined to be C<0>, then they are not.
2784
2785=item EV_ASYNC_ENABLE
2786
2787If undefined or defined to be C<1>, then async watchers are supported. If
2571defined to be C<0>, then they are not. 2788defined to be C<0>, then they are not.
2572 2789
2573=item EV_MINIMAL 2790=item EV_MINIMAL
2574 2791
2575If you need to shave off some kilobytes of code at the expense of some 2792If you need to shave off some kilobytes of code at the expense of some
2696=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers) 2913=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
2697 2914
2698That means that changing a timer costs less than removing/adding them 2915That means that changing a timer costs less than removing/adding them
2699as only the relative motion in the event queue has to be paid for. 2916as only the relative motion in the event queue has to be paid for.
2700 2917
2701=item Starting io/check/prepare/idle/signal/child watchers: O(1) 2918=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)
2702 2919
2703These just add the watcher into an array or at the head of a list. 2920These just add the watcher into an array or at the head of a list.
2704 2921
2705=item Stopping check/prepare/idle watchers: O(1) 2922=item Stopping check/prepare/idle/fork/async watchers: O(1)
2706 2923
2707=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) 2924=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
2708 2925
2709These watchers are stored in lists then need to be walked to find the 2926These watchers are stored in lists then need to be walked to find the
2710correct watcher to remove. The lists are usually short (you don't usually 2927correct watcher to remove. The lists are usually short (you don't usually
2726=item Priority handling: O(number_of_priorities) 2943=item Priority handling: O(number_of_priorities)
2727 2944
2728Priorities are implemented by allocating some space for each 2945Priorities are implemented by allocating some space for each
2729priority. When doing priority-based operations, libev usually has to 2946priority. When doing priority-based operations, libev usually has to
2730linearly search all the priorities, but starting/stopping and activating 2947linearly search all the priorities, but starting/stopping and activating
2731watchers becomes O(1) w.r.t. prioritiy handling. 2948watchers becomes O(1) w.r.t. priority handling.
2949
2950=item Sending an ev_async: O(1)
2951
2952=item Processing ev_async_send: O(number_of_async_watchers)
2953
2954=item Processing signals: O(max_signal_number)
2955
2956Sending involves a syscall I<iff> there were no other C<ev_async_send>
2957calls in the current loop iteration. Checking for async and signal events
2958involves iterating over all running async watchers or all signal numbers.
2732 2959
2733=back 2960=back
2734 2961
2735 2962
2963=head1 Win32 platform limitations and workarounds
2964
2965Win32 doesn't support any of the standards (e.g. POSIX) that libev
2966requires, and its I/O model is fundamentally incompatible with the POSIX
2967model. Libev still offers limited functionality on this platform in
2968the form of the C<EVBACKEND_SELECT> backend, and only supports socket
2969descriptors. This only applies when using Win32 natively, not when using
2970e.g. cygwin.
2971
2972There is no supported compilation method available on windows except
2973embedding it into other applications.
2974
2975Due to the many, low, and arbitrary limits on the win32 platform and the
2976abysmal performance of winsockets, using a large number of sockets is not
2977recommended (and not reasonable). If your program needs to use more than
2978a hundred or so sockets, then likely it needs to use a totally different
2979implementation for windows, as libev offers the POSIX model, which cannot
2980be implemented efficiently on windows (microsoft monopoly games).
2981
2982=over 4
2983
2984=item The winsocket select function
2985
2986The winsocket C<select> function doesn't follow POSIX in that it requires
2987socket I<handles> and not socket I<file descriptors>. This makes select
2988very inefficient, and also requires a mapping from file descriptors
2989to socket handles. See the discussion of the C<EV_SELECT_USE_FD_SET>,
2990C<EV_SELECT_IS_WINSOCKET> and C<EV_FD_TO_WIN32_HANDLE> preprocessor
2991symbols for more info.
2992
2993The configuration for a "naked" win32 using the microsoft runtime
2994libraries and raw winsocket select is:
2995
2996 #define EV_USE_SELECT 1
2997 #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
2998
2999Note that winsockets handling of fd sets is O(n), so you can easily get a
3000complexity in the O(n²) range when using win32.
3001
3002=item Limited number of file descriptors
3003
3004Windows has numerous arbitrary (and low) limits on things. Early versions
3005of winsocket's select only supported waiting for a max. of C<64> handles
3006(probably owning to the fact that all windows kernels can only wait for
3007C<64> things at the same time internally; microsoft recommends spawning a
3008chain of threads and wait for 63 handles and the previous thread in each).
3009
3010Newer versions support more handles, but you need to define C<FD_SETSIZE>
3011to some high number (e.g. C<2048>) before compiling the winsocket select
3012call (which might be in libev or elsewhere, for example, perl does its own
3013select emulation on windows).
3014
3015Another limit is the number of file descriptors in the microsoft runtime
3016libraries, which by default is C<64> (there must be a hidden I<64> fetish
3017or something like this inside microsoft). You can increase this by calling
3018C<_setmaxstdio>, which can increase this limit to C<2048> (another
3019arbitrary limit), but is broken in many versions of the microsoft runtime
3020libraries.
3021
3022This might get you to about C<512> or C<2048> sockets (depending on
3023windows version and/or the phase of the moon). To get more, you need to
3024wrap all I/O functions and provide your own fd management, but the cost of
3025calling select (O(n²)) will likely make this unworkable.
3026
3027=back
3028
3029
2736=head1 AUTHOR 3030=head1 AUTHOR
2737 3031
2738Marc Lehmann <libev@schmorp.de>. 3032Marc Lehmann <libev@schmorp.de>.
2739 3033

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines