| … | |
… | |
| 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 |
