… | |
… | |
41 | EV::loop EV::LOOP_ONSHOT; |
41 | EV::loop EV::LOOP_ONSHOT; |
42 | |
42 | |
43 | =head1 DESCRIPTION |
43 | =head1 DESCRIPTION |
44 | |
44 | |
45 | This module provides an interface to libevent |
45 | This module provides an interface to libevent |
46 | (L<http://monkey.org/~provos/libevent/>). |
46 | (L<http://monkey.org/~provos/libevent/>). You probably should acquaint |
|
|
47 | yourself with its documentation and source code to be able to use this |
|
|
48 | module fully. |
|
|
49 | |
|
|
50 | Please note thta this module disables the libevent EPOLL method by |
|
|
51 | default, see BUGS, below, if you need to enable it. |
47 | |
52 | |
48 | =cut |
53 | =cut |
49 | |
54 | |
50 | package EV; |
55 | package EV; |
51 | |
56 | |
… | |
… | |
55 | our $VERSION = '0.01'; |
60 | our $VERSION = '0.01'; |
56 | use XSLoader; |
61 | use XSLoader; |
57 | XSLoader::load "EV", $VERSION; |
62 | XSLoader::load "EV", $VERSION; |
58 | } |
63 | } |
59 | |
64 | |
60 | =head1 FUNCTIONAL INTERFACE |
65 | =head1 BASIC INTERFACE |
61 | |
66 | |
62 | =over 4 |
67 | =over 4 |
63 | |
68 | |
64 | =item $EV::NPRI |
69 | =item $EV::NPRI |
65 | |
70 | |
66 | How many priority levels are available. |
71 | How many priority levels are available. |
|
|
72 | |
|
|
73 | =item $EV::DIED |
|
|
74 | |
|
|
75 | Must contain a reference to a function that is called when a callback |
|
|
76 | throws an exception (with $@ containing thr error). The default prints an |
|
|
77 | informative message and continues. |
|
|
78 | |
|
|
79 | If this callback throws an exception it will be silently ignored. |
67 | |
80 | |
68 | =item $time = EV::now |
81 | =item $time = EV::now |
69 | |
82 | |
70 | Returns the time in (fractional) seconds since the epoch. |
83 | Returns the time in (fractional) seconds since the epoch. |
71 | |
84 | |
… | |
… | |
96 | |
109 | |
97 | As long as the returned watcher object is alive, call the C<$callback> |
110 | As long as the returned watcher object is alive, call the C<$callback> |
98 | when the events specified in C<$eventmask> happen. Initially, the timeout |
111 | when the events specified in C<$eventmask> happen. Initially, the timeout |
99 | is disabled. |
112 | is disabled. |
100 | |
113 | |
101 | The C<io_ns> variant doesn't add/start the newly created watcher. |
114 | Youc an additionall set a timeout to occur on the watcher, but note that |
|
|
115 | this timeout will not be reset when you get an I/O event in the EV::PERSIST |
|
|
116 | case, and reaching a timeout will always stop the watcher even in the |
|
|
117 | EV::PERSIST case. |
|
|
118 | |
|
|
119 | If you want a timeout to occur only after a specific time of inactivity, set |
|
|
120 | a repeating timeout and do NOT use EV::PERSIST. |
102 | |
121 | |
103 | Eventmask can be one or more of these constants ORed together: |
122 | Eventmask can be one or more of these constants ORed together: |
104 | |
123 | |
105 | EV::READ wait until read() wouldn't block anymore |
124 | EV::READ wait until read() wouldn't block anymore |
106 | EV::WRITE wait until write() wouldn't block anymore |
125 | EV::WRITE wait until write() wouldn't block anymore |
107 | EV::PERSIST stay active after an event occured |
126 | EV::PERSIST stay active after a (non-timeout) event occured |
|
|
127 | |
|
|
128 | The C<io_ns> variant doesn't add/start the newly created watcher. |
108 | |
129 | |
109 | =item my $w = EV::timer $after, $repeat, $callback |
130 | =item my $w = EV::timer $after, $repeat, $callback |
110 | |
131 | |
111 | =item my $w = EV::timer_ns $after, $repeat, $callback |
132 | =item my $w = EV::timer_ns $after, $repeat, $callback |
112 | |
133 | |
… | |
… | |
133 | |
154 | |
134 | This can be used to schedule a callback to run at very regular intervals, |
155 | This can be used to schedule a callback to run at very regular intervals, |
135 | as long as the processing time is less then the interval (otherwise |
156 | as long as the processing time is less then the interval (otherwise |
136 | obviously events will be skipped). |
157 | obviously events will be skipped). |
137 | |
158 | |
|
|
159 | Another way to think about it (for the mathematically inclined) is that |
|
|
160 | C<timer_abs> will try to tun the callback at the next possible time where |
|
|
161 | C<$time = $at (mod $interval)>, regardless of any time jumps. |
|
|
162 | |
138 | The C<timer_abs_ns> variant doesn't add/start the newly created watcher. |
163 | The C<timer_abs_ns> variant doesn't add/start the newly created watcher. |
139 | |
164 | |
140 | =item my $w = EV::signal $signum, $callback |
165 | =item my $w = EV::signal $signum, $callback |
141 | |
166 | |
142 | =item my $w = EV::signal_ns $signum, $callback |
167 | =item my $w = EV::signal_ns $signum, $callback |
… | |
… | |
204 | =head1 BUGS |
229 | =head1 BUGS |
205 | |
230 | |
206 | Lots. Libevent itself isn't well tested and rather buggy, and this module |
231 | Lots. Libevent itself isn't well tested and rather buggy, and this module |
207 | is quite new at the moment. |
232 | is quite new at the moment. |
208 | |
233 | |
|
|
234 | Please note that the epoll method is not, in general, reliable in programs |
|
|
235 | that use fork (even if no libveent calls are being made in the forked |
|
|
236 | process). If your program behaves erratically, try setting the environment |
|
|
237 | variable C<EVENT_NOEPOLL> first when running the program. |
|
|
238 | |
|
|
239 | In general, if you fork, then you can only use the EV module in one of the |
|
|
240 | children. |
|
|
241 | |
209 | =cut |
242 | =cut |
|
|
243 | |
|
|
244 | our $DIED = sub { |
|
|
245 | warn "EV: error in callback (ignoring): $@"; |
|
|
246 | }; |
210 | |
247 | |
211 | our $NPRI = 4; |
248 | our $NPRI = 4; |
212 | our $BASE = init; |
249 | our $BASE = init; |
213 | priority_init $NPRI; |
250 | priority_init $NPRI; |
214 | |
251 | |
… | |
… | |
217 | 1; |
254 | 1; |
218 | |
255 | |
219 | =head1 SEE ALSO |
256 | =head1 SEE ALSO |
220 | |
257 | |
221 | L<EV::DNS>, L<event(3)>, L<event.h>, L<evdns.h>. |
258 | L<EV::DNS>, L<event(3)>, L<event.h>, L<evdns.h>. |
|
|
259 | L<EV::AnyEvent>. |
222 | |
260 | |
223 | =head1 AUTHOR |
261 | =head1 AUTHOR |
224 | |
262 | |
225 | Marc Lehmann <schmorp@schmorp.de> |
263 | Marc Lehmann <schmorp@schmorp.de> |
226 | http://home.schmorp.de/ |
264 | http://home.schmorp.de/ |