1 | package AnyEvent::Handle; |
1 | package AnyEvent::Handle; |
2 | |
2 | |
3 | no warnings; |
3 | no warnings; |
4 | use strict; |
4 | use strict qw(subs vars); |
5 | |
5 | |
6 | use AnyEvent (); |
6 | use AnyEvent (); |
7 | use AnyEvent::Util qw(WSAWOULDBLOCK); |
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
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 file handles 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.04'; |
19 | our $VERSION = 4.232; |
20 | |
20 | |
21 | =head1 SYNOPSIS |
21 | =head1 SYNOPSIS |
22 | |
22 | |
23 | use AnyEvent; |
23 | use AnyEvent; |
24 | use AnyEvent::Handle; |
24 | use AnyEvent::Handle; |
… | |
… | |
73 | The filehandle this L<AnyEvent::Handle> object will operate on. |
73 | The filehandle this L<AnyEvent::Handle> object will operate on. |
74 | |
74 | |
75 | NOTE: The filehandle will be set to non-blocking (using |
75 | NOTE: The filehandle will be set to non-blocking (using |
76 | AnyEvent::Util::fh_nonblocking). |
76 | AnyEvent::Util::fh_nonblocking). |
77 | |
77 | |
78 | =item on_eof => $cb->($self) |
78 | =item on_eof => $cb->($handle) |
79 | |
79 | |
80 | Set the callback to be called on EOF. |
80 | Set the callback to be called when an end-of-file condition is detected, |
|
|
81 | i.e. in the case of a socket, when the other side has closed the |
|
|
82 | connection cleanly. |
81 | |
83 | |
|
|
84 | For sockets, this just means that the other side has stopped sending data, |
|
|
85 | you can still try to write data, and, in fact, one can return from the eof |
|
|
86 | callback and continue writing data, as only the read part has been shut |
|
|
87 | down. |
|
|
88 | |
82 | While not mandatory, it is highly recommended to set an eof callback, |
89 | While not mandatory, it is I<highly> recommended to set an eof callback, |
83 | otherwise you might end up with a closed socket while you are still |
90 | otherwise you might end up with a closed socket while you are still |
84 | waiting for data. |
91 | waiting for data. |
85 | |
92 | |
|
|
93 | If an EOF condition has been detected but no C<on_eof> callback has been |
|
|
94 | set, then a fatal error will be raised with C<$!> set to <0>. |
|
|
95 | |
86 | =item on_error => $cb->($self) |
96 | =item on_error => $cb->($handle, $fatal) |
87 | |
97 | |
88 | This is the fatal error callback, that is called when, well, a fatal error |
98 | This is the error callback, which is called when, well, some error |
89 | occurs, such as not being able to resolve the hostname, failure to connect |
99 | occured, such as not being able to resolve the hostname, failure to |
90 | or a read error. |
100 | connect or a read error. |
91 | |
101 | |
92 | The object will not be in a usable state when this callback has been |
102 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
93 | called. |
103 | fatal errors the handle object will be shut down and will not be usable |
|
|
104 | (but you are free to look at the current C< ->rbuf >). Examples of fatal |
|
|
105 | errors are an EOF condition with active (but unsatisifable) read watchers |
|
|
106 | (C<EPIPE>) or I/O errors. |
|
|
107 | |
|
|
108 | Non-fatal errors can be retried by simply returning, but it is recommended |
|
|
109 | to simply ignore this parameter and instead abondon the handle object |
|
|
110 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
111 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
94 | |
112 | |
95 | On callback entrance, the value of C<$!> contains the operating system |
113 | On callback entrance, the value of C<$!> contains the operating system |
96 | error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>). |
114 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
97 | |
115 | |
98 | While not mandatory, it is I<highly> recommended to set this callback, as |
116 | While not mandatory, it is I<highly> recommended to set this callback, as |
99 | you will not be notified of errors otherwise. The default simply calls |
117 | you will not be notified of errors otherwise. The default simply calls |
100 | die. |
118 | C<croak>. |
101 | |
119 | |
102 | =item on_read => $cb->($self) |
120 | =item on_read => $cb->($handle) |
103 | |
121 | |
104 | This sets the default read callback, which is called when data arrives |
122 | This sets the default read callback, which is called when data arrives |
105 | and no read request is in the queue. |
123 | and no read request is in the queue (unlike read queue callbacks, this |
|
|
124 | callback will only be called when at least one octet of data is in the |
|
|
125 | read buffer). |
106 | |
126 | |
107 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
127 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
108 | method or access the C<$self->{rbuf}> member directly. |
128 | method or access the C<$handle->{rbuf}> member directly. |
109 | |
129 | |
110 | When an EOF condition is detected then AnyEvent::Handle will first try to |
130 | When an EOF condition is detected then AnyEvent::Handle will first try to |
111 | feed all the remaining data to the queued callbacks and C<on_read> before |
131 | feed all the remaining data to the queued callbacks and C<on_read> before |
112 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
132 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
113 | error will be raised (with C<$!> set to C<EPIPE>). |
133 | error will be raised (with C<$!> set to C<EPIPE>). |
114 | |
134 | |
115 | =item on_drain => $cb->() |
135 | =item on_drain => $cb->($handle) |
116 | |
136 | |
117 | This sets the callback that is called when the write buffer becomes empty |
137 | This sets the callback that is called when the write buffer becomes empty |
118 | (or when the callback is set and the buffer is empty already). |
138 | (or when the callback is set and the buffer is empty already). |
119 | |
139 | |
120 | To append to the write buffer, use the C<< ->push_write >> method. |
140 | To append to the write buffer, use the C<< ->push_write >> method. |
|
|
141 | |
|
|
142 | This callback is useful when you don't want to put all of your write data |
|
|
143 | into the queue at once, for example, when you want to write the contents |
|
|
144 | of some file to the socket you might not want to read the whole file into |
|
|
145 | memory and push it into the queue, but instead only read more data from |
|
|
146 | the file when the write queue becomes empty. |
|
|
147 | |
|
|
148 | =item timeout => $fractional_seconds |
|
|
149 | |
|
|
150 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
|
|
151 | seconds pass without a successful read or write on the underlying file |
|
|
152 | handle, the C<on_timeout> callback will be invoked (and if that one is |
|
|
153 | missing, an C<ETIMEDOUT> error will be raised). |
|
|
154 | |
|
|
155 | Note that timeout processing is also active when you currently do not have |
|
|
156 | any outstanding read or write requests: If you plan to keep the connection |
|
|
157 | idle then you should disable the timout temporarily or ignore the timeout |
|
|
158 | in the C<on_timeout> callback. |
|
|
159 | |
|
|
160 | Zero (the default) disables this timeout. |
|
|
161 | |
|
|
162 | =item on_timeout => $cb->($handle) |
|
|
163 | |
|
|
164 | Called whenever the inactivity timeout passes. If you return from this |
|
|
165 | callback, then the timeout will be reset as if some activity had happened, |
|
|
166 | so this condition is not fatal in any way. |
121 | |
167 | |
122 | =item rbuf_max => <bytes> |
168 | =item rbuf_max => <bytes> |
123 | |
169 | |
124 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
170 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
125 | when the read buffer ever (strictly) exceeds this size. This is useful to |
171 | when the read buffer ever (strictly) exceeds this size. This is useful to |
… | |
… | |
129 | be configured to accept only so-and-so much data that it cannot act on |
175 | be configured to accept only so-and-so much data that it cannot act on |
130 | (for example, when expecting a line, an attacker could send an unlimited |
176 | (for example, when expecting a line, an attacker could send an unlimited |
131 | amount of data without a callback ever being called as long as the line |
177 | amount of data without a callback ever being called as long as the line |
132 | isn't finished). |
178 | isn't finished). |
133 | |
179 | |
|
|
180 | =item autocork => <boolean> |
|
|
181 | |
|
|
182 | When disabled (the default), then C<push_write> will try to immediately |
|
|
183 | write the data to the handle if possible. This avoids having to register |
|
|
184 | a write watcher and wait for the next event loop iteration, but can be |
|
|
185 | inefficient if you write multiple small chunks (this disadvantage is |
|
|
186 | usually avoided by your kernel's nagle algorithm, see C<low_delay>). |
|
|
187 | |
|
|
188 | When enabled, then writes will always be queued till the next event loop |
|
|
189 | iteration. This is efficient when you do many small writes per iteration, |
|
|
190 | but less efficient when you do a single write only. |
|
|
191 | |
|
|
192 | =item no_delay => <boolean> |
|
|
193 | |
|
|
194 | When doing small writes on sockets, your operating system kernel might |
|
|
195 | wait a bit for more data before actually sending it out. This is called |
|
|
196 | the Nagle algorithm, and usually it is beneficial. |
|
|
197 | |
|
|
198 | In some situations you want as low a delay as possible, which cna be |
|
|
199 | accomplishd by setting this option to true. |
|
|
200 | |
|
|
201 | The default is your opertaing system's default behaviour, this option |
|
|
202 | explicitly enables or disables it, if possible. |
|
|
203 | |
134 | =item read_size => <bytes> |
204 | =item read_size => <bytes> |
135 | |
205 | |
136 | The default read block size (the amount of bytes this module will try to read |
206 | The default read block size (the amount of bytes this module will try to read |
137 | on each [loop iteration). Default: C<4096>. |
207 | during each (loop iteration). Default: C<8192>. |
138 | |
208 | |
139 | =item low_water_mark => <bytes> |
209 | =item low_water_mark => <bytes> |
140 | |
210 | |
141 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
211 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
142 | buffer: If the write reaches this size or gets even samller it is |
212 | buffer: If the write reaches this size or gets even samller it is |
143 | considered empty. |
213 | considered empty. |
|
|
214 | |
|
|
215 | =item linger => <seconds> |
|
|
216 | |
|
|
217 | If non-zero (default: C<3600>), then the destructor of the |
|
|
218 | AnyEvent::Handle object will check wether there is still outstanding write |
|
|
219 | data and will install a watcher that will write out this data. No errors |
|
|
220 | will be reported (this mostly matches how the operating system treats |
|
|
221 | outstanding data at socket close time). |
|
|
222 | |
|
|
223 | This will not work for partial TLS data that could not yet been |
|
|
224 | encoded. This data will be lost. |
144 | |
225 | |
145 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
226 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
146 | |
227 | |
147 | When this parameter is given, it enables TLS (SSL) mode, that means it |
228 | When this parameter is given, it enables TLS (SSL) mode, that means it |
148 | will start making tls handshake and will transparently encrypt/decrypt |
229 | will start making tls handshake and will transparently encrypt/decrypt |
… | |
… | |
157 | You can also provide your own TLS connection object, but you have |
238 | You can also provide your own TLS connection object, but you have |
158 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
239 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
159 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
240 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
160 | AnyEvent::Handle. |
241 | AnyEvent::Handle. |
161 | |
242 | |
162 | See the C<starttls> method if you need to start TLs negotiation later. |
243 | See the C<starttls> method if you need to start TLS negotiation later. |
163 | |
244 | |
164 | =item tls_ctx => $ssl_ctx |
245 | =item tls_ctx => $ssl_ctx |
165 | |
246 | |
166 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
247 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
167 | (unless a connection object was specified directly). If this parameter is |
248 | (unless a connection object was specified directly). If this parameter is |
168 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
249 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
169 | |
250 | |
|
|
251 | =item json => JSON or JSON::XS object |
|
|
252 | |
|
|
253 | This is the json coder object used by the C<json> read and write types. |
|
|
254 | |
|
|
255 | If you don't supply it, then AnyEvent::Handle will create and use a |
|
|
256 | suitable one, which will write and expect UTF-8 encoded JSON texts. |
|
|
257 | |
|
|
258 | Note that you are responsible to depend on the JSON module if you want to |
|
|
259 | use this functionality, as AnyEvent does not have a dependency itself. |
|
|
260 | |
|
|
261 | =item filter_r => $cb |
|
|
262 | |
|
|
263 | =item filter_w => $cb |
|
|
264 | |
|
|
265 | These exist, but are undocumented at this time. |
|
|
266 | |
170 | =back |
267 | =back |
171 | |
268 | |
172 | =cut |
269 | =cut |
173 | |
270 | |
174 | sub new { |
271 | sub new { |
… | |
… | |
183 | if ($self->{tls}) { |
280 | if ($self->{tls}) { |
184 | require Net::SSLeay; |
281 | require Net::SSLeay; |
185 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
282 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
186 | } |
283 | } |
187 | |
284 | |
188 | $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; |
285 | $self->{_activity} = AnyEvent->now; |
189 | $self->on_error (delete $self->{on_error}) if $self->{on_error}; |
286 | $self->_timeout; |
|
|
287 | |
190 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
288 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
191 | $self->on_read (delete $self->{on_read} ) if $self->{on_read}; |
289 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
192 | |
290 | |
193 | $self->start_read; |
291 | $self->start_read |
|
|
292 | if $self->{on_read}; |
194 | |
293 | |
195 | $self |
294 | $self |
196 | } |
295 | } |
197 | |
296 | |
198 | sub _shutdown { |
297 | sub _shutdown { |
199 | my ($self) = @_; |
298 | my ($self) = @_; |
200 | |
299 | |
|
|
300 | delete $self->{_tw}; |
201 | delete $self->{rw}; |
301 | delete $self->{_rw}; |
202 | delete $self->{ww}; |
302 | delete $self->{_ww}; |
203 | delete $self->{fh}; |
303 | delete $self->{fh}; |
204 | } |
|
|
205 | |
304 | |
|
|
305 | $self->stoptls; |
|
|
306 | |
|
|
307 | delete $self->{on_read}; |
|
|
308 | delete $self->{_queue}; |
|
|
309 | } |
|
|
310 | |
206 | sub error { |
311 | sub _error { |
207 | my ($self) = @_; |
312 | my ($self, $errno, $fatal) = @_; |
208 | |
313 | |
209 | { |
|
|
210 | local $!; |
|
|
211 | $self->_shutdown; |
314 | $self->_shutdown |
212 | } |
315 | if $fatal; |
|
|
316 | |
|
|
317 | $! = $errno; |
213 | |
318 | |
214 | if ($self->{on_error}) { |
319 | if ($self->{on_error}) { |
215 | $self->{on_error}($self); |
320 | $self->{on_error}($self, $fatal); |
216 | } else { |
321 | } else { |
217 | Carp::croak "AnyEvent::Handle uncaught fatal error: $!"; |
322 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
218 | } |
323 | } |
219 | } |
324 | } |
220 | |
325 | |
221 | =item $fh = $handle->fh |
326 | =item $fh = $handle->fh |
222 | |
327 | |
223 | This method returns the file handle of the L<AnyEvent::Handle> object. |
328 | This method returns the file handle of the L<AnyEvent::Handle> object. |
224 | |
329 | |
225 | =cut |
330 | =cut |
226 | |
331 | |
227 | sub fh { $_[0]->{fh} } |
332 | sub fh { $_[0]{fh} } |
228 | |
333 | |
229 | =item $handle->on_error ($cb) |
334 | =item $handle->on_error ($cb) |
230 | |
335 | |
231 | Replace the current C<on_error> callback (see the C<on_error> constructor argument). |
336 | Replace the current C<on_error> callback (see the C<on_error> constructor argument). |
232 | |
337 | |
… | |
… | |
242 | |
347 | |
243 | =cut |
348 | =cut |
244 | |
349 | |
245 | sub on_eof { |
350 | sub on_eof { |
246 | $_[0]{on_eof} = $_[1]; |
351 | $_[0]{on_eof} = $_[1]; |
|
|
352 | } |
|
|
353 | |
|
|
354 | =item $handle->on_timeout ($cb) |
|
|
355 | |
|
|
356 | Replace the current C<on_timeout> callback, or disables the callback |
|
|
357 | (but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor |
|
|
358 | argument. |
|
|
359 | |
|
|
360 | =cut |
|
|
361 | |
|
|
362 | sub on_timeout { |
|
|
363 | $_[0]{on_timeout} = $_[1]; |
|
|
364 | } |
|
|
365 | |
|
|
366 | =item $handle->autocork ($boolean) |
|
|
367 | |
|
|
368 | Enables or disables the current autocork behaviour (see C<autocork> |
|
|
369 | constructor argument). |
|
|
370 | |
|
|
371 | =cut |
|
|
372 | |
|
|
373 | =item $handle->no_delay ($boolean) |
|
|
374 | |
|
|
375 | Enables or disables the C<no_delay> setting (see constructor argument of |
|
|
376 | the same name for details). |
|
|
377 | |
|
|
378 | =cut |
|
|
379 | |
|
|
380 | sub no_delay { |
|
|
381 | $_[0]{no_delay} = $_[1]; |
|
|
382 | |
|
|
383 | eval { |
|
|
384 | local $SIG{__DIE__}; |
|
|
385 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
|
|
386 | }; |
|
|
387 | } |
|
|
388 | |
|
|
389 | ############################################################################# |
|
|
390 | |
|
|
391 | =item $handle->timeout ($seconds) |
|
|
392 | |
|
|
393 | Configures (or disables) the inactivity timeout. |
|
|
394 | |
|
|
395 | =cut |
|
|
396 | |
|
|
397 | sub timeout { |
|
|
398 | my ($self, $timeout) = @_; |
|
|
399 | |
|
|
400 | $self->{timeout} = $timeout; |
|
|
401 | $self->_timeout; |
|
|
402 | } |
|
|
403 | |
|
|
404 | # reset the timeout watcher, as neccessary |
|
|
405 | # also check for time-outs |
|
|
406 | sub _timeout { |
|
|
407 | my ($self) = @_; |
|
|
408 | |
|
|
409 | if ($self->{timeout}) { |
|
|
410 | my $NOW = AnyEvent->now; |
|
|
411 | |
|
|
412 | # when would the timeout trigger? |
|
|
413 | my $after = $self->{_activity} + $self->{timeout} - $NOW; |
|
|
414 | |
|
|
415 | # now or in the past already? |
|
|
416 | if ($after <= 0) { |
|
|
417 | $self->{_activity} = $NOW; |
|
|
418 | |
|
|
419 | if ($self->{on_timeout}) { |
|
|
420 | $self->{on_timeout}($self); |
|
|
421 | } else { |
|
|
422 | $self->_error (&Errno::ETIMEDOUT); |
|
|
423 | } |
|
|
424 | |
|
|
425 | # callback could have changed timeout value, optimise |
|
|
426 | return unless $self->{timeout}; |
|
|
427 | |
|
|
428 | # calculate new after |
|
|
429 | $after = $self->{timeout}; |
|
|
430 | } |
|
|
431 | |
|
|
432 | Scalar::Util::weaken $self; |
|
|
433 | return unless $self; # ->error could have destroyed $self |
|
|
434 | |
|
|
435 | $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { |
|
|
436 | delete $self->{_tw}; |
|
|
437 | $self->_timeout; |
|
|
438 | }); |
|
|
439 | } else { |
|
|
440 | delete $self->{_tw}; |
|
|
441 | } |
247 | } |
442 | } |
248 | |
443 | |
249 | ############################################################################# |
444 | ############################################################################# |
250 | |
445 | |
251 | =back |
446 | =back |
… | |
… | |
288 | =cut |
483 | =cut |
289 | |
484 | |
290 | sub _drain_wbuf { |
485 | sub _drain_wbuf { |
291 | my ($self) = @_; |
486 | my ($self) = @_; |
292 | |
487 | |
293 | if (!$self->{ww} && length $self->{wbuf}) { |
488 | if (!$self->{_ww} && length $self->{wbuf}) { |
294 | |
489 | |
295 | Scalar::Util::weaken $self; |
490 | Scalar::Util::weaken $self; |
296 | |
491 | |
297 | my $cb = sub { |
492 | my $cb = sub { |
298 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
493 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
299 | |
494 | |
300 | if ($len >= 0) { |
495 | if ($len >= 0) { |
301 | substr $self->{wbuf}, 0, $len, ""; |
496 | substr $self->{wbuf}, 0, $len, ""; |
|
|
497 | |
|
|
498 | $self->{_activity} = AnyEvent->now; |
302 | |
499 | |
303 | $self->{on_drain}($self) |
500 | $self->{on_drain}($self) |
304 | if $self->{low_water_mark} >= length $self->{wbuf} |
501 | if $self->{low_water_mark} >= length $self->{wbuf} |
305 | && $self->{on_drain}; |
502 | && $self->{on_drain}; |
306 | |
503 | |
307 | delete $self->{ww} unless length $self->{wbuf}; |
504 | delete $self->{_ww} unless length $self->{wbuf}; |
308 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) { |
505 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
309 | $self->error; |
506 | $self->_error ($!, 1); |
310 | } |
507 | } |
311 | }; |
508 | }; |
312 | |
509 | |
313 | # try to write data immediately |
510 | # try to write data immediately |
314 | $cb->(); |
511 | $cb->() unless $self->{autocork}; |
315 | |
512 | |
316 | # if still data left in wbuf, we need to poll |
513 | # if still data left in wbuf, we need to poll |
317 | $self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
514 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
318 | if length $self->{wbuf}; |
515 | if length $self->{wbuf}; |
319 | }; |
516 | }; |
320 | } |
517 | } |
321 | |
518 | |
322 | our %WH; |
519 | our %WH; |
… | |
… | |
334 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
531 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
335 | ->($self, @_); |
532 | ->($self, @_); |
336 | } |
533 | } |
337 | |
534 | |
338 | if ($self->{filter_w}) { |
535 | if ($self->{filter_w}) { |
339 | $self->{filter_w}->($self, \$_[0]); |
536 | $self->{filter_w}($self, \$_[0]); |
340 | } else { |
537 | } else { |
341 | $self->{wbuf} .= $_[0]; |
538 | $self->{wbuf} .= $_[0]; |
342 | $self->_drain_wbuf; |
539 | $self->_drain_wbuf; |
343 | } |
540 | } |
344 | } |
541 | } |
345 | |
542 | |
346 | =item $handle->push_write (type => @args) |
543 | =item $handle->push_write (type => @args) |
347 | |
544 | |
348 | =item $handle->unshift_write (type => @args) |
|
|
349 | |
|
|
350 | Instead of formatting your data yourself, you can also let this module do |
545 | Instead of formatting your data yourself, you can also let this module do |
351 | the job by specifying a type and type-specific arguments. |
546 | the job by specifying a type and type-specific arguments. |
352 | |
547 | |
353 | Predefined types are (if you have ideas for additional types, feel free to |
548 | Predefined types are (if you have ideas for additional types, feel free to |
354 | drop by and tell us): |
549 | drop by and tell us): |
… | |
… | |
358 | =item netstring => $string |
553 | =item netstring => $string |
359 | |
554 | |
360 | Formats the given value as netstring |
555 | Formats the given value as netstring |
361 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
556 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
362 | |
557 | |
363 | =back |
|
|
364 | |
|
|
365 | =cut |
558 | =cut |
366 | |
559 | |
367 | register_write_type netstring => sub { |
560 | register_write_type netstring => sub { |
368 | my ($self, $string) = @_; |
561 | my ($self, $string) = @_; |
369 | |
562 | |
370 | sprintf "%d:%s,", (length $string), $string |
563 | sprintf "%d:%s,", (length $string), $string |
371 | }; |
564 | }; |
372 | |
565 | |
|
|
566 | =item packstring => $format, $data |
|
|
567 | |
|
|
568 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
569 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
570 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
571 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
572 | |
|
|
573 | =cut |
|
|
574 | |
|
|
575 | register_write_type packstring => sub { |
|
|
576 | my ($self, $format, $string) = @_; |
|
|
577 | |
|
|
578 | pack "$format/a*", $string |
|
|
579 | }; |
|
|
580 | |
|
|
581 | =item json => $array_or_hashref |
|
|
582 | |
|
|
583 | Encodes the given hash or array reference into a JSON object. Unless you |
|
|
584 | provide your own JSON object, this means it will be encoded to JSON text |
|
|
585 | in UTF-8. |
|
|
586 | |
|
|
587 | JSON objects (and arrays) are self-delimiting, so you can write JSON at |
|
|
588 | one end of a handle and read them at the other end without using any |
|
|
589 | additional framing. |
|
|
590 | |
|
|
591 | The generated JSON text is guaranteed not to contain any newlines: While |
|
|
592 | this module doesn't need delimiters after or between JSON texts to be |
|
|
593 | able to read them, many other languages depend on that. |
|
|
594 | |
|
|
595 | A simple RPC protocol that interoperates easily with others is to send |
|
|
596 | JSON arrays (or objects, although arrays are usually the better choice as |
|
|
597 | they mimic how function argument passing works) and a newline after each |
|
|
598 | JSON text: |
|
|
599 | |
|
|
600 | $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever |
|
|
601 | $handle->push_write ("\012"); |
|
|
602 | |
|
|
603 | An AnyEvent::Handle receiver would simply use the C<json> read type and |
|
|
604 | rely on the fact that the newline will be skipped as leading whitespace: |
|
|
605 | |
|
|
606 | $handle->push_read (json => sub { my $array = $_[1]; ... }); |
|
|
607 | |
|
|
608 | Other languages could read single lines terminated by a newline and pass |
|
|
609 | this line into their JSON decoder of choice. |
|
|
610 | |
|
|
611 | =cut |
|
|
612 | |
|
|
613 | register_write_type json => sub { |
|
|
614 | my ($self, $ref) = @_; |
|
|
615 | |
|
|
616 | require JSON; |
|
|
617 | |
|
|
618 | $self->{json} ? $self->{json}->encode ($ref) |
|
|
619 | : JSON::encode_json ($ref) |
|
|
620 | }; |
|
|
621 | |
|
|
622 | =item storable => $reference |
|
|
623 | |
|
|
624 | Freezes the given reference using L<Storable> and writes it to the |
|
|
625 | handle. Uses the C<nfreeze> format. |
|
|
626 | |
|
|
627 | =cut |
|
|
628 | |
|
|
629 | register_write_type storable => sub { |
|
|
630 | my ($self, $ref) = @_; |
|
|
631 | |
|
|
632 | require Storable; |
|
|
633 | |
|
|
634 | pack "w/a*", Storable::nfreeze ($ref) |
|
|
635 | }; |
|
|
636 | |
|
|
637 | =back |
|
|
638 | |
373 | =item AnyEvent::Handle::register_write_type type => $coderef->($self, @args) |
639 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
374 | |
640 | |
375 | This function (not method) lets you add your own types to C<push_write>. |
641 | This function (not method) lets you add your own types to C<push_write>. |
376 | Whenever the given C<type> is used, C<push_write> will invoke the code |
642 | Whenever the given C<type> is used, C<push_write> will invoke the code |
377 | reference with the handle object and the remaining arguments. |
643 | reference with the handle object and the remaining arguments. |
378 | |
644 | |
… | |
… | |
397 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
663 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
398 | a queue. |
664 | a queue. |
399 | |
665 | |
400 | In the simple case, you just install an C<on_read> callback and whenever |
666 | In the simple case, you just install an C<on_read> callback and whenever |
401 | new data arrives, it will be called. You can then remove some data (if |
667 | new data arrives, it will be called. You can then remove some data (if |
402 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
668 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
403 | or not. |
669 | leave the data there if you want to accumulate more (e.g. when only a |
|
|
670 | partial message has been received so far). |
404 | |
671 | |
405 | In the more complex case, you want to queue multiple callbacks. In this |
672 | In the more complex case, you want to queue multiple callbacks. In this |
406 | case, AnyEvent::Handle will call the first queued callback each time new |
673 | case, AnyEvent::Handle will call the first queued callback each time new |
407 | data arrives and removes it when it has done its job (see C<push_read>, |
674 | data arrives (also the first time it is queued) and removes it when it has |
408 | below). |
675 | done its job (see C<push_read>, below). |
409 | |
676 | |
410 | This way you can, for example, push three line-reads, followed by reading |
677 | This way you can, for example, push three line-reads, followed by reading |
411 | a chunk of data, and AnyEvent::Handle will execute them in order. |
678 | a chunk of data, and AnyEvent::Handle will execute them in order. |
412 | |
679 | |
413 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
680 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
414 | the specified number of bytes which give an XML datagram. |
681 | the specified number of bytes which give an XML datagram. |
415 | |
682 | |
416 | # in the default state, expect some header bytes |
683 | # in the default state, expect some header bytes |
417 | $handle->on_read (sub { |
684 | $handle->on_read (sub { |
418 | # some data is here, now queue the length-header-read (4 octets) |
685 | # some data is here, now queue the length-header-read (4 octets) |
419 | shift->unshift_read_chunk (4, sub { |
686 | shift->unshift_read (chunk => 4, sub { |
420 | # header arrived, decode |
687 | # header arrived, decode |
421 | my $len = unpack "N", $_[1]; |
688 | my $len = unpack "N", $_[1]; |
422 | |
689 | |
423 | # now read the payload |
690 | # now read the payload |
424 | shift->unshift_read_chunk ($len, sub { |
691 | shift->unshift_read (chunk => $len, sub { |
425 | my $xml = $_[1]; |
692 | my $xml = $_[1]; |
426 | # handle xml |
693 | # handle xml |
427 | }); |
694 | }); |
428 | }); |
695 | }); |
429 | }); |
696 | }); |
430 | |
697 | |
431 | Example 2: Implement a client for a protocol that replies either with |
698 | Example 2: Implement a client for a protocol that replies either with "OK" |
432 | "OK" and another line or "ERROR" for one request, and 64 bytes for the |
699 | and another line or "ERROR" for the first request that is sent, and 64 |
433 | second request. Due tot he availability of a full queue, we can just |
700 | bytes for the second request. Due to the availability of a queue, we can |
434 | pipeline sending both requests and manipulate the queue as necessary in |
701 | just pipeline sending both requests and manipulate the queue as necessary |
435 | the callbacks: |
702 | in the callbacks. |
436 | |
703 | |
437 | # request one |
704 | When the first callback is called and sees an "OK" response, it will |
|
|
705 | C<unshift> another line-read. This line-read will be queued I<before> the |
|
|
706 | 64-byte chunk callback. |
|
|
707 | |
|
|
708 | # request one, returns either "OK + extra line" or "ERROR" |
438 | $handle->push_write ("request 1\015\012"); |
709 | $handle->push_write ("request 1\015\012"); |
439 | |
710 | |
440 | # we expect "ERROR" or "OK" as response, so push a line read |
711 | # we expect "ERROR" or "OK" as response, so push a line read |
441 | $handle->push_read_line (sub { |
712 | $handle->push_read (line => sub { |
442 | # if we got an "OK", we have to _prepend_ another line, |
713 | # if we got an "OK", we have to _prepend_ another line, |
443 | # so it will be read before the second request reads its 64 bytes |
714 | # so it will be read before the second request reads its 64 bytes |
444 | # which are already in the queue when this callback is called |
715 | # which are already in the queue when this callback is called |
445 | # we don't do this in case we got an error |
716 | # we don't do this in case we got an error |
446 | if ($_[1] eq "OK") { |
717 | if ($_[1] eq "OK") { |
447 | $_[0]->unshift_read_line (sub { |
718 | $_[0]->unshift_read (line => sub { |
448 | my $response = $_[1]; |
719 | my $response = $_[1]; |
449 | ... |
720 | ... |
450 | }); |
721 | }); |
451 | } |
722 | } |
452 | }); |
723 | }); |
453 | |
724 | |
454 | # request two |
725 | # request two, simply returns 64 octets |
455 | $handle->push_write ("request 2\015\012"); |
726 | $handle->push_write ("request 2\015\012"); |
456 | |
727 | |
457 | # simply read 64 bytes, always |
728 | # simply read 64 bytes, always |
458 | $handle->push_read_chunk (64, sub { |
729 | $handle->push_read (chunk => 64, sub { |
459 | my $response = $_[1]; |
730 | my $response = $_[1]; |
460 | ... |
731 | ... |
461 | }); |
732 | }); |
462 | |
733 | |
463 | =over 4 |
734 | =over 4 |
464 | |
735 | |
465 | =cut |
736 | =cut |
466 | |
737 | |
467 | sub _drain_rbuf { |
738 | sub _drain_rbuf { |
468 | my ($self) = @_; |
739 | my ($self) = @_; |
|
|
740 | |
|
|
741 | local $self->{_in_drain} = 1; |
469 | |
742 | |
470 | if ( |
743 | if ( |
471 | defined $self->{rbuf_max} |
744 | defined $self->{rbuf_max} |
472 | && $self->{rbuf_max} < length $self->{rbuf} |
745 | && $self->{rbuf_max} < length $self->{rbuf} |
473 | ) { |
746 | ) { |
474 | $! = &Errno::ENOSPC; return $self->error; |
747 | $self->_error (&Errno::ENOSPC, 1), return; |
475 | } |
748 | } |
476 | |
749 | |
477 | return if $self->{in_drain}; |
750 | while () { |
478 | local $self->{in_drain} = 1; |
|
|
479 | |
|
|
480 | while (my $len = length $self->{rbuf}) { |
751 | my $len = length $self->{rbuf}; |
481 | no strict 'refs'; |
752 | |
482 | if (my $cb = shift @{ $self->{queue} }) { |
753 | if (my $cb = shift @{ $self->{_queue} }) { |
483 | unless ($cb->($self)) { |
754 | unless ($cb->($self)) { |
484 | if ($self->{eof}) { |
755 | if ($self->{_eof}) { |
485 | # no progress can be made (not enough data and no data forthcoming) |
756 | # no progress can be made (not enough data and no data forthcoming) |
486 | $! = &Errno::EPIPE; return $self->error; |
757 | $self->_error (&Errno::EPIPE, 1), return; |
487 | } |
758 | } |
488 | |
759 | |
489 | unshift @{ $self->{queue} }, $cb; |
760 | unshift @{ $self->{_queue} }, $cb; |
490 | return; |
761 | last; |
491 | } |
762 | } |
492 | } elsif ($self->{on_read}) { |
763 | } elsif ($self->{on_read}) { |
|
|
764 | last unless $len; |
|
|
765 | |
493 | $self->{on_read}($self); |
766 | $self->{on_read}($self); |
494 | |
767 | |
495 | if ( |
768 | if ( |
496 | $self->{eof} # if no further data will arrive |
|
|
497 | && $len == length $self->{rbuf} # and no data has been consumed |
769 | $len == length $self->{rbuf} # if no data has been consumed |
498 | && !@{ $self->{queue} } # and the queue is still empty |
770 | && !@{ $self->{_queue} } # and the queue is still empty |
499 | && $self->{on_read} # and we still want to read data |
771 | && $self->{on_read} # but we still have on_read |
500 | ) { |
772 | ) { |
|
|
773 | # no further data will arrive |
501 | # then no progress can be made |
774 | # so no progress can be made |
502 | $! = &Errno::EPIPE; return $self->error; |
775 | $self->_error (&Errno::EPIPE, 1), return |
|
|
776 | if $self->{_eof}; |
|
|
777 | |
|
|
778 | last; # more data might arrive |
503 | } |
779 | } |
504 | } else { |
780 | } else { |
505 | # read side becomes idle |
781 | # read side becomes idle |
506 | delete $self->{rw}; |
782 | delete $self->{_rw}; |
507 | return; |
783 | last; |
508 | } |
784 | } |
509 | } |
785 | } |
510 | |
786 | |
511 | if ($self->{eof}) { |
787 | if ($self->{_eof}) { |
512 | $self->_shutdown; |
788 | if ($self->{on_eof}) { |
513 | $self->{on_eof}($self) |
789 | $self->{on_eof}($self) |
514 | if $self->{on_eof}; |
790 | } else { |
|
|
791 | $self->_error (0, 1); |
|
|
792 | } |
|
|
793 | } |
|
|
794 | |
|
|
795 | # may need to restart read watcher |
|
|
796 | unless ($self->{_rw}) { |
|
|
797 | $self->start_read |
|
|
798 | if $self->{on_read} || @{ $self->{_queue} }; |
515 | } |
799 | } |
516 | } |
800 | } |
517 | |
801 | |
518 | =item $handle->on_read ($cb) |
802 | =item $handle->on_read ($cb) |
519 | |
803 | |
… | |
… | |
525 | |
809 | |
526 | sub on_read { |
810 | sub on_read { |
527 | my ($self, $cb) = @_; |
811 | my ($self, $cb) = @_; |
528 | |
812 | |
529 | $self->{on_read} = $cb; |
813 | $self->{on_read} = $cb; |
|
|
814 | $self->_drain_rbuf if $cb && !$self->{_in_drain}; |
530 | } |
815 | } |
531 | |
816 | |
532 | =item $handle->rbuf |
817 | =item $handle->rbuf |
533 | |
818 | |
534 | Returns the read buffer (as a modifiable lvalue). |
819 | Returns the read buffer (as a modifiable lvalue). |
… | |
… | |
582 | |
867 | |
583 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
868 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
584 | ->($self, $cb, @_); |
869 | ->($self, $cb, @_); |
585 | } |
870 | } |
586 | |
871 | |
587 | push @{ $self->{queue} }, $cb; |
872 | push @{ $self->{_queue} }, $cb; |
588 | $self->_drain_rbuf; |
873 | $self->_drain_rbuf unless $self->{_in_drain}; |
589 | } |
874 | } |
590 | |
875 | |
591 | sub unshift_read { |
876 | sub unshift_read { |
592 | my $self = shift; |
877 | my $self = shift; |
593 | my $cb = pop; |
878 | my $cb = pop; |
… | |
… | |
598 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") |
883 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") |
599 | ->($self, $cb, @_); |
884 | ->($self, $cb, @_); |
600 | } |
885 | } |
601 | |
886 | |
602 | |
887 | |
603 | unshift @{ $self->{queue} }, $cb; |
888 | unshift @{ $self->{_queue} }, $cb; |
604 | $self->_drain_rbuf; |
889 | $self->_drain_rbuf unless $self->{_in_drain}; |
605 | } |
890 | } |
606 | |
891 | |
607 | =item $handle->push_read (type => @args, $cb) |
892 | =item $handle->push_read (type => @args, $cb) |
608 | |
893 | |
609 | =item $handle->unshift_read (type => @args, $cb) |
894 | =item $handle->unshift_read (type => @args, $cb) |
… | |
… | |
615 | Predefined types are (if you have ideas for additional types, feel free to |
900 | Predefined types are (if you have ideas for additional types, feel free to |
616 | drop by and tell us): |
901 | drop by and tell us): |
617 | |
902 | |
618 | =over 4 |
903 | =over 4 |
619 | |
904 | |
620 | =item chunk => $octets, $cb->($self, $data) |
905 | =item chunk => $octets, $cb->($handle, $data) |
621 | |
906 | |
622 | Invoke the callback only once C<$octets> bytes have been read. Pass the |
907 | Invoke the callback only once C<$octets> bytes have been read. Pass the |
623 | data read to the callback. The callback will never be called with less |
908 | data read to the callback. The callback will never be called with less |
624 | data. |
909 | data. |
625 | |
910 | |
… | |
… | |
639 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
924 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
640 | 1 |
925 | 1 |
641 | } |
926 | } |
642 | }; |
927 | }; |
643 | |
928 | |
644 | # compatibility with older API |
|
|
645 | sub push_read_chunk { |
|
|
646 | $_[0]->push_read (chunk => $_[1], $_[2]); |
|
|
647 | } |
|
|
648 | |
|
|
649 | sub unshift_read_chunk { |
|
|
650 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
|
|
651 | } |
|
|
652 | |
|
|
653 | =item line => [$eol, ]$cb->($self, $line, $eol) |
929 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
654 | |
930 | |
655 | The callback will be called only once a full line (including the end of |
931 | The callback will be called only once a full line (including the end of |
656 | line marker, C<$eol>) has been read. This line (excluding the end of line |
932 | line marker, C<$eol>) has been read. This line (excluding the end of line |
657 | marker) will be passed to the callback as second argument (C<$line>), and |
933 | marker) will be passed to the callback as second argument (C<$line>), and |
658 | the end of line marker as the third argument (C<$eol>). |
934 | the end of line marker as the third argument (C<$eol>). |
… | |
… | |
672 | =cut |
948 | =cut |
673 | |
949 | |
674 | register_read_type line => sub { |
950 | register_read_type line => sub { |
675 | my ($self, $cb, $eol) = @_; |
951 | my ($self, $cb, $eol) = @_; |
676 | |
952 | |
677 | $eol = qr|(\015?\012)| if @_ < 3; |
953 | if (@_ < 3) { |
|
|
954 | # this is more than twice as fast as the generic code below |
|
|
955 | sub { |
|
|
956 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
|
|
957 | |
|
|
958 | $cb->($_[0], $1, $2); |
|
|
959 | 1 |
|
|
960 | } |
|
|
961 | } else { |
678 | $eol = quotemeta $eol unless ref $eol; |
962 | $eol = quotemeta $eol unless ref $eol; |
679 | $eol = qr|^(.*?)($eol)|s; |
963 | $eol = qr|^(.*?)($eol)|s; |
680 | |
964 | |
681 | sub { |
965 | sub { |
682 | $_[0]{rbuf} =~ s/$eol// or return; |
966 | $_[0]{rbuf} =~ s/$eol// or return; |
683 | |
967 | |
684 | $cb->($_[0], $1, $2); |
968 | $cb->($_[0], $1, $2); |
|
|
969 | 1 |
685 | 1 |
970 | } |
686 | } |
971 | } |
687 | }; |
972 | }; |
688 | |
973 | |
689 | # compatibility with older API |
|
|
690 | sub push_read_line { |
|
|
691 | my $self = shift; |
|
|
692 | $self->push_read (line => @_); |
|
|
693 | } |
|
|
694 | |
|
|
695 | sub unshift_read_line { |
|
|
696 | my $self = shift; |
|
|
697 | $self->unshift_read (line => @_); |
|
|
698 | } |
|
|
699 | |
|
|
700 | =item netstring => $cb->($string) |
|
|
701 | |
|
|
702 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
703 | |
|
|
704 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
705 | |
|
|
706 | =cut |
|
|
707 | |
|
|
708 | register_read_type netstring => sub { |
|
|
709 | my ($self, $cb) = @_; |
|
|
710 | |
|
|
711 | sub { |
|
|
712 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
713 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
714 | $! = &Errno::EBADMSG; |
|
|
715 | $self->error; |
|
|
716 | } |
|
|
717 | return; |
|
|
718 | } |
|
|
719 | |
|
|
720 | my $len = $1; |
|
|
721 | |
|
|
722 | $self->unshift_read (chunk => $len, sub { |
|
|
723 | my $string = $_[1]; |
|
|
724 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
725 | if ($_[1] eq ",") { |
|
|
726 | $cb->($_[0], $string); |
|
|
727 | } else { |
|
|
728 | $! = &Errno::EBADMSG; |
|
|
729 | $self->error; |
|
|
730 | } |
|
|
731 | }); |
|
|
732 | }); |
|
|
733 | |
|
|
734 | 1 |
|
|
735 | } |
|
|
736 | }; |
|
|
737 | |
|
|
738 | =item regex => $accept[, $reject[, $skip], $cb->($data) |
974 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
739 | |
975 | |
740 | Makes a regex match against the regex object C<$accept> and returns |
976 | Makes a regex match against the regex object C<$accept> and returns |
741 | everything up to and including the match. |
977 | everything up to and including the match. |
742 | |
978 | |
743 | Example: read a single line terminated by '\n'. |
979 | Example: read a single line terminated by '\n'. |
… | |
… | |
791 | return 1; |
1027 | return 1; |
792 | } |
1028 | } |
793 | |
1029 | |
794 | # reject |
1030 | # reject |
795 | if ($reject && $$rbuf =~ $reject) { |
1031 | if ($reject && $$rbuf =~ $reject) { |
796 | $! = &Errno::EBADMSG; |
1032 | $self->_error (&Errno::EBADMSG); |
797 | $self->error; |
|
|
798 | } |
1033 | } |
799 | |
1034 | |
800 | # skip |
1035 | # skip |
801 | if ($skip && $$rbuf =~ $skip) { |
1036 | if ($skip && $$rbuf =~ $skip) { |
802 | $data .= substr $$rbuf, 0, $+[0], ""; |
1037 | $data .= substr $$rbuf, 0, $+[0], ""; |
… | |
… | |
804 | |
1039 | |
805 | () |
1040 | () |
806 | } |
1041 | } |
807 | }; |
1042 | }; |
808 | |
1043 | |
|
|
1044 | =item netstring => $cb->($handle, $string) |
|
|
1045 | |
|
|
1046 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
1047 | |
|
|
1048 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
1049 | |
|
|
1050 | =cut |
|
|
1051 | |
|
|
1052 | register_read_type netstring => sub { |
|
|
1053 | my ($self, $cb) = @_; |
|
|
1054 | |
|
|
1055 | sub { |
|
|
1056 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
1057 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
1058 | $self->_error (&Errno::EBADMSG); |
|
|
1059 | } |
|
|
1060 | return; |
|
|
1061 | } |
|
|
1062 | |
|
|
1063 | my $len = $1; |
|
|
1064 | |
|
|
1065 | $self->unshift_read (chunk => $len, sub { |
|
|
1066 | my $string = $_[1]; |
|
|
1067 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
1068 | if ($_[1] eq ",") { |
|
|
1069 | $cb->($_[0], $string); |
|
|
1070 | } else { |
|
|
1071 | $self->_error (&Errno::EBADMSG); |
|
|
1072 | } |
|
|
1073 | }); |
|
|
1074 | }); |
|
|
1075 | |
|
|
1076 | 1 |
|
|
1077 | } |
|
|
1078 | }; |
|
|
1079 | |
|
|
1080 | =item packstring => $format, $cb->($handle, $string) |
|
|
1081 | |
|
|
1082 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
1083 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
1084 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
1085 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
1086 | |
|
|
1087 | DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. |
|
|
1088 | |
|
|
1089 | Example: read a block of data prefixed by its length in BER-encoded |
|
|
1090 | format (very efficient). |
|
|
1091 | |
|
|
1092 | $handle->push_read (packstring => "w", sub { |
|
|
1093 | my ($handle, $data) = @_; |
|
|
1094 | }); |
|
|
1095 | |
|
|
1096 | =cut |
|
|
1097 | |
|
|
1098 | register_read_type packstring => sub { |
|
|
1099 | my ($self, $cb, $format) = @_; |
|
|
1100 | |
|
|
1101 | sub { |
|
|
1102 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1103 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
|
|
1104 | or return; |
|
|
1105 | |
|
|
1106 | $format = length pack $format, $len; |
|
|
1107 | |
|
|
1108 | # bypass unshift if we already have the remaining chunk |
|
|
1109 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1110 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1111 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1112 | $cb->($_[0], $data); |
|
|
1113 | } else { |
|
|
1114 | # remove prefix |
|
|
1115 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1116 | |
|
|
1117 | # read remaining chunk |
|
|
1118 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1119 | } |
|
|
1120 | |
|
|
1121 | 1 |
|
|
1122 | } |
|
|
1123 | }; |
|
|
1124 | |
|
|
1125 | =item json => $cb->($handle, $hash_or_arrayref) |
|
|
1126 | |
|
|
1127 | Reads a JSON object or array, decodes it and passes it to the callback. |
|
|
1128 | |
|
|
1129 | If a C<json> object was passed to the constructor, then that will be used |
|
|
1130 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
|
|
1131 | |
|
|
1132 | This read type uses the incremental parser available with JSON version |
|
|
1133 | 2.09 (and JSON::XS version 2.2) and above. You have to provide a |
|
|
1134 | dependency on your own: this module will load the JSON module, but |
|
|
1135 | AnyEvent does not depend on it itself. |
|
|
1136 | |
|
|
1137 | Since JSON texts are fully self-delimiting, the C<json> read and write |
|
|
1138 | types are an ideal simple RPC protocol: just exchange JSON datagrams. See |
|
|
1139 | the C<json> write type description, above, for an actual example. |
|
|
1140 | |
|
|
1141 | =cut |
|
|
1142 | |
|
|
1143 | register_read_type json => sub { |
|
|
1144 | my ($self, $cb) = @_; |
|
|
1145 | |
|
|
1146 | require JSON; |
|
|
1147 | |
|
|
1148 | my $data; |
|
|
1149 | my $rbuf = \$self->{rbuf}; |
|
|
1150 | |
|
|
1151 | my $json = $self->{json} ||= JSON->new->utf8; |
|
|
1152 | |
|
|
1153 | sub { |
|
|
1154 | my $ref = $json->incr_parse ($self->{rbuf}); |
|
|
1155 | |
|
|
1156 | if ($ref) { |
|
|
1157 | $self->{rbuf} = $json->incr_text; |
|
|
1158 | $json->incr_text = ""; |
|
|
1159 | $cb->($self, $ref); |
|
|
1160 | |
|
|
1161 | 1 |
|
|
1162 | } else { |
|
|
1163 | $self->{rbuf} = ""; |
|
|
1164 | () |
|
|
1165 | } |
|
|
1166 | } |
|
|
1167 | }; |
|
|
1168 | |
|
|
1169 | =item storable => $cb->($handle, $ref) |
|
|
1170 | |
|
|
1171 | Deserialises a L<Storable> frozen representation as written by the |
|
|
1172 | C<storable> write type (BER-encoded length prefix followed by nfreeze'd |
|
|
1173 | data). |
|
|
1174 | |
|
|
1175 | Raises C<EBADMSG> error if the data could not be decoded. |
|
|
1176 | |
|
|
1177 | =cut |
|
|
1178 | |
|
|
1179 | register_read_type storable => sub { |
|
|
1180 | my ($self, $cb) = @_; |
|
|
1181 | |
|
|
1182 | require Storable; |
|
|
1183 | |
|
|
1184 | sub { |
|
|
1185 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1186 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
|
|
1187 | or return; |
|
|
1188 | |
|
|
1189 | my $format = length pack "w", $len; |
|
|
1190 | |
|
|
1191 | # bypass unshift if we already have the remaining chunk |
|
|
1192 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1193 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1194 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1195 | $cb->($_[0], Storable::thaw ($data)); |
|
|
1196 | } else { |
|
|
1197 | # remove prefix |
|
|
1198 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1199 | |
|
|
1200 | # read remaining chunk |
|
|
1201 | $_[0]->unshift_read (chunk => $len, sub { |
|
|
1202 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
|
|
1203 | $cb->($_[0], $ref); |
|
|
1204 | } else { |
|
|
1205 | $self->_error (&Errno::EBADMSG); |
|
|
1206 | } |
|
|
1207 | }); |
|
|
1208 | } |
|
|
1209 | |
|
|
1210 | 1 |
|
|
1211 | } |
|
|
1212 | }; |
|
|
1213 | |
809 | =back |
1214 | =back |
810 | |
1215 | |
811 | =item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args) |
1216 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
812 | |
1217 | |
813 | This function (not method) lets you add your own types to C<push_read>. |
1218 | This function (not method) lets you add your own types to C<push_read>. |
814 | |
1219 | |
815 | Whenever the given C<type> is used, C<push_read> will invoke the code |
1220 | Whenever the given C<type> is used, C<push_read> will invoke the code |
816 | reference with the handle object, the callback and the remaining |
1221 | reference with the handle object, the callback and the remaining |
… | |
… | |
818 | |
1223 | |
819 | The code reference is supposed to return a callback (usually a closure) |
1224 | The code reference is supposed to return a callback (usually a closure) |
820 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
1225 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
821 | |
1226 | |
822 | It should invoke the passed callback when it is done reading (remember to |
1227 | It should invoke the passed callback when it is done reading (remember to |
823 | pass C<$self> as first argument as all other callbacks do that). |
1228 | pass C<$handle> as first argument as all other callbacks do that). |
824 | |
1229 | |
825 | Note that this is a function, and all types registered this way will be |
1230 | Note that this is a function, and all types registered this way will be |
826 | global, so try to use unique names. |
1231 | global, so try to use unique names. |
827 | |
1232 | |
828 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
1233 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
… | |
… | |
831 | =item $handle->stop_read |
1236 | =item $handle->stop_read |
832 | |
1237 | |
833 | =item $handle->start_read |
1238 | =item $handle->start_read |
834 | |
1239 | |
835 | In rare cases you actually do not want to read anything from the |
1240 | In rare cases you actually do not want to read anything from the |
836 | socket. In this case you can call C<stop_read>. Neither C<on_read> no |
1241 | socket. In this case you can call C<stop_read>. Neither C<on_read> nor |
837 | any queued callbacks will be executed then. To start reading again, call |
1242 | any queued callbacks will be executed then. To start reading again, call |
838 | C<start_read>. |
1243 | C<start_read>. |
839 | |
1244 | |
|
|
1245 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
|
|
1246 | you change the C<on_read> callback or push/unshift a read callback, and it |
|
|
1247 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
|
|
1248 | there are any read requests in the queue. |
|
|
1249 | |
840 | =cut |
1250 | =cut |
841 | |
1251 | |
842 | sub stop_read { |
1252 | sub stop_read { |
843 | my ($self) = @_; |
1253 | my ($self) = @_; |
844 | |
1254 | |
845 | delete $self->{rw}; |
1255 | delete $self->{_rw}; |
846 | } |
1256 | } |
847 | |
1257 | |
848 | sub start_read { |
1258 | sub start_read { |
849 | my ($self) = @_; |
1259 | my ($self) = @_; |
850 | |
1260 | |
851 | unless ($self->{rw} || $self->{eof}) { |
1261 | unless ($self->{_rw} || $self->{_eof}) { |
852 | Scalar::Util::weaken $self; |
1262 | Scalar::Util::weaken $self; |
853 | |
1263 | |
854 | $self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1264 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
855 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
1265 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
856 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1266 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
857 | |
1267 | |
858 | if ($len > 0) { |
1268 | if ($len > 0) { |
|
|
1269 | $self->{_activity} = AnyEvent->now; |
|
|
1270 | |
859 | $self->{filter_r} |
1271 | $self->{filter_r} |
860 | ? $self->{filter_r}->($self, $rbuf) |
1272 | ? $self->{filter_r}($self, $rbuf) |
861 | : $self->_drain_rbuf; |
1273 | : $self->{_in_drain} || $self->_drain_rbuf; |
862 | |
1274 | |
863 | } elsif (defined $len) { |
1275 | } elsif (defined $len) { |
864 | delete $self->{rw}; |
1276 | delete $self->{_rw}; |
865 | $self->{eof} = 1; |
1277 | $self->{_eof} = 1; |
866 | $self->_drain_rbuf; |
1278 | $self->_drain_rbuf unless $self->{_in_drain}; |
867 | |
1279 | |
868 | } elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) { |
1280 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
869 | return $self->error; |
1281 | return $self->_error ($!, 1); |
870 | } |
1282 | } |
871 | }); |
1283 | }); |
872 | } |
1284 | } |
873 | } |
1285 | } |
874 | |
1286 | |
875 | sub _dotls { |
1287 | sub _dotls { |
876 | my ($self) = @_; |
1288 | my ($self) = @_; |
877 | |
1289 | |
|
|
1290 | my $buf; |
|
|
1291 | |
878 | if (length $self->{tls_wbuf}) { |
1292 | if (length $self->{_tls_wbuf}) { |
879 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) { |
1293 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
880 | substr $self->{tls_wbuf}, 0, $len, ""; |
1294 | substr $self->{_tls_wbuf}, 0, $len, ""; |
881 | } |
1295 | } |
882 | } |
1296 | } |
883 | |
1297 | |
884 | if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) { |
1298 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
885 | $self->{wbuf} .= $buf; |
1299 | $self->{wbuf} .= $buf; |
886 | $self->_drain_wbuf; |
1300 | $self->_drain_wbuf; |
887 | } |
1301 | } |
888 | |
1302 | |
889 | while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { |
1303 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
|
|
1304 | if (length $buf) { |
890 | $self->{rbuf} .= $buf; |
1305 | $self->{rbuf} .= $buf; |
891 | $self->_drain_rbuf; |
1306 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1307 | } else { |
|
|
1308 | # let's treat SSL-eof as we treat normal EOF |
|
|
1309 | $self->{_eof} = 1; |
|
|
1310 | $self->_shutdown; |
|
|
1311 | return; |
|
|
1312 | } |
892 | } |
1313 | } |
893 | |
1314 | |
894 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1315 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
895 | |
1316 | |
896 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1317 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
897 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
1318 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
898 | $self->error; |
1319 | return $self->_error ($!, 1); |
899 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1320 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
900 | $! = &Errno::EIO; |
1321 | return $self->_error (&Errno::EIO, 1); |
901 | $self->error; |
|
|
902 | } |
1322 | } |
903 | |
1323 | |
904 | # all others are fine for our purposes |
1324 | # all others are fine for our purposes |
905 | } |
1325 | } |
906 | } |
1326 | } |
… | |
… | |
915 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1335 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
916 | |
1336 | |
917 | The second argument is the optional C<Net::SSLeay::CTX> object that is |
1337 | The second argument is the optional C<Net::SSLeay::CTX> object that is |
918 | used when AnyEvent::Handle has to create its own TLS connection object. |
1338 | used when AnyEvent::Handle has to create its own TLS connection object. |
919 | |
1339 | |
920 | =cut |
1340 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
|
|
1341 | call and can be used or changed to your liking. Note that the handshake |
|
|
1342 | might have already started when this function returns. |
921 | |
1343 | |
922 | # TODO: maybe document... |
1344 | =cut |
|
|
1345 | |
923 | sub starttls { |
1346 | sub starttls { |
924 | my ($self, $ssl, $ctx) = @_; |
1347 | my ($self, $ssl, $ctx) = @_; |
925 | |
1348 | |
926 | $self->stoptls; |
1349 | $self->stoptls; |
927 | |
1350 | |
… | |
… | |
942 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
1365 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
943 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1366 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
944 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1367 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
945 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1368 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
946 | |
1369 | |
947 | $self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1370 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
948 | $self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1371 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
949 | |
1372 | |
950 | Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio}); |
1373 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
951 | |
1374 | |
952 | $self->{filter_w} = sub { |
1375 | $self->{filter_w} = sub { |
953 | $_[0]{tls_wbuf} .= ${$_[1]}; |
1376 | $_[0]{_tls_wbuf} .= ${$_[1]}; |
954 | &_dotls; |
1377 | &_dotls; |
955 | }; |
1378 | }; |
956 | $self->{filter_r} = sub { |
1379 | $self->{filter_r} = sub { |
957 | Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]}); |
1380 | Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]}); |
958 | &_dotls; |
1381 | &_dotls; |
959 | }; |
1382 | }; |
960 | } |
1383 | } |
961 | |
1384 | |
962 | =item $handle->stoptls |
1385 | =item $handle->stoptls |
… | |
… | |
968 | |
1391 | |
969 | sub stoptls { |
1392 | sub stoptls { |
970 | my ($self) = @_; |
1393 | my ($self) = @_; |
971 | |
1394 | |
972 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
1395 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
|
|
1396 | |
973 | delete $self->{tls_rbio}; |
1397 | delete $self->{_rbio}; |
974 | delete $self->{tls_wbio}; |
1398 | delete $self->{_wbio}; |
975 | delete $self->{tls_wbuf}; |
1399 | delete $self->{_tls_wbuf}; |
976 | delete $self->{filter_r}; |
1400 | delete $self->{filter_r}; |
977 | delete $self->{filter_w}; |
1401 | delete $self->{filter_w}; |
978 | } |
1402 | } |
979 | |
1403 | |
980 | sub DESTROY { |
1404 | sub DESTROY { |
981 | my $self = shift; |
1405 | my $self = shift; |
982 | |
1406 | |
983 | $self->stoptls; |
1407 | $self->stoptls; |
|
|
1408 | |
|
|
1409 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
|
|
1410 | |
|
|
1411 | if ($linger && length $self->{wbuf}) { |
|
|
1412 | my $fh = delete $self->{fh}; |
|
|
1413 | my $wbuf = delete $self->{wbuf}; |
|
|
1414 | |
|
|
1415 | my @linger; |
|
|
1416 | |
|
|
1417 | push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { |
|
|
1418 | my $len = syswrite $fh, $wbuf, length $wbuf; |
|
|
1419 | |
|
|
1420 | if ($len > 0) { |
|
|
1421 | substr $wbuf, 0, $len, ""; |
|
|
1422 | } else { |
|
|
1423 | @linger = (); # end |
|
|
1424 | } |
|
|
1425 | }); |
|
|
1426 | push @linger, AnyEvent->timer (after => $linger, cb => sub { |
|
|
1427 | @linger = (); |
|
|
1428 | }); |
|
|
1429 | } |
984 | } |
1430 | } |
985 | |
1431 | |
986 | =item AnyEvent::Handle::TLS_CTX |
1432 | =item AnyEvent::Handle::TLS_CTX |
987 | |
1433 | |
988 | This function creates and returns the Net::SSLeay::CTX object used by |
1434 | This function creates and returns the Net::SSLeay::CTX object used by |
… | |
… | |
1018 | } |
1464 | } |
1019 | } |
1465 | } |
1020 | |
1466 | |
1021 | =back |
1467 | =back |
1022 | |
1468 | |
|
|
1469 | =head1 SUBCLASSING AnyEvent::Handle |
|
|
1470 | |
|
|
1471 | In many cases, you might want to subclass AnyEvent::Handle. |
|
|
1472 | |
|
|
1473 | To make this easier, a given version of AnyEvent::Handle uses these |
|
|
1474 | conventions: |
|
|
1475 | |
|
|
1476 | =over 4 |
|
|
1477 | |
|
|
1478 | =item * all constructor arguments become object members. |
|
|
1479 | |
|
|
1480 | At least initially, when you pass a C<tls>-argument to the constructor it |
|
|
1481 | will end up in C<< $handle->{tls} >>. Those members might be changed or |
|
|
1482 | mutated later on (for example C<tls> will hold the TLS connection object). |
|
|
1483 | |
|
|
1484 | =item * other object member names are prefixed with an C<_>. |
|
|
1485 | |
|
|
1486 | All object members not explicitly documented (internal use) are prefixed |
|
|
1487 | with an underscore character, so the remaining non-C<_>-namespace is free |
|
|
1488 | for use for subclasses. |
|
|
1489 | |
|
|
1490 | =item * all members not documented here and not prefixed with an underscore |
|
|
1491 | are free to use in subclasses. |
|
|
1492 | |
|
|
1493 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
|
|
1494 | member variables, but thats just life, at least it is documented. |
|
|
1495 | |
|
|
1496 | =back |
|
|
1497 | |
1023 | =head1 AUTHOR |
1498 | =head1 AUTHOR |
1024 | |
1499 | |
1025 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
1500 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
1026 | |
1501 | |
1027 | =cut |
1502 | =cut |