… | |
… | |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | #include <ev.h> |
7 | #include <ev.h> |
8 | |
8 | |
9 | =head1 EXAMPLE PROGRAM |
9 | =head2 EXAMPLE PROGRAM |
10 | |
10 | |
11 | #include <ev.h> |
11 | #include <ev.h> |
12 | |
12 | |
13 | ev_io stdin_watcher; |
13 | ev_io stdin_watcher; |
14 | ev_timer timeout_watcher; |
14 | ev_timer timeout_watcher; |
… | |
… | |
65 | You register interest in certain events by registering so-called I<event |
65 | You register interest in certain events by registering so-called I<event |
66 | watchers>, which are relatively small C structures you initialise with the |
66 | watchers>, which are relatively small C structures you initialise with the |
67 | details of the event, and then hand it over to libev by I<starting> the |
67 | details of the event, and then hand it over to libev by I<starting> the |
68 | watcher. |
68 | watcher. |
69 | |
69 | |
70 | =head1 FEATURES |
70 | =head2 FEATURES |
71 | |
71 | |
72 | Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the |
72 | Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the |
73 | BSD-specific C<kqueue> and the Solaris-specific event port mechanisms |
73 | BSD-specific C<kqueue> and the Solaris-specific event port mechanisms |
74 | for file descriptor events (C<ev_io>), the Linux C<inotify> interface |
74 | for file descriptor events (C<ev_io>), the Linux C<inotify> interface |
75 | (for C<ev_stat>), relative timers (C<ev_timer>), absolute timers |
75 | (for C<ev_stat>), relative timers (C<ev_timer>), absolute timers |
… | |
… | |
82 | |
82 | |
83 | It also is quite fast (see this |
83 | It also is quite fast (see this |
84 | L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent |
84 | L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent |
85 | for example). |
85 | for example). |
86 | |
86 | |
87 | =head1 CONVENTIONS |
87 | =head2 CONVENTIONS |
88 | |
88 | |
89 | Libev is very configurable. In this manual the default configuration will |
89 | Libev is very configurable. In this manual the default configuration will |
90 | be described, which supports multiple event loops. For more info about |
90 | be described, which supports multiple event loops. For more info about |
91 | various configuration options please have a look at B<EMBED> section in |
91 | various configuration options please have a look at B<EMBED> section in |
92 | this manual. If libev was configured without support for multiple event |
92 | this manual. If libev was configured without support for multiple event |
93 | loops, then all functions taking an initial argument of name C<loop> |
93 | loops, then all functions taking an initial argument of name C<loop> |
94 | (which is always of type C<struct ev_loop *>) will not have this argument. |
94 | (which is always of type C<struct ev_loop *>) will not have this argument. |
95 | |
95 | |
96 | =head1 TIME REPRESENTATION |
96 | =head2 TIME REPRESENTATION |
97 | |
97 | |
98 | Libev represents time as a single floating point number, representing the |
98 | Libev represents time as a single floating point number, representing the |
99 | (fractional) number of seconds since the (POSIX) epoch (somewhere near |
99 | (fractional) number of seconds since the (POSIX) epoch (somewhere near |
100 | the beginning of 1970, details are complicated, don't ask). This type is |
100 | the beginning of 1970, details are complicated, don't ask). This type is |
101 | called C<ev_tstamp>, which is what you should use too. It usually aliases |
101 | called C<ev_tstamp>, which is what you should use too. It usually aliases |
… | |
… | |
551 | usually a better approach for this kind of thing. |
551 | usually a better approach for this kind of thing. |
552 | |
552 | |
553 | Here are the gory details of what C<ev_loop> does: |
553 | Here are the gory details of what C<ev_loop> does: |
554 | |
554 | |
555 | - Before the first iteration, call any pending watchers. |
555 | - Before the first iteration, call any pending watchers. |
556 | * If there are no active watchers (reference count is zero), return. |
556 | * If EVFLAG_FORKCHECK was used, check for a fork. |
557 | - Queue all prepare watchers and then call all outstanding watchers. |
557 | - If a fork was detected, queue and call all fork watchers. |
|
|
558 | - Queue and call all prepare watchers. |
558 | - If we have been forked, recreate the kernel state. |
559 | - If we have been forked, recreate the kernel state. |
559 | - Update the kernel state with all outstanding changes. |
560 | - Update the kernel state with all outstanding changes. |
560 | - Update the "event loop time". |
561 | - Update the "event loop time". |
561 | - Calculate for how long to block. |
562 | - Calculate for how long to sleep or block, if at all |
|
|
563 | (active idle watchers, EVLOOP_NONBLOCK or not having |
|
|
564 | any active watchers at all will result in not sleeping). |
|
|
565 | - Sleep if the I/O and timer collect interval say so. |
562 | - Block the process, waiting for any events. |
566 | - Block the process, waiting for any events. |
563 | - Queue all outstanding I/O (fd) events. |
567 | - Queue all outstanding I/O (fd) events. |
564 | - Update the "event loop time" and do time jump handling. |
568 | - Update the "event loop time" and do time jump handling. |
565 | - Queue all outstanding timers. |
569 | - Queue all outstanding timers. |
566 | - Queue all outstanding periodics. |
570 | - Queue all outstanding periodics. |
567 | - If no events are pending now, queue all idle watchers. |
571 | - If no events are pending now, queue all idle watchers. |
568 | - Queue all check watchers. |
572 | - Queue all check watchers. |
569 | - Call all queued watchers in reverse order (i.e. check watchers first). |
573 | - 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 |
574 | Signals and child watchers are implemented as I/O watchers, and will |
571 | be handled here by queueing them when their watcher gets executed. |
575 | be handled here by queueing them when their watcher gets executed. |
572 | - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
576 | - If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
573 | were used, return, otherwise continue with step *. |
577 | were used, or there are no active watchers, return, otherwise |
|
|
578 | continue with step *. |
574 | |
579 | |
575 | Example: Queue some jobs and then loop until no events are outsanding |
580 | Example: Queue some jobs and then loop until no events are outstanding |
576 | anymore. |
581 | anymore. |
577 | |
582 | |
578 | ... queue jobs here, make sure they register event watchers as long |
583 | ... 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..) |
584 | ... as they still have work to do (even an idle watcher will do..) |
580 | ev_loop (my_loop, 0); |
585 | ev_loop (my_loop, 0); |
… | |
… | |
584 | |
589 | |
585 | Can be used to make a call to C<ev_loop> return early (but only after it |
590 | Can be used to make a call to C<ev_loop> return early (but only after it |
586 | has processed all outstanding events). The C<how> argument must be either |
591 | has processed all outstanding events). The C<how> argument must be either |
587 | C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or |
592 | C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or |
588 | C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. |
593 | C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. |
|
|
594 | |
|
|
595 | This "unloop state" will be cleared when entering C<ev_loop> again. |
589 | |
596 | |
590 | =item ev_ref (loop) |
597 | =item ev_ref (loop) |
591 | |
598 | |
592 | =item ev_unref (loop) |
599 | =item ev_unref (loop) |
593 | |
600 | |
… | |
… | |
598 | returning, ev_unref() after starting, and ev_ref() before stopping it. For |
605 | returning, ev_unref() after starting, and ev_ref() before stopping it. For |
599 | example, libev itself uses this for its internal signal pipe: It is not |
606 | example, libev itself uses this for its internal signal pipe: It is not |
600 | visible to the libev user and should not keep C<ev_loop> from exiting if |
607 | visible to the libev user and should not keep C<ev_loop> from exiting if |
601 | no event watchers registered by it are active. It is also an excellent |
608 | no event watchers registered by it are active. It is also an excellent |
602 | way to do this for generic recurring timers or from within third-party |
609 | way to do this for generic recurring timers or from within third-party |
603 | libraries. Just remember to I<unref after start> and I<ref before stop>. |
610 | libraries. Just remember to I<unref after start> and I<ref before stop> |
|
|
611 | (but only if the watcher wasn't active before, or was active before, |
|
|
612 | respectively). |
604 | |
613 | |
605 | Example: Create a signal watcher, but keep it from keeping C<ev_loop> |
614 | Example: Create a signal watcher, but keep it from keeping C<ev_loop> |
606 | running when nothing else is active. |
615 | running when nothing else is active. |
607 | |
616 | |
608 | struct ev_signal exitsig; |
617 | struct ev_signal exitsig; |
… | |
… | |
983 | In general you can register as many read and/or write event watchers per |
992 | In general you can register as many read and/or write event watchers per |
984 | fd as you want (as long as you don't confuse yourself). Setting all file |
993 | fd as you want (as long as you don't confuse yourself). Setting all file |
985 | descriptors to non-blocking mode is also usually a good idea (but not |
994 | descriptors to non-blocking mode is also usually a good idea (but not |
986 | required if you know what you are doing). |
995 | required if you know what you are doing). |
987 | |
996 | |
988 | You have to be careful with dup'ed file descriptors, though. Some backends |
|
|
989 | (the linux epoll backend is a notable example) cannot handle dup'ed file |
|
|
990 | descriptors correctly if you register interest in two or more fds pointing |
|
|
991 | to the same underlying file/socket/etc. description (that is, they share |
|
|
992 | the same underlying "file open"). |
|
|
993 | |
|
|
994 | If you must do this, then force the use of a known-to-be-good backend |
997 | If you must do this, then force the use of a known-to-be-good backend |
995 | (at the time of this writing, this includes only C<EVBACKEND_SELECT> and |
998 | (at the time of this writing, this includes only C<EVBACKEND_SELECT> and |
996 | C<EVBACKEND_POLL>). |
999 | C<EVBACKEND_POLL>). |
997 | |
1000 | |
998 | Another thing you have to watch out for is that it is quite easy to |
1001 | Another thing you have to watch out for is that it is quite easy to |
… | |
… | |
1033 | |
1036 | |
1034 | =head3 The special problem of dup'ed file descriptors |
1037 | =head3 The special problem of dup'ed file descriptors |
1035 | |
1038 | |
1036 | Some backends (e.g. epoll), cannot register events for file descriptors, |
1039 | Some backends (e.g. epoll), cannot register events for file descriptors, |
1037 | but only events for the underlying file descriptions. That means when you |
1040 | but only events for the underlying file descriptions. That means when you |
1038 | have C<dup ()>'ed file descriptors and register events for them, only one |
1041 | have C<dup ()>'ed file descriptors or weirder constellations, and register |
1039 | file descriptor might actually receive events. |
1042 | events for them, only one file descriptor might actually receive events. |
1040 | |
1043 | |
1041 | There is no workaround possible except not registering events |
1044 | There is no workaround possible except not registering events |
1042 | for potentially C<dup ()>'ed file descriptors, or to resort to |
1045 | for potentially C<dup ()>'ed file descriptors, or to resort to |
1043 | C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. |
1046 | C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. |
1044 | |
1047 | |
… | |
… | |
1073 | =item int events [read-only] |
1076 | =item int events [read-only] |
1074 | |
1077 | |
1075 | The events being watched. |
1078 | The events being watched. |
1076 | |
1079 | |
1077 | =back |
1080 | =back |
|
|
1081 | |
|
|
1082 | =head3 Examples |
1078 | |
1083 | |
1079 | Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well |
1084 | Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well |
1080 | readable, but only once. Since it is likely line-buffered, you could |
1085 | readable, but only once. Since it is likely line-buffered, you could |
1081 | attempt to read a whole line in the callback. |
1086 | attempt to read a whole line in the callback. |
1082 | |
1087 | |
… | |
… | |
1180 | or C<ev_timer_again> is called and determines the next timeout (if any), |
1185 | or C<ev_timer_again> is called and determines the next timeout (if any), |
1181 | which is also when any modifications are taken into account. |
1186 | which is also when any modifications are taken into account. |
1182 | |
1187 | |
1183 | =back |
1188 | =back |
1184 | |
1189 | |
|
|
1190 | =head3 Examples |
|
|
1191 | |
1185 | Example: Create a timer that fires after 60 seconds. |
1192 | Example: Create a timer that fires after 60 seconds. |
1186 | |
1193 | |
1187 | static void |
1194 | static void |
1188 | one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1195 | one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1189 | { |
1196 | { |
… | |
… | |
1346 | When active, contains the absolute time that the watcher is supposed to |
1353 | When active, contains the absolute time that the watcher is supposed to |
1347 | trigger next. |
1354 | trigger next. |
1348 | |
1355 | |
1349 | =back |
1356 | =back |
1350 | |
1357 | |
|
|
1358 | =head3 Examples |
|
|
1359 | |
1351 | Example: Call a callback every hour, or, more precisely, whenever the |
1360 | Example: Call a callback every hour, or, more precisely, whenever the |
1352 | system clock is divisible by 3600. The callback invocation times have |
1361 | system clock is divisible by 3600. The callback invocation times have |
1353 | potentially a lot of jittering, but good long-term stability. |
1362 | potentially a lot of jittering, but good long-term stability. |
1354 | |
1363 | |
1355 | static void |
1364 | static void |
… | |
… | |
1446 | |
1455 | |
1447 | The process exit/trace status caused by C<rpid> (see your systems |
1456 | The process exit/trace status caused by C<rpid> (see your systems |
1448 | C<waitpid> and C<sys/wait.h> documentation for details). |
1457 | C<waitpid> and C<sys/wait.h> documentation for details). |
1449 | |
1458 | |
1450 | =back |
1459 | =back |
|
|
1460 | |
|
|
1461 | =head3 Examples |
1451 | |
1462 | |
1452 | Example: Try to exit cleanly on SIGINT and SIGTERM. |
1463 | Example: Try to exit cleanly on SIGINT and SIGTERM. |
1453 | |
1464 | |
1454 | static void |
1465 | static void |
1455 | sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
1466 | sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
… | |
… | |
1496 | semantics of C<ev_stat> watchers, which means that libev sometimes needs |
1507 | semantics of C<ev_stat> watchers, which means that libev sometimes needs |
1497 | to fall back to regular polling again even with inotify, but changes are |
1508 | to fall back to regular polling again even with inotify, but changes are |
1498 | usually detected immediately, and if the file exists there will be no |
1509 | usually detected immediately, and if the file exists there will be no |
1499 | polling. |
1510 | polling. |
1500 | |
1511 | |
|
|
1512 | =head3 Inotify |
|
|
1513 | |
|
|
1514 | When C<inotify (7)> support has been compiled into libev (generally only |
|
|
1515 | available on Linux) and present at runtime, it will be used to speed up |
|
|
1516 | change detection where possible. The inotify descriptor will be created lazily |
|
|
1517 | when the first C<ev_stat> watcher is being started. |
|
|
1518 | |
|
|
1519 | Inotify presense does not change the semantics of C<ev_stat> watchers |
|
|
1520 | except that changes might be detected earlier, and in some cases, to avoid |
|
|
1521 | making regular C<stat> calls. Even in the presense of inotify support |
|
|
1522 | there are many cases where libev has to resort to regular C<stat> polling. |
|
|
1523 | |
|
|
1524 | (There is no support for kqueue, as apparently it cannot be used to |
|
|
1525 | implement this functionality, due to the requirement of having a file |
|
|
1526 | descriptor open on the object at all times). |
|
|
1527 | |
|
|
1528 | =head3 The special problem of stat time resolution |
|
|
1529 | |
|
|
1530 | The C<stat ()> syscall only supports full-second resolution portably, and |
|
|
1531 | even on systems where the resolution is higher, many filesystems still |
|
|
1532 | only support whole seconds. |
|
|
1533 | |
|
|
1534 | That means that, if the time is the only thing that changes, you might |
|
|
1535 | miss updates: on the first update, C<ev_stat> detects a change and calls |
|
|
1536 | your callback, which does something. When there is another update within |
|
|
1537 | the same second, C<ev_stat> will be unable to detect it. |
|
|
1538 | |
|
|
1539 | The solution to this is to delay acting on a change for a second (or till |
|
|
1540 | the next second boundary), using a roughly one-second delay C<ev_timer> |
|
|
1541 | (C<ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)>). The C<.01> |
|
|
1542 | is added to work around small timing inconsistencies of some operating |
|
|
1543 | systems. |
|
|
1544 | |
1501 | =head3 Watcher-Specific Functions and Data Members |
1545 | =head3 Watcher-Specific Functions and Data Members |
1502 | |
1546 | |
1503 | =over 4 |
1547 | =over 4 |
1504 | |
1548 | |
1505 | =item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval) |
1549 | =item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval) |
… | |
… | |
1542 | =item const char *path [read-only] |
1586 | =item const char *path [read-only] |
1543 | |
1587 | |
1544 | The filesystem path that is being watched. |
1588 | The filesystem path that is being watched. |
1545 | |
1589 | |
1546 | =back |
1590 | =back |
|
|
1591 | |
|
|
1592 | =head3 Examples |
1547 | |
1593 | |
1548 | Example: Watch C</etc/passwd> for attribute changes. |
1594 | Example: Watch C</etc/passwd> for attribute changes. |
1549 | |
1595 | |
1550 | static void |
1596 | static void |
1551 | passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) |
1597 | passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) |
… | |
… | |
1564 | } |
1610 | } |
1565 | |
1611 | |
1566 | ... |
1612 | ... |
1567 | ev_stat passwd; |
1613 | ev_stat passwd; |
1568 | |
1614 | |
1569 | ev_stat_init (&passwd, passwd_cb, "/etc/passwd"); |
1615 | ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.); |
1570 | ev_stat_start (loop, &passwd); |
1616 | ev_stat_start (loop, &passwd); |
|
|
1617 | |
|
|
1618 | Example: Like above, but additionally use a one-second delay so we do not |
|
|
1619 | miss updates (however, frequent updates will delay processing, too, so |
|
|
1620 | one might do the work both on C<ev_stat> callback invocation I<and> on |
|
|
1621 | C<ev_timer> callback invocation). |
|
|
1622 | |
|
|
1623 | static ev_stat passwd; |
|
|
1624 | static ev_timer timer; |
|
|
1625 | |
|
|
1626 | static void |
|
|
1627 | timer_cb (EV_P_ ev_timer *w, int revents) |
|
|
1628 | { |
|
|
1629 | ev_timer_stop (EV_A_ w); |
|
|
1630 | |
|
|
1631 | /* now it's one second after the most recent passwd change */ |
|
|
1632 | } |
|
|
1633 | |
|
|
1634 | static void |
|
|
1635 | stat_cb (EV_P_ ev_stat *w, int revents) |
|
|
1636 | { |
|
|
1637 | /* reset the one-second timer */ |
|
|
1638 | ev_timer_again (EV_A_ &timer); |
|
|
1639 | } |
|
|
1640 | |
|
|
1641 | ... |
|
|
1642 | ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.); |
|
|
1643 | ev_stat_start (loop, &passwd); |
|
|
1644 | ev_timer_init (&timer, timer_cb, 0., 1.01); |
1571 | |
1645 | |
1572 | |
1646 | |
1573 | =head2 C<ev_idle> - when you've got nothing better to do... |
1647 | =head2 C<ev_idle> - when you've got nothing better to do... |
1574 | |
1648 | |
1575 | Idle watchers trigger events when no other events of the same or higher |
1649 | Idle watchers trigger events when no other events of the same or higher |
… | |
… | |
1600 | Initialises and configures the idle watcher - it has no parameters of any |
1674 | Initialises and configures the idle watcher - it has no parameters of any |
1601 | kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, |
1675 | kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, |
1602 | believe me. |
1676 | believe me. |
1603 | |
1677 | |
1604 | =back |
1678 | =back |
|
|
1679 | |
|
|
1680 | =head3 Examples |
1605 | |
1681 | |
1606 | Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the |
1682 | Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the |
1607 | callback, free it. Also, use no error checking, as usual. |
1683 | callback, free it. Also, use no error checking, as usual. |
1608 | |
1684 | |
1609 | static void |
1685 | static void |
… | |
… | |
1681 | parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> |
1757 | parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> |
1682 | macros, but using them is utterly, utterly and completely pointless. |
1758 | macros, but using them is utterly, utterly and completely pointless. |
1683 | |
1759 | |
1684 | =back |
1760 | =back |
1685 | |
1761 | |
|
|
1762 | =head3 Examples |
|
|
1763 | |
1686 | There are a number of principal ways to embed other event loops or modules |
1764 | There are a number of principal ways to embed other event loops or modules |
1687 | into libev. Here are some ideas on how to include libadns into libev |
1765 | into libev. Here are some ideas on how to include libadns into libev |
1688 | (there is a Perl module named C<EV::ADNS> that does this, which you could |
1766 | (there is a Perl module named C<EV::ADNS> that does this, which you could |
1689 | use for an actually working example. Another Perl module named C<EV::Glib> |
1767 | use for an actually working example. Another Perl module named C<EV::Glib> |
1690 | embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV |
1768 | embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV |
… | |
… | |
1858 | portable one. |
1936 | portable one. |
1859 | |
1937 | |
1860 | So when you want to use this feature you will always have to be prepared |
1938 | So when you want to use this feature you will always have to be prepared |
1861 | that you cannot get an embeddable loop. The recommended way to get around |
1939 | that you cannot get an embeddable loop. The recommended way to get around |
1862 | this is to have a separate variables for your embeddable loop, try to |
1940 | this is to have a separate variables for your embeddable loop, try to |
1863 | create it, and if that fails, use the normal loop for everything: |
1941 | create it, and if that fails, use the normal loop for everything. |
|
|
1942 | |
|
|
1943 | =head3 Watcher-Specific Functions and Data Members |
|
|
1944 | |
|
|
1945 | =over 4 |
|
|
1946 | |
|
|
1947 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
|
|
1948 | |
|
|
1949 | =item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) |
|
|
1950 | |
|
|
1951 | Configures the watcher to embed the given loop, which must be |
|
|
1952 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
|
|
1953 | invoked automatically, otherwise it is the responsibility of the callback |
|
|
1954 | to invoke it (it will continue to be called until the sweep has been done, |
|
|
1955 | if you do not want thta, you need to temporarily stop the embed watcher). |
|
|
1956 | |
|
|
1957 | =item ev_embed_sweep (loop, ev_embed *) |
|
|
1958 | |
|
|
1959 | Make a single, non-blocking sweep over the embedded loop. This works |
|
|
1960 | similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most |
|
|
1961 | apropriate way for embedded loops. |
|
|
1962 | |
|
|
1963 | =item struct ev_loop *other [read-only] |
|
|
1964 | |
|
|
1965 | The embedded event loop. |
|
|
1966 | |
|
|
1967 | =back |
|
|
1968 | |
|
|
1969 | =head3 Examples |
|
|
1970 | |
|
|
1971 | Example: Try to get an embeddable event loop and embed it into the default |
|
|
1972 | event loop. If that is not possible, use the default loop. The default |
|
|
1973 | loop is stored in C<loop_hi>, while the mebeddable loop is stored in |
|
|
1974 | C<loop_lo> (which is C<loop_hi> in the acse no embeddable loop can be |
|
|
1975 | used). |
1864 | |
1976 | |
1865 | struct ev_loop *loop_hi = ev_default_init (0); |
1977 | struct ev_loop *loop_hi = ev_default_init (0); |
1866 | struct ev_loop *loop_lo = 0; |
1978 | struct ev_loop *loop_lo = 0; |
1867 | struct ev_embed embed; |
1979 | struct ev_embed embed; |
1868 | |
1980 | |
… | |
… | |
1879 | ev_embed_start (loop_hi, &embed); |
1991 | ev_embed_start (loop_hi, &embed); |
1880 | } |
1992 | } |
1881 | else |
1993 | else |
1882 | loop_lo = loop_hi; |
1994 | loop_lo = loop_hi; |
1883 | |
1995 | |
1884 | =head3 Watcher-Specific Functions and Data Members |
1996 | Example: Check if kqueue is available but not recommended and create |
|
|
1997 | a kqueue backend for use with sockets (which usually work with any |
|
|
1998 | kqueue implementation). Store the kqueue/socket-only event loop in |
|
|
1999 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
1885 | |
2000 | |
1886 | =over 4 |
2001 | struct ev_loop *loop = ev_default_init (0); |
|
|
2002 | struct ev_loop *loop_socket = 0; |
|
|
2003 | struct ev_embed embed; |
|
|
2004 | |
|
|
2005 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
|
|
2006 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
|
|
2007 | { |
|
|
2008 | ev_embed_init (&embed, 0, loop_socket); |
|
|
2009 | ev_embed_start (loop, &embed); |
|
|
2010 | } |
1887 | |
2011 | |
1888 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
2012 | if (!loop_socket) |
|
|
2013 | loop_socket = loop; |
1889 | |
2014 | |
1890 | =item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) |
2015 | // now use loop_socket for all sockets, and loop for everything else |
1891 | |
|
|
1892 | Configures the watcher to embed the given loop, which must be |
|
|
1893 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
|
|
1894 | invoked automatically, otherwise it is the responsibility of the callback |
|
|
1895 | to invoke it (it will continue to be called until the sweep has been done, |
|
|
1896 | if you do not want thta, you need to temporarily stop the embed watcher). |
|
|
1897 | |
|
|
1898 | =item ev_embed_sweep (loop, ev_embed *) |
|
|
1899 | |
|
|
1900 | Make a single, non-blocking sweep over the embedded loop. This works |
|
|
1901 | similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most |
|
|
1902 | apropriate way for embedded loops. |
|
|
1903 | |
|
|
1904 | =item struct ev_loop *other [read-only] |
|
|
1905 | |
|
|
1906 | The embedded event loop. |
|
|
1907 | |
|
|
1908 | =back |
|
|
1909 | |
2016 | |
1910 | |
2017 | |
1911 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
2018 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
1912 | |
2019 | |
1913 | Fork watchers are called when a C<fork ()> was detected (usually because |
2020 | Fork watchers are called when a C<fork ()> was detected (usually because |
… | |
… | |
2392 | wants osf handles on win32 (this is the case when the select to |
2499 | wants osf handles on win32 (this is the case when the select to |
2393 | be used is the winsock select). This means that it will call |
2500 | be used is the winsock select). This means that it will call |
2394 | C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, |
2501 | C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, |
2395 | it is assumed that all these functions actually work on fds, even |
2502 | it is assumed that all these functions actually work on fds, even |
2396 | on win32. Should not be defined on non-win32 platforms. |
2503 | on win32. Should not be defined on non-win32 platforms. |
|
|
2504 | |
|
|
2505 | =item EV_FD_TO_WIN32_HANDLE |
|
|
2506 | |
|
|
2507 | If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map |
|
|
2508 | file descriptors to socket handles. When not defining this symbol (the |
|
|
2509 | default), then libev will call C<_get_osfhandle>, which is usually |
|
|
2510 | correct. In some cases, programs use their own file descriptor management, |
|
|
2511 | in which case they can provide this function to map fds to socket handles. |
2397 | |
2512 | |
2398 | =item EV_USE_POLL |
2513 | =item EV_USE_POLL |
2399 | |
2514 | |
2400 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
2515 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
2401 | backend. Otherwise it will be enabled on non-win32 platforms. It |
2516 | backend. Otherwise it will be enabled on non-win32 platforms. It |
… | |
… | |
2438 | be detected at runtime. |
2553 | be detected at runtime. |
2439 | |
2554 | |
2440 | =item EV_H |
2555 | =item EV_H |
2441 | |
2556 | |
2442 | The name of the F<ev.h> header file used to include it. The default if |
2557 | The name of the F<ev.h> header file used to include it. The default if |
2443 | undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This |
2558 | undefined is C<"ev.h"> in F<event.h> and F<ev.c>. This can be used to |
2444 | can be used to virtually rename the F<ev.h> header file in case of conflicts. |
2559 | virtually rename the F<ev.h> header file in case of conflicts. |
2445 | |
2560 | |
2446 | =item EV_CONFIG_H |
2561 | =item EV_CONFIG_H |
2447 | |
2562 | |
2448 | If C<EV_STANDALONE> isn't C<1>, this variable can be used to override |
2563 | If C<EV_STANDALONE> isn't C<1>, this variable can be used to override |
2449 | F<ev.c>'s idea of where to find the F<config.h> file, similarly to |
2564 | F<ev.c>'s idea of where to find the F<config.h> file, similarly to |
2450 | C<EV_H>, above. |
2565 | C<EV_H>, above. |
2451 | |
2566 | |
2452 | =item EV_EVENT_H |
2567 | =item EV_EVENT_H |
2453 | |
2568 | |
2454 | Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea |
2569 | Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea |
2455 | of how the F<event.h> header can be found. |
2570 | of how the F<event.h> header can be found, the dfeault is C<"event.h">. |
2456 | |
2571 | |
2457 | =item EV_PROTOTYPES |
2572 | =item EV_PROTOTYPES |
2458 | |
2573 | |
2459 | If defined to be C<0>, then F<ev.h> will not define any function |
2574 | If defined to be C<0>, then F<ev.h> will not define any function |
2460 | prototypes, but still define all the structs and other symbols. This is |
2575 | prototypes, but still define all the structs and other symbols. This is |
… | |
… | |
2526 | than enough. If you need to manage thousands of children you might want to |
2641 | than enough. If you need to manage thousands of children you might want to |
2527 | increase this value (I<must> be a power of two). |
2642 | increase this value (I<must> be a power of two). |
2528 | |
2643 | |
2529 | =item EV_INOTIFY_HASHSIZE |
2644 | =item EV_INOTIFY_HASHSIZE |
2530 | |
2645 | |
2531 | C<ev_staz> watchers use a small hash table to distribute workload by |
2646 | C<ev_stat> watchers use a small hash table to distribute workload by |
2532 | inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>), |
2647 | inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>), |
2533 | usually more than enough. If you need to manage thousands of C<ev_stat> |
2648 | usually more than enough. If you need to manage thousands of C<ev_stat> |
2534 | watchers you might want to increase this value (I<must> be a power of |
2649 | watchers you might want to increase this value (I<must> be a power of |
2535 | two). |
2650 | two). |
2536 | |
2651 | |
… | |
… | |
2632 | |
2747 | |
2633 | =item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) |
2748 | =item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) |
2634 | |
2749 | |
2635 | This means that, when you have a watcher that triggers in one hour and |
2750 | This means that, when you have a watcher that triggers in one hour and |
2636 | there are 100 watchers that would trigger before that then inserting will |
2751 | there are 100 watchers that would trigger before that then inserting will |
2637 | have to skip those 100 watchers. |
2752 | have to skip roughly seven (C<ld 100>) of these watchers. |
2638 | |
2753 | |
2639 | =item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers) |
2754 | =item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers) |
2640 | |
2755 | |
2641 | That means that for changing a timer costs less than removing/adding them |
2756 | That means that changing a timer costs less than removing/adding them |
2642 | as only the relative motion in the event queue has to be paid for. |
2757 | as only the relative motion in the event queue has to be paid for. |
2643 | |
2758 | |
2644 | =item Starting io/check/prepare/idle/signal/child watchers: O(1) |
2759 | =item Starting io/check/prepare/idle/signal/child watchers: O(1) |
2645 | |
2760 | |
2646 | These just add the watcher into an array or at the head of a list. |
2761 | These just add the watcher into an array or at the head of a list. |
|
|
2762 | |
2647 | =item Stopping check/prepare/idle watchers: O(1) |
2763 | =item Stopping check/prepare/idle watchers: O(1) |
2648 | |
2764 | |
2649 | =item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) |
2765 | =item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) |
2650 | |
2766 | |
2651 | These watchers are stored in lists then need to be walked to find the |
2767 | These watchers are stored in lists then need to be walked to find the |
2652 | correct watcher to remove. The lists are usually short (you don't usually |
2768 | correct watcher to remove. The lists are usually short (you don't usually |
2653 | have many watchers waiting for the same fd or signal). |
2769 | have many watchers waiting for the same fd or signal). |
2654 | |
2770 | |
2655 | =item Finding the next timer per loop iteration: O(1) |
2771 | =item Finding the next timer in each loop iteration: O(1) |
|
|
2772 | |
|
|
2773 | By virtue of using a binary heap, the next timer is always found at the |
|
|
2774 | beginning of the storage array. |
2656 | |
2775 | |
2657 | =item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) |
2776 | =item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) |
2658 | |
2777 | |
2659 | A change means an I/O watcher gets started or stopped, which requires |
2778 | A change means an I/O watcher gets started or stopped, which requires |
2660 | libev to recalculate its status (and possibly tell the kernel). |
2779 | libev to recalculate its status (and possibly tell the kernel, depending |
|
|
2780 | on backend and wether C<ev_io_set> was used). |
2661 | |
2781 | |
2662 | =item Activating one watcher: O(1) |
2782 | =item Activating one watcher (putting it into the pending state): O(1) |
2663 | |
2783 | |
2664 | =item Priority handling: O(number_of_priorities) |
2784 | =item Priority handling: O(number_of_priorities) |
2665 | |
2785 | |
2666 | Priorities are implemented by allocating some space for each |
2786 | Priorities are implemented by allocating some space for each |
2667 | priority. When doing priority-based operations, libev usually has to |
2787 | priority. When doing priority-based operations, libev usually has to |
2668 | linearly search all the priorities. |
2788 | linearly search all the priorities, but starting/stopping and activating |
|
|
2789 | watchers becomes O(1) w.r.t. prioritiy handling. |
2669 | |
2790 | |
2670 | =back |
2791 | =back |
2671 | |
2792 | |
2672 | |
2793 | |
|
|
2794 | =head1 Win32 platform limitations and workarounds |
|
|
2795 | |
|
|
2796 | Win32 doesn't support any of the standards (e.g. POSIX) that libev |
|
|
2797 | requires, and its I/O model is fundamentally incompatible with the POSIX |
|
|
2798 | model. Libev still offers limited functionality on this platform in |
|
|
2799 | the form of the C<EVBACKEND_SELECT> backend, and only supports socket |
|
|
2800 | descriptors. This only applies when using Win32 natively, not when using |
|
|
2801 | e.g. cygwin. |
|
|
2802 | |
|
|
2803 | There is no supported compilation method available on windows except |
|
|
2804 | embedding it into other applications. |
|
|
2805 | |
|
|
2806 | Due to the many, low, and arbitrary limits on the win32 platform and the |
|
|
2807 | abysmal performance of winsockets, using a large number of sockets is not |
|
|
2808 | recommended (and not reasonable). If your program needs to use more than |
|
|
2809 | a hundred or so sockets, then likely it needs to use a totally different |
|
|
2810 | implementation for windows, as libev offers the POSIX model, which cannot |
|
|
2811 | be implemented efficiently on windows (microsoft monopoly games). |
|
|
2812 | |
|
|
2813 | =over 4 |
|
|
2814 | |
|
|
2815 | =item The winsocket select function |
|
|
2816 | |
|
|
2817 | The winsocket C<select> function doesn't follow POSIX in that it requires |
|
|
2818 | socket I<handles> and not socket I<file descriptors>. This makes select |
|
|
2819 | very inefficient, and also requires a mapping from file descriptors |
|
|
2820 | to socket handles. See the discussion of the C<EV_SELECT_USE_FD_SET>, |
|
|
2821 | C<EV_SELECT_IS_WINSOCKET> and C<EV_FD_TO_WIN32_HANDLE> preprocessor |
|
|
2822 | symbols for more info. |
|
|
2823 | |
|
|
2824 | The configuration for a "naked" win32 using the microsoft runtime |
|
|
2825 | libraries and raw winsocket select is: |
|
|
2826 | |
|
|
2827 | #define EV_USE_SELECT 1 |
|
|
2828 | #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ |
|
|
2829 | |
|
|
2830 | Note that winsockets handling of fd sets is O(n), so you can easily get a |
|
|
2831 | complexity in the O(n²) range when using win32. |
|
|
2832 | |
|
|
2833 | =item Limited number of file descriptors |
|
|
2834 | |
|
|
2835 | Windows has numerous arbitrary (and low) limits on things. Early versions |
|
|
2836 | of winsocket's select only supported waiting for a max. of C<64> handles |
|
|
2837 | (probably owning to the fact that all windows kernels can only wait for |
|
|
2838 | C<64> things at the same time internally; microsoft recommends spawning a |
|
|
2839 | chain of threads and wait for 63 handles and the previous thread in each). |
|
|
2840 | |
|
|
2841 | Newer versions support more handles, but you need to define C<FD_SETSIZE> |
|
|
2842 | to some high number (e.g. C<2048>) before compiling the winsocket select |
|
|
2843 | call (which might be in libev or elsewhere, for example, perl does its own |
|
|
2844 | select emulation on windows). |
|
|
2845 | |
|
|
2846 | Another limit is the number of file descriptors in the microsoft runtime |
|
|
2847 | libraries, which by default is C<64> (there must be a hidden I<64> fetish |
|
|
2848 | or something like this inside microsoft). You can increase this by calling |
|
|
2849 | C<_setmaxstdio>, which can increase this limit to C<2048> (another |
|
|
2850 | arbitrary limit), but is broken in many versions of the microsoft runtime |
|
|
2851 | libraries. |
|
|
2852 | |
|
|
2853 | This might get you to about C<512> or C<2048> sockets (depending on |
|
|
2854 | windows version and/or the phase of the moon). To get more, you need to |
|
|
2855 | wrap all I/O functions and provide your own fd management, but the cost of |
|
|
2856 | calling select (O(n²)) will likely make this unworkable. |
|
|
2857 | |
|
|
2858 | =back |
|
|
2859 | |
|
|
2860 | |
2673 | =head1 AUTHOR |
2861 | =head1 AUTHOR |
2674 | |
2862 | |
2675 | Marc Lehmann <libev@schmorp.de>. |
2863 | Marc Lehmann <libev@schmorp.de>. |
2676 | |
2864 | |