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.15; |
19 | our $VERSION = 4.3; |
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 |
59 | argument. |
62 | argument. |
60 | |
63 | |
|
|
64 | =head2 SIGPIPE is not handled by this module |
|
|
65 | |
|
|
66 | SIGPIPE is not handled by this module, so one of the practical |
|
|
67 | requirements of using it is to ignore SIGPIPE (C<$SIG{PIPE} = |
|
|
68 | 'IGNORE'>). At least, this is highly recommend in a networked program: If |
|
|
69 | you use AnyEvent::Handle in a filter program (like sort), exiting on |
|
|
70 | SIGPIPE is probably the right thing to do. |
|
|
71 | |
61 | =head1 METHODS |
72 | =head1 METHODS |
62 | |
73 | |
63 | =over 4 |
74 | =over 4 |
64 | |
75 | |
65 | =item B<new (%args)> |
76 | =item B<new (%args)> |
… | |
… | |
70 | |
81 | |
71 | =item fh => $filehandle [MANDATORY] |
82 | =item fh => $filehandle [MANDATORY] |
72 | |
83 | |
73 | The filehandle this L<AnyEvent::Handle> object will operate on. |
84 | The filehandle this L<AnyEvent::Handle> object will operate on. |
74 | |
85 | |
75 | NOTE: The filehandle will be set to non-blocking (using |
86 | NOTE: The filehandle will be set to non-blocking mode (using |
76 | AnyEvent::Util::fh_nonblocking). |
87 | C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in |
|
|
88 | that mode. |
77 | |
89 | |
78 | =item on_eof => $cb->($handle) |
90 | =item on_eof => $cb->($handle) |
79 | |
91 | |
80 | Set the callback to be called when an end-of-file condition is detcted, |
92 | 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 |
93 | i.e. in the case of a socket, when the other side has closed the |
82 | connection cleanly. |
94 | connection cleanly. |
83 | |
95 | |
|
|
96 | For sockets, this just means that the other side has stopped sending data, |
|
|
97 | you can still try to write data, and, in fact, one can return from the eof |
|
|
98 | callback and continue writing data, as only the read part has been shut |
|
|
99 | down. |
|
|
100 | |
84 | While not mandatory, it is highly recommended to set an eof callback, |
101 | 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 |
102 | otherwise you might end up with a closed socket while you are still |
86 | waiting for data. |
103 | waiting for data. |
|
|
104 | |
|
|
105 | If an EOF condition has been detected but no C<on_eof> callback has been |
|
|
106 | set, then a fatal error will be raised with C<$!> set to <0>. |
87 | |
107 | |
88 | =item on_error => $cb->($handle, $fatal) |
108 | =item on_error => $cb->($handle, $fatal) |
89 | |
109 | |
90 | This is the error callback, which is called when, well, some error |
110 | 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 |
111 | occured, such as not being able to resolve the hostname, failure to |
92 | connect or a read error. |
112 | connect or a read error. |
93 | |
113 | |
94 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
114 | 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 |
115 | fatal errors the handle object will be shut down and will not be usable |
|
|
116 | (but you are free to look at the current C<< ->rbuf >>). Examples of fatal |
|
|
117 | errors are an EOF condition with active (but unsatisifable) read watchers |
|
|
118 | (C<EPIPE>) or I/O errors. |
|
|
119 | |
96 | usable. Non-fatal errors can be retried by simply returning, but it is |
120 | 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 |
121 | to simply ignore this parameter and instead abondon the handle object |
98 | object when this callback is invoked. |
122 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
123 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
99 | |
124 | |
100 | On callback entrance, the value of C<$!> contains the operating system |
125 | On callback entrance, the value of C<$!> contains the operating system |
101 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
126 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
102 | |
127 | |
103 | While not mandatory, it is I<highly> recommended to set this callback, as |
128 | 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 |
149 | 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). |
150 | (or when the callback is set and the buffer is empty already). |
126 | |
151 | |
127 | To append to the write buffer, use the C<< ->push_write >> method. |
152 | To append to the write buffer, use the C<< ->push_write >> method. |
128 | |
153 | |
|
|
154 | This callback is useful when you don't want to put all of your write data |
|
|
155 | into the queue at once, for example, when you want to write the contents |
|
|
156 | of some file to the socket you might not want to read the whole file into |
|
|
157 | memory and push it into the queue, but instead only read more data from |
|
|
158 | the file when the write queue becomes empty. |
|
|
159 | |
129 | =item timeout => $fractional_seconds |
160 | =item timeout => $fractional_seconds |
130 | |
161 | |
131 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
162 | 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 |
163 | 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 |
164 | handle, the C<on_timeout> callback will be invoked (and if that one is |
134 | missing, an C<ETIMEDOUT> error will be raised). |
165 | missing, a non-fatal C<ETIMEDOUT> error will be raised). |
135 | |
166 | |
136 | Note that timeout processing is also active when you currently do not have |
167 | 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 |
168 | 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 |
169 | idle then you should disable the timout temporarily or ignore the timeout |
139 | in the C<on_timeout> callback. |
170 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
|
|
171 | restart the timeout. |
140 | |
172 | |
141 | Zero (the default) disables this timeout. |
173 | Zero (the default) disables this timeout. |
142 | |
174 | |
143 | =item on_timeout => $cb->($handle) |
175 | =item on_timeout => $cb->($handle) |
144 | |
176 | |
… | |
… | |
148 | |
180 | |
149 | =item rbuf_max => <bytes> |
181 | =item rbuf_max => <bytes> |
150 | |
182 | |
151 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
183 | 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 |
184 | when the read buffer ever (strictly) exceeds this size. This is useful to |
153 | avoid denial-of-service attacks. |
185 | avoid some forms of denial-of-service attacks. |
154 | |
186 | |
155 | For example, a server accepting connections from untrusted sources should |
187 | 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 |
188 | 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 |
189 | (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 |
190 | amount of data without a callback ever being called as long as the line |
159 | isn't finished). |
191 | isn't finished). |
160 | |
192 | |
|
|
193 | =item autocork => <boolean> |
|
|
194 | |
|
|
195 | When disabled (the default), then C<push_write> will try to immediately |
|
|
196 | write the data to the handle, if possible. This avoids having to register |
|
|
197 | a write watcher and wait for the next event loop iteration, but can |
|
|
198 | be inefficient if you write multiple small chunks (on the wire, this |
|
|
199 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
|
|
200 | C<no_delay>, but this option can save costly syscalls). |
|
|
201 | |
|
|
202 | When enabled, then writes will always be queued till the next event loop |
|
|
203 | iteration. This is efficient when you do many small writes per iteration, |
|
|
204 | but less efficient when you do a single write only per iteration (or when |
|
|
205 | the write buffer often is full). It also increases write latency. |
|
|
206 | |
|
|
207 | =item no_delay => <boolean> |
|
|
208 | |
|
|
209 | When doing small writes on sockets, your operating system kernel might |
|
|
210 | wait a bit for more data before actually sending it out. This is called |
|
|
211 | the Nagle algorithm, and usually it is beneficial. |
|
|
212 | |
|
|
213 | In some situations you want as low a delay as possible, which can be |
|
|
214 | accomplishd by setting this option to a true value. |
|
|
215 | |
|
|
216 | The default is your opertaing system's default behaviour (most likely |
|
|
217 | enabled), this option explicitly enables or disables it, if possible. |
|
|
218 | |
161 | =item read_size => <bytes> |
219 | =item read_size => <bytes> |
162 | |
220 | |
163 | The default read block size (the amount of bytes this module will try to read |
221 | The default read block size (the amount of bytes this module will |
164 | during each (loop iteration). Default: C<8192>. |
222 | try to read during each loop iteration, which affects memory |
|
|
223 | requirements). Default: C<8192>. |
165 | |
224 | |
166 | =item low_water_mark => <bytes> |
225 | =item low_water_mark => <bytes> |
167 | |
226 | |
168 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
227 | 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 |
228 | buffer: If the write reaches this size or gets even samller it is |
170 | considered empty. |
229 | considered empty. |
171 | |
230 | |
|
|
231 | Sometimes it can be beneficial (for performance reasons) to add data to |
|
|
232 | the write buffer before it is fully drained, but this is a rare case, as |
|
|
233 | the operating system kernel usually buffers data as well, so the default |
|
|
234 | is good in almost all cases. |
|
|
235 | |
172 | =item linger => <seconds> |
236 | =item linger => <seconds> |
173 | |
237 | |
174 | If non-zero (default: C<3600>), then the destructor of the |
238 | If non-zero (default: C<3600>), then the destructor of the |
175 | AnyEvent::Handle object will check wether there is still outstanding write |
239 | AnyEvent::Handle object will check whether there is still outstanding |
176 | data and will install a watcher that will write out this data. No errors |
240 | write data and will install a watcher that will write this data to the |
177 | will be reported (this mostly matches how the operating system treats |
241 | socket. No errors will be reported (this mostly matches how the operating |
178 | outstanding data at socket close time). |
242 | system treats outstanding data at socket close time). |
179 | |
243 | |
180 | This will not work for partial TLS data that could not yet been |
244 | This will not work for partial TLS data that could not be encoded |
181 | encoded. This data will be lost. |
245 | yet. This data will be lost. Calling the C<stoptls> method in time might |
|
|
246 | help. |
182 | |
247 | |
183 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
248 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
184 | |
249 | |
185 | When this parameter is given, it enables TLS (SSL) mode, that means it |
250 | When this parameter is given, it enables TLS (SSL) mode, that means |
186 | will start making tls handshake and will transparently encrypt/decrypt |
251 | AnyEvent will start a TLS handshake as soon as the conenction has been |
187 | data. |
252 | established and will transparently encrypt/decrypt data afterwards. |
188 | |
253 | |
189 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
254 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
190 | automatically when you try to create a TLS handle). |
255 | automatically when you try to create a TLS handle): this module doesn't |
|
|
256 | have a dependency on that module, so if your module requires it, you have |
|
|
257 | to add the dependency yourself. |
191 | |
258 | |
192 | For the TLS server side, use C<accept>, and for the TLS client side of a |
259 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
193 | connection, use C<connect> mode. |
260 | C<accept>, and for the TLS client side of a connection, use C<connect> |
|
|
261 | mode. |
194 | |
262 | |
195 | You can also provide your own TLS connection object, but you have |
263 | You can also provide your own TLS connection object, but you have |
196 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
264 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
197 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
265 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
198 | AnyEvent::Handle. |
266 | AnyEvent::Handle. |
199 | |
267 | |
200 | See the C<starttls> method if you need to start TLs negotiation later. |
268 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
201 | |
269 | |
202 | =item tls_ctx => $ssl_ctx |
270 | =item tls_ctx => $ssl_ctx |
203 | |
271 | |
204 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
272 | Use the given C<Net::SSLeay::CTX> object to create the new TLS connection |
205 | (unless a connection object was specified directly). If this parameter is |
273 | (unless a connection object was specified directly). If this parameter is |
206 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
274 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
207 | |
275 | |
208 | =item json => JSON or JSON::XS object |
276 | =item json => JSON or JSON::XS object |
209 | |
277 | |
210 | This is the json coder object used by the C<json> read and write types. |
278 | This is the json coder object used by the C<json> read and write types. |
211 | |
279 | |
212 | If you don't supply it, then AnyEvent::Handle will create and use a |
280 | If you don't supply it, then AnyEvent::Handle will create and use a |
213 | suitable one, which will write and expect UTF-8 encoded JSON texts. |
281 | suitable one (on demand), which will write and expect UTF-8 encoded JSON |
|
|
282 | texts. |
214 | |
283 | |
215 | Note that you are responsible to depend on the JSON module if you want to |
284 | Note that you are responsible to depend on the JSON module if you want to |
216 | use this functionality, as AnyEvent does not have a dependency itself. |
285 | use this functionality, as AnyEvent does not have a dependency itself. |
217 | |
286 | |
218 | =item filter_r => $cb |
|
|
219 | |
|
|
220 | =item filter_w => $cb |
|
|
221 | |
|
|
222 | These exist, but are undocumented at this time. |
|
|
223 | |
|
|
224 | =back |
287 | =back |
225 | |
288 | |
226 | =cut |
289 | =cut |
227 | |
290 | |
228 | sub new { |
291 | sub new { |
… | |
… | |
232 | |
295 | |
233 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
296 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
234 | |
297 | |
235 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
298 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
236 | |
299 | |
237 | if ($self->{tls}) { |
|
|
238 | require Net::SSLeay; |
|
|
239 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
300 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
240 | } |
301 | if $self->{tls}; |
241 | |
302 | |
242 | $self->{_activity} = AnyEvent->now; |
303 | $self->{_activity} = AnyEvent->now; |
243 | $self->_timeout; |
304 | $self->_timeout; |
244 | |
305 | |
245 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
306 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
|
|
307 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
|
|
308 | |
|
|
309 | $self->start_read |
|
|
310 | if $self->{on_read}; |
246 | |
311 | |
247 | $self |
312 | $self |
248 | } |
313 | } |
249 | |
314 | |
250 | sub _shutdown { |
315 | sub _shutdown { |
… | |
… | |
253 | delete $self->{_tw}; |
318 | delete $self->{_tw}; |
254 | delete $self->{_rw}; |
319 | delete $self->{_rw}; |
255 | delete $self->{_ww}; |
320 | delete $self->{_ww}; |
256 | delete $self->{fh}; |
321 | delete $self->{fh}; |
257 | |
322 | |
258 | $self->stoptls; |
323 | &_freetls; |
|
|
324 | |
|
|
325 | delete $self->{on_read}; |
|
|
326 | delete $self->{_queue}; |
259 | } |
327 | } |
260 | |
328 | |
261 | sub _error { |
329 | sub _error { |
262 | my ($self, $errno, $fatal) = @_; |
330 | my ($self, $errno, $fatal) = @_; |
263 | |
331 | |
… | |
… | |
273 | } |
341 | } |
274 | } |
342 | } |
275 | |
343 | |
276 | =item $fh = $handle->fh |
344 | =item $fh = $handle->fh |
277 | |
345 | |
278 | This method returns the file handle of the L<AnyEvent::Handle> object. |
346 | This method returns the file handle used to create the L<AnyEvent::Handle> object. |
279 | |
347 | |
280 | =cut |
348 | =cut |
281 | |
349 | |
282 | sub fh { $_[0]{fh} } |
350 | sub fh { $_[0]{fh} } |
283 | |
351 | |
… | |
… | |
301 | $_[0]{on_eof} = $_[1]; |
369 | $_[0]{on_eof} = $_[1]; |
302 | } |
370 | } |
303 | |
371 | |
304 | =item $handle->on_timeout ($cb) |
372 | =item $handle->on_timeout ($cb) |
305 | |
373 | |
306 | Replace the current C<on_timeout> callback, or disables the callback |
374 | Replace the current C<on_timeout> callback, or disables the callback (but |
307 | (but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor |
375 | not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor |
308 | argument. |
376 | argument and method. |
309 | |
377 | |
310 | =cut |
378 | =cut |
311 | |
379 | |
312 | sub on_timeout { |
380 | sub on_timeout { |
313 | $_[0]{on_timeout} = $_[1]; |
381 | $_[0]{on_timeout} = $_[1]; |
|
|
382 | } |
|
|
383 | |
|
|
384 | =item $handle->autocork ($boolean) |
|
|
385 | |
|
|
386 | Enables or disables the current autocork behaviour (see C<autocork> |
|
|
387 | constructor argument). |
|
|
388 | |
|
|
389 | =cut |
|
|
390 | |
|
|
391 | =item $handle->no_delay ($boolean) |
|
|
392 | |
|
|
393 | Enables or disables the C<no_delay> setting (see constructor argument of |
|
|
394 | the same name for details). |
|
|
395 | |
|
|
396 | =cut |
|
|
397 | |
|
|
398 | sub no_delay { |
|
|
399 | $_[0]{no_delay} = $_[1]; |
|
|
400 | |
|
|
401 | eval { |
|
|
402 | local $SIG{__DIE__}; |
|
|
403 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
|
|
404 | }; |
314 | } |
405 | } |
315 | |
406 | |
316 | ############################################################################# |
407 | ############################################################################# |
317 | |
408 | |
318 | =item $handle->timeout ($seconds) |
409 | =item $handle->timeout ($seconds) |
… | |
… | |
396 | my ($self, $cb) = @_; |
487 | my ($self, $cb) = @_; |
397 | |
488 | |
398 | $self->{on_drain} = $cb; |
489 | $self->{on_drain} = $cb; |
399 | |
490 | |
400 | $cb->($self) |
491 | $cb->($self) |
401 | if $cb && $self->{low_water_mark} >= length $self->{wbuf}; |
492 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
402 | } |
493 | } |
403 | |
494 | |
404 | =item $handle->push_write ($data) |
495 | =item $handle->push_write ($data) |
405 | |
496 | |
406 | Queues the given scalar to be written. You can push as much data as you |
497 | Queues the given scalar to be written. You can push as much data as you |
… | |
… | |
423 | substr $self->{wbuf}, 0, $len, ""; |
514 | substr $self->{wbuf}, 0, $len, ""; |
424 | |
515 | |
425 | $self->{_activity} = AnyEvent->now; |
516 | $self->{_activity} = AnyEvent->now; |
426 | |
517 | |
427 | $self->{on_drain}($self) |
518 | $self->{on_drain}($self) |
428 | if $self->{low_water_mark} >= length $self->{wbuf} |
519 | if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) |
429 | && $self->{on_drain}; |
520 | && $self->{on_drain}; |
430 | |
521 | |
431 | delete $self->{_ww} unless length $self->{wbuf}; |
522 | delete $self->{_ww} unless length $self->{wbuf}; |
432 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
523 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
433 | $self->_error ($!, 1); |
524 | $self->_error ($!, 1); |
434 | } |
525 | } |
435 | }; |
526 | }; |
436 | |
527 | |
437 | # try to write data immediately |
528 | # try to write data immediately |
438 | $cb->(); |
529 | $cb->() unless $self->{autocork}; |
439 | |
530 | |
440 | # if still data left in wbuf, we need to poll |
531 | # if still data left in wbuf, we need to poll |
441 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
532 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
442 | if length $self->{wbuf}; |
533 | if length $self->{wbuf}; |
443 | }; |
534 | }; |
… | |
… | |
457 | |
548 | |
458 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
549 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
459 | ->($self, @_); |
550 | ->($self, @_); |
460 | } |
551 | } |
461 | |
552 | |
462 | if ($self->{filter_w}) { |
553 | if ($self->{tls}) { |
463 | $self->{filter_w}($self, \$_[0]); |
554 | $self->{_tls_wbuf} .= $_[0]; |
|
|
555 | |
|
|
556 | &_dotls ($self); |
464 | } else { |
557 | } else { |
465 | $self->{wbuf} .= $_[0]; |
558 | $self->{wbuf} .= $_[0]; |
466 | $self->_drain_wbuf; |
559 | $self->_drain_wbuf; |
467 | } |
560 | } |
468 | } |
561 | } |
… | |
… | |
485 | =cut |
578 | =cut |
486 | |
579 | |
487 | register_write_type netstring => sub { |
580 | register_write_type netstring => sub { |
488 | my ($self, $string) = @_; |
581 | my ($self, $string) = @_; |
489 | |
582 | |
490 | sprintf "%d:%s,", (length $string), $string |
583 | (length $string) . ":$string," |
491 | }; |
584 | }; |
492 | |
585 | |
493 | =item packstring => $format, $data |
586 | =item packstring => $format, $data |
494 | |
587 | |
495 | An octet string prefixed with an encoded length. The encoding C<$format> |
588 | An octet string prefixed with an encoded length. The encoding C<$format> |
… | |
… | |
590 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
683 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
591 | a queue. |
684 | a queue. |
592 | |
685 | |
593 | In the simple case, you just install an C<on_read> callback and whenever |
686 | In the simple case, you just install an C<on_read> callback and whenever |
594 | new data arrives, it will be called. You can then remove some data (if |
687 | new data arrives, it will be called. You can then remove some data (if |
595 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
688 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
596 | or not. |
689 | leave the data there if you want to accumulate more (e.g. when only a |
|
|
690 | partial message has been received so far). |
597 | |
691 | |
598 | In the more complex case, you want to queue multiple callbacks. In this |
692 | In the more complex case, you want to queue multiple callbacks. In this |
599 | case, AnyEvent::Handle will call the first queued callback each time new |
693 | case, AnyEvent::Handle will call the first queued callback each time new |
600 | data arrives (also the first time it is queued) and removes it when it has |
694 | data arrives (also the first time it is queued) and removes it when it has |
601 | done its job (see C<push_read>, below). |
695 | done its job (see C<push_read>, below). |
… | |
… | |
619 | # handle xml |
713 | # handle xml |
620 | }); |
714 | }); |
621 | }); |
715 | }); |
622 | }); |
716 | }); |
623 | |
717 | |
624 | Example 2: Implement a client for a protocol that replies either with |
718 | Example 2: Implement a client for a protocol that replies either with "OK" |
625 | "OK" and another line or "ERROR" for one request, and 64 bytes for the |
719 | and another line or "ERROR" for the first request that is sent, and 64 |
626 | second request. Due tot he availability of a full queue, we can just |
720 | bytes for the second request. Due to the availability of a queue, we can |
627 | pipeline sending both requests and manipulate the queue as necessary in |
721 | just pipeline sending both requests and manipulate the queue as necessary |
628 | the callbacks: |
722 | in the callbacks. |
629 | |
723 | |
630 | # request one |
724 | When the first callback is called and sees an "OK" response, it will |
|
|
725 | C<unshift> another line-read. This line-read will be queued I<before> the |
|
|
726 | 64-byte chunk callback. |
|
|
727 | |
|
|
728 | # request one, returns either "OK + extra line" or "ERROR" |
631 | $handle->push_write ("request 1\015\012"); |
729 | $handle->push_write ("request 1\015\012"); |
632 | |
730 | |
633 | # we expect "ERROR" or "OK" as response, so push a line read |
731 | # we expect "ERROR" or "OK" as response, so push a line read |
634 | $handle->push_read (line => sub { |
732 | $handle->push_read (line => sub { |
635 | # if we got an "OK", we have to _prepend_ another line, |
733 | # if we got an "OK", we have to _prepend_ another line, |
… | |
… | |
642 | ... |
740 | ... |
643 | }); |
741 | }); |
644 | } |
742 | } |
645 | }); |
743 | }); |
646 | |
744 | |
647 | # request two |
745 | # request two, simply returns 64 octets |
648 | $handle->push_write ("request 2\015\012"); |
746 | $handle->push_write ("request 2\015\012"); |
649 | |
747 | |
650 | # simply read 64 bytes, always |
748 | # simply read 64 bytes, always |
651 | $handle->push_read (chunk => 64, sub { |
749 | $handle->push_read (chunk => 64, sub { |
652 | my $response = $_[1]; |
750 | my $response = $_[1]; |
… | |
… | |
664 | |
762 | |
665 | if ( |
763 | if ( |
666 | defined $self->{rbuf_max} |
764 | defined $self->{rbuf_max} |
667 | && $self->{rbuf_max} < length $self->{rbuf} |
765 | && $self->{rbuf_max} < length $self->{rbuf} |
668 | ) { |
766 | ) { |
669 | return $self->_error (&Errno::ENOSPC, 1); |
767 | $self->_error (&Errno::ENOSPC, 1), return; |
670 | } |
768 | } |
671 | |
769 | |
672 | while () { |
770 | while () { |
673 | no strict 'refs'; |
|
|
674 | |
|
|
675 | my $len = length $self->{rbuf}; |
771 | my $len = length $self->{rbuf}; |
676 | |
772 | |
677 | if (my $cb = shift @{ $self->{_queue} }) { |
773 | if (my $cb = shift @{ $self->{_queue} }) { |
678 | unless ($cb->($self)) { |
774 | unless ($cb->($self)) { |
679 | if ($self->{_eof}) { |
775 | if ($self->{_eof}) { |
680 | # no progress can be made (not enough data and no data forthcoming) |
776 | # no progress can be made (not enough data and no data forthcoming) |
681 | $self->_error (&Errno::EPIPE, 1), last; |
777 | $self->_error (&Errno::EPIPE, 1), return; |
682 | } |
778 | } |
683 | |
779 | |
684 | unshift @{ $self->{_queue} }, $cb; |
780 | unshift @{ $self->{_queue} }, $cb; |
685 | last; |
781 | last; |
686 | } |
782 | } |
… | |
… | |
694 | && !@{ $self->{_queue} } # and the queue is still empty |
790 | && !@{ $self->{_queue} } # and the queue is still empty |
695 | && $self->{on_read} # but we still have on_read |
791 | && $self->{on_read} # but we still have on_read |
696 | ) { |
792 | ) { |
697 | # no further data will arrive |
793 | # no further data will arrive |
698 | # so no progress can be made |
794 | # so no progress can be made |
699 | $self->_error (&Errno::EPIPE, 1), last |
795 | $self->_error (&Errno::EPIPE, 1), return |
700 | if $self->{_eof}; |
796 | if $self->{_eof}; |
701 | |
797 | |
702 | last; # more data might arrive |
798 | last; # more data might arrive |
703 | } |
799 | } |
704 | } else { |
800 | } else { |
705 | # read side becomes idle |
801 | # read side becomes idle |
706 | delete $self->{_rw}; |
802 | delete $self->{_rw} unless $self->{tls}; |
707 | last; |
803 | last; |
708 | } |
804 | } |
709 | } |
805 | } |
710 | |
806 | |
|
|
807 | if ($self->{_eof}) { |
|
|
808 | if ($self->{on_eof}) { |
711 | $self->{on_eof}($self) |
809 | $self->{on_eof}($self) |
712 | if $self->{_eof} && $self->{on_eof}; |
810 | } else { |
|
|
811 | $self->_error (0, 1); |
|
|
812 | } |
|
|
813 | } |
713 | |
814 | |
714 | # may need to restart read watcher |
815 | # may need to restart read watcher |
715 | unless ($self->{_rw}) { |
816 | unless ($self->{_rw}) { |
716 | $self->start_read |
817 | $self->start_read |
717 | if $self->{on_read} || @{ $self->{_queue} }; |
818 | if $self->{on_read} || @{ $self->{_queue} }; |
… | |
… | |
843 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
944 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
844 | 1 |
945 | 1 |
845 | } |
946 | } |
846 | }; |
947 | }; |
847 | |
948 | |
848 | # compatibility with older API |
|
|
849 | sub push_read_chunk { |
|
|
850 | $_[0]->push_read (chunk => $_[1], $_[2]); |
|
|
851 | } |
|
|
852 | |
|
|
853 | sub unshift_read_chunk { |
|
|
854 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
|
|
855 | } |
|
|
856 | |
|
|
857 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
949 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
858 | |
950 | |
859 | The callback will be called only once a full line (including the end of |
951 | The callback will be called only once a full line (including the end of |
860 | line marker, C<$eol>) has been read. This line (excluding the end of line |
952 | line marker, C<$eol>) has been read. This line (excluding the end of line |
861 | marker) will be passed to the callback as second argument (C<$line>), and |
953 | marker) will be passed to the callback as second argument (C<$line>), and |
… | |
… | |
876 | =cut |
968 | =cut |
877 | |
969 | |
878 | register_read_type line => sub { |
970 | register_read_type line => sub { |
879 | my ($self, $cb, $eol) = @_; |
971 | my ($self, $cb, $eol) = @_; |
880 | |
972 | |
881 | $eol = qr|(\015?\012)| if @_ < 3; |
973 | if (@_ < 3) { |
|
|
974 | # this is more than twice as fast as the generic code below |
|
|
975 | sub { |
|
|
976 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
|
|
977 | |
|
|
978 | $cb->($_[0], $1, $2); |
|
|
979 | 1 |
|
|
980 | } |
|
|
981 | } else { |
882 | $eol = quotemeta $eol unless ref $eol; |
982 | $eol = quotemeta $eol unless ref $eol; |
883 | $eol = qr|^(.*?)($eol)|s; |
983 | $eol = qr|^(.*?)($eol)|s; |
884 | |
984 | |
885 | sub { |
985 | sub { |
886 | $_[0]{rbuf} =~ s/$eol// or return; |
986 | $_[0]{rbuf} =~ s/$eol// or return; |
887 | |
987 | |
888 | $cb->($_[0], $1, $2); |
988 | $cb->($_[0], $1, $2); |
|
|
989 | 1 |
889 | 1 |
990 | } |
890 | } |
991 | } |
891 | }; |
992 | }; |
892 | |
|
|
893 | # compatibility with older API |
|
|
894 | sub push_read_line { |
|
|
895 | my $self = shift; |
|
|
896 | $self->push_read (line => @_); |
|
|
897 | } |
|
|
898 | |
|
|
899 | sub unshift_read_line { |
|
|
900 | my $self = shift; |
|
|
901 | $self->unshift_read (line => @_); |
|
|
902 | } |
|
|
903 | |
993 | |
904 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
994 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
905 | |
995 | |
906 | Makes a regex match against the regex object C<$accept> and returns |
996 | Makes a regex match against the regex object C<$accept> and returns |
907 | everything up to and including the match. |
997 | everything up to and including the match. |
… | |
… | |
1012 | An octet string prefixed with an encoded length. The encoding C<$format> |
1102 | An octet string prefixed with an encoded length. The encoding C<$format> |
1013 | uses the same format as a Perl C<pack> format, but must specify a single |
1103 | uses the same format as a Perl C<pack> format, but must specify a single |
1014 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
1104 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
1015 | optional C<!>, C<< < >> or C<< > >> modifier). |
1105 | optional C<!>, C<< < >> or C<< > >> modifier). |
1016 | |
1106 | |
1017 | DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. |
1107 | For example, DNS over TCP uses a prefix of C<n> (2 octet network order), |
|
|
1108 | EPP uses a prefix of C<N> (4 octtes). |
1018 | |
1109 | |
1019 | Example: read a block of data prefixed by its length in BER-encoded |
1110 | Example: read a block of data prefixed by its length in BER-encoded |
1020 | format (very efficient). |
1111 | format (very efficient). |
1021 | |
1112 | |
1022 | $handle->push_read (packstring => "w", sub { |
1113 | $handle->push_read (packstring => "w", sub { |
… | |
… | |
1028 | register_read_type packstring => sub { |
1119 | register_read_type packstring => sub { |
1029 | my ($self, $cb, $format) = @_; |
1120 | my ($self, $cb, $format) = @_; |
1030 | |
1121 | |
1031 | sub { |
1122 | sub { |
1032 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1123 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1033 | defined (my $len = eval { unpack $format, $_[0]->{rbuf} }) |
1124 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
1034 | or return; |
1125 | or return; |
1035 | |
1126 | |
|
|
1127 | $format = length pack $format, $len; |
|
|
1128 | |
|
|
1129 | # bypass unshift if we already have the remaining chunk |
|
|
1130 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1131 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1132 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1133 | $cb->($_[0], $data); |
|
|
1134 | } else { |
1036 | # remove prefix |
1135 | # remove prefix |
1037 | substr $_[0]->{rbuf}, 0, (length pack $format, $len), ""; |
1136 | substr $_[0]{rbuf}, 0, $format, ""; |
1038 | |
1137 | |
1039 | # read rest |
1138 | # read remaining chunk |
1040 | $_[0]->unshift_read (chunk => $len, $cb); |
1139 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1140 | } |
1041 | |
1141 | |
1042 | 1 |
1142 | 1 |
1043 | } |
1143 | } |
1044 | }; |
1144 | }; |
1045 | |
1145 | |
… | |
… | |
1102 | |
1202 | |
1103 | require Storable; |
1203 | require Storable; |
1104 | |
1204 | |
1105 | sub { |
1205 | sub { |
1106 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1206 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1107 | defined (my $len = eval { unpack "w", $_[0]->{rbuf} }) |
1207 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
1108 | or return; |
1208 | or return; |
1109 | |
1209 | |
|
|
1210 | my $format = length pack "w", $len; |
|
|
1211 | |
|
|
1212 | # bypass unshift if we already have the remaining chunk |
|
|
1213 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1214 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1215 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1216 | $cb->($_[0], Storable::thaw ($data)); |
|
|
1217 | } else { |
1110 | # remove prefix |
1218 | # remove prefix |
1111 | substr $_[0]->{rbuf}, 0, (length pack "w", $len), ""; |
1219 | substr $_[0]{rbuf}, 0, $format, ""; |
1112 | |
1220 | |
1113 | # read rest |
1221 | # read remaining chunk |
1114 | $_[0]->unshift_read (chunk => $len, sub { |
1222 | $_[0]->unshift_read (chunk => $len, sub { |
1115 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1223 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1116 | $cb->($_[0], $ref); |
1224 | $cb->($_[0], $ref); |
1117 | } else { |
1225 | } else { |
1118 | $self->_error (&Errno::EBADMSG); |
1226 | $self->_error (&Errno::EBADMSG); |
|
|
1227 | } |
1119 | } |
1228 | }); |
1120 | }); |
1229 | } |
|
|
1230 | |
|
|
1231 | 1 |
1121 | } |
1232 | } |
1122 | }; |
1233 | }; |
1123 | |
1234 | |
1124 | =back |
1235 | =back |
1125 | |
1236 | |
… | |
… | |
1155 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1266 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1156 | you change the C<on_read> callback or push/unshift a read callback, and it |
1267 | you change the C<on_read> callback or push/unshift a read callback, and it |
1157 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1268 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1158 | there are any read requests in the queue. |
1269 | there are any read requests in the queue. |
1159 | |
1270 | |
|
|
1271 | These methods will have no effect when in TLS mode (as TLS doesn't support |
|
|
1272 | half-duplex connections). |
|
|
1273 | |
1160 | =cut |
1274 | =cut |
1161 | |
1275 | |
1162 | sub stop_read { |
1276 | sub stop_read { |
1163 | my ($self) = @_; |
1277 | my ($self) = @_; |
1164 | |
1278 | |
1165 | delete $self->{_rw}; |
1279 | delete $self->{_rw} unless $self->{tls}; |
1166 | } |
1280 | } |
1167 | |
1281 | |
1168 | sub start_read { |
1282 | sub start_read { |
1169 | my ($self) = @_; |
1283 | my ($self) = @_; |
1170 | |
1284 | |
1171 | unless ($self->{_rw} || $self->{_eof}) { |
1285 | unless ($self->{_rw} || $self->{_eof}) { |
1172 | Scalar::Util::weaken $self; |
1286 | Scalar::Util::weaken $self; |
1173 | |
1287 | |
1174 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1288 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1175 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
1289 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1176 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1290 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1177 | |
1291 | |
1178 | if ($len > 0) { |
1292 | if ($len > 0) { |
1179 | $self->{_activity} = AnyEvent->now; |
1293 | $self->{_activity} = AnyEvent->now; |
1180 | |
1294 | |
1181 | $self->{filter_r} |
1295 | if ($self->{tls}) { |
1182 | ? $self->{filter_r}($self, $rbuf) |
1296 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1183 | : $self->{_in_drain} || $self->_drain_rbuf; |
1297 | |
|
|
1298 | &_dotls ($self); |
|
|
1299 | } else { |
|
|
1300 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1301 | } |
1184 | |
1302 | |
1185 | } elsif (defined $len) { |
1303 | } elsif (defined $len) { |
1186 | delete $self->{_rw}; |
1304 | delete $self->{_rw}; |
1187 | $self->{_eof} = 1; |
1305 | $self->{_eof} = 1; |
1188 | $self->_drain_rbuf unless $self->{_in_drain}; |
1306 | $self->_drain_rbuf unless $self->{_in_drain}; |
… | |
… | |
1192 | } |
1310 | } |
1193 | }); |
1311 | }); |
1194 | } |
1312 | } |
1195 | } |
1313 | } |
1196 | |
1314 | |
|
|
1315 | # poll the write BIO and send the data if applicable |
1197 | sub _dotls { |
1316 | sub _dotls { |
1198 | my ($self) = @_; |
1317 | my ($self) = @_; |
1199 | |
1318 | |
1200 | my $buf; |
1319 | my $tmp; |
1201 | |
1320 | |
1202 | if (length $self->{_tls_wbuf}) { |
1321 | if (length $self->{_tls_wbuf}) { |
1203 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1322 | while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1204 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1323 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
1205 | } |
1324 | } |
1206 | } |
1325 | } |
1207 | |
1326 | |
1208 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
|
|
1209 | $self->{wbuf} .= $buf; |
|
|
1210 | $self->_drain_wbuf; |
|
|
1211 | } |
|
|
1212 | |
|
|
1213 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
1327 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
1214 | if (length $buf) { |
1328 | unless (length $tmp) { |
1215 | $self->{rbuf} .= $buf; |
|
|
1216 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1217 | } else { |
|
|
1218 | # let's treat SSL-eof as we treat normal EOF |
1329 | # let's treat SSL-eof as we treat normal EOF |
|
|
1330 | delete $self->{_rw}; |
1219 | $self->{_eof} = 1; |
1331 | $self->{_eof} = 1; |
1220 | $self->_shutdown; |
1332 | &_freetls; |
1221 | return; |
|
|
1222 | } |
1333 | } |
1223 | } |
|
|
1224 | |
1334 | |
|
|
1335 | $self->{rbuf} .= $tmp; |
|
|
1336 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1337 | $self->{tls} or return; # tls session might have gone away in callback |
|
|
1338 | } |
|
|
1339 | |
1225 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1340 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
1226 | |
1341 | |
1227 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1342 | if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) { |
1228 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
1343 | if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) { |
1229 | return $self->_error ($!, 1); |
1344 | return $self->_error ($!, 1); |
1230 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1345 | } elsif ($tmp == Net::SSLeay::ERROR_SSL ()) { |
1231 | return $self->_error (&Errno::EIO, 1); |
1346 | return $self->_error (&Errno::EIO, 1); |
1232 | } |
1347 | } |
1233 | |
1348 | |
1234 | # all others are fine for our purposes |
1349 | # all other errors are fine for our purposes |
|
|
1350 | } |
|
|
1351 | |
|
|
1352 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
|
|
1353 | $self->{wbuf} .= $tmp; |
|
|
1354 | $self->_drain_wbuf; |
1235 | } |
1355 | } |
1236 | } |
1356 | } |
1237 | |
1357 | |
1238 | =item $handle->starttls ($tls[, $tls_ctx]) |
1358 | =item $handle->starttls ($tls[, $tls_ctx]) |
1239 | |
1359 | |
… | |
… | |
1249 | |
1369 | |
1250 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
1370 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
1251 | call and can be used or changed to your liking. Note that the handshake |
1371 | call and can be used or changed to your liking. Note that the handshake |
1252 | might have already started when this function returns. |
1372 | might have already started when this function returns. |
1253 | |
1373 | |
|
|
1374 | If it an error to start a TLS handshake more than once per |
|
|
1375 | AnyEvent::Handle object (this is due to bugs in OpenSSL). |
|
|
1376 | |
1254 | =cut |
1377 | =cut |
1255 | |
1378 | |
1256 | sub starttls { |
1379 | sub starttls { |
1257 | my ($self, $ssl, $ctx) = @_; |
1380 | my ($self, $ssl, $ctx) = @_; |
1258 | |
1381 | |
1259 | $self->stoptls; |
1382 | require Net::SSLeay; |
1260 | |
1383 | |
|
|
1384 | Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object" |
|
|
1385 | if $self->{tls}; |
|
|
1386 | |
1261 | if ($ssl eq "accept") { |
1387 | if ($ssl eq "accept") { |
1262 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1388 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1263 | Net::SSLeay::set_accept_state ($ssl); |
1389 | Net::SSLeay::set_accept_state ($ssl); |
1264 | } elsif ($ssl eq "connect") { |
1390 | } elsif ($ssl eq "connect") { |
1265 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1391 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
… | |
… | |
1271 | # basically, this is deep magic (because SSL_read should have the same issues) |
1397 | # basically, this is deep magic (because SSL_read should have the same issues) |
1272 | # but the openssl maintainers basically said: "trust us, it just works". |
1398 | # but the openssl maintainers basically said: "trust us, it just works". |
1273 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1399 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1274 | # and mismaintained ssleay-module doesn't even offer them). |
1400 | # and mismaintained ssleay-module doesn't even offer them). |
1275 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
1401 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
|
|
1402 | # |
|
|
1403 | # in short: this is a mess. |
|
|
1404 | # |
|
|
1405 | # note that we do not try to keep the length constant between writes as we are required to do. |
|
|
1406 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
|
|
1407 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
|
|
1408 | # have identity issues in that area. |
1276 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1409 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1277 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1410 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1278 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1411 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1279 | |
1412 | |
1280 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1413 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1281 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1414 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1282 | |
1415 | |
1283 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1416 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1284 | |
1417 | |
1285 | $self->{filter_w} = sub { |
1418 | &_dotls; # need to trigger the initial handshake |
1286 | $_[0]{_tls_wbuf} .= ${$_[1]}; |
1419 | $self->start_read; # make sure we actually do read |
1287 | &_dotls; |
|
|
1288 | }; |
|
|
1289 | $self->{filter_r} = sub { |
|
|
1290 | Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]}); |
|
|
1291 | &_dotls; |
|
|
1292 | }; |
|
|
1293 | } |
1420 | } |
1294 | |
1421 | |
1295 | =item $handle->stoptls |
1422 | =item $handle->stoptls |
1296 | |
1423 | |
1297 | Destroys the SSL connection, if any. Partial read or write data will be |
1424 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1298 | lost. |
1425 | sending a close notify to the other side, but since OpenSSL doesn't |
|
|
1426 | support non-blocking shut downs, it is not possible to re-use the stream |
|
|
1427 | afterwards. |
1299 | |
1428 | |
1300 | =cut |
1429 | =cut |
1301 | |
1430 | |
1302 | sub stoptls { |
1431 | sub stoptls { |
1303 | my ($self) = @_; |
1432 | my ($self) = @_; |
1304 | |
1433 | |
|
|
1434 | if ($self->{tls}) { |
|
|
1435 | Net::SSLeay::shutdown ($self->{tls}); |
|
|
1436 | |
|
|
1437 | &_dotls; |
|
|
1438 | |
|
|
1439 | # we don't give a shit. no, we do, but we can't. no... |
|
|
1440 | # we, we... have to use openssl :/ |
|
|
1441 | &_freetls; |
|
|
1442 | } |
|
|
1443 | } |
|
|
1444 | |
|
|
1445 | sub _freetls { |
|
|
1446 | my ($self) = @_; |
|
|
1447 | |
|
|
1448 | return unless $self->{tls}; |
|
|
1449 | |
1305 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
1450 | Net::SSLeay::free (delete $self->{tls}); |
1306 | |
1451 | |
1307 | delete $self->{_rbio}; |
1452 | delete @$self{qw(_rbio _wbio _tls_wbuf)}; |
1308 | delete $self->{_wbio}; |
|
|
1309 | delete $self->{_tls_wbuf}; |
|
|
1310 | delete $self->{filter_r}; |
|
|
1311 | delete $self->{filter_w}; |
|
|
1312 | } |
1453 | } |
1313 | |
1454 | |
1314 | sub DESTROY { |
1455 | sub DESTROY { |
1315 | my $self = shift; |
1456 | my $self = shift; |
1316 | |
1457 | |
1317 | $self->stoptls; |
1458 | &_freetls; |
1318 | |
1459 | |
1319 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1460 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1320 | |
1461 | |
1321 | if ($linger && length $self->{wbuf}) { |
1462 | if ($linger && length $self->{wbuf}) { |
1322 | my $fh = delete $self->{fh}; |
1463 | my $fh = delete $self->{fh}; |
… | |
… | |
1374 | } |
1515 | } |
1375 | } |
1516 | } |
1376 | |
1517 | |
1377 | =back |
1518 | =back |
1378 | |
1519 | |
|
|
1520 | |
|
|
1521 | =head1 NONFREQUENTLY ASKED QUESTIONS |
|
|
1522 | |
|
|
1523 | =over 4 |
|
|
1524 | |
|
|
1525 | =item How do I read data until the other side closes the connection? |
|
|
1526 | |
|
|
1527 | If you just want to read your data into a perl scalar, the easiest way |
|
|
1528 | to achieve this is by setting an C<on_read> callback that does nothing, |
|
|
1529 | clearing the C<on_eof> callback and in the C<on_error> callback, the data |
|
|
1530 | will be in C<$_[0]{rbuf}>: |
|
|
1531 | |
|
|
1532 | $handle->on_read (sub { }); |
|
|
1533 | $handle->on_eof (undef); |
|
|
1534 | $handle->on_error (sub { |
|
|
1535 | my $data = delete $_[0]{rbuf}; |
|
|
1536 | undef $handle; |
|
|
1537 | }); |
|
|
1538 | |
|
|
1539 | The reason to use C<on_error> is that TCP connections, due to latencies |
|
|
1540 | and packets loss, might get closed quite violently with an error, when in |
|
|
1541 | fact, all data has been received. |
|
|
1542 | |
|
|
1543 | It is usually better to use acknowledgements when transfering data, |
|
|
1544 | to make sure the other side hasn't just died and you got the data |
|
|
1545 | intact. This is also one reason why so many internet protocols have an |
|
|
1546 | explicit QUIT command. |
|
|
1547 | |
|
|
1548 | |
|
|
1549 | =item I don't want to destroy the handle too early - how do I wait until |
|
|
1550 | all data has been written? |
|
|
1551 | |
|
|
1552 | After writing your last bits of data, set the C<on_drain> callback |
|
|
1553 | and destroy the handle in there - with the default setting of |
|
|
1554 | C<low_water_mark> this will be called precisely when all data has been |
|
|
1555 | written to the socket: |
|
|
1556 | |
|
|
1557 | $handle->push_write (...); |
|
|
1558 | $handle->on_drain (sub { |
|
|
1559 | warn "all data submitted to the kernel\n"; |
|
|
1560 | undef $handle; |
|
|
1561 | }); |
|
|
1562 | |
|
|
1563 | =back |
|
|
1564 | |
|
|
1565 | |
1379 | =head1 SUBCLASSING AnyEvent::Handle |
1566 | =head1 SUBCLASSING AnyEvent::Handle |
1380 | |
1567 | |
1381 | In many cases, you might want to subclass AnyEvent::Handle. |
1568 | In many cases, you might want to subclass AnyEvent::Handle. |
1382 | |
1569 | |
1383 | To make this easier, a given version of AnyEvent::Handle uses these |
1570 | To make this easier, a given version of AnyEvent::Handle uses these |
… | |
… | |
1386 | =over 4 |
1573 | =over 4 |
1387 | |
1574 | |
1388 | =item * all constructor arguments become object members. |
1575 | =item * all constructor arguments become object members. |
1389 | |
1576 | |
1390 | At least initially, when you pass a C<tls>-argument to the constructor it |
1577 | At least initially, when you pass a C<tls>-argument to the constructor it |
1391 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
1578 | will end up in C<< $handle->{tls} >>. Those members might be changed or |
1392 | mutated later on (for example C<tls> will hold the TLS connection object). |
1579 | mutated later on (for example C<tls> will hold the TLS connection object). |
1393 | |
1580 | |
1394 | =item * other object member names are prefixed with an C<_>. |
1581 | =item * other object member names are prefixed with an C<_>. |
1395 | |
1582 | |
1396 | All object members not explicitly documented (internal use) are prefixed |
1583 | All object members not explicitly documented (internal use) are prefixed |