1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
3 | AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | use AnyEvent; |
7 | use AnyEvent; |
8 | use AnyEvent::Handle; |
8 | use AnyEvent::Handle; |
… | |
… | |
14 | on_error => sub { |
14 | on_error => sub { |
15 | my ($hdl, $fatal, $msg) = @_; |
15 | my ($hdl, $fatal, $msg) = @_; |
16 | warn "got error $msg\n"; |
16 | warn "got error $msg\n"; |
17 | $hdl->destroy; |
17 | $hdl->destroy; |
18 | $cv->send; |
18 | $cv->send; |
19 | ); |
19 | }; |
20 | |
20 | |
21 | # send some request line |
21 | # send some request line |
22 | $hdl->push_write ("getinfo\015\012"); |
22 | $hdl->push_write ("getinfo\015\012"); |
23 | |
23 | |
24 | # read the response line |
24 | # read the response line |
… | |
… | |
30 | |
30 | |
31 | $cv->recv; |
31 | $cv->recv; |
32 | |
32 | |
33 | =head1 DESCRIPTION |
33 | =head1 DESCRIPTION |
34 | |
34 | |
35 | This module is a helper module to make it easier to do event-based I/O on |
35 | This is a helper module to make it easier to do event-based I/O on |
36 | filehandles. |
36 | stream-based filehandles (sockets, pipes, and other stream things). |
37 | |
37 | |
38 | The L<AnyEvent::Intro> tutorial contains some well-documented |
38 | The L<AnyEvent::Intro> tutorial contains some well-documented |
39 | AnyEvent::Handle examples. |
39 | AnyEvent::Handle examples. |
40 | |
40 | |
41 | In the following, when the documentation refers to of "bytes" then this |
41 | In the following, where the documentation refers to "bytes", it means |
42 | means characters. As sysread and syswrite are used for all I/O, their |
42 | characters. As sysread and syswrite are used for all I/O, their |
43 | treatment of characters applies to this module as well. |
43 | treatment of characters applies to this module as well. |
44 | |
44 | |
45 | At the very minimum, you should specify C<fh> or C<connect>, and the |
45 | At the very minimum, you should specify C<fh> or C<connect>, and the |
46 | C<on_error> callback. |
46 | C<on_error> callback. |
47 | |
47 | |
… | |
… | |
75 | } |
75 | } |
76 | |
76 | |
77 | \&$func |
77 | \&$func |
78 | } |
78 | } |
79 | |
79 | |
|
|
80 | sub MAX_READ_SIZE() { 131072 } |
|
|
81 | |
80 | =head1 METHODS |
82 | =head1 METHODS |
81 | |
83 | |
82 | =over 4 |
84 | =over 4 |
83 | |
85 | |
84 | =item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value... |
86 | =item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value... |
85 | |
87 | |
86 | The constructor supports these arguments (all as C<< key => value >> pairs). |
88 | The constructor supports these arguments (all as C<< key => value >> pairs). |
87 | |
89 | |
88 | =over 4 |
90 | =over 4 |
89 | |
91 | |
… | |
… | |
118 | prepare the file handle with parameters required for the actual connect |
120 | prepare the file handle with parameters required for the actual connect |
119 | (as opposed to settings that can be changed when the connection is already |
121 | (as opposed to settings that can be changed when the connection is already |
120 | established). |
122 | established). |
121 | |
123 | |
122 | The return value of this callback should be the connect timeout value in |
124 | The return value of this callback should be the connect timeout value in |
123 | seconds (or C<0>, or C<undef>, or the empty list, to indicate the default |
125 | seconds (or C<0>, or C<undef>, or the empty list, to indicate that the |
124 | timeout is to be used). |
126 | default timeout is to be used). |
125 | |
127 | |
126 | =item on_connect => $cb->($handle, $host, $port, $retry->()) |
128 | =item on_connect => $cb->($handle, $host, $port, $retry->()) |
127 | |
129 | |
128 | This callback is called when a connection has been successfully established. |
130 | This callback is called when a connection has been successfully established. |
129 | |
131 | |
130 | The actual numeric host and port (the socket peername) are passed as |
132 | The peer's numeric host and port (the socket peername) are passed as |
131 | parameters, together with a retry callback. |
133 | parameters, together with a retry callback. |
132 | |
134 | |
133 | When, for some reason, the handle is not acceptable, then calling |
135 | If, for some reason, the handle is not acceptable, calling C<$retry> |
134 | C<$retry> will continue with the next connection target (in case of |
136 | will continue with the next connection target (in case of multi-homed |
135 | multi-homed hosts or SRV records there can be multiple connection |
137 | hosts or SRV records there can be multiple connection endpoints). At the |
136 | endpoints). At the time it is called the read and write queues, eof |
138 | time it is called the read and write queues, eof status, tls status and |
137 | status, tls status and similar properties of the handle will have been |
139 | similar properties of the handle will have been reset. |
138 | reset. |
|
|
139 | |
140 | |
140 | In most cases, ignoring the C<$retry> parameter is the way to go. |
141 | In most cases, you should ignore the C<$retry> parameter. |
141 | |
142 | |
142 | =item on_connect_error => $cb->($handle, $message) |
143 | =item on_connect_error => $cb->($handle, $message) |
143 | |
144 | |
144 | This callback is called when the connection could not be |
145 | This callback is called when the connection could not be |
145 | established. C<$!> will contain the relevant error code, and C<$message> a |
146 | established. C<$!> will contain the relevant error code, and C<$message> a |
… | |
… | |
152 | |
153 | |
153 | =item on_error => $cb->($handle, $fatal, $message) |
154 | =item on_error => $cb->($handle, $fatal, $message) |
154 | |
155 | |
155 | This is the error callback, which is called when, well, some error |
156 | This is the error callback, which is called when, well, some error |
156 | occured, such as not being able to resolve the hostname, failure to |
157 | occured, such as not being able to resolve the hostname, failure to |
157 | connect or a read error. |
158 | connect, or a read error. |
158 | |
159 | |
159 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
160 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
160 | fatal errors the handle object will be destroyed (by a call to C<< -> |
161 | fatal errors the handle object will be destroyed (by a call to C<< -> |
161 | destroy >>) after invoking the error callback (which means you are free to |
162 | destroy >>) after invoking the error callback (which means you are free to |
162 | examine the handle object). Examples of fatal errors are an EOF condition |
163 | examine the handle object). Examples of fatal errors are an EOF condition |
163 | with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In |
164 | with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In |
164 | cases where the other side can close the connection at their will it is |
165 | cases where the other side can close the connection at will, it is |
165 | often easiest to not report C<EPIPE> errors in this callback. |
166 | often easiest to not report C<EPIPE> errors in this callback. |
166 | |
167 | |
167 | AnyEvent::Handle tries to find an appropriate error code for you to check |
168 | AnyEvent::Handle tries to find an appropriate error code for you to check |
168 | against, but in some cases (TLS errors), this does not work well. It is |
169 | against, but in some cases (TLS errors), this does not work well. It is |
169 | recommended to always output the C<$message> argument in human-readable |
170 | recommended to always output the C<$message> argument in human-readable |
170 | error messages (it's usually the same as C<"$!">). |
171 | error messages (it's usually the same as C<"$!">). |
171 | |
172 | |
172 | Non-fatal errors can be retried by simply returning, but it is recommended |
173 | Non-fatal errors can be retried by returning, but it is recommended |
173 | to simply ignore this parameter and instead abondon the handle object |
174 | to simply ignore this parameter and instead abondon the handle object |
174 | when this callback is invoked. Examples of non-fatal errors are timeouts |
175 | when this callback is invoked. Examples of non-fatal errors are timeouts |
175 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
176 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
176 | |
177 | |
177 | On callback entrance, the value of C<$!> contains the operating system |
178 | On entry to the callback, the value of C<$!> contains the operating |
178 | error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or |
179 | system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or |
179 | C<EPROTO>). |
180 | C<EPROTO>). |
180 | |
181 | |
181 | While not mandatory, it is I<highly> recommended to set this callback, as |
182 | While not mandatory, it is I<highly> recommended to set this callback, as |
182 | you will not be notified of errors otherwise. The default simply calls |
183 | you will not be notified of errors otherwise. The default just calls |
183 | C<croak>. |
184 | C<croak>. |
184 | |
185 | |
185 | =item on_read => $cb->($handle) |
186 | =item on_read => $cb->($handle) |
186 | |
187 | |
187 | This sets the default read callback, which is called when data arrives |
188 | This sets the default read callback, which is called when data arrives |
… | |
… | |
192 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
193 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
193 | method or access the C<< $handle->{rbuf} >> member directly. Note that you |
194 | method or access the C<< $handle->{rbuf} >> member directly. Note that you |
194 | must not enlarge or modify the read buffer, you can only remove data at |
195 | must not enlarge or modify the read buffer, you can only remove data at |
195 | the beginning from it. |
196 | the beginning from it. |
196 | |
197 | |
|
|
198 | You can also call C<< ->push_read (...) >> or any other function that |
|
|
199 | modifies the read queue. Or do both. Or ... |
|
|
200 | |
197 | When an EOF condition is detected then AnyEvent::Handle will first try to |
201 | When an EOF condition is detected, AnyEvent::Handle will first try to |
198 | feed all the remaining data to the queued callbacks and C<on_read> before |
202 | feed all the remaining data to the queued callbacks and C<on_read> before |
199 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
203 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
200 | error will be raised (with C<$!> set to C<EPIPE>). |
204 | error will be raised (with C<$!> set to C<EPIPE>). |
201 | |
205 | |
202 | Note that, unlike requests in the read queue, an C<on_read> callback |
206 | Note that, unlike requests in the read queue, an C<on_read> callback |
… | |
… | |
221 | set, then a fatal error will be raised with C<$!> set to <0>. |
225 | set, then a fatal error will be raised with C<$!> set to <0>. |
222 | |
226 | |
223 | =item on_drain => $cb->($handle) |
227 | =item on_drain => $cb->($handle) |
224 | |
228 | |
225 | This sets the callback that is called when the write buffer becomes empty |
229 | This sets the callback that is called when the write buffer becomes empty |
226 | (or when the callback is set and the buffer is empty already). |
230 | (or immediately if the buffer is empty already). |
227 | |
231 | |
228 | To append to the write buffer, use the C<< ->push_write >> method. |
232 | To append to the write buffer, use the C<< ->push_write >> method. |
229 | |
233 | |
230 | This callback is useful when you don't want to put all of your write data |
234 | This callback is useful when you don't want to put all of your write data |
231 | into the queue at once, for example, when you want to write the contents |
235 | into the queue at once, for example, when you want to write the contents |
… | |
… | |
243 | many seconds pass without a successful read or write on the underlying |
247 | many seconds pass without a successful read or write on the underlying |
244 | file handle (or a call to C<timeout_reset>), the C<on_timeout> callback |
248 | file handle (or a call to C<timeout_reset>), the C<on_timeout> callback |
245 | will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT> |
249 | will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT> |
246 | error will be raised). |
250 | error will be raised). |
247 | |
251 | |
248 | There are three variants of the timeouts that work fully independent |
252 | There are three variants of the timeouts that work independently |
249 | of each other, for both read and write, just read, and just write: |
253 | of each other, for both read and write, just read, and just write: |
250 | C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks |
254 | C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks |
251 | C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions |
255 | C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions |
252 | C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. |
256 | C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. |
253 | |
257 | |
254 | Note that timeout processing is also active when you currently do not have |
258 | Note that timeout processing is active even when you do not have |
255 | any outstanding read or write requests: If you plan to keep the connection |
259 | any outstanding read or write requests: If you plan to keep the connection |
256 | idle then you should disable the timout temporarily or ignore the timeout |
260 | idle then you should disable the timeout temporarily or ignore the timeout |
257 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
261 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
258 | restart the timeout. |
262 | restart the timeout. |
259 | |
263 | |
260 | Zero (the default) disables this timeout. |
264 | Zero (the default) disables this timeout. |
261 | |
265 | |
… | |
… | |
277 | amount of data without a callback ever being called as long as the line |
281 | amount of data without a callback ever being called as long as the line |
278 | isn't finished). |
282 | isn't finished). |
279 | |
283 | |
280 | =item autocork => <boolean> |
284 | =item autocork => <boolean> |
281 | |
285 | |
282 | When disabled (the default), then C<push_write> will try to immediately |
286 | When disabled (the default), C<push_write> will try to immediately |
283 | write the data to the handle, if possible. This avoids having to register |
287 | write the data to the handle if possible. This avoids having to register |
284 | a write watcher and wait for the next event loop iteration, but can |
288 | a write watcher and wait for the next event loop iteration, but can |
285 | be inefficient if you write multiple small chunks (on the wire, this |
289 | be inefficient if you write multiple small chunks (on the wire, this |
286 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
290 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
287 | C<no_delay>, but this option can save costly syscalls). |
291 | C<no_delay>, but this option can save costly syscalls). |
288 | |
292 | |
289 | When enabled, then writes will always be queued till the next event loop |
293 | When enabled, writes will always be queued till the next event loop |
290 | iteration. This is efficient when you do many small writes per iteration, |
294 | iteration. This is efficient when you do many small writes per iteration, |
291 | but less efficient when you do a single write only per iteration (or when |
295 | but less efficient when you do a single write only per iteration (or when |
292 | the write buffer often is full). It also increases write latency. |
296 | the write buffer often is full). It also increases write latency. |
293 | |
297 | |
294 | =item no_delay => <boolean> |
298 | =item no_delay => <boolean> |
… | |
… | |
298 | the Nagle algorithm, and usually it is beneficial. |
302 | the Nagle algorithm, and usually it is beneficial. |
299 | |
303 | |
300 | In some situations you want as low a delay as possible, which can be |
304 | In some situations you want as low a delay as possible, which can be |
301 | accomplishd by setting this option to a true value. |
305 | accomplishd by setting this option to a true value. |
302 | |
306 | |
303 | The default is your opertaing system's default behaviour (most likely |
307 | The default is your operating system's default behaviour (most likely |
304 | enabled), this option explicitly enables or disables it, if possible. |
308 | enabled). This option explicitly enables or disables it, if possible. |
305 | |
309 | |
306 | =item keepalive => <boolean> |
310 | =item keepalive => <boolean> |
307 | |
311 | |
308 | Enables (default disable) the SO_KEEPALIVE option on the stream socket: |
312 | Enables (default disable) the SO_KEEPALIVE option on the stream socket: |
309 | normally, TCP connections have no time-out once established, so TCP |
313 | normally, TCP connections have no time-out once established, so TCP |
310 | connections, once established, can stay alive forever even when the other |
314 | connections, once established, can stay alive forever even when the other |
311 | side has long gone. TCP keepalives are a cheap way to take down long-lived |
315 | side has long gone. TCP keepalives are a cheap way to take down long-lived |
312 | TCP connections whent he other side becomes unreachable. While the default |
316 | TCP connections when the other side becomes unreachable. While the default |
313 | is OS-dependent, TCP keepalives usually kick in after around two hours, |
317 | is OS-dependent, TCP keepalives usually kick in after around two hours, |
314 | and, if the other side doesn't reply, take down the TCP connection some 10 |
318 | and, if the other side doesn't reply, take down the TCP connection some 10 |
315 | to 15 minutes later. |
319 | to 15 minutes later. |
316 | |
320 | |
317 | It is harmless to specify this option for file handles that do not support |
321 | It is harmless to specify this option for file handles that do not support |
… | |
… | |
335 | already have occured on BSD systems), but at least it will protect you |
339 | already have occured on BSD systems), but at least it will protect you |
336 | from most attacks. |
340 | from most attacks. |
337 | |
341 | |
338 | =item read_size => <bytes> |
342 | =item read_size => <bytes> |
339 | |
343 | |
340 | The default read block size (the amount of bytes this module will |
344 | The initial read block size, the number of bytes this module will try to |
341 | try to read during each loop iteration, which affects memory |
345 | read during each loop iteration. Each handle object will consume at least |
342 | requirements). Default: C<8192>. |
346 | this amount of memory for the read buffer as well, so when handling many |
|
|
347 | connections requirements). See also C<max_read_size>. Default: C<2048>. |
|
|
348 | |
|
|
349 | =item max_read_size => <bytes> |
|
|
350 | |
|
|
351 | The maximum read buffer size used by the dynamic adjustment |
|
|
352 | algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in |
|
|
353 | one go it will double C<read_size> up to the maximum given by this |
|
|
354 | option. Default: C<131072> or C<read_size>, whichever is higher. |
343 | |
355 | |
344 | =item low_water_mark => <bytes> |
356 | =item low_water_mark => <bytes> |
345 | |
357 | |
346 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
358 | Sets the number of bytes (default: C<0>) that make up an "empty" write |
347 | buffer: If the write reaches this size or gets even samller it is |
359 | buffer: If the buffer reaches this size or gets even samller it is |
348 | considered empty. |
360 | considered empty. |
349 | |
361 | |
350 | Sometimes it can be beneficial (for performance reasons) to add data to |
362 | Sometimes it can be beneficial (for performance reasons) to add data to |
351 | the write buffer before it is fully drained, but this is a rare case, as |
363 | the write buffer before it is fully drained, but this is a rare case, as |
352 | the operating system kernel usually buffers data as well, so the default |
364 | the operating system kernel usually buffers data as well, so the default |
353 | is good in almost all cases. |
365 | is good in almost all cases. |
354 | |
366 | |
355 | =item linger => <seconds> |
367 | =item linger => <seconds> |
356 | |
368 | |
357 | If non-zero (default: C<3600>), then the destructor of the |
369 | If this is non-zero (default: C<3600>), the destructor of the |
358 | AnyEvent::Handle object will check whether there is still outstanding |
370 | AnyEvent::Handle object will check whether there is still outstanding |
359 | write data and will install a watcher that will write this data to the |
371 | write data and will install a watcher that will write this data to the |
360 | socket. No errors will be reported (this mostly matches how the operating |
372 | socket. No errors will be reported (this mostly matches how the operating |
361 | system treats outstanding data at socket close time). |
373 | system treats outstanding data at socket close time). |
362 | |
374 | |
… | |
… | |
369 | A string used to identify the remote site - usually the DNS hostname |
381 | A string used to identify the remote site - usually the DNS hostname |
370 | (I<not> IDN!) used to create the connection, rarely the IP address. |
382 | (I<not> IDN!) used to create the connection, rarely the IP address. |
371 | |
383 | |
372 | Apart from being useful in error messages, this string is also used in TLS |
384 | Apart from being useful in error messages, this string is also used in TLS |
373 | peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This |
385 | peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This |
374 | verification will be skipped when C<peername> is not specified or |
386 | verification will be skipped when C<peername> is not specified or is |
375 | C<undef>. |
387 | C<undef>. |
376 | |
388 | |
377 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
389 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
378 | |
390 | |
379 | When this parameter is given, it enables TLS (SSL) mode, that means |
391 | When this parameter is given, it enables TLS (SSL) mode, that means |
… | |
… | |
405 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
417 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
406 | passing in the wrong integer will lead to certain crash. This most often |
418 | passing in the wrong integer will lead to certain crash. This most often |
407 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
419 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
408 | segmentation fault. |
420 | segmentation fault. |
409 | |
421 | |
410 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
422 | Use the C<< ->starttls >> method if you need to start TLS negotiation later. |
411 | |
423 | |
412 | =item tls_ctx => $anyevent_tls |
424 | =item tls_ctx => $anyevent_tls |
413 | |
425 | |
414 | Use the given C<AnyEvent::TLS> object to create the new TLS connection |
426 | Use the given C<AnyEvent::TLS> object to create the new TLS connection |
415 | (unless a connection object was specified directly). If this parameter is |
427 | (unless a connection object was specified directly). If this parameter is |
… | |
… | |
430 | |
442 | |
431 | TLS handshake failures will not cause C<on_error> to be invoked when this |
443 | TLS handshake failures will not cause C<on_error> to be invoked when this |
432 | callback is in effect, instead, the error message will be passed to C<on_starttls>. |
444 | callback is in effect, instead, the error message will be passed to C<on_starttls>. |
433 | |
445 | |
434 | Without this callback, handshake failures lead to C<on_error> being |
446 | Without this callback, handshake failures lead to C<on_error> being |
435 | called, as normal. |
447 | called as usual. |
436 | |
448 | |
437 | Note that you cannot call C<starttls> right again in this callback. If you |
449 | Note that you cannot just call C<starttls> again in this callback. If you |
438 | need to do that, start an zero-second timer instead whose callback can |
450 | need to do that, start an zero-second timer instead whose callback can |
439 | then call C<< ->starttls >> again. |
451 | then call C<< ->starttls >> again. |
440 | |
452 | |
441 | =item on_stoptls => $cb->($handle) |
453 | =item on_stoptls => $cb->($handle) |
442 | |
454 | |
… | |
… | |
489 | AnyEvent::Socket::tcp_connect ( |
501 | AnyEvent::Socket::tcp_connect ( |
490 | $self->{connect}[0], |
502 | $self->{connect}[0], |
491 | $self->{connect}[1], |
503 | $self->{connect}[1], |
492 | sub { |
504 | sub { |
493 | my ($fh, $host, $port, $retry) = @_; |
505 | my ($fh, $host, $port, $retry) = @_; |
|
|
506 | |
|
|
507 | delete $self->{_connect}; |
494 | |
508 | |
495 | if ($fh) { |
509 | if ($fh) { |
496 | $self->{fh} = $fh; |
510 | $self->{fh} = $fh; |
497 | |
511 | |
498 | delete $self->{_skip_drain_rbuf}; |
512 | delete $self->{_skip_drain_rbuf}; |
… | |
… | |
532 | } |
546 | } |
533 | |
547 | |
534 | sub _start { |
548 | sub _start { |
535 | my ($self) = @_; |
549 | my ($self) = @_; |
536 | |
550 | |
|
|
551 | # too many clueless people try to use udp and similar sockets |
|
|
552 | # with AnyEvent::Handle, do them a favour. |
|
|
553 | my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE (); |
|
|
554 | Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!" |
|
|
555 | if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type; |
|
|
556 | |
537 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
557 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
538 | |
558 | |
539 | $self->{_activity} = |
559 | $self->{_activity} = |
540 | $self->{_ractivity} = |
560 | $self->{_ractivity} = |
541 | $self->{_wactivity} = AE::now; |
561 | $self->{_wactivity} = AE::now; |
542 | |
562 | |
|
|
563 | $self->{read_size} ||= 2048; |
|
|
564 | $self->{max_read_size} = $self->{read_size} |
|
|
565 | if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE); |
|
|
566 | |
543 | $self->timeout (delete $self->{timeout} ) if $self->{timeout}; |
567 | $self->timeout (delete $self->{timeout} ) if $self->{timeout}; |
544 | $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout}; |
568 | $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout}; |
545 | $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout}; |
569 | $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout}; |
546 | |
570 | |
547 | $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay}; |
571 | $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay}; |
… | |
… | |
550 | $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1); |
574 | $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1); |
551 | |
575 | |
552 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
576 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
553 | if $self->{tls}; |
577 | if $self->{tls}; |
554 | |
578 | |
555 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
579 | $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain}; |
556 | |
580 | |
557 | $self->start_read |
581 | $self->start_read |
558 | if $self->{on_read} || @{ $self->{_queue} }; |
582 | if $self->{on_read} || @{ $self->{_queue} }; |
559 | |
583 | |
560 | $self->_drain_wbuf; |
584 | $self->_drain_wbuf; |
… | |
… | |
567 | $message ||= "$!"; |
591 | $message ||= "$!"; |
568 | |
592 | |
569 | if ($self->{on_error}) { |
593 | if ($self->{on_error}) { |
570 | $self->{on_error}($self, $fatal, $message); |
594 | $self->{on_error}($self, $fatal, $message); |
571 | $self->destroy if $fatal; |
595 | $self->destroy if $fatal; |
572 | } elsif ($self->{fh}) { |
596 | } elsif ($self->{fh} || $self->{connect}) { |
573 | $self->destroy; |
597 | $self->destroy; |
574 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
598 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
575 | } |
599 | } |
576 | } |
600 | } |
577 | |
601 | |
… | |
… | |
636 | =cut |
660 | =cut |
637 | |
661 | |
638 | sub no_delay { |
662 | sub no_delay { |
639 | $_[0]{no_delay} = $_[1]; |
663 | $_[0]{no_delay} = $_[1]; |
640 | |
664 | |
641 | eval { |
|
|
642 | local $SIG{__DIE__}; |
|
|
643 | setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1] |
665 | setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1] |
644 | if $_[0]{fh}; |
666 | if $_[0]{fh}; |
645 | }; |
|
|
646 | } |
667 | } |
647 | |
668 | |
648 | =item $handle->keepalive ($boolean) |
669 | =item $handle->keepalive ($boolean) |
649 | |
670 | |
650 | Enables or disables the C<keepalive> setting (see constructor argument of |
671 | Enables or disables the C<keepalive> setting (see constructor argument of |
… | |
… | |
710 | |
731 | |
711 | Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). |
732 | Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). |
712 | |
733 | |
713 | =cut |
734 | =cut |
714 | |
735 | |
715 | sub on_starttls { |
736 | sub on_stoptls { |
716 | $_[0]{on_stoptls} = $_[1]; |
737 | $_[0]{on_stoptls} = $_[1]; |
717 | } |
738 | } |
718 | |
739 | |
719 | =item $handle->rbuf_max ($max_octets) |
740 | =item $handle->rbuf_max ($max_octets) |
720 | |
741 | |
… | |
… | |
759 | $_[0]{$on_timeout} = $_[1]; |
780 | $_[0]{$on_timeout} = $_[1]; |
760 | }; |
781 | }; |
761 | |
782 | |
762 | *$timeout = sub { |
783 | *$timeout = sub { |
763 | my ($self, $new_value) = @_; |
784 | my ($self, $new_value) = @_; |
|
|
785 | |
|
|
786 | $new_value >= 0 |
|
|
787 | or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught"; |
764 | |
788 | |
765 | $self->{$timeout} = $new_value; |
789 | $self->{$timeout} = $new_value; |
766 | delete $self->{$tw}; &$cb; |
790 | delete $self->{$tw}; &$cb; |
767 | }; |
791 | }; |
768 | |
792 | |
… | |
… | |
832 | =item $handle->on_drain ($cb) |
856 | =item $handle->on_drain ($cb) |
833 | |
857 | |
834 | Sets the C<on_drain> callback or clears it (see the description of |
858 | Sets the C<on_drain> callback or clears it (see the description of |
835 | C<on_drain> in the constructor). |
859 | C<on_drain> in the constructor). |
836 | |
860 | |
|
|
861 | This method may invoke callbacks (and therefore the handle might be |
|
|
862 | destroyed after it returns). |
|
|
863 | |
837 | =cut |
864 | =cut |
838 | |
865 | |
839 | sub on_drain { |
866 | sub on_drain { |
840 | my ($self, $cb) = @_; |
867 | my ($self, $cb) = @_; |
841 | |
868 | |
… | |
… | |
848 | =item $handle->push_write ($data) |
875 | =item $handle->push_write ($data) |
849 | |
876 | |
850 | Queues the given scalar to be written. You can push as much data as you |
877 | Queues the given scalar to be written. You can push as much data as you |
851 | want (only limited by the available memory), as C<AnyEvent::Handle> |
878 | want (only limited by the available memory), as C<AnyEvent::Handle> |
852 | buffers it independently of the kernel. |
879 | buffers it independently of the kernel. |
|
|
880 | |
|
|
881 | This method may invoke callbacks (and therefore the handle might be |
|
|
882 | destroyed after it returns). |
853 | |
883 | |
854 | =cut |
884 | =cut |
855 | |
885 | |
856 | sub _drain_wbuf { |
886 | sub _drain_wbuf { |
857 | my ($self) = @_; |
887 | my ($self) = @_; |
… | |
… | |
903 | @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type" |
933 | @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type" |
904 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write") |
934 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write") |
905 | ->($self, @_); |
935 | ->($self, @_); |
906 | } |
936 | } |
907 | |
937 | |
|
|
938 | # we downgrade here to avoid hard-to-track-down bugs, |
|
|
939 | # and diagnose the problem earlier and better. |
|
|
940 | |
908 | if ($self->{tls}) { |
941 | if ($self->{tls}) { |
909 | $self->{_tls_wbuf} .= $_[0]; |
942 | utf8::downgrade $self->{_tls_wbuf} .= $_[0]; |
910 | &_dotls ($self) if $self->{fh}; |
943 | &_dotls ($self) if $self->{fh}; |
911 | } else { |
944 | } else { |
912 | $self->{wbuf} .= $_[0]; |
945 | utf8::downgrade $self->{wbuf} .= $_[0]; |
913 | $self->_drain_wbuf if $self->{fh}; |
946 | $self->_drain_wbuf if $self->{fh}; |
914 | } |
947 | } |
915 | } |
948 | } |
916 | |
949 | |
917 | =item $handle->push_write (type => @args) |
950 | =item $handle->push_write (type => @args) |
918 | |
951 | |
919 | Instead of formatting your data yourself, you can also let this module |
952 | Instead of formatting your data yourself, you can also let this module |
920 | do the job by specifying a type and type-specific arguments. You |
953 | do the job by specifying a type and type-specific arguments. You |
921 | can also specify the (fully qualified) name of a package, in which |
954 | can also specify the (fully qualified) name of a package, in which |
922 | case AnyEvent tries to load the package and then expects to find the |
955 | case AnyEvent tries to load the package and then expects to find the |
923 | C<anyevent_read_type> function inside (see "custom write types", below). |
956 | C<anyevent_write_type> function inside (see "custom write types", below). |
924 | |
957 | |
925 | Predefined types are (if you have ideas for additional types, feel free to |
958 | Predefined types are (if you have ideas for additional types, feel free to |
926 | drop by and tell us): |
959 | drop by and tell us): |
927 | |
960 | |
928 | =over 4 |
961 | =over 4 |
… | |
… | |
1031 | the peer. |
1064 | the peer. |
1032 | |
1065 | |
1033 | You can rely on the normal read queue and C<on_eof> handling |
1066 | You can rely on the normal read queue and C<on_eof> handling |
1034 | afterwards. This is the cleanest way to close a connection. |
1067 | afterwards. This is the cleanest way to close a connection. |
1035 | |
1068 | |
|
|
1069 | This method may invoke callbacks (and therefore the handle might be |
|
|
1070 | destroyed after it returns). |
|
|
1071 | |
1036 | =cut |
1072 | =cut |
1037 | |
1073 | |
1038 | sub push_shutdown { |
1074 | sub push_shutdown { |
1039 | my ($self) = @_; |
1075 | my ($self) = @_; |
1040 | |
1076 | |
… | |
… | |
1089 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
1125 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
1090 | a queue. |
1126 | a queue. |
1091 | |
1127 | |
1092 | In the simple case, you just install an C<on_read> callback and whenever |
1128 | In the simple case, you just install an C<on_read> callback and whenever |
1093 | new data arrives, it will be called. You can then remove some data (if |
1129 | new data arrives, it will be called. You can then remove some data (if |
1094 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
1130 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can |
1095 | leave the data there if you want to accumulate more (e.g. when only a |
1131 | leave the data there if you want to accumulate more (e.g. when only a |
1096 | partial message has been received so far). |
1132 | partial message has been received so far), or change the read queue with |
|
|
1133 | e.g. C<push_read>. |
1097 | |
1134 | |
1098 | In the more complex case, you want to queue multiple callbacks. In this |
1135 | In the more complex case, you want to queue multiple callbacks. In this |
1099 | case, AnyEvent::Handle will call the first queued callback each time new |
1136 | case, AnyEvent::Handle will call the first queued callback each time new |
1100 | data arrives (also the first time it is queued) and removes it when it has |
1137 | data arrives (also the first time it is queued) and remove it when it has |
1101 | done its job (see C<push_read>, below). |
1138 | done its job (see C<push_read>, below). |
1102 | |
1139 | |
1103 | This way you can, for example, push three line-reads, followed by reading |
1140 | This way you can, for example, push three line-reads, followed by reading |
1104 | a chunk of data, and AnyEvent::Handle will execute them in order. |
1141 | a chunk of data, and AnyEvent::Handle will execute them in order. |
1105 | |
1142 | |
… | |
… | |
1236 | |
1273 | |
1237 | This replaces the currently set C<on_read> callback, or clears it (when |
1274 | This replaces the currently set C<on_read> callback, or clears it (when |
1238 | the new callback is C<undef>). See the description of C<on_read> in the |
1275 | the new callback is C<undef>). See the description of C<on_read> in the |
1239 | constructor. |
1276 | constructor. |
1240 | |
1277 | |
|
|
1278 | This method may invoke callbacks (and therefore the handle might be |
|
|
1279 | destroyed after it returns). |
|
|
1280 | |
1241 | =cut |
1281 | =cut |
1242 | |
1282 | |
1243 | sub on_read { |
1283 | sub on_read { |
1244 | my ($self, $cb) = @_; |
1284 | my ($self, $cb) = @_; |
1245 | |
1285 | |
… | |
… | |
1247 | $self->_drain_rbuf if $cb; |
1287 | $self->_drain_rbuf if $cb; |
1248 | } |
1288 | } |
1249 | |
1289 | |
1250 | =item $handle->rbuf |
1290 | =item $handle->rbuf |
1251 | |
1291 | |
1252 | Returns the read buffer (as a modifiable lvalue). |
1292 | Returns the read buffer (as a modifiable lvalue). You can also access the |
|
|
1293 | read buffer directly as the C<< ->{rbuf} >> member, if you want (this is |
|
|
1294 | much faster, and no less clean). |
1253 | |
1295 | |
1254 | You can access the read buffer directly as the C<< ->{rbuf} >> |
1296 | The only operation allowed on the read buffer (apart from looking at it) |
1255 | member, if you want. However, the only operation allowed on the |
1297 | is removing data from its beginning. Otherwise modifying or appending to |
1256 | read buffer (apart from looking at it) is removing data from its |
1298 | it is not allowed and will lead to hard-to-track-down bugs. |
1257 | beginning. Otherwise modifying or appending to it is not allowed and will |
|
|
1258 | lead to hard-to-track-down bugs. |
|
|
1259 | |
1299 | |
1260 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
1300 | NOTE: The read buffer should only be used or modified in the C<on_read> |
1261 | C<push_read> or C<unshift_read> methods are used. The other read methods |
1301 | callback or when C<push_read> or C<unshift_read> are used with a single |
1262 | automatically manage the read buffer. |
1302 | callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods |
|
|
1303 | will manage the read buffer on their own. |
1263 | |
1304 | |
1264 | =cut |
1305 | =cut |
1265 | |
1306 | |
1266 | sub rbuf : lvalue { |
1307 | sub rbuf : lvalue { |
1267 | $_[0]{rbuf} |
1308 | $_[0]{rbuf} |
… | |
… | |
1284 | |
1325 | |
1285 | If enough data was available, then the callback must remove all data it is |
1326 | If enough data was available, then the callback must remove all data it is |
1286 | interested in (which can be none at all) and return a true value. After returning |
1327 | interested in (which can be none at all) and return a true value. After returning |
1287 | true, it will be removed from the queue. |
1328 | true, it will be removed from the queue. |
1288 | |
1329 | |
|
|
1330 | These methods may invoke callbacks (and therefore the handle might be |
|
|
1331 | destroyed after it returns). |
|
|
1332 | |
1289 | =cut |
1333 | =cut |
1290 | |
1334 | |
1291 | our %RH; |
1335 | our %RH; |
1292 | |
1336 | |
1293 | sub register_read_type($$) { |
1337 | sub register_read_type($$) { |
… | |
… | |
1315 | my $cb = pop; |
1359 | my $cb = pop; |
1316 | |
1360 | |
1317 | if (@_) { |
1361 | if (@_) { |
1318 | my $type = shift; |
1362 | my $type = shift; |
1319 | |
1363 | |
|
|
1364 | $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type" |
1320 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") |
1365 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read") |
1321 | ->($self, $cb, @_); |
1366 | ->($self, $cb, @_); |
1322 | } |
1367 | } |
1323 | |
1368 | |
1324 | unshift @{ $self->{_queue} }, $cb; |
1369 | unshift @{ $self->{_queue} }, $cb; |
1325 | $self->_drain_rbuf; |
1370 | $self->_drain_rbuf; |
… | |
… | |
1433 | the receive buffer when neither C<$accept> nor C<$reject> match, |
1478 | the receive buffer when neither C<$accept> nor C<$reject> match, |
1434 | and everything preceding and including the match will be accepted |
1479 | and everything preceding and including the match will be accepted |
1435 | unconditionally. This is useful to skip large amounts of data that you |
1480 | unconditionally. This is useful to skip large amounts of data that you |
1436 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
1481 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
1437 | have to start matching from the beginning. This is purely an optimisation |
1482 | have to start matching from the beginning. This is purely an optimisation |
1438 | and is usually worth only when you expect more than a few kilobytes. |
1483 | and is usually worth it only when you expect more than a few kilobytes. |
1439 | |
1484 | |
1440 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
1485 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
1441 | expect the header to be very large (it isn't in practise, but...), we use |
1486 | expect the header to be very large (it isn't in practice, but...), we use |
1442 | a skip regex to skip initial portions. The skip regex is tricky in that |
1487 | a skip regex to skip initial portions. The skip regex is tricky in that |
1443 | it only accepts something not ending in either \015 or \012, as these are |
1488 | it only accepts something not ending in either \015 or \012, as these are |
1444 | required for the accept regex. |
1489 | required for the accept regex. |
1445 | |
1490 | |
1446 | $handle->push_read (regex => |
1491 | $handle->push_read (regex => |
… | |
… | |
1711 | } |
1756 | } |
1712 | |
1757 | |
1713 | sub start_read { |
1758 | sub start_read { |
1714 | my ($self) = @_; |
1759 | my ($self) = @_; |
1715 | |
1760 | |
1716 | unless ($self->{_rw} || $self->{_eof}) { |
1761 | unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) { |
1717 | Scalar::Util::weaken $self; |
1762 | Scalar::Util::weaken $self; |
1718 | |
1763 | |
1719 | $self->{_rw} = AE::io $self->{fh}, 0, sub { |
1764 | $self->{_rw} = AE::io $self->{fh}, 0, sub { |
1720 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1765 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1721 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1766 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf; |
1722 | |
1767 | |
1723 | if ($len > 0) { |
1768 | if ($len > 0) { |
1724 | $self->{_activity} = $self->{_ractivity} = AE::now; |
1769 | $self->{_activity} = $self->{_ractivity} = AE::now; |
1725 | |
1770 | |
1726 | if ($self->{tls}) { |
1771 | if ($self->{tls}) { |
1727 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1772 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1728 | |
1773 | |
1729 | &_dotls ($self); |
1774 | &_dotls ($self); |
1730 | } else { |
1775 | } else { |
1731 | $self->_drain_rbuf; |
1776 | $self->_drain_rbuf; |
|
|
1777 | } |
|
|
1778 | |
|
|
1779 | if ($len == $self->{read_size}) { |
|
|
1780 | $self->{read_size} *= 2; |
|
|
1781 | $self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE |
|
|
1782 | if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE); |
1732 | } |
1783 | } |
1733 | |
1784 | |
1734 | } elsif (defined $len) { |
1785 | } elsif (defined $len) { |
1735 | delete $self->{_rw}; |
1786 | delete $self->{_rw}; |
1736 | $self->{_eof} = 1; |
1787 | $self->{_eof} = 1; |
… | |
… | |
1814 | && ($tmp != $ERROR_SYSCALL || $!); |
1865 | && ($tmp != $ERROR_SYSCALL || $!); |
1815 | |
1866 | |
1816 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1867 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1817 | $self->{wbuf} .= $tmp; |
1868 | $self->{wbuf} .= $tmp; |
1818 | $self->_drain_wbuf; |
1869 | $self->_drain_wbuf; |
|
|
1870 | $self->{tls} or return; # tls session might have gone away in callback |
1819 | } |
1871 | } |
1820 | |
1872 | |
1821 | $self->{_on_starttls} |
1873 | $self->{_on_starttls} |
1822 | and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () |
1874 | and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () |
1823 | and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); |
1875 | and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); |
… | |
… | |
1845 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1897 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1846 | changed to your liking. Note that the handshake might have already started |
1898 | changed to your liking. Note that the handshake might have already started |
1847 | when this function returns. |
1899 | when this function returns. |
1848 | |
1900 | |
1849 | Due to bugs in OpenSSL, it might or might not be possible to do multiple |
1901 | Due to bugs in OpenSSL, it might or might not be possible to do multiple |
1850 | handshakes on the same stream. Best do not attempt to use the stream after |
1902 | handshakes on the same stream. It is best to not attempt to use the |
1851 | stopping TLS. |
1903 | stream after stopping TLS. |
|
|
1904 | |
|
|
1905 | This method may invoke callbacks (and therefore the handle might be |
|
|
1906 | destroyed after it returns). |
1852 | |
1907 | |
1853 | =cut |
1908 | =cut |
1854 | |
1909 | |
1855 | our %TLS_CACHE; #TODO not yet documented, should we? |
1910 | our %TLS_CACHE; #TODO not yet documented, should we? |
1856 | |
1911 | |
… | |
… | |
1922 | |
1977 | |
1923 | =item $handle->stoptls |
1978 | =item $handle->stoptls |
1924 | |
1979 | |
1925 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1980 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1926 | sending a close notify to the other side, but since OpenSSL doesn't |
1981 | sending a close notify to the other side, but since OpenSSL doesn't |
1927 | support non-blocking shut downs, it is not guarenteed that you can re-use |
1982 | support non-blocking shut downs, it is not guaranteed that you can re-use |
1928 | the stream afterwards. |
1983 | the stream afterwards. |
|
|
1984 | |
|
|
1985 | This method may invoke callbacks (and therefore the handle might be |
|
|
1986 | destroyed after it returns). |
1929 | |
1987 | |
1930 | =cut |
1988 | =cut |
1931 | |
1989 | |
1932 | sub stoptls { |
1990 | sub stoptls { |
1933 | my ($self) = @_; |
1991 | my ($self) = @_; |
1934 | |
1992 | |
1935 | if ($self->{tls}) { |
1993 | if ($self->{tls} && $self->{fh}) { |
1936 | Net::SSLeay::shutdown ($self->{tls}); |
1994 | Net::SSLeay::shutdown ($self->{tls}); |
1937 | |
1995 | |
1938 | &_dotls; |
1996 | &_dotls; |
1939 | |
1997 | |
1940 | # # we don't give a shit. no, we do, but we can't. no...#d# |
1998 | # # we don't give a shit. no, we do, but we can't. no...#d# |
… | |
… | |
1970 | push @linger, AE::io $fh, 1, sub { |
2028 | push @linger, AE::io $fh, 1, sub { |
1971 | my $len = syswrite $fh, $wbuf, length $wbuf; |
2029 | my $len = syswrite $fh, $wbuf, length $wbuf; |
1972 | |
2030 | |
1973 | if ($len > 0) { |
2031 | if ($len > 0) { |
1974 | substr $wbuf, 0, $len, ""; |
2032 | substr $wbuf, 0, $len, ""; |
1975 | } else { |
2033 | } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) { |
1976 | @linger = (); # end |
2034 | @linger = (); # end |
1977 | } |
2035 | } |
1978 | }; |
2036 | }; |
1979 | push @linger, AE::timer $linger, 0, sub { |
2037 | push @linger, AE::timer $linger, 0, sub { |
1980 | @linger = (); |
2038 | @linger = (); |
… | |
… | |
2017 | |
2075 | |
2018 | sub AnyEvent::Handle::destroyed::AUTOLOAD { |
2076 | sub AnyEvent::Handle::destroyed::AUTOLOAD { |
2019 | #nop |
2077 | #nop |
2020 | } |
2078 | } |
2021 | |
2079 | |
|
|
2080 | =item $handle->destroyed |
|
|
2081 | |
|
|
2082 | Returns false as long as the handle hasn't been destroyed by a call to C<< |
|
|
2083 | ->destroy >>, true otherwise. |
|
|
2084 | |
|
|
2085 | Can be useful to decide whether the handle is still valid after some |
|
|
2086 | callback possibly destroyed the handle. For example, C<< ->push_write >>, |
|
|
2087 | C<< ->starttls >> and other methods can call user callbacks, which in turn |
|
|
2088 | can destroy the handle, so work can be avoided by checking sometimes: |
|
|
2089 | |
|
|
2090 | $hdl->starttls ("accept"); |
|
|
2091 | return if $hdl->destroyed; |
|
|
2092 | $hdl->push_write (... |
|
|
2093 | |
|
|
2094 | Note that the call to C<push_write> will silently be ignored if the handle |
|
|
2095 | has been destroyed, so often you can just ignore the possibility of the |
|
|
2096 | handle being destroyed. |
|
|
2097 | |
|
|
2098 | =cut |
|
|
2099 | |
|
|
2100 | sub destroyed { 0 } |
|
|
2101 | sub AnyEvent::Handle::destroyed::destroyed { 1 } |
|
|
2102 | |
2022 | =item AnyEvent::Handle::TLS_CTX |
2103 | =item AnyEvent::Handle::TLS_CTX |
2023 | |
2104 | |
2024 | This function creates and returns the AnyEvent::TLS object used by default |
2105 | This function creates and returns the AnyEvent::TLS object used by default |
2025 | for TLS mode. |
2106 | for TLS mode. |
2026 | |
2107 | |
… | |
… | |
2057 | |
2138 | |
2058 | =item I get different callback invocations in TLS mode/Why can't I pause |
2139 | =item I get different callback invocations in TLS mode/Why can't I pause |
2059 | reading? |
2140 | reading? |
2060 | |
2141 | |
2061 | Unlike, say, TCP, TLS connections do not consist of two independent |
2142 | Unlike, say, TCP, TLS connections do not consist of two independent |
2062 | communication channels, one for each direction. Or put differently. The |
2143 | communication channels, one for each direction. Or put differently, the |
2063 | read and write directions are not independent of each other: you cannot |
2144 | read and write directions are not independent of each other: you cannot |
2064 | write data unless you are also prepared to read, and vice versa. |
2145 | write data unless you are also prepared to read, and vice versa. |
2065 | |
2146 | |
2066 | This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> |
2147 | This means that, in TLS mode, you might get C<on_error> or C<on_eof> |
2067 | callback invocations when you are not expecting any read data - the reason |
2148 | callback invocations when you are not expecting any read data - the reason |
2068 | is that AnyEvent::Handle always reads in TLS mode. |
2149 | is that AnyEvent::Handle always reads in TLS mode. |
2069 | |
2150 | |
2070 | During the connection, you have to make sure that you always have a |
2151 | During the connection, you have to make sure that you always have a |
2071 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
2152 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
… | |
… | |
2085 | my $data = delete $_[0]{rbuf}; |
2166 | my $data = delete $_[0]{rbuf}; |
2086 | }); |
2167 | }); |
2087 | |
2168 | |
2088 | The reason to use C<on_error> is that TCP connections, due to latencies |
2169 | The reason to use C<on_error> is that TCP connections, due to latencies |
2089 | and packets loss, might get closed quite violently with an error, when in |
2170 | and packets loss, might get closed quite violently with an error, when in |
2090 | fact, all data has been received. |
2171 | fact all data has been received. |
2091 | |
2172 | |
2092 | It is usually better to use acknowledgements when transferring data, |
2173 | It is usually better to use acknowledgements when transferring data, |
2093 | to make sure the other side hasn't just died and you got the data |
2174 | to make sure the other side hasn't just died and you got the data |
2094 | intact. This is also one reason why so many internet protocols have an |
2175 | intact. This is also one reason why so many internet protocols have an |
2095 | explicit QUIT command. |
2176 | explicit QUIT command. |
… | |
… | |
2112 | consider using C<< ->push_shutdown >> instead. |
2193 | consider using C<< ->push_shutdown >> instead. |
2113 | |
2194 | |
2114 | =item I want to contact a TLS/SSL server, I don't care about security. |
2195 | =item I want to contact a TLS/SSL server, I don't care about security. |
2115 | |
2196 | |
2116 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
2197 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
2117 | simply connect to it and then create the AnyEvent::Handle with the C<tls> |
2198 | connect to it and then create the AnyEvent::Handle with the C<tls> |
2118 | parameter: |
2199 | parameter: |
2119 | |
2200 | |
2120 | tcp_connect $host, $port, sub { |
2201 | tcp_connect $host, $port, sub { |
2121 | my ($fh) = @_; |
2202 | my ($fh) = @_; |
2122 | |
2203 | |
… | |
… | |
2222 | |
2303 | |
2223 | =item * all members not documented here and not prefixed with an underscore |
2304 | =item * all members not documented here and not prefixed with an underscore |
2224 | are free to use in subclasses. |
2305 | are free to use in subclasses. |
2225 | |
2306 | |
2226 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
2307 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
2227 | member variables, but thats just life, at least it is documented. |
2308 | member variables, but that's just life. At least it is documented. |
2228 | |
2309 | |
2229 | =back |
2310 | =back |
2230 | |
2311 | |
2231 | =head1 AUTHOR |
2312 | =head1 AUTHOR |
2232 | |
2313 | |