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(WSAEWOULDBLOCK); |
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
8 | use Scalar::Util (); |
8 | use Scalar::Util (); |
9 | use Carp (); |
9 | use Carp (); |
… | |
… | |
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 = 4.14; |
19 | our $VERSION = 4.32; |
20 | |
20 | |
21 | =head1 SYNOPSIS |
21 | =head1 SYNOPSIS |
22 | |
22 | |
23 | use AnyEvent; |
23 | use AnyEvent; |
24 | use AnyEvent::Handle; |
24 | use AnyEvent::Handle; |
… | |
… | |
49 | |
49 | |
50 | 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 |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
52 | on sockets see L<AnyEvent::Util>. |
52 | on sockets see L<AnyEvent::Util>. |
53 | |
53 | |
|
|
54 | The L<AnyEvent::Intro> tutorial contains some well-documented |
|
|
55 | AnyEvent::Handle examples. |
|
|
56 | |
54 | In the following, when the documentation refers to of "bytes" then this |
57 | In the following, when the documentation refers to of "bytes" then this |
55 | means characters. As sysread and syswrite are used for all I/O, their |
58 | means characters. As sysread and syswrite are used for all I/O, their |
56 | treatment of characters applies to this module as well. |
59 | treatment of characters applies to this module as well. |
57 | |
60 | |
58 | All callbacks will be invoked with the handle object as their first |
61 | All callbacks will be invoked with the handle object as their first |
… | |
… | |
70 | |
73 | |
71 | =item fh => $filehandle [MANDATORY] |
74 | =item fh => $filehandle [MANDATORY] |
72 | |
75 | |
73 | The filehandle this L<AnyEvent::Handle> object will operate on. |
76 | The filehandle this L<AnyEvent::Handle> object will operate on. |
74 | |
77 | |
75 | NOTE: The filehandle will be set to non-blocking (using |
78 | NOTE: The filehandle will be set to non-blocking mode (using |
76 | AnyEvent::Util::fh_nonblocking). |
79 | C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in |
|
|
80 | that mode. |
77 | |
81 | |
78 | =item on_eof => $cb->($handle) |
82 | =item on_eof => $cb->($handle) |
79 | |
83 | |
80 | Set the callback to be called when an end-of-file condition is detcted, |
84 | 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 |
85 | i.e. in the case of a socket, when the other side has closed the |
82 | connection cleanly. |
86 | connection cleanly. |
83 | |
87 | |
|
|
88 | For sockets, this just means that the other side has stopped sending data, |
|
|
89 | you can still try to write data, and, in fact, one can return from the EOF |
|
|
90 | callback and continue writing data, as only the read part has been shut |
|
|
91 | down. |
|
|
92 | |
84 | While not mandatory, it is highly recommended to set an eof callback, |
93 | While not mandatory, it is I<highly> recommended to set an EOF callback, |
85 | otherwise you might end up with a closed socket while you are still |
94 | otherwise you might end up with a closed socket while you are still |
86 | waiting for data. |
95 | waiting for data. |
|
|
96 | |
|
|
97 | If an EOF condition has been detected but no C<on_eof> callback has been |
|
|
98 | set, then a fatal error will be raised with C<$!> set to <0>. |
87 | |
99 | |
88 | =item on_error => $cb->($handle, $fatal) |
100 | =item on_error => $cb->($handle, $fatal) |
89 | |
101 | |
90 | This is the error callback, which is called when, well, some error |
102 | This is the error callback, which is called when, well, some error |
91 | occured, such as not being able to resolve the hostname, failure to |
103 | occured, such as not being able to resolve the hostname, failure to |
92 | connect or a read error. |
104 | connect or a read error. |
93 | |
105 | |
94 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
106 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
95 | fatal errors the handle object will be shut down and will not be |
107 | fatal errors the handle object will be shut down and will not be usable |
|
|
108 | (but you are free to look at the current C<< ->rbuf >>). Examples of fatal |
|
|
109 | errors are an EOF condition with active (but unsatisifable) read watchers |
|
|
110 | (C<EPIPE>) or I/O errors. |
|
|
111 | |
96 | usable. Non-fatal errors can be retried by simply returning, but it is |
112 | Non-fatal errors can be retried by simply returning, but it is recommended |
97 | recommended to simply ignore this parameter and instead abondon the handle |
113 | to simply ignore this parameter and instead abondon the handle object |
98 | object when this callback is invoked. |
114 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
115 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
99 | |
116 | |
100 | On callback entrance, the value of C<$!> contains the operating system |
117 | On callback entrance, the value of C<$!> contains the operating system |
101 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
118 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
102 | |
119 | |
103 | While not mandatory, it is I<highly> recommended to set this callback, as |
120 | While not mandatory, it is I<highly> recommended to set this callback, as |
… | |
… | |
124 | This sets the callback that is called when the write buffer becomes empty |
141 | This sets the callback that is called when the write buffer becomes empty |
125 | (or when the callback is set and the buffer is empty already). |
142 | (or when the callback is set and the buffer is empty already). |
126 | |
143 | |
127 | To append to the write buffer, use the C<< ->push_write >> method. |
144 | To append to the write buffer, use the C<< ->push_write >> method. |
128 | |
145 | |
|
|
146 | This callback is useful when you don't want to put all of your write data |
|
|
147 | into the queue at once, for example, when you want to write the contents |
|
|
148 | of some file to the socket you might not want to read the whole file into |
|
|
149 | memory and push it into the queue, but instead only read more data from |
|
|
150 | the file when the write queue becomes empty. |
|
|
151 | |
129 | =item timeout => $fractional_seconds |
152 | =item timeout => $fractional_seconds |
130 | |
153 | |
131 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
154 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
132 | seconds pass without a successful read or write on the underlying file |
155 | seconds pass without a successful read or write on the underlying file |
133 | handle, the C<on_timeout> callback will be invoked (and if that one is |
156 | handle, the C<on_timeout> callback will be invoked (and if that one is |
134 | missing, an C<ETIMEDOUT> error will be raised). |
157 | missing, a non-fatal C<ETIMEDOUT> error will be raised). |
135 | |
158 | |
136 | Note that timeout processing is also active when you currently do not have |
159 | Note that timeout processing is also active when you currently do not have |
137 | any outstanding read or write requests: If you plan to keep the connection |
160 | any outstanding read or write requests: If you plan to keep the connection |
138 | idle then you should disable the timout temporarily or ignore the timeout |
161 | idle then you should disable the timout temporarily or ignore the timeout |
139 | in the C<on_timeout> callback. |
162 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
|
|
163 | restart the timeout. |
140 | |
164 | |
141 | Zero (the default) disables this timeout. |
165 | Zero (the default) disables this timeout. |
142 | |
166 | |
143 | =item on_timeout => $cb->($handle) |
167 | =item on_timeout => $cb->($handle) |
144 | |
168 | |
… | |
… | |
148 | |
172 | |
149 | =item rbuf_max => <bytes> |
173 | =item rbuf_max => <bytes> |
150 | |
174 | |
151 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
175 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
152 | when the read buffer ever (strictly) exceeds this size. This is useful to |
176 | when the read buffer ever (strictly) exceeds this size. This is useful to |
153 | avoid denial-of-service attacks. |
177 | avoid some forms of denial-of-service attacks. |
154 | |
178 | |
155 | For example, a server accepting connections from untrusted sources should |
179 | For example, a server accepting connections from untrusted sources should |
156 | be configured to accept only so-and-so much data that it cannot act on |
180 | be configured to accept only so-and-so much data that it cannot act on |
157 | (for example, when expecting a line, an attacker could send an unlimited |
181 | (for example, when expecting a line, an attacker could send an unlimited |
158 | amount of data without a callback ever being called as long as the line |
182 | amount of data without a callback ever being called as long as the line |
159 | isn't finished). |
183 | isn't finished). |
160 | |
184 | |
|
|
185 | =item autocork => <boolean> |
|
|
186 | |
|
|
187 | When disabled (the default), then C<push_write> will try to immediately |
|
|
188 | write the data to the handle, if possible. This avoids having to register |
|
|
189 | a write watcher and wait for the next event loop iteration, but can |
|
|
190 | be inefficient if you write multiple small chunks (on the wire, this |
|
|
191 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
|
|
192 | C<no_delay>, but this option can save costly syscalls). |
|
|
193 | |
|
|
194 | When enabled, then writes will always be queued till the next event loop |
|
|
195 | iteration. This is efficient when you do many small writes per iteration, |
|
|
196 | but less efficient when you do a single write only per iteration (or when |
|
|
197 | the write buffer often is full). It also increases write latency. |
|
|
198 | |
|
|
199 | =item no_delay => <boolean> |
|
|
200 | |
|
|
201 | When doing small writes on sockets, your operating system kernel might |
|
|
202 | wait a bit for more data before actually sending it out. This is called |
|
|
203 | the Nagle algorithm, and usually it is beneficial. |
|
|
204 | |
|
|
205 | In some situations you want as low a delay as possible, which can be |
|
|
206 | accomplishd by setting this option to a true value. |
|
|
207 | |
|
|
208 | The default is your opertaing system's default behaviour (most likely |
|
|
209 | enabled), this option explicitly enables or disables it, if possible. |
|
|
210 | |
161 | =item read_size => <bytes> |
211 | =item read_size => <bytes> |
162 | |
212 | |
163 | The default read block size (the amount of bytes this module will try to read |
213 | The default read block size (the amount of bytes this module will |
164 | during each (loop iteration). Default: C<8192>. |
214 | try to read during each loop iteration, which affects memory |
|
|
215 | requirements). Default: C<8192>. |
165 | |
216 | |
166 | =item low_water_mark => <bytes> |
217 | =item low_water_mark => <bytes> |
167 | |
218 | |
168 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
219 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
169 | buffer: If the write reaches this size or gets even samller it is |
220 | buffer: If the write reaches this size or gets even samller it is |
170 | considered empty. |
221 | considered empty. |
171 | |
222 | |
|
|
223 | Sometimes it can be beneficial (for performance reasons) to add data to |
|
|
224 | the write buffer before it is fully drained, but this is a rare case, as |
|
|
225 | the operating system kernel usually buffers data as well, so the default |
|
|
226 | is good in almost all cases. |
|
|
227 | |
|
|
228 | =item linger => <seconds> |
|
|
229 | |
|
|
230 | If non-zero (default: C<3600>), then the destructor of the |
|
|
231 | AnyEvent::Handle object will check whether there is still outstanding |
|
|
232 | write data and will install a watcher that will write this data to the |
|
|
233 | socket. No errors will be reported (this mostly matches how the operating |
|
|
234 | system treats outstanding data at socket close time). |
|
|
235 | |
|
|
236 | This will not work for partial TLS data that could not be encoded |
|
|
237 | yet. This data will be lost. Calling the C<stoptls> method in time might |
|
|
238 | help. |
|
|
239 | |
172 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
240 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
173 | |
241 | |
174 | When this parameter is given, it enables TLS (SSL) mode, that means it |
242 | When this parameter is given, it enables TLS (SSL) mode, that means |
175 | will start making tls handshake and will transparently encrypt/decrypt |
243 | AnyEvent will start a TLS handshake as soon as the conenction has been |
176 | data. |
244 | established and will transparently encrypt/decrypt data afterwards. |
177 | |
245 | |
178 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
246 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
179 | automatically when you try to create a TLS handle). |
247 | automatically when you try to create a TLS handle): this module doesn't |
|
|
248 | have a dependency on that module, so if your module requires it, you have |
|
|
249 | to add the dependency yourself. |
180 | |
250 | |
181 | For the TLS server side, use C<accept>, and for the TLS client side of a |
251 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
182 | connection, use C<connect> mode. |
252 | C<accept>, and for the TLS client side of a connection, use C<connect> |
|
|
253 | mode. |
183 | |
254 | |
184 | You can also provide your own TLS connection object, but you have |
255 | You can also provide your own TLS connection object, but you have |
185 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
256 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
186 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
257 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
187 | AnyEvent::Handle. |
258 | AnyEvent::Handle. |
188 | |
259 | |
189 | See the C<starttls> method if you need to start TLs negotiation later. |
260 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
190 | |
261 | |
191 | =item tls_ctx => $ssl_ctx |
262 | =item tls_ctx => $ssl_ctx |
192 | |
263 | |
193 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
264 | Use the given C<Net::SSLeay::CTX> object to create the new TLS connection |
194 | (unless a connection object was specified directly). If this parameter is |
265 | (unless a connection object was specified directly). If this parameter is |
195 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
266 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
196 | |
267 | |
197 | =item json => JSON or JSON::XS object |
268 | =item json => JSON or JSON::XS object |
198 | |
269 | |
199 | This is the json coder object used by the C<json> read and write types. |
270 | This is the json coder object used by the C<json> read and write types. |
200 | |
271 | |
201 | If you don't supply it, then AnyEvent::Handle will create and use a |
272 | If you don't supply it, then AnyEvent::Handle will create and use a |
202 | suitable one, which will write and expect UTF-8 encoded JSON texts. |
273 | suitable one (on demand), which will write and expect UTF-8 encoded JSON |
|
|
274 | texts. |
203 | |
275 | |
204 | Note that you are responsible to depend on the JSON module if you want to |
276 | Note that you are responsible to depend on the JSON module if you want to |
205 | use this functionality, as AnyEvent does not have a dependency itself. |
277 | use this functionality, as AnyEvent does not have a dependency itself. |
206 | |
278 | |
207 | =item filter_r => $cb |
|
|
208 | |
|
|
209 | =item filter_w => $cb |
|
|
210 | |
|
|
211 | These exist, but are undocumented at this time. |
|
|
212 | |
|
|
213 | =back |
279 | =back |
214 | |
280 | |
215 | =cut |
281 | =cut |
216 | |
282 | |
217 | sub new { |
283 | sub new { |
… | |
… | |
221 | |
287 | |
222 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
288 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
223 | |
289 | |
224 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
290 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
225 | |
291 | |
226 | if ($self->{tls}) { |
|
|
227 | require Net::SSLeay; |
|
|
228 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
292 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
229 | } |
293 | if $self->{tls}; |
230 | |
294 | |
231 | $self->{_activity} = AnyEvent->now; |
295 | $self->{_activity} = AnyEvent->now; |
232 | $self->_timeout; |
296 | $self->_timeout; |
233 | |
297 | |
234 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
298 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
|
|
299 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
|
|
300 | |
|
|
301 | $self->start_read |
|
|
302 | if $self->{on_read}; |
235 | |
303 | |
236 | $self |
304 | $self |
237 | } |
305 | } |
238 | |
306 | |
239 | sub _shutdown { |
307 | sub _shutdown { |
… | |
… | |
242 | delete $self->{_tw}; |
310 | delete $self->{_tw}; |
243 | delete $self->{_rw}; |
311 | delete $self->{_rw}; |
244 | delete $self->{_ww}; |
312 | delete $self->{_ww}; |
245 | delete $self->{fh}; |
313 | delete $self->{fh}; |
246 | |
314 | |
247 | $self->stoptls; |
315 | &_freetls; |
|
|
316 | |
|
|
317 | delete $self->{on_read}; |
|
|
318 | delete $self->{_queue}; |
248 | } |
319 | } |
249 | |
320 | |
250 | sub _error { |
321 | sub _error { |
251 | my ($self, $errno, $fatal) = @_; |
322 | my ($self, $errno, $fatal) = @_; |
252 | |
323 | |
… | |
… | |
255 | |
326 | |
256 | $! = $errno; |
327 | $! = $errno; |
257 | |
328 | |
258 | if ($self->{on_error}) { |
329 | if ($self->{on_error}) { |
259 | $self->{on_error}($self, $fatal); |
330 | $self->{on_error}($self, $fatal); |
260 | } else { |
331 | } elsif ($self->{fh}) { |
261 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
332 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
262 | } |
333 | } |
263 | } |
334 | } |
264 | |
335 | |
265 | =item $fh = $handle->fh |
336 | =item $fh = $handle->fh |
266 | |
337 | |
267 | This method returns the file handle of the L<AnyEvent::Handle> object. |
338 | This method returns the file handle used to create the L<AnyEvent::Handle> object. |
268 | |
339 | |
269 | =cut |
340 | =cut |
270 | |
341 | |
271 | sub fh { $_[0]{fh} } |
342 | sub fh { $_[0]{fh} } |
272 | |
343 | |
… | |
… | |
290 | $_[0]{on_eof} = $_[1]; |
361 | $_[0]{on_eof} = $_[1]; |
291 | } |
362 | } |
292 | |
363 | |
293 | =item $handle->on_timeout ($cb) |
364 | =item $handle->on_timeout ($cb) |
294 | |
365 | |
295 | Replace the current C<on_timeout> callback, or disables the callback |
366 | Replace the current C<on_timeout> callback, or disables the callback (but |
296 | (but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor |
367 | not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor |
297 | argument. |
368 | argument and method. |
298 | |
369 | |
299 | =cut |
370 | =cut |
300 | |
371 | |
301 | sub on_timeout { |
372 | sub on_timeout { |
302 | $_[0]{on_timeout} = $_[1]; |
373 | $_[0]{on_timeout} = $_[1]; |
|
|
374 | } |
|
|
375 | |
|
|
376 | =item $handle->autocork ($boolean) |
|
|
377 | |
|
|
378 | Enables or disables the current autocork behaviour (see C<autocork> |
|
|
379 | constructor argument). Changes will only take effect on the next write. |
|
|
380 | |
|
|
381 | =cut |
|
|
382 | |
|
|
383 | sub autocork { |
|
|
384 | $_[0]{autocork} = $_[1]; |
|
|
385 | } |
|
|
386 | |
|
|
387 | =item $handle->no_delay ($boolean) |
|
|
388 | |
|
|
389 | Enables or disables the C<no_delay> setting (see constructor argument of |
|
|
390 | the same name for details). |
|
|
391 | |
|
|
392 | =cut |
|
|
393 | |
|
|
394 | sub no_delay { |
|
|
395 | $_[0]{no_delay} = $_[1]; |
|
|
396 | |
|
|
397 | eval { |
|
|
398 | local $SIG{__DIE__}; |
|
|
399 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
|
|
400 | }; |
303 | } |
401 | } |
304 | |
402 | |
305 | ############################################################################# |
403 | ############################################################################# |
306 | |
404 | |
307 | =item $handle->timeout ($seconds) |
405 | =item $handle->timeout ($seconds) |
… | |
… | |
385 | my ($self, $cb) = @_; |
483 | my ($self, $cb) = @_; |
386 | |
484 | |
387 | $self->{on_drain} = $cb; |
485 | $self->{on_drain} = $cb; |
388 | |
486 | |
389 | $cb->($self) |
487 | $cb->($self) |
390 | if $cb && $self->{low_water_mark} >= length $self->{wbuf}; |
488 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
391 | } |
489 | } |
392 | |
490 | |
393 | =item $handle->push_write ($data) |
491 | =item $handle->push_write ($data) |
394 | |
492 | |
395 | Queues the given scalar to be written. You can push as much data as you |
493 | Queues the given scalar to be written. You can push as much data as you |
… | |
… | |
412 | substr $self->{wbuf}, 0, $len, ""; |
510 | substr $self->{wbuf}, 0, $len, ""; |
413 | |
511 | |
414 | $self->{_activity} = AnyEvent->now; |
512 | $self->{_activity} = AnyEvent->now; |
415 | |
513 | |
416 | $self->{on_drain}($self) |
514 | $self->{on_drain}($self) |
417 | if $self->{low_water_mark} >= length $self->{wbuf} |
515 | if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) |
418 | && $self->{on_drain}; |
516 | && $self->{on_drain}; |
419 | |
517 | |
420 | delete $self->{_ww} unless length $self->{wbuf}; |
518 | delete $self->{_ww} unless length $self->{wbuf}; |
421 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
519 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
422 | $self->_error ($!, 1); |
520 | $self->_error ($!, 1); |
423 | } |
521 | } |
424 | }; |
522 | }; |
425 | |
523 | |
426 | # try to write data immediately |
524 | # try to write data immediately |
427 | $cb->(); |
525 | $cb->() unless $self->{autocork}; |
428 | |
526 | |
429 | # if still data left in wbuf, we need to poll |
527 | # if still data left in wbuf, we need to poll |
430 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
528 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
431 | if length $self->{wbuf}; |
529 | if length $self->{wbuf}; |
432 | }; |
530 | }; |
… | |
… | |
446 | |
544 | |
447 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
545 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
448 | ->($self, @_); |
546 | ->($self, @_); |
449 | } |
547 | } |
450 | |
548 | |
451 | if ($self->{filter_w}) { |
549 | if ($self->{tls}) { |
452 | $self->{filter_w}($self, \$_[0]); |
550 | $self->{_tls_wbuf} .= $_[0]; |
|
|
551 | |
|
|
552 | &_dotls ($self); |
453 | } else { |
553 | } else { |
454 | $self->{wbuf} .= $_[0]; |
554 | $self->{wbuf} .= $_[0]; |
455 | $self->_drain_wbuf; |
555 | $self->_drain_wbuf; |
456 | } |
556 | } |
457 | } |
557 | } |
… | |
… | |
474 | =cut |
574 | =cut |
475 | |
575 | |
476 | register_write_type netstring => sub { |
576 | register_write_type netstring => sub { |
477 | my ($self, $string) = @_; |
577 | my ($self, $string) = @_; |
478 | |
578 | |
479 | sprintf "%d:%s,", (length $string), $string |
579 | (length $string) . ":$string," |
480 | }; |
580 | }; |
481 | |
581 | |
482 | =item packstring => $format, $data |
582 | =item packstring => $format, $data |
483 | |
583 | |
484 | An octet string prefixed with an encoded length. The encoding C<$format> |
584 | An octet string prefixed with an encoded length. The encoding C<$format> |
… | |
… | |
489 | =cut |
589 | =cut |
490 | |
590 | |
491 | register_write_type packstring => sub { |
591 | register_write_type packstring => sub { |
492 | my ($self, $format, $string) = @_; |
592 | my ($self, $format, $string) = @_; |
493 | |
593 | |
494 | pack "$format/a", $string |
594 | pack "$format/a*", $string |
495 | }; |
595 | }; |
496 | |
596 | |
497 | =item json => $array_or_hashref |
597 | =item json => $array_or_hashref |
498 | |
598 | |
499 | Encodes the given hash or array reference into a JSON object. Unless you |
599 | Encodes the given hash or array reference into a JSON object. Unless you |
… | |
… | |
533 | |
633 | |
534 | $self->{json} ? $self->{json}->encode ($ref) |
634 | $self->{json} ? $self->{json}->encode ($ref) |
535 | : JSON::encode_json ($ref) |
635 | : JSON::encode_json ($ref) |
536 | }; |
636 | }; |
537 | |
637 | |
|
|
638 | =item storable => $reference |
|
|
639 | |
|
|
640 | Freezes the given reference using L<Storable> and writes it to the |
|
|
641 | handle. Uses the C<nfreeze> format. |
|
|
642 | |
|
|
643 | =cut |
|
|
644 | |
|
|
645 | register_write_type storable => sub { |
|
|
646 | my ($self, $ref) = @_; |
|
|
647 | |
|
|
648 | require Storable; |
|
|
649 | |
|
|
650 | pack "w/a*", Storable::nfreeze ($ref) |
|
|
651 | }; |
|
|
652 | |
538 | =back |
653 | =back |
539 | |
654 | |
540 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
655 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
541 | |
656 | |
542 | This function (not method) lets you add your own types to C<push_write>. |
657 | This function (not method) lets you add your own types to C<push_write>. |
… | |
… | |
564 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
679 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
565 | a queue. |
680 | a queue. |
566 | |
681 | |
567 | In the simple case, you just install an C<on_read> callback and whenever |
682 | In the simple case, you just install an C<on_read> callback and whenever |
568 | new data arrives, it will be called. You can then remove some data (if |
683 | new data arrives, it will be called. You can then remove some data (if |
569 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
684 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
570 | or not. |
685 | leave the data there if you want to accumulate more (e.g. when only a |
|
|
686 | partial message has been received so far). |
571 | |
687 | |
572 | In the more complex case, you want to queue multiple callbacks. In this |
688 | In the more complex case, you want to queue multiple callbacks. In this |
573 | case, AnyEvent::Handle will call the first queued callback each time new |
689 | case, AnyEvent::Handle will call the first queued callback each time new |
574 | data arrives (also the first time it is queued) and removes it when it has |
690 | data arrives (also the first time it is queued) and removes it when it has |
575 | done its job (see C<push_read>, below). |
691 | done its job (see C<push_read>, below). |
… | |
… | |
593 | # handle xml |
709 | # handle xml |
594 | }); |
710 | }); |
595 | }); |
711 | }); |
596 | }); |
712 | }); |
597 | |
713 | |
598 | Example 2: Implement a client for a protocol that replies either with |
714 | Example 2: Implement a client for a protocol that replies either with "OK" |
599 | "OK" and another line or "ERROR" for one request, and 64 bytes for the |
715 | and another line or "ERROR" for the first request that is sent, and 64 |
600 | second request. Due tot he availability of a full queue, we can just |
716 | bytes for the second request. Due to the availability of a queue, we can |
601 | pipeline sending both requests and manipulate the queue as necessary in |
717 | just pipeline sending both requests and manipulate the queue as necessary |
602 | the callbacks: |
718 | in the callbacks. |
603 | |
719 | |
604 | # request one |
720 | When the first callback is called and sees an "OK" response, it will |
|
|
721 | C<unshift> another line-read. This line-read will be queued I<before> the |
|
|
722 | 64-byte chunk callback. |
|
|
723 | |
|
|
724 | # request one, returns either "OK + extra line" or "ERROR" |
605 | $handle->push_write ("request 1\015\012"); |
725 | $handle->push_write ("request 1\015\012"); |
606 | |
726 | |
607 | # we expect "ERROR" or "OK" as response, so push a line read |
727 | # we expect "ERROR" or "OK" as response, so push a line read |
608 | $handle->push_read (line => sub { |
728 | $handle->push_read (line => sub { |
609 | # if we got an "OK", we have to _prepend_ another line, |
729 | # if we got an "OK", we have to _prepend_ another line, |
… | |
… | |
616 | ... |
736 | ... |
617 | }); |
737 | }); |
618 | } |
738 | } |
619 | }); |
739 | }); |
620 | |
740 | |
621 | # request two |
741 | # request two, simply returns 64 octets |
622 | $handle->push_write ("request 2\015\012"); |
742 | $handle->push_write ("request 2\015\012"); |
623 | |
743 | |
624 | # simply read 64 bytes, always |
744 | # simply read 64 bytes, always |
625 | $handle->push_read (chunk => 64, sub { |
745 | $handle->push_read (chunk => 64, sub { |
626 | my $response = $_[1]; |
746 | my $response = $_[1]; |
… | |
… | |
638 | |
758 | |
639 | if ( |
759 | if ( |
640 | defined $self->{rbuf_max} |
760 | defined $self->{rbuf_max} |
641 | && $self->{rbuf_max} < length $self->{rbuf} |
761 | && $self->{rbuf_max} < length $self->{rbuf} |
642 | ) { |
762 | ) { |
643 | return $self->_error (&Errno::ENOSPC, 1); |
763 | $self->_error (&Errno::ENOSPC, 1), return; |
644 | } |
764 | } |
645 | |
765 | |
646 | while () { |
766 | while () { |
647 | no strict 'refs'; |
|
|
648 | |
|
|
649 | my $len = length $self->{rbuf}; |
767 | my $len = length $self->{rbuf}; |
650 | |
768 | |
651 | if (my $cb = shift @{ $self->{_queue} }) { |
769 | if (my $cb = shift @{ $self->{_queue} }) { |
652 | unless ($cb->($self)) { |
770 | unless ($cb->($self)) { |
653 | if ($self->{_eof}) { |
771 | if ($self->{_eof}) { |
654 | # no progress can be made (not enough data and no data forthcoming) |
772 | # no progress can be made (not enough data and no data forthcoming) |
655 | $self->_error (&Errno::EPIPE, 1), last; |
773 | $self->_error (&Errno::EPIPE, 1), return; |
656 | } |
774 | } |
657 | |
775 | |
658 | unshift @{ $self->{_queue} }, $cb; |
776 | unshift @{ $self->{_queue} }, $cb; |
659 | last; |
777 | last; |
660 | } |
778 | } |
… | |
… | |
668 | && !@{ $self->{_queue} } # and the queue is still empty |
786 | && !@{ $self->{_queue} } # and the queue is still empty |
669 | && $self->{on_read} # but we still have on_read |
787 | && $self->{on_read} # but we still have on_read |
670 | ) { |
788 | ) { |
671 | # no further data will arrive |
789 | # no further data will arrive |
672 | # so no progress can be made |
790 | # so no progress can be made |
673 | $self->_error (&Errno::EPIPE, 1), last |
791 | $self->_error (&Errno::EPIPE, 1), return |
674 | if $self->{_eof}; |
792 | if $self->{_eof}; |
675 | |
793 | |
676 | last; # more data might arrive |
794 | last; # more data might arrive |
677 | } |
795 | } |
678 | } else { |
796 | } else { |
679 | # read side becomes idle |
797 | # read side becomes idle |
680 | delete $self->{_rw}; |
798 | delete $self->{_rw} unless $self->{tls}; |
681 | last; |
799 | last; |
682 | } |
800 | } |
683 | } |
801 | } |
684 | |
802 | |
|
|
803 | if ($self->{_eof}) { |
|
|
804 | if ($self->{on_eof}) { |
685 | $self->{on_eof}($self) |
805 | $self->{on_eof}($self) |
686 | if $self->{_eof} && $self->{on_eof}; |
806 | } else { |
|
|
807 | $self->_error (0, 1); |
|
|
808 | } |
|
|
809 | } |
687 | |
810 | |
688 | # may need to restart read watcher |
811 | # may need to restart read watcher |
689 | unless ($self->{_rw}) { |
812 | unless ($self->{_rw}) { |
690 | $self->start_read |
813 | $self->start_read |
691 | if $self->{on_read} || @{ $self->{_queue} }; |
814 | if $self->{on_read} || @{ $self->{_queue} }; |
… | |
… | |
817 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
940 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
818 | 1 |
941 | 1 |
819 | } |
942 | } |
820 | }; |
943 | }; |
821 | |
944 | |
822 | # compatibility with older API |
|
|
823 | sub push_read_chunk { |
|
|
824 | $_[0]->push_read (chunk => $_[1], $_[2]); |
|
|
825 | } |
|
|
826 | |
|
|
827 | sub unshift_read_chunk { |
|
|
828 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
|
|
829 | } |
|
|
830 | |
|
|
831 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
945 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
832 | |
946 | |
833 | The callback will be called only once a full line (including the end of |
947 | The callback will be called only once a full line (including the end of |
834 | line marker, C<$eol>) has been read. This line (excluding the end of line |
948 | line marker, C<$eol>) has been read. This line (excluding the end of line |
835 | marker) will be passed to the callback as second argument (C<$line>), and |
949 | marker) will be passed to the callback as second argument (C<$line>), and |
… | |
… | |
850 | =cut |
964 | =cut |
851 | |
965 | |
852 | register_read_type line => sub { |
966 | register_read_type line => sub { |
853 | my ($self, $cb, $eol) = @_; |
967 | my ($self, $cb, $eol) = @_; |
854 | |
968 | |
855 | $eol = qr|(\015?\012)| if @_ < 3; |
969 | if (@_ < 3) { |
|
|
970 | # this is more than twice as fast as the generic code below |
|
|
971 | sub { |
|
|
972 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
|
|
973 | |
|
|
974 | $cb->($_[0], $1, $2); |
|
|
975 | 1 |
|
|
976 | } |
|
|
977 | } else { |
856 | $eol = quotemeta $eol unless ref $eol; |
978 | $eol = quotemeta $eol unless ref $eol; |
857 | $eol = qr|^(.*?)($eol)|s; |
979 | $eol = qr|^(.*?)($eol)|s; |
858 | |
980 | |
859 | sub { |
981 | sub { |
860 | $_[0]{rbuf} =~ s/$eol// or return; |
982 | $_[0]{rbuf} =~ s/$eol// or return; |
861 | |
983 | |
862 | $cb->($_[0], $1, $2); |
984 | $cb->($_[0], $1, $2); |
|
|
985 | 1 |
863 | 1 |
986 | } |
864 | } |
987 | } |
865 | }; |
988 | }; |
866 | |
|
|
867 | # compatibility with older API |
|
|
868 | sub push_read_line { |
|
|
869 | my $self = shift; |
|
|
870 | $self->push_read (line => @_); |
|
|
871 | } |
|
|
872 | |
|
|
873 | sub unshift_read_line { |
|
|
874 | my $self = shift; |
|
|
875 | $self->unshift_read (line => @_); |
|
|
876 | } |
|
|
877 | |
989 | |
878 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
990 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
879 | |
991 | |
880 | Makes a regex match against the regex object C<$accept> and returns |
992 | Makes a regex match against the regex object C<$accept> and returns |
881 | everything up to and including the match. |
993 | everything up to and including the match. |
… | |
… | |
986 | An octet string prefixed with an encoded length. The encoding C<$format> |
1098 | An octet string prefixed with an encoded length. The encoding C<$format> |
987 | uses the same format as a Perl C<pack> format, but must specify a single |
1099 | uses the same format as a Perl C<pack> format, but must specify a single |
988 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
1100 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
989 | optional C<!>, C<< < >> or C<< > >> modifier). |
1101 | optional C<!>, C<< < >> or C<< > >> modifier). |
990 | |
1102 | |
991 | DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. |
1103 | For example, DNS over TCP uses a prefix of C<n> (2 octet network order), |
|
|
1104 | EPP uses a prefix of C<N> (4 octtes). |
992 | |
1105 | |
993 | Example: read a block of data prefixed by its length in BER-encoded |
1106 | Example: read a block of data prefixed by its length in BER-encoded |
994 | format (very efficient). |
1107 | format (very efficient). |
995 | |
1108 | |
996 | $handle->push_read (packstring => "w", sub { |
1109 | $handle->push_read (packstring => "w", sub { |
… | |
… | |
1002 | register_read_type packstring => sub { |
1115 | register_read_type packstring => sub { |
1003 | my ($self, $cb, $format) = @_; |
1116 | my ($self, $cb, $format) = @_; |
1004 | |
1117 | |
1005 | sub { |
1118 | sub { |
1006 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1119 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1007 | defined (my $len = eval { unpack $format, $_[0]->{rbuf} }) |
1120 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
1008 | or return; |
1121 | or return; |
1009 | |
1122 | |
|
|
1123 | $format = length pack $format, $len; |
|
|
1124 | |
|
|
1125 | # bypass unshift if we already have the remaining chunk |
|
|
1126 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1127 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1128 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1129 | $cb->($_[0], $data); |
|
|
1130 | } else { |
1010 | # remove prefix |
1131 | # remove prefix |
1011 | substr $_[0]->{rbuf}, 0, (length pack $format, $len), ""; |
1132 | substr $_[0]{rbuf}, 0, $format, ""; |
1012 | |
1133 | |
1013 | # read rest |
1134 | # read remaining chunk |
1014 | $_[0]->unshift_read (chunk => $len, $cb); |
1135 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1136 | } |
1015 | |
1137 | |
1016 | 1 |
1138 | 1 |
1017 | } |
1139 | } |
1018 | }; |
1140 | }; |
1019 | |
1141 | |
… | |
… | |
1034 | the C<json> write type description, above, for an actual example. |
1156 | the C<json> write type description, above, for an actual example. |
1035 | |
1157 | |
1036 | =cut |
1158 | =cut |
1037 | |
1159 | |
1038 | register_read_type json => sub { |
1160 | register_read_type json => sub { |
1039 | my ($self, $cb, $accept, $reject, $skip) = @_; |
1161 | my ($self, $cb) = @_; |
1040 | |
1162 | |
1041 | require JSON; |
1163 | require JSON; |
1042 | |
1164 | |
1043 | my $data; |
1165 | my $data; |
1044 | my $rbuf = \$self->{rbuf}; |
1166 | my $rbuf = \$self->{rbuf}; |
… | |
… | |
1059 | () |
1181 | () |
1060 | } |
1182 | } |
1061 | } |
1183 | } |
1062 | }; |
1184 | }; |
1063 | |
1185 | |
|
|
1186 | =item storable => $cb->($handle, $ref) |
|
|
1187 | |
|
|
1188 | Deserialises a L<Storable> frozen representation as written by the |
|
|
1189 | C<storable> write type (BER-encoded length prefix followed by nfreeze'd |
|
|
1190 | data). |
|
|
1191 | |
|
|
1192 | Raises C<EBADMSG> error if the data could not be decoded. |
|
|
1193 | |
|
|
1194 | =cut |
|
|
1195 | |
|
|
1196 | register_read_type storable => sub { |
|
|
1197 | my ($self, $cb) = @_; |
|
|
1198 | |
|
|
1199 | require Storable; |
|
|
1200 | |
|
|
1201 | sub { |
|
|
1202 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1203 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
|
|
1204 | or return; |
|
|
1205 | |
|
|
1206 | my $format = length pack "w", $len; |
|
|
1207 | |
|
|
1208 | # bypass unshift if we already have the remaining chunk |
|
|
1209 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1210 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1211 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1212 | $cb->($_[0], Storable::thaw ($data)); |
|
|
1213 | } else { |
|
|
1214 | # remove prefix |
|
|
1215 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1216 | |
|
|
1217 | # read remaining chunk |
|
|
1218 | $_[0]->unshift_read (chunk => $len, sub { |
|
|
1219 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
|
|
1220 | $cb->($_[0], $ref); |
|
|
1221 | } else { |
|
|
1222 | $self->_error (&Errno::EBADMSG); |
|
|
1223 | } |
|
|
1224 | }); |
|
|
1225 | } |
|
|
1226 | |
|
|
1227 | 1 |
|
|
1228 | } |
|
|
1229 | }; |
|
|
1230 | |
1064 | =back |
1231 | =back |
1065 | |
1232 | |
1066 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1233 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1067 | |
1234 | |
1068 | This function (not method) lets you add your own types to C<push_read>. |
1235 | This function (not method) lets you add your own types to C<push_read>. |
… | |
… | |
1095 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1262 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1096 | you change the C<on_read> callback or push/unshift a read callback, and it |
1263 | you change the C<on_read> callback or push/unshift a read callback, and it |
1097 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1264 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1098 | there are any read requests in the queue. |
1265 | there are any read requests in the queue. |
1099 | |
1266 | |
|
|
1267 | These methods will have no effect when in TLS mode (as TLS doesn't support |
|
|
1268 | half-duplex connections). |
|
|
1269 | |
1100 | =cut |
1270 | =cut |
1101 | |
1271 | |
1102 | sub stop_read { |
1272 | sub stop_read { |
1103 | my ($self) = @_; |
1273 | my ($self) = @_; |
1104 | |
1274 | |
1105 | delete $self->{_rw}; |
1275 | delete $self->{_rw} unless $self->{tls}; |
1106 | } |
1276 | } |
1107 | |
1277 | |
1108 | sub start_read { |
1278 | sub start_read { |
1109 | my ($self) = @_; |
1279 | my ($self) = @_; |
1110 | |
1280 | |
1111 | unless ($self->{_rw} || $self->{_eof}) { |
1281 | unless ($self->{_rw} || $self->{_eof}) { |
1112 | Scalar::Util::weaken $self; |
1282 | Scalar::Util::weaken $self; |
1113 | |
1283 | |
1114 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1284 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1115 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
1285 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1116 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1286 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1117 | |
1287 | |
1118 | if ($len > 0) { |
1288 | if ($len > 0) { |
1119 | $self->{_activity} = AnyEvent->now; |
1289 | $self->{_activity} = AnyEvent->now; |
1120 | |
1290 | |
1121 | $self->{filter_r} |
1291 | if ($self->{tls}) { |
1122 | ? $self->{filter_r}($self, $rbuf) |
1292 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1123 | : $self->{_in_drain} || $self->_drain_rbuf; |
1293 | |
|
|
1294 | &_dotls ($self); |
|
|
1295 | } else { |
|
|
1296 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1297 | } |
1124 | |
1298 | |
1125 | } elsif (defined $len) { |
1299 | } elsif (defined $len) { |
1126 | delete $self->{_rw}; |
1300 | delete $self->{_rw}; |
1127 | $self->{_eof} = 1; |
1301 | $self->{_eof} = 1; |
1128 | $self->_drain_rbuf unless $self->{_in_drain}; |
1302 | $self->_drain_rbuf unless $self->{_in_drain}; |
… | |
… | |
1132 | } |
1306 | } |
1133 | }); |
1307 | }); |
1134 | } |
1308 | } |
1135 | } |
1309 | } |
1136 | |
1310 | |
|
|
1311 | # poll the write BIO and send the data if applicable |
1137 | sub _dotls { |
1312 | sub _dotls { |
1138 | my ($self) = @_; |
1313 | my ($self) = @_; |
1139 | |
1314 | |
1140 | my $buf; |
1315 | my $tmp; |
1141 | |
1316 | |
1142 | if (length $self->{_tls_wbuf}) { |
1317 | if (length $self->{_tls_wbuf}) { |
1143 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1318 | while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1144 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1319 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
1145 | } |
1320 | } |
1146 | } |
1321 | } |
1147 | |
1322 | |
1148 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
|
|
1149 | $self->{wbuf} .= $buf; |
|
|
1150 | $self->_drain_wbuf; |
|
|
1151 | } |
|
|
1152 | |
|
|
1153 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
1323 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
1154 | if (length $buf) { |
1324 | unless (length $tmp) { |
1155 | $self->{rbuf} .= $buf; |
|
|
1156 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1157 | } else { |
|
|
1158 | # let's treat SSL-eof as we treat normal EOF |
1325 | # let's treat SSL-eof as we treat normal EOF |
|
|
1326 | delete $self->{_rw}; |
1159 | $self->{_eof} = 1; |
1327 | $self->{_eof} = 1; |
1160 | $self->_shutdown; |
1328 | &_freetls; |
1161 | return; |
|
|
1162 | } |
1329 | } |
1163 | } |
|
|
1164 | |
1330 | |
|
|
1331 | $self->{rbuf} .= $tmp; |
|
|
1332 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1333 | $self->{tls} or return; # tls session might have gone away in callback |
|
|
1334 | } |
|
|
1335 | |
1165 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1336 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
1166 | |
1337 | |
1167 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1338 | if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) { |
1168 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
1339 | if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) { |
1169 | return $self->_error ($!, 1); |
1340 | return $self->_error ($!, 1); |
1170 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1341 | } elsif ($tmp == Net::SSLeay::ERROR_SSL ()) { |
1171 | return $self->_error (&Errno::EIO, 1); |
1342 | return $self->_error (&Errno::EIO, 1); |
1172 | } |
1343 | } |
1173 | |
1344 | |
1174 | # all others are fine for our purposes |
1345 | # all other errors are fine for our purposes |
|
|
1346 | } |
|
|
1347 | |
|
|
1348 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
|
|
1349 | $self->{wbuf} .= $tmp; |
|
|
1350 | $self->_drain_wbuf; |
1175 | } |
1351 | } |
1176 | } |
1352 | } |
1177 | |
1353 | |
1178 | =item $handle->starttls ($tls[, $tls_ctx]) |
1354 | =item $handle->starttls ($tls[, $tls_ctx]) |
1179 | |
1355 | |
… | |
… | |
1189 | |
1365 | |
1190 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
1366 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
1191 | call and can be used or changed to your liking. Note that the handshake |
1367 | call and can be used or changed to your liking. Note that the handshake |
1192 | might have already started when this function returns. |
1368 | might have already started when this function returns. |
1193 | |
1369 | |
|
|
1370 | If it an error to start a TLS handshake more than once per |
|
|
1371 | AnyEvent::Handle object (this is due to bugs in OpenSSL). |
|
|
1372 | |
1194 | =cut |
1373 | =cut |
1195 | |
1374 | |
1196 | sub starttls { |
1375 | sub starttls { |
1197 | my ($self, $ssl, $ctx) = @_; |
1376 | my ($self, $ssl, $ctx) = @_; |
1198 | |
1377 | |
1199 | $self->stoptls; |
1378 | require Net::SSLeay; |
1200 | |
1379 | |
|
|
1380 | Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object" |
|
|
1381 | if $self->{tls}; |
|
|
1382 | |
1201 | if ($ssl eq "accept") { |
1383 | if ($ssl eq "accept") { |
1202 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1384 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1203 | Net::SSLeay::set_accept_state ($ssl); |
1385 | Net::SSLeay::set_accept_state ($ssl); |
1204 | } elsif ($ssl eq "connect") { |
1386 | } elsif ($ssl eq "connect") { |
1205 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1387 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
… | |
… | |
1211 | # basically, this is deep magic (because SSL_read should have the same issues) |
1393 | # basically, this is deep magic (because SSL_read should have the same issues) |
1212 | # but the openssl maintainers basically said: "trust us, it just works". |
1394 | # but the openssl maintainers basically said: "trust us, it just works". |
1213 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1395 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1214 | # and mismaintained ssleay-module doesn't even offer them). |
1396 | # and mismaintained ssleay-module doesn't even offer them). |
1215 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
1397 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
|
|
1398 | # |
|
|
1399 | # in short: this is a mess. |
|
|
1400 | # |
|
|
1401 | # note that we do not try to keep the length constant between writes as we are required to do. |
|
|
1402 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
|
|
1403 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
|
|
1404 | # have identity issues in that area. |
1216 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1405 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1217 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1406 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1218 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1407 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1219 | |
1408 | |
1220 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1409 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1221 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1410 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1222 | |
1411 | |
1223 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1412 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1224 | |
1413 | |
1225 | $self->{filter_w} = sub { |
1414 | &_dotls; # need to trigger the initial handshake |
1226 | $_[0]{_tls_wbuf} .= ${$_[1]}; |
1415 | $self->start_read; # make sure we actually do read |
1227 | &_dotls; |
|
|
1228 | }; |
|
|
1229 | $self->{filter_r} = sub { |
|
|
1230 | Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]}); |
|
|
1231 | &_dotls; |
|
|
1232 | }; |
|
|
1233 | } |
1416 | } |
1234 | |
1417 | |
1235 | =item $handle->stoptls |
1418 | =item $handle->stoptls |
1236 | |
1419 | |
1237 | Destroys the SSL connection, if any. Partial read or write data will be |
1420 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1238 | lost. |
1421 | sending a close notify to the other side, but since OpenSSL doesn't |
|
|
1422 | support non-blocking shut downs, it is not possible to re-use the stream |
|
|
1423 | afterwards. |
1239 | |
1424 | |
1240 | =cut |
1425 | =cut |
1241 | |
1426 | |
1242 | sub stoptls { |
1427 | sub stoptls { |
1243 | my ($self) = @_; |
1428 | my ($self) = @_; |
1244 | |
1429 | |
|
|
1430 | if ($self->{tls}) { |
|
|
1431 | Net::SSLeay::shutdown ($self->{tls}); |
|
|
1432 | |
|
|
1433 | &_dotls; |
|
|
1434 | |
|
|
1435 | # we don't give a shit. no, we do, but we can't. no... |
|
|
1436 | # we, we... have to use openssl :/ |
|
|
1437 | &_freetls; |
|
|
1438 | } |
|
|
1439 | } |
|
|
1440 | |
|
|
1441 | sub _freetls { |
|
|
1442 | my ($self) = @_; |
|
|
1443 | |
|
|
1444 | return unless $self->{tls}; |
|
|
1445 | |
1245 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
1446 | Net::SSLeay::free (delete $self->{tls}); |
1246 | |
1447 | |
1247 | delete $self->{_rbio}; |
1448 | delete @$self{qw(_rbio _wbio _tls_wbuf)}; |
1248 | delete $self->{_wbio}; |
|
|
1249 | delete $self->{_tls_wbuf}; |
|
|
1250 | delete $self->{filter_r}; |
|
|
1251 | delete $self->{filter_w}; |
|
|
1252 | } |
1449 | } |
1253 | |
1450 | |
1254 | sub DESTROY { |
1451 | sub DESTROY { |
1255 | my $self = shift; |
1452 | my $self = shift; |
1256 | |
1453 | |
1257 | $self->stoptls; |
1454 | &_freetls; |
|
|
1455 | |
|
|
1456 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
|
|
1457 | |
|
|
1458 | if ($linger && length $self->{wbuf}) { |
|
|
1459 | my $fh = delete $self->{fh}; |
|
|
1460 | my $wbuf = delete $self->{wbuf}; |
|
|
1461 | |
|
|
1462 | my @linger; |
|
|
1463 | |
|
|
1464 | push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { |
|
|
1465 | my $len = syswrite $fh, $wbuf, length $wbuf; |
|
|
1466 | |
|
|
1467 | if ($len > 0) { |
|
|
1468 | substr $wbuf, 0, $len, ""; |
|
|
1469 | } else { |
|
|
1470 | @linger = (); # end |
|
|
1471 | } |
|
|
1472 | }); |
|
|
1473 | push @linger, AnyEvent->timer (after => $linger, cb => sub { |
|
|
1474 | @linger = (); |
|
|
1475 | }); |
|
|
1476 | } |
|
|
1477 | } |
|
|
1478 | |
|
|
1479 | =item $handle->destroy |
|
|
1480 | |
|
|
1481 | Shuts down the handle object as much as possible - this call ensures that |
|
|
1482 | no further callbacks will be invoked and resources will be freed as much |
|
|
1483 | as possible. You must not call any methods on the object afterwards. |
|
|
1484 | |
|
|
1485 | Normally, you can just "forget" any references to an AnyEvent::Handle |
|
|
1486 | object and it will simply shut down. This works in fatal error and EOF |
|
|
1487 | callbacks, as well as code outside. It does I<NOT> work in a read or write |
|
|
1488 | callback, so when you want to destroy the AnyEvent::Handle object from |
|
|
1489 | within such an callback. You I<MUST> call C<< ->destroy >> explicitly in |
|
|
1490 | that case. |
|
|
1491 | |
|
|
1492 | The handle might still linger in the background and write out remaining |
|
|
1493 | data, as specified by the C<linger> option, however. |
|
|
1494 | |
|
|
1495 | =cut |
|
|
1496 | |
|
|
1497 | sub destroy { |
|
|
1498 | my ($self) = @_; |
|
|
1499 | |
|
|
1500 | $self->DESTROY; |
|
|
1501 | %$self = (); |
1258 | } |
1502 | } |
1259 | |
1503 | |
1260 | =item AnyEvent::Handle::TLS_CTX |
1504 | =item AnyEvent::Handle::TLS_CTX |
1261 | |
1505 | |
1262 | This function creates and returns the Net::SSLeay::CTX object used by |
1506 | This function creates and returns the Net::SSLeay::CTX object used by |
… | |
… | |
1292 | } |
1536 | } |
1293 | } |
1537 | } |
1294 | |
1538 | |
1295 | =back |
1539 | =back |
1296 | |
1540 | |
|
|
1541 | |
|
|
1542 | =head1 NONFREQUENTLY ASKED QUESTIONS |
|
|
1543 | |
|
|
1544 | =over 4 |
|
|
1545 | |
|
|
1546 | =item I C<undef> the AnyEvent::Handle reference inside my callback and |
|
|
1547 | still get further invocations! |
|
|
1548 | |
|
|
1549 | That's because AnyEvent::Handle keeps a reference to itself when handling |
|
|
1550 | read or write callbacks. |
|
|
1551 | |
|
|
1552 | It is only safe to "forget" the reference inside EOF or error callbacks, |
|
|
1553 | from within all other callbacks, you need to explicitly call the C<< |
|
|
1554 | ->destroy >> method. |
|
|
1555 | |
|
|
1556 | =item I get different callback invocations in TLS mode/Why can't I pause |
|
|
1557 | reading? |
|
|
1558 | |
|
|
1559 | Unlike, say, TCP, TLS connections do not consist of two independent |
|
|
1560 | communication channels, one for each direction. Or put differently. The |
|
|
1561 | read and write directions are not independent of each other: you cannot |
|
|
1562 | write data unless you are also prepared to read, and vice versa. |
|
|
1563 | |
|
|
1564 | This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> |
|
|
1565 | callback invocations when you are not expecting any read data - the reason |
|
|
1566 | is that AnyEvent::Handle always reads in TLS mode. |
|
|
1567 | |
|
|
1568 | During the connection, you have to make sure that you always have a |
|
|
1569 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
|
|
1570 | connection (or when you no longer want to use it) you can call the |
|
|
1571 | C<destroy> method. |
|
|
1572 | |
|
|
1573 | =item How do I read data until the other side closes the connection? |
|
|
1574 | |
|
|
1575 | If you just want to read your data into a perl scalar, the easiest way |
|
|
1576 | to achieve this is by setting an C<on_read> callback that does nothing, |
|
|
1577 | clearing the C<on_eof> callback and in the C<on_error> callback, the data |
|
|
1578 | will be in C<$_[0]{rbuf}>: |
|
|
1579 | |
|
|
1580 | $handle->on_read (sub { }); |
|
|
1581 | $handle->on_eof (undef); |
|
|
1582 | $handle->on_error (sub { |
|
|
1583 | my $data = delete $_[0]{rbuf}; |
|
|
1584 | undef $handle; |
|
|
1585 | }); |
|
|
1586 | |
|
|
1587 | The reason to use C<on_error> is that TCP connections, due to latencies |
|
|
1588 | and packets loss, might get closed quite violently with an error, when in |
|
|
1589 | fact, all data has been received. |
|
|
1590 | |
|
|
1591 | It is usually better to use acknowledgements when transferring data, |
|
|
1592 | to make sure the other side hasn't just died and you got the data |
|
|
1593 | intact. This is also one reason why so many internet protocols have an |
|
|
1594 | explicit QUIT command. |
|
|
1595 | |
|
|
1596 | =item I don't want to destroy the handle too early - how do I wait until |
|
|
1597 | all data has been written? |
|
|
1598 | |
|
|
1599 | After writing your last bits of data, set the C<on_drain> callback |
|
|
1600 | and destroy the handle in there - with the default setting of |
|
|
1601 | C<low_water_mark> this will be called precisely when all data has been |
|
|
1602 | written to the socket: |
|
|
1603 | |
|
|
1604 | $handle->push_write (...); |
|
|
1605 | $handle->on_drain (sub { |
|
|
1606 | warn "all data submitted to the kernel\n"; |
|
|
1607 | undef $handle; |
|
|
1608 | }); |
|
|
1609 | |
|
|
1610 | =back |
|
|
1611 | |
|
|
1612 | |
1297 | =head1 SUBCLASSING AnyEvent::Handle |
1613 | =head1 SUBCLASSING AnyEvent::Handle |
1298 | |
1614 | |
1299 | In many cases, you might want to subclass AnyEvent::Handle. |
1615 | In many cases, you might want to subclass AnyEvent::Handle. |
1300 | |
1616 | |
1301 | To make this easier, a given version of AnyEvent::Handle uses these |
1617 | To make this easier, a given version of AnyEvent::Handle uses these |
… | |
… | |
1304 | =over 4 |
1620 | =over 4 |
1305 | |
1621 | |
1306 | =item * all constructor arguments become object members. |
1622 | =item * all constructor arguments become object members. |
1307 | |
1623 | |
1308 | At least initially, when you pass a C<tls>-argument to the constructor it |
1624 | At least initially, when you pass a C<tls>-argument to the constructor it |
1309 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
1625 | will end up in C<< $handle->{tls} >>. Those members might be changed or |
1310 | mutated later on (for example C<tls> will hold the TLS connection object). |
1626 | mutated later on (for example C<tls> will hold the TLS connection object). |
1311 | |
1627 | |
1312 | =item * other object member names are prefixed with an C<_>. |
1628 | =item * other object member names are prefixed with an C<_>. |
1313 | |
1629 | |
1314 | All object members not explicitly documented (internal use) are prefixed |
1630 | All object members not explicitly documented (internal use) are prefixed |