… | |
… | |
2 | |
2 | |
3 | no warnings; |
3 | no warnings; |
4 | use strict; |
4 | use strict; |
5 | |
5 | |
6 | use AnyEvent (); |
6 | use AnyEvent (); |
7 | use AnyEvent::Util (); |
7 | use AnyEvent::Util qw(WSAWOULDBLOCK); |
8 | use Scalar::Util (); |
8 | use Scalar::Util (); |
9 | use Carp (); |
9 | use Carp (); |
10 | use Fcntl (); |
10 | use Fcntl (); |
11 | use Errno qw/EAGAIN EINTR/; |
11 | use Errno qw/EAGAIN EINTR/; |
12 | |
12 | |
13 | =head1 NAME |
13 | =head1 NAME |
14 | |
14 | |
15 | AnyEvent::Handle - non-blocking I/O on filehandles via AnyEvent |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
16 | |
16 | |
17 | =cut |
17 | =cut |
18 | |
18 | |
19 | our $VERSION = '0.02'; |
19 | our $VERSION = '0.04'; |
20 | |
20 | |
21 | =head1 SYNOPSIS |
21 | =head1 SYNOPSIS |
22 | |
22 | |
23 | use AnyEvent; |
23 | use AnyEvent; |
24 | use AnyEvent::Handle; |
24 | use AnyEvent::Handle; |
25 | |
25 | |
26 | my $cv = AnyEvent->condvar; |
26 | my $cv = AnyEvent->condvar; |
27 | |
27 | |
28 | my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN); |
28 | my $handle = |
29 | |
|
|
30 | #TODO |
|
|
31 | |
|
|
32 | # or use the constructor to pass the callback: |
|
|
33 | |
|
|
34 | my $ae_fh2 = |
|
|
35 | AnyEvent::Handle->new ( |
29 | AnyEvent::Handle->new ( |
36 | fh => \*STDIN, |
30 | fh => \*STDIN, |
37 | on_eof => sub { |
31 | on_eof => sub { |
38 | $cv->broadcast; |
32 | $cv->broadcast; |
39 | }, |
33 | }, |
40 | #TODO |
|
|
41 | ); |
34 | ); |
42 | |
35 | |
43 | $cv->wait; |
36 | # send some request line |
|
|
37 | $handle->push_write ("getinfo\015\012"); |
|
|
38 | |
|
|
39 | # read the response line |
|
|
40 | $handle->push_read (line => sub { |
|
|
41 | my ($handle, $line) = @_; |
|
|
42 | warn "read line <$line>\n"; |
|
|
43 | $cv->send; |
|
|
44 | }); |
|
|
45 | |
|
|
46 | $cv->recv; |
44 | |
47 | |
45 | =head1 DESCRIPTION |
48 | =head1 DESCRIPTION |
46 | |
49 | |
47 | This module is a helper module to make it easier to do event-based I/O on |
50 | This module is a helper module to make it easier to do event-based I/O on |
48 | filehandles (and sockets, see L<AnyEvent::Socket> for an easy way to make |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
49 | non-blocking resolves and connects). |
52 | on sockets see L<AnyEvent::Util>. |
50 | |
53 | |
51 | In the following, when the documentation refers to of "bytes" then this |
54 | In the following, when the documentation refers to of "bytes" then this |
52 | means characters. As sysread and syswrite are used for all I/O, their |
55 | means characters. As sysread and syswrite are used for all I/O, their |
53 | treatment of characters applies to this module as well. |
56 | treatment of characters applies to this module as well. |
54 | |
57 | |
… | |
… | |
70 | The filehandle this L<AnyEvent::Handle> object will operate on. |
73 | The filehandle this L<AnyEvent::Handle> object will operate on. |
71 | |
74 | |
72 | NOTE: The filehandle will be set to non-blocking (using |
75 | NOTE: The filehandle will be set to non-blocking (using |
73 | AnyEvent::Util::fh_nonblocking). |
76 | AnyEvent::Util::fh_nonblocking). |
74 | |
77 | |
|
|
78 | =item on_eof => $cb->($self) |
|
|
79 | |
|
|
80 | Set the callback to be called on EOF. |
|
|
81 | |
|
|
82 | While not mandatory, it is highly recommended to set an eof callback, |
|
|
83 | otherwise you might end up with a closed socket while you are still |
|
|
84 | waiting for data. |
|
|
85 | |
75 | =item on_error => $cb->($self) [MANDATORY] |
86 | =item on_error => $cb->($self) |
76 | |
87 | |
77 | This is the fatal error callback, that is called when a fatal error ocurs, |
88 | This is the fatal error callback, that is called when, well, a fatal error |
78 | such as not being able to resolve the hostname, failure to connect or a |
89 | occurs, such as not being able to resolve the hostname, failure to connect |
79 | read error. |
90 | or a read error. |
80 | |
91 | |
81 | The object will not be in a usable state when this callback has been |
92 | The object will not be in a usable state when this callback has been |
82 | called. |
93 | called. |
83 | |
94 | |
84 | On callback entrance, the value of C<$!> contains the opertaing system |
95 | On callback entrance, the value of C<$!> contains the operating system |
85 | error (or C<ENOSPC> or C<EPIPE>). |
96 | error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>). |
86 | |
97 | |
87 | =item on_eof => $cb->($self) [MANDATORY] |
98 | The callback should throw an exception. If it returns, then |
|
|
99 | AnyEvent::Handle will C<croak> for you. |
88 | |
100 | |
89 | Set the callback to be called on EOF. |
101 | While not mandatory, it is I<highly> recommended to set this callback, as |
|
|
102 | you will not be notified of errors otherwise. The default simply calls |
|
|
103 | die. |
90 | |
104 | |
91 | =item on_read => $cb->($self) |
105 | =item on_read => $cb->($self) |
92 | |
106 | |
93 | This sets the default read callback, which is called when data arrives |
107 | This sets the default read callback, which is called when data arrives |
94 | and no read request is in the queue. If the read callback is C<undef> |
108 | and no read request is in the queue. |
95 | or has never been set, than AnyEvent::Handle will cease reading from the |
|
|
96 | filehandle. |
|
|
97 | |
109 | |
98 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
110 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
99 | method or acces sthe C<$self->{rbuf}> member directly. |
111 | method or access the C<$self->{rbuf}> member directly. |
100 | |
112 | |
101 | When an EOF condition is detected then AnyEvent::Handle will first try to |
113 | When an EOF condition is detected then AnyEvent::Handle will first try to |
102 | feed all the remaining data to the queued callbacks and C<on_read> before |
114 | feed all the remaining data to the queued callbacks and C<on_read> before |
103 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
115 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
104 | error will be raised (with C<$!> set to C<EPIPE>). |
116 | error will be raised (with C<$!> set to C<EPIPE>). |
… | |
… | |
131 | |
143 | |
132 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
144 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
133 | buffer: If the write reaches this size or gets even samller it is |
145 | buffer: If the write reaches this size or gets even samller it is |
134 | considered empty. |
146 | considered empty. |
135 | |
147 | |
|
|
148 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
|
|
149 | |
|
|
150 | When this parameter is given, it enables TLS (SSL) mode, that means it |
|
|
151 | will start making tls handshake and will transparently encrypt/decrypt |
|
|
152 | data. |
|
|
153 | |
|
|
154 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
|
|
155 | automatically when you try to create a TLS handle). |
|
|
156 | |
|
|
157 | For the TLS server side, use C<accept>, and for the TLS client side of a |
|
|
158 | connection, use C<connect> mode. |
|
|
159 | |
|
|
160 | You can also provide your own TLS connection object, but you have |
|
|
161 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
|
|
162 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
|
|
163 | AnyEvent::Handle. |
|
|
164 | |
|
|
165 | See the C<starttls> method if you need to start TLs negotiation later. |
|
|
166 | |
|
|
167 | =item tls_ctx => $ssl_ctx |
|
|
168 | |
|
|
169 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
|
|
170 | (unless a connection object was specified directly). If this parameter is |
|
|
171 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
|
|
172 | |
|
|
173 | =item filter_r => $cb |
|
|
174 | |
|
|
175 | =item filter_w => $cb |
|
|
176 | |
|
|
177 | These exist, but are undocumented at this time. |
|
|
178 | |
136 | =back |
179 | =back |
137 | |
180 | |
138 | =cut |
181 | =cut |
139 | |
182 | |
140 | sub new { |
183 | sub new { |
… | |
… | |
144 | |
187 | |
145 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
188 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
146 | |
189 | |
147 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
190 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
148 | |
191 | |
149 | $self->on_error ((delete $self->{on_error}) or Carp::croak "mandatory argument on_error is missing"); |
192 | if ($self->{tls}) { |
150 | $self->on_eof ((delete $self->{on_eof} ) or Carp::croak "mandatory argument on_eof is missing"); |
193 | require Net::SSLeay; |
|
|
194 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
|
|
195 | } |
151 | |
196 | |
|
|
197 | $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; |
|
|
198 | $self->on_error (delete $self->{on_error}) if $self->{on_error}; |
152 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
199 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
153 | $self->on_read (delete $self->{on_read} ) if $self->{on_read}; |
200 | $self->on_read (delete $self->{on_read} ) if $self->{on_read}; |
154 | |
201 | |
|
|
202 | $self->start_read; |
|
|
203 | |
155 | $self |
204 | $self |
156 | } |
205 | } |
157 | |
206 | |
158 | sub _shutdown { |
207 | sub _shutdown { |
159 | my ($self) = @_; |
208 | my ($self) = @_; |
160 | |
209 | |
161 | delete $self->{rw}; |
210 | delete $self->{_rw}; |
162 | delete $self->{ww}; |
211 | delete $self->{_ww}; |
163 | delete $self->{fh}; |
212 | delete $self->{fh}; |
164 | } |
213 | } |
165 | |
214 | |
166 | sub error { |
215 | sub error { |
167 | my ($self) = @_; |
216 | my ($self) = @_; |
… | |
… | |
169 | { |
218 | { |
170 | local $!; |
219 | local $!; |
171 | $self->_shutdown; |
220 | $self->_shutdown; |
172 | } |
221 | } |
173 | |
222 | |
174 | $self->{on_error}($self); |
223 | $self->{on_error}($self) |
|
|
224 | if $self->{on_error}; |
|
|
225 | |
|
|
226 | Carp::croak "AnyEvent::Handle uncaught fatal error: $!"; |
175 | } |
227 | } |
176 | |
228 | |
177 | =item $fh = $handle->fh |
229 | =item $fh = $handle->fh |
178 | |
230 | |
179 | This method returns the filehandle of the L<AnyEvent::Handle> object. |
231 | This method returns the file handle of the L<AnyEvent::Handle> object. |
180 | |
232 | |
181 | =cut |
233 | =cut |
182 | |
234 | |
183 | sub fh { $_[0]->{fh} } |
235 | sub fh { $_[0]{fh} } |
184 | |
236 | |
185 | =item $handle->on_error ($cb) |
237 | =item $handle->on_error ($cb) |
186 | |
238 | |
187 | Replace the current C<on_error> callback (see the C<on_error> constructor argument). |
239 | Replace the current C<on_error> callback (see the C<on_error> constructor argument). |
188 | |
240 | |
… | |
… | |
212 | for reading. |
264 | for reading. |
213 | |
265 | |
214 | The write queue is very simple: you can add data to its end, and |
266 | The write queue is very simple: you can add data to its end, and |
215 | AnyEvent::Handle will automatically try to get rid of it for you. |
267 | AnyEvent::Handle will automatically try to get rid of it for you. |
216 | |
268 | |
217 | When data could be writtena nd the write buffer is shorter then the low |
269 | When data could be written and the write buffer is shorter then the low |
218 | water mark, the C<on_drain> callback will be invoked. |
270 | water mark, the C<on_drain> callback will be invoked. |
219 | |
271 | |
220 | =over 4 |
272 | =over 4 |
221 | |
273 | |
222 | =item $handle->on_drain ($cb) |
274 | =item $handle->on_drain ($cb) |
… | |
… | |
241 | want (only limited by the available memory), as C<AnyEvent::Handle> |
293 | want (only limited by the available memory), as C<AnyEvent::Handle> |
242 | buffers it independently of the kernel. |
294 | buffers it independently of the kernel. |
243 | |
295 | |
244 | =cut |
296 | =cut |
245 | |
297 | |
246 | sub push_write { |
298 | sub _drain_wbuf { |
247 | my ($self, $data) = @_; |
299 | my ($self) = @_; |
248 | |
300 | |
249 | $self->{wbuf} .= $data; |
301 | if (!$self->{_ww} && length $self->{wbuf}) { |
250 | |
302 | |
251 | unless ($self->{ww}) { |
|
|
252 | Scalar::Util::weaken $self; |
303 | Scalar::Util::weaken $self; |
|
|
304 | |
253 | my $cb = sub { |
305 | my $cb = sub { |
254 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
306 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
255 | |
307 | |
256 | if ($len > 0) { |
308 | if ($len >= 0) { |
257 | substr $self->{wbuf}, 0, $len, ""; |
309 | substr $self->{wbuf}, 0, $len, ""; |
258 | |
|
|
259 | |
310 | |
260 | $self->{on_drain}($self) |
311 | $self->{on_drain}($self) |
261 | if $self->{low_water_mark} >= length $self->{wbuf} |
312 | if $self->{low_water_mark} >= length $self->{wbuf} |
262 | && $self->{on_drain}; |
313 | && $self->{on_drain}; |
263 | |
314 | |
264 | delete $self->{ww} unless length $self->{wbuf}; |
315 | delete $self->{_ww} unless length $self->{wbuf}; |
265 | } elsif ($! != EAGAIN && $! != EINTR) { |
316 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) { |
266 | $self->error; |
317 | $self->error; |
267 | } |
318 | } |
268 | }; |
319 | }; |
269 | |
320 | |
|
|
321 | # try to write data immediately |
|
|
322 | $cb->(); |
|
|
323 | |
|
|
324 | # if still data left in wbuf, we need to poll |
270 | $self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb); |
325 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
271 | |
326 | if length $self->{wbuf}; |
272 | $cb->($self); |
|
|
273 | }; |
327 | }; |
274 | } |
328 | } |
|
|
329 | |
|
|
330 | our %WH; |
|
|
331 | |
|
|
332 | sub register_write_type($$) { |
|
|
333 | $WH{$_[0]} = $_[1]; |
|
|
334 | } |
|
|
335 | |
|
|
336 | sub push_write { |
|
|
337 | my $self = shift; |
|
|
338 | |
|
|
339 | if (@_ > 1) { |
|
|
340 | my $type = shift; |
|
|
341 | |
|
|
342 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
|
|
343 | ->($self, @_); |
|
|
344 | } |
|
|
345 | |
|
|
346 | if ($self->{filter_w}) { |
|
|
347 | $self->{filter_w}->($self, \$_[0]); |
|
|
348 | } else { |
|
|
349 | $self->{wbuf} .= $_[0]; |
|
|
350 | $self->_drain_wbuf; |
|
|
351 | } |
|
|
352 | } |
|
|
353 | |
|
|
354 | =item $handle->push_write (type => @args) |
|
|
355 | |
|
|
356 | =item $handle->unshift_write (type => @args) |
|
|
357 | |
|
|
358 | Instead of formatting your data yourself, you can also let this module do |
|
|
359 | the job by specifying a type and type-specific arguments. |
|
|
360 | |
|
|
361 | Predefined types are (if you have ideas for additional types, feel free to |
|
|
362 | drop by and tell us): |
|
|
363 | |
|
|
364 | =over 4 |
|
|
365 | |
|
|
366 | =item netstring => $string |
|
|
367 | |
|
|
368 | Formats the given value as netstring |
|
|
369 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
|
|
370 | |
|
|
371 | =back |
|
|
372 | |
|
|
373 | =cut |
|
|
374 | |
|
|
375 | register_write_type netstring => sub { |
|
|
376 | my ($self, $string) = @_; |
|
|
377 | |
|
|
378 | sprintf "%d:%s,", (length $string), $string |
|
|
379 | }; |
|
|
380 | |
|
|
381 | =item AnyEvent::Handle::register_write_type type => $coderef->($self, @args) |
|
|
382 | |
|
|
383 | This function (not method) lets you add your own types to C<push_write>. |
|
|
384 | Whenever the given C<type> is used, C<push_write> will invoke the code |
|
|
385 | reference with the handle object and the remaining arguments. |
|
|
386 | |
|
|
387 | The code reference is supposed to return a single octet string that will |
|
|
388 | be appended to the write buffer. |
|
|
389 | |
|
|
390 | Note that this is a function, and all types registered this way will be |
|
|
391 | global, so try to use unique names. |
|
|
392 | |
|
|
393 | =cut |
275 | |
394 | |
276 | ############################################################################# |
395 | ############################################################################# |
277 | |
396 | |
278 | =back |
397 | =back |
279 | |
398 | |
… | |
… | |
349 | ... |
468 | ... |
350 | }); |
469 | }); |
351 | |
470 | |
352 | =over 4 |
471 | =over 4 |
353 | |
472 | |
|
|
473 | =cut |
|
|
474 | |
354 | sub _drain_rbuf { |
475 | sub _drain_rbuf { |
355 | my ($self) = @_; |
476 | my ($self) = @_; |
356 | |
477 | |
|
|
478 | if ( |
|
|
479 | defined $self->{rbuf_max} |
|
|
480 | && $self->{rbuf_max} < length $self->{rbuf} |
|
|
481 | ) { |
|
|
482 | $! = &Errno::ENOSPC; |
|
|
483 | $self->error; |
|
|
484 | } |
|
|
485 | |
357 | return if exists $self->{in_drain}; |
486 | return if $self->{in_drain}; |
358 | local $self->{in_drain} = 1; |
487 | local $self->{in_drain} = 1; |
359 | |
488 | |
360 | while (my $len = length $self->{rbuf}) { |
489 | while (my $len = length $self->{rbuf}) { |
361 | no strict 'refs'; |
490 | no strict 'refs'; |
362 | if (@{ $self->{queue} }) { |
491 | if (my $cb = shift @{ $self->{_queue} }) { |
363 | if ($self->{queue}[0]($self)) { |
492 | unless ($cb->($self)) { |
364 | shift @{ $self->{queue} }; |
|
|
365 | } elsif ($self->{eof}) { |
493 | if ($self->{_eof}) { |
366 | # no progress can be made (not enough data and no data forthcoming) |
494 | # no progress can be made (not enough data and no data forthcoming) |
367 | $! = &Errno::EPIPE; return $self->error; |
495 | $! = &Errno::EPIPE; |
368 | } else { |
496 | $self->error; |
|
|
497 | } |
|
|
498 | |
|
|
499 | unshift @{ $self->{_queue} }, $cb; |
369 | return; |
500 | return; |
370 | } |
501 | } |
371 | } elsif ($self->{on_read}) { |
502 | } elsif ($self->{on_read}) { |
372 | $self->{on_read}($self); |
503 | $self->{on_read}($self); |
373 | |
504 | |
374 | if ( |
505 | if ( |
375 | $self->{eof} # if no further data will arrive |
506 | $self->{_eof} # if no further data will arrive |
376 | && $len == length $self->{rbuf} # and no data has been consumed |
507 | && $len == length $self->{rbuf} # and no data has been consumed |
377 | && !@{ $self->{queue} } # and the queue is still empty |
508 | && !@{ $self->{_queue} } # and the queue is still empty |
378 | && $self->{on_read} # and we still want to read data |
509 | && $self->{on_read} # and we still want to read data |
379 | ) { |
510 | ) { |
380 | # then no progress can be made |
511 | # then no progress can be made |
381 | $! = &Errno::EPIPE; return $self->error; |
512 | $! = &Errno::EPIPE; |
|
|
513 | $self->error; |
382 | } |
514 | } |
383 | } else { |
515 | } else { |
384 | # read side becomes idle |
516 | # read side becomes idle |
385 | delete $self->{rw}; |
517 | delete $self->{_rw}; |
386 | return; |
518 | return; |
387 | } |
519 | } |
388 | } |
520 | } |
389 | |
521 | |
390 | if ($self->{eof}) { |
522 | if ($self->{_eof}) { |
391 | $self->_shutdown; |
523 | $self->_shutdown; |
392 | $self->{on_eof}($self); |
524 | $self->{on_eof}($self) |
|
|
525 | if $self->{on_eof}; |
393 | } |
526 | } |
394 | } |
527 | } |
395 | |
528 | |
396 | =item $handle->on_read ($cb) |
529 | =item $handle->on_read ($cb) |
397 | |
530 | |
… | |
… | |
403 | |
536 | |
404 | sub on_read { |
537 | sub on_read { |
405 | my ($self, $cb) = @_; |
538 | my ($self, $cb) = @_; |
406 | |
539 | |
407 | $self->{on_read} = $cb; |
540 | $self->{on_read} = $cb; |
408 | |
|
|
409 | unless ($self->{rw} || $self->{eof}) { |
|
|
410 | Scalar::Util::weaken $self; |
|
|
411 | |
|
|
412 | $self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
|
|
413 | my $len = sysread $self->{fh}, $self->{rbuf}, $self->{read_size} || 8192, length $self->{rbuf}; |
|
|
414 | |
|
|
415 | if ($len > 0) { |
|
|
416 | if (exists $self->{rbuf_max}) { |
|
|
417 | if ($self->{rbuf_max} < length $self->{rbuf}) { |
|
|
418 | $! = &Errno::ENOSPC; return $self->error; |
|
|
419 | } |
|
|
420 | } |
|
|
421 | |
|
|
422 | } elsif (defined $len) { |
|
|
423 | $self->{eof} = 1; |
|
|
424 | delete $self->{rw}; |
|
|
425 | |
|
|
426 | } elsif ($! != EAGAIN && $! != EINTR) { |
|
|
427 | return $self->error; |
|
|
428 | } |
|
|
429 | |
|
|
430 | $self->_drain_rbuf; |
|
|
431 | }); |
|
|
432 | } |
|
|
433 | } |
541 | } |
434 | |
542 | |
435 | =item $handle->rbuf |
543 | =item $handle->rbuf |
436 | |
544 | |
437 | Returns the read buffer (as a modifiable lvalue). |
545 | Returns the read buffer (as a modifiable lvalue). |
… | |
… | |
456 | Append the given callback to the end of the queue (C<push_read>) or |
564 | Append the given callback to the end of the queue (C<push_read>) or |
457 | prepend it (C<unshift_read>). |
565 | prepend it (C<unshift_read>). |
458 | |
566 | |
459 | The callback is called each time some additional read data arrives. |
567 | The callback is called each time some additional read data arrives. |
460 | |
568 | |
461 | It must check wether enough data is in the read buffer already. |
569 | It must check whether enough data is in the read buffer already. |
462 | |
570 | |
463 | If not enough data is available, it must return the empty list or a false |
571 | If not enough data is available, it must return the empty list or a false |
464 | value, in which case it will be called repeatedly until enough data is |
572 | value, in which case it will be called repeatedly until enough data is |
465 | available (or an error condition is detected). |
573 | available (or an error condition is detected). |
466 | |
574 | |
… | |
… | |
468 | interested in (which can be none at all) and return a true value. After returning |
576 | interested in (which can be none at all) and return a true value. After returning |
469 | true, it will be removed from the queue. |
577 | true, it will be removed from the queue. |
470 | |
578 | |
471 | =cut |
579 | =cut |
472 | |
580 | |
|
|
581 | our %RH; |
|
|
582 | |
|
|
583 | sub register_read_type($$) { |
|
|
584 | $RH{$_[0]} = $_[1]; |
|
|
585 | } |
|
|
586 | |
473 | sub push_read { |
587 | sub push_read { |
474 | my ($self, $cb) = @_; |
588 | my $self = shift; |
|
|
589 | my $cb = pop; |
475 | |
590 | |
|
|
591 | if (@_) { |
|
|
592 | my $type = shift; |
|
|
593 | |
|
|
594 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
|
|
595 | ->($self, $cb, @_); |
|
|
596 | } |
|
|
597 | |
476 | push @{ $self->{queue} }, $cb; |
598 | push @{ $self->{_queue} }, $cb; |
477 | $self->_drain_rbuf; |
599 | $self->_drain_rbuf; |
478 | } |
600 | } |
479 | |
601 | |
480 | sub unshift_read { |
602 | sub unshift_read { |
481 | my ($self, $cb) = @_; |
603 | my $self = shift; |
|
|
604 | my $cb = pop; |
482 | |
605 | |
|
|
606 | if (@_) { |
|
|
607 | my $type = shift; |
|
|
608 | |
|
|
609 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") |
|
|
610 | ->($self, $cb, @_); |
|
|
611 | } |
|
|
612 | |
|
|
613 | |
483 | push @{ $self->{queue} }, $cb; |
614 | unshift @{ $self->{_queue} }, $cb; |
484 | $self->_drain_rbuf; |
615 | $self->_drain_rbuf; |
485 | } |
616 | } |
486 | |
617 | |
487 | =item $handle->push_read_chunk ($len, $cb->($self, $data)) |
618 | =item $handle->push_read (type => @args, $cb) |
488 | |
619 | |
489 | =item $handle->unshift_read_chunk ($len, $cb->($self, $data)) |
620 | =item $handle->unshift_read (type => @args, $cb) |
490 | |
621 | |
491 | Append the given callback to the end of the queue (C<push_read_chunk>) or |
622 | Instead of providing a callback that parses the data itself you can chose |
492 | prepend it (C<unshift_read_chunk>). |
623 | between a number of predefined parsing formats, for chunks of data, lines |
|
|
624 | etc. |
493 | |
625 | |
494 | The callback will be called only once C<$len> bytes have been read, and |
626 | Predefined types are (if you have ideas for additional types, feel free to |
495 | these C<$len> bytes will be passed to the callback. |
627 | drop by and tell us): |
496 | |
628 | |
497 | =cut |
629 | =over 4 |
498 | |
630 | |
499 | sub _read_chunk($$) { |
631 | =item chunk => $octets, $cb->($self, $data) |
500 | my ($len, $cb) = @_; |
632 | |
|
|
633 | Invoke the callback only once C<$octets> bytes have been read. Pass the |
|
|
634 | data read to the callback. The callback will never be called with less |
|
|
635 | data. |
|
|
636 | |
|
|
637 | Example: read 2 bytes. |
|
|
638 | |
|
|
639 | $handle->push_read (chunk => 2, sub { |
|
|
640 | warn "yay ", unpack "H*", $_[1]; |
|
|
641 | }); |
|
|
642 | |
|
|
643 | =cut |
|
|
644 | |
|
|
645 | register_read_type chunk => sub { |
|
|
646 | my ($self, $cb, $len) = @_; |
501 | |
647 | |
502 | sub { |
648 | sub { |
503 | $len <= length $_[0]{rbuf} or return; |
649 | $len <= length $_[0]{rbuf} or return; |
504 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
650 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
505 | 1 |
651 | 1 |
506 | } |
652 | } |
507 | } |
653 | }; |
508 | |
654 | |
|
|
655 | # compatibility with older API |
509 | sub push_read_chunk { |
656 | sub push_read_chunk { |
510 | my ($self, $len, $cb) = @_; |
657 | $_[0]->push_read (chunk => $_[1], $_[2]); |
511 | |
|
|
512 | $self->push_read (_read_chunk $len, $cb); |
|
|
513 | } |
658 | } |
514 | |
|
|
515 | |
659 | |
516 | sub unshift_read_chunk { |
660 | sub unshift_read_chunk { |
517 | my ($self, $len, $cb) = @_; |
661 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
518 | |
|
|
519 | $self->unshift_read (_read_chunk $len, $cb); |
|
|
520 | } |
662 | } |
521 | |
663 | |
522 | =item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol)) |
664 | =item line => [$eol, ]$cb->($self, $line, $eol) |
523 | |
|
|
524 | =item $handle->unshift_read_line ([$eol, ]$cb->($self, $line, $eol)) |
|
|
525 | |
|
|
526 | Append the given callback to the end of the queue (C<push_read_line>) or |
|
|
527 | prepend it (C<unshift_read_line>). |
|
|
528 | |
665 | |
529 | The callback will be called only once a full line (including the end of |
666 | The callback will be called only once a full line (including the end of |
530 | line marker, C<$eol>) has been read. This line (excluding the end of line |
667 | line marker, C<$eol>) has been read. This line (excluding the end of line |
531 | marker) will be passed to the callback as second argument (C<$line>), and |
668 | marker) will be passed to the callback as second argument (C<$line>), and |
532 | the end of line marker as the third argument (C<$eol>). |
669 | the end of line marker as the third argument (C<$eol>). |
… | |
… | |
543 | Partial lines at the end of the stream will never be returned, as they are |
680 | Partial lines at the end of the stream will never be returned, as they are |
544 | not marked by the end of line marker. |
681 | not marked by the end of line marker. |
545 | |
682 | |
546 | =cut |
683 | =cut |
547 | |
684 | |
548 | sub _read_line($$) { |
685 | register_read_type line => sub { |
549 | my $cb = pop; |
686 | my ($self, $cb, $eol) = @_; |
550 | my $eol = @_ ? shift : qr|(\015?\012)|; |
|
|
551 | my $pos; |
|
|
552 | |
687 | |
|
|
688 | $eol = qr|(\015?\012)| if @_ < 3; |
553 | $eol = qr|(\Q$eol\E)| unless ref $eol; |
689 | $eol = quotemeta $eol unless ref $eol; |
554 | $eol = qr|^(.*?)($eol)|; |
690 | $eol = qr|^(.*?)($eol)|s; |
555 | |
691 | |
556 | sub { |
692 | sub { |
557 | $_[0]{rbuf} =~ s/$eol// or return; |
693 | $_[0]{rbuf} =~ s/$eol// or return; |
558 | |
694 | |
559 | $cb->($1, $2); |
695 | $cb->($_[0], $1, $2); |
560 | 1 |
696 | 1 |
561 | } |
697 | } |
562 | } |
698 | }; |
563 | |
699 | |
|
|
700 | # compatibility with older API |
564 | sub push_read_line { |
701 | sub push_read_line { |
565 | my $self = shift; |
702 | my $self = shift; |
566 | |
|
|
567 | $self->push_read (&_read_line); |
703 | $self->push_read (line => @_); |
568 | } |
704 | } |
569 | |
705 | |
570 | sub unshift_read_line { |
706 | sub unshift_read_line { |
571 | my $self = shift; |
707 | my $self = shift; |
572 | |
|
|
573 | $self->unshift_read (&_read_line); |
708 | $self->unshift_read (line => @_); |
574 | } |
709 | } |
|
|
710 | |
|
|
711 | =item netstring => $cb->($string) |
|
|
712 | |
|
|
713 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
714 | |
|
|
715 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
716 | |
|
|
717 | =cut |
|
|
718 | |
|
|
719 | register_read_type netstring => sub { |
|
|
720 | my ($self, $cb) = @_; |
|
|
721 | |
|
|
722 | sub { |
|
|
723 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
724 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
725 | $! = &Errno::EBADMSG; |
|
|
726 | $self->error; |
|
|
727 | } |
|
|
728 | return; |
|
|
729 | } |
|
|
730 | |
|
|
731 | my $len = $1; |
|
|
732 | |
|
|
733 | $self->unshift_read (chunk => $len, sub { |
|
|
734 | my $string = $_[1]; |
|
|
735 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
736 | if ($_[1] eq ",") { |
|
|
737 | $cb->($_[0], $string); |
|
|
738 | } else { |
|
|
739 | $! = &Errno::EBADMSG; |
|
|
740 | $self->error; |
|
|
741 | } |
|
|
742 | }); |
|
|
743 | }); |
|
|
744 | |
|
|
745 | 1 |
|
|
746 | } |
|
|
747 | }; |
|
|
748 | |
|
|
749 | =item regex => $accept[, $reject[, $skip], $cb->($data) |
|
|
750 | |
|
|
751 | Makes a regex match against the regex object C<$accept> and returns |
|
|
752 | everything up to and including the match. |
|
|
753 | |
|
|
754 | Example: read a single line terminated by '\n'. |
|
|
755 | |
|
|
756 | $handle->push_read (regex => qr<\n>, sub { ... }); |
|
|
757 | |
|
|
758 | If C<$reject> is given and not undef, then it determines when the data is |
|
|
759 | to be rejected: it is matched against the data when the C<$accept> regex |
|
|
760 | does not match and generates an C<EBADMSG> error when it matches. This is |
|
|
761 | useful to quickly reject wrong data (to avoid waiting for a timeout or a |
|
|
762 | receive buffer overflow). |
|
|
763 | |
|
|
764 | Example: expect a single decimal number followed by whitespace, reject |
|
|
765 | anything else (not the use of an anchor). |
|
|
766 | |
|
|
767 | $handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... }); |
|
|
768 | |
|
|
769 | If C<$skip> is given and not C<undef>, then it will be matched against |
|
|
770 | the receive buffer when neither C<$accept> nor C<$reject> match, |
|
|
771 | and everything preceding and including the match will be accepted |
|
|
772 | unconditionally. This is useful to skip large amounts of data that you |
|
|
773 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
|
|
774 | have to start matching from the beginning. This is purely an optimisation |
|
|
775 | and is usually worth only when you expect more than a few kilobytes. |
|
|
776 | |
|
|
777 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
|
|
778 | expect the header to be very large (it isn't in practise, but...), we use |
|
|
779 | a skip regex to skip initial portions. The skip regex is tricky in that |
|
|
780 | it only accepts something not ending in either \015 or \012, as these are |
|
|
781 | required for the accept regex. |
|
|
782 | |
|
|
783 | $handle->push_read (regex => |
|
|
784 | qr<\015\012\015\012>, |
|
|
785 | undef, # no reject |
|
|
786 | qr<^.*[^\015\012]>, |
|
|
787 | sub { ... }); |
|
|
788 | |
|
|
789 | =cut |
|
|
790 | |
|
|
791 | register_read_type regex => sub { |
|
|
792 | my ($self, $cb, $accept, $reject, $skip) = @_; |
|
|
793 | |
|
|
794 | my $data; |
|
|
795 | my $rbuf = \$self->{rbuf}; |
|
|
796 | |
|
|
797 | sub { |
|
|
798 | # accept |
|
|
799 | if ($$rbuf =~ $accept) { |
|
|
800 | $data .= substr $$rbuf, 0, $+[0], ""; |
|
|
801 | $cb->($self, $data); |
|
|
802 | return 1; |
|
|
803 | } |
|
|
804 | |
|
|
805 | # reject |
|
|
806 | if ($reject && $$rbuf =~ $reject) { |
|
|
807 | $! = &Errno::EBADMSG; |
|
|
808 | $self->error; |
|
|
809 | } |
|
|
810 | |
|
|
811 | # skip |
|
|
812 | if ($skip && $$rbuf =~ $skip) { |
|
|
813 | $data .= substr $$rbuf, 0, $+[0], ""; |
|
|
814 | } |
|
|
815 | |
|
|
816 | () |
|
|
817 | } |
|
|
818 | }; |
575 | |
819 | |
576 | =back |
820 | =back |
577 | |
821 | |
|
|
822 | =item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args) |
|
|
823 | |
|
|
824 | This function (not method) lets you add your own types to C<push_read>. |
|
|
825 | |
|
|
826 | Whenever the given C<type> is used, C<push_read> will invoke the code |
|
|
827 | reference with the handle object, the callback and the remaining |
|
|
828 | arguments. |
|
|
829 | |
|
|
830 | The code reference is supposed to return a callback (usually a closure) |
|
|
831 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
|
|
832 | |
|
|
833 | It should invoke the passed callback when it is done reading (remember to |
|
|
834 | pass C<$self> as first argument as all other callbacks do that). |
|
|
835 | |
|
|
836 | Note that this is a function, and all types registered this way will be |
|
|
837 | global, so try to use unique names. |
|
|
838 | |
|
|
839 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
|
|
840 | search for C<register_read_type>)). |
|
|
841 | |
|
|
842 | =item $handle->stop_read |
|
|
843 | |
|
|
844 | =item $handle->start_read |
|
|
845 | |
|
|
846 | In rare cases you actually do not want to read anything from the |
|
|
847 | socket. In this case you can call C<stop_read>. Neither C<on_read> no |
|
|
848 | any queued callbacks will be executed then. To start reading again, call |
|
|
849 | C<start_read>. |
|
|
850 | |
|
|
851 | =cut |
|
|
852 | |
|
|
853 | sub stop_read { |
|
|
854 | my ($self) = @_; |
|
|
855 | |
|
|
856 | delete $self->{_rw}; |
|
|
857 | } |
|
|
858 | |
|
|
859 | sub start_read { |
|
|
860 | my ($self) = @_; |
|
|
861 | |
|
|
862 | unless ($self->{_rw} || $self->{_eof}) { |
|
|
863 | Scalar::Util::weaken $self; |
|
|
864 | |
|
|
865 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
|
|
866 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
|
|
867 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
|
|
868 | |
|
|
869 | if ($len > 0) { |
|
|
870 | $self->{filter_r} |
|
|
871 | ? $self->{filter_r}->($self, $rbuf) |
|
|
872 | : $self->_drain_rbuf; |
|
|
873 | |
|
|
874 | } elsif (defined $len) { |
|
|
875 | delete $self->{_rw}; |
|
|
876 | $self->{_eof} = 1; |
|
|
877 | $self->_drain_rbuf; |
|
|
878 | |
|
|
879 | } elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) { |
|
|
880 | return $self->error; |
|
|
881 | } |
|
|
882 | }); |
|
|
883 | } |
|
|
884 | } |
|
|
885 | |
|
|
886 | sub _dotls { |
|
|
887 | my ($self) = @_; |
|
|
888 | |
|
|
889 | if (length $self->{_tls_wbuf}) { |
|
|
890 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
|
|
891 | substr $self->{_tls_wbuf}, 0, $len, ""; |
|
|
892 | } |
|
|
893 | } |
|
|
894 | |
|
|
895 | if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
|
|
896 | $self->{wbuf} .= $buf; |
|
|
897 | $self->_drain_wbuf; |
|
|
898 | } |
|
|
899 | |
|
|
900 | while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { |
|
|
901 | $self->{rbuf} .= $buf; |
|
|
902 | $self->_drain_rbuf; |
|
|
903 | } |
|
|
904 | |
|
|
905 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
|
|
906 | |
|
|
907 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
|
|
908 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
|
|
909 | $self->error; |
|
|
910 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
|
|
911 | $! = &Errno::EIO; |
|
|
912 | $self->error; |
|
|
913 | } |
|
|
914 | |
|
|
915 | # all others are fine for our purposes |
|
|
916 | } |
|
|
917 | } |
|
|
918 | |
|
|
919 | =item $handle->starttls ($tls[, $tls_ctx]) |
|
|
920 | |
|
|
921 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
|
|
922 | object is created, you can also do that at a later time by calling |
|
|
923 | C<starttls>. |
|
|
924 | |
|
|
925 | The first argument is the same as the C<tls> constructor argument (either |
|
|
926 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
|
|
927 | |
|
|
928 | The second argument is the optional C<Net::SSLeay::CTX> object that is |
|
|
929 | used when AnyEvent::Handle has to create its own TLS connection object. |
|
|
930 | |
|
|
931 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
|
|
932 | call and can be used or changed to your liking. Note that the handshake |
|
|
933 | might have already started when this function returns. |
|
|
934 | |
|
|
935 | =cut |
|
|
936 | |
|
|
937 | # TODO: maybe document... |
|
|
938 | sub starttls { |
|
|
939 | my ($self, $ssl, $ctx) = @_; |
|
|
940 | |
|
|
941 | $self->stoptls; |
|
|
942 | |
|
|
943 | if ($ssl eq "accept") { |
|
|
944 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
|
|
945 | Net::SSLeay::set_accept_state ($ssl); |
|
|
946 | } elsif ($ssl eq "connect") { |
|
|
947 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
|
|
948 | Net::SSLeay::set_connect_state ($ssl); |
|
|
949 | } |
|
|
950 | |
|
|
951 | $self->{tls} = $ssl; |
|
|
952 | |
|
|
953 | # basically, this is deep magic (because SSL_read should have the same issues) |
|
|
954 | # but the openssl maintainers basically said: "trust us, it just works". |
|
|
955 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
|
|
956 | # and mismaintained ssleay-module doesn't even offer them). |
|
|
957 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
|
|
958 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
|
|
959 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
|
|
960 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
|
|
961 | |
|
|
962 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
|
|
963 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
|
|
964 | |
|
|
965 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
|
|
966 | |
|
|
967 | $self->{filter_w} = sub { |
|
|
968 | $_[0]{_tls_wbuf} .= ${$_[1]}; |
|
|
969 | &_dotls; |
|
|
970 | }; |
|
|
971 | $self->{filter_r} = sub { |
|
|
972 | Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]}); |
|
|
973 | &_dotls; |
|
|
974 | }; |
|
|
975 | } |
|
|
976 | |
|
|
977 | =item $handle->stoptls |
|
|
978 | |
|
|
979 | Destroys the SSL connection, if any. Partial read or write data will be |
|
|
980 | lost. |
|
|
981 | |
|
|
982 | =cut |
|
|
983 | |
|
|
984 | sub stoptls { |
|
|
985 | my ($self) = @_; |
|
|
986 | |
|
|
987 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
|
|
988 | |
|
|
989 | delete $self->{_rbio}; |
|
|
990 | delete $self->{_wbio}; |
|
|
991 | delete $self->{_tls_wbuf}; |
|
|
992 | delete $self->{filter_r}; |
|
|
993 | delete $self->{filter_w}; |
|
|
994 | } |
|
|
995 | |
|
|
996 | sub DESTROY { |
|
|
997 | my $self = shift; |
|
|
998 | |
|
|
999 | $self->stoptls; |
|
|
1000 | } |
|
|
1001 | |
|
|
1002 | =item AnyEvent::Handle::TLS_CTX |
|
|
1003 | |
|
|
1004 | This function creates and returns the Net::SSLeay::CTX object used by |
|
|
1005 | default for TLS mode. |
|
|
1006 | |
|
|
1007 | The context is created like this: |
|
|
1008 | |
|
|
1009 | Net::SSLeay::load_error_strings; |
|
|
1010 | Net::SSLeay::SSLeay_add_ssl_algorithms; |
|
|
1011 | Net::SSLeay::randomize; |
|
|
1012 | |
|
|
1013 | my $CTX = Net::SSLeay::CTX_new; |
|
|
1014 | |
|
|
1015 | Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL |
|
|
1016 | |
|
|
1017 | =cut |
|
|
1018 | |
|
|
1019 | our $TLS_CTX; |
|
|
1020 | |
|
|
1021 | sub TLS_CTX() { |
|
|
1022 | $TLS_CTX || do { |
|
|
1023 | require Net::SSLeay; |
|
|
1024 | |
|
|
1025 | Net::SSLeay::load_error_strings (); |
|
|
1026 | Net::SSLeay::SSLeay_add_ssl_algorithms (); |
|
|
1027 | Net::SSLeay::randomize (); |
|
|
1028 | |
|
|
1029 | $TLS_CTX = Net::SSLeay::CTX_new (); |
|
|
1030 | |
|
|
1031 | Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ()); |
|
|
1032 | |
|
|
1033 | $TLS_CTX |
|
|
1034 | } |
|
|
1035 | } |
|
|
1036 | |
|
|
1037 | =back |
|
|
1038 | |
|
|
1039 | =head1 SUBCLASSING AnyEvent::Handle |
|
|
1040 | |
|
|
1041 | In many cases, you might want to subclass AnyEvent::Handle. |
|
|
1042 | |
|
|
1043 | To make this easier, a given version of AnyEvent::Handle uses these |
|
|
1044 | conventions: |
|
|
1045 | |
|
|
1046 | =over 4 |
|
|
1047 | |
|
|
1048 | =item * all constructor arguments become object members. |
|
|
1049 | |
|
|
1050 | At least initially, when you pass a C<tls>-argument to the constructor it |
|
|
1051 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
|
|
1052 | mutated later on (for example C<tls> will hold the TLS connection object). |
|
|
1053 | |
|
|
1054 | =item * other object member names are prefixed with an C<_>. |
|
|
1055 | |
|
|
1056 | All object members not explicitly documented (internal use) are prefixed |
|
|
1057 | with an underscore character, so the remaining non-C<_>-namespace is free |
|
|
1058 | for use for subclasses. |
|
|
1059 | |
|
|
1060 | =item * all members not documented here and not prefixed with an underscore |
|
|
1061 | are free to use in subclasses. |
|
|
1062 | |
|
|
1063 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
|
|
1064 | member variables, but thats just life, at least it is documented. |
|
|
1065 | |
|
|
1066 | =back |
|
|
1067 | |
578 | =head1 AUTHOR |
1068 | =head1 AUTHOR |
579 | |
1069 | |
580 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
1070 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
581 | |
1071 | |
582 | =cut |
1072 | =cut |