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; |
… | |
… | |
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::Handle fh => $filehandle, key => value... |
86 | =item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value... |
… | |
… | |
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 |
416 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
428 | parameter is missing (or C<undef>), then AnyEvent::Handle will use |
|
|
429 | C<AnyEvent::Handle::TLS_CTX>. |
417 | |
430 | |
418 | Instead of an object, you can also specify a hash reference with C<< key |
431 | Instead of an object, you can also specify a hash reference with C<< key |
419 | => value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a |
432 | => value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a |
420 | new TLS context object. |
433 | new TLS context object. |
421 | |
434 | |
… | |
… | |
430 | |
443 | |
431 | TLS handshake failures will not cause C<on_error> to be invoked when this |
444 | 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>. |
445 | callback is in effect, instead, the error message will be passed to C<on_starttls>. |
433 | |
446 | |
434 | Without this callback, handshake failures lead to C<on_error> being |
447 | Without this callback, handshake failures lead to C<on_error> being |
435 | called, as normal. |
448 | called as usual. |
436 | |
449 | |
437 | Note that you cannot call C<starttls> right again in this callback. If you |
450 | 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 |
451 | need to do that, start an zero-second timer instead whose callback can |
439 | then call C<< ->starttls >> again. |
452 | then call C<< ->starttls >> again. |
440 | |
453 | |
441 | =item on_stoptls => $cb->($handle) |
454 | =item on_stoptls => $cb->($handle) |
442 | |
455 | |
… | |
… | |
489 | AnyEvent::Socket::tcp_connect ( |
502 | AnyEvent::Socket::tcp_connect ( |
490 | $self->{connect}[0], |
503 | $self->{connect}[0], |
491 | $self->{connect}[1], |
504 | $self->{connect}[1], |
492 | sub { |
505 | sub { |
493 | my ($fh, $host, $port, $retry) = @_; |
506 | my ($fh, $host, $port, $retry) = @_; |
|
|
507 | |
|
|
508 | delete $self->{_connect}; # no longer needed |
494 | |
509 | |
495 | if ($fh) { |
510 | if ($fh) { |
496 | $self->{fh} = $fh; |
511 | $self->{fh} = $fh; |
497 | |
512 | |
498 | delete $self->{_skip_drain_rbuf}; |
513 | delete $self->{_skip_drain_rbuf}; |
… | |
… | |
532 | } |
547 | } |
533 | |
548 | |
534 | sub _start { |
549 | sub _start { |
535 | my ($self) = @_; |
550 | my ($self) = @_; |
536 | |
551 | |
|
|
552 | # too many clueless people try to use udp and similar sockets |
|
|
553 | # with AnyEvent::Handle, do them a favour. |
|
|
554 | my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE (); |
|
|
555 | Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!" |
|
|
556 | if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type; |
|
|
557 | |
537 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
558 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
538 | |
559 | |
539 | $self->{_activity} = |
560 | $self->{_activity} = |
540 | $self->{_ractivity} = |
561 | $self->{_ractivity} = |
541 | $self->{_wactivity} = AE::now; |
562 | $self->{_wactivity} = AE::now; |
542 | |
563 | |
|
|
564 | $self->{read_size} ||= 2048; |
|
|
565 | $self->{max_read_size} = $self->{read_size} |
|
|
566 | if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE); |
|
|
567 | |
543 | $self->timeout (delete $self->{timeout} ) if $self->{timeout}; |
568 | $self->timeout (delete $self->{timeout} ) if $self->{timeout}; |
544 | $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout}; |
569 | $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout}; |
545 | $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout}; |
570 | $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout}; |
546 | |
571 | |
547 | $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay}; |
572 | $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); |
575 | $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1); |
551 | |
576 | |
552 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
577 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
553 | if $self->{tls}; |
578 | if $self->{tls}; |
554 | |
579 | |
555 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
580 | $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain}; |
556 | |
581 | |
557 | $self->start_read |
582 | $self->start_read |
558 | if $self->{on_read} || @{ $self->{_queue} }; |
583 | if $self->{on_read} || @{ $self->{_queue} }; |
559 | |
584 | |
560 | $self->_drain_wbuf; |
585 | $self->_drain_wbuf; |
… | |
… | |
636 | =cut |
661 | =cut |
637 | |
662 | |
638 | sub no_delay { |
663 | sub no_delay { |
639 | $_[0]{no_delay} = $_[1]; |
664 | $_[0]{no_delay} = $_[1]; |
640 | |
665 | |
641 | eval { |
|
|
642 | local $SIG{__DIE__}; |
|
|
643 | setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1] |
666 | setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1] |
644 | if $_[0]{fh}; |
667 | if $_[0]{fh}; |
645 | }; |
|
|
646 | } |
668 | } |
647 | |
669 | |
648 | =item $handle->keepalive ($boolean) |
670 | =item $handle->keepalive ($boolean) |
649 | |
671 | |
650 | Enables or disables the C<keepalive> setting (see constructor argument of |
672 | Enables or disables the C<keepalive> setting (see constructor argument of |
… | |
… | |
759 | $_[0]{$on_timeout} = $_[1]; |
781 | $_[0]{$on_timeout} = $_[1]; |
760 | }; |
782 | }; |
761 | |
783 | |
762 | *$timeout = sub { |
784 | *$timeout = sub { |
763 | my ($self, $new_value) = @_; |
785 | my ($self, $new_value) = @_; |
|
|
786 | |
|
|
787 | $new_value >= 0 |
|
|
788 | or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught"; |
764 | |
789 | |
765 | $self->{$timeout} = $new_value; |
790 | $self->{$timeout} = $new_value; |
766 | delete $self->{$tw}; &$cb; |
791 | delete $self->{$tw}; &$cb; |
767 | }; |
792 | }; |
768 | |
793 | |
… | |
… | |
927 | |
952 | |
928 | Instead of formatting your data yourself, you can also let this module |
953 | Instead of formatting your data yourself, you can also let this module |
929 | do the job by specifying a type and type-specific arguments. You |
954 | do the job by specifying a type and type-specific arguments. You |
930 | can also specify the (fully qualified) name of a package, in which |
955 | can also specify the (fully qualified) name of a package, in which |
931 | case AnyEvent tries to load the package and then expects to find the |
956 | case AnyEvent tries to load the package and then expects to find the |
932 | C<anyevent_read_type> function inside (see "custom write types", below). |
957 | C<anyevent_write_type> function inside (see "custom write types", below). |
933 | |
958 | |
934 | Predefined types are (if you have ideas for additional types, feel free to |
959 | Predefined types are (if you have ideas for additional types, feel free to |
935 | drop by and tell us): |
960 | drop by and tell us): |
936 | |
961 | |
937 | =over 4 |
962 | =over 4 |
… | |
… | |
1101 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
1126 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
1102 | a queue. |
1127 | a queue. |
1103 | |
1128 | |
1104 | In the simple case, you just install an C<on_read> callback and whenever |
1129 | In the simple case, you just install an C<on_read> callback and whenever |
1105 | new data arrives, it will be called. You can then remove some data (if |
1130 | new data arrives, it will be called. You can then remove some data (if |
1106 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
1131 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can |
1107 | leave the data there if you want to accumulate more (e.g. when only a |
1132 | leave the data there if you want to accumulate more (e.g. when only a |
1108 | partial message has been received so far). |
1133 | partial message has been received so far), or change the read queue with |
|
|
1134 | e.g. C<push_read>. |
1109 | |
1135 | |
1110 | In the more complex case, you want to queue multiple callbacks. In this |
1136 | In the more complex case, you want to queue multiple callbacks. In this |
1111 | case, AnyEvent::Handle will call the first queued callback each time new |
1137 | case, AnyEvent::Handle will call the first queued callback each time new |
1112 | data arrives (also the first time it is queued) and removes it when it has |
1138 | data arrives (also the first time it is queued) and remove it when it has |
1113 | done its job (see C<push_read>, below). |
1139 | done its job (see C<push_read>, below). |
1114 | |
1140 | |
1115 | This way you can, for example, push three line-reads, followed by reading |
1141 | This way you can, for example, push three line-reads, followed by reading |
1116 | a chunk of data, and AnyEvent::Handle will execute them in order. |
1142 | a chunk of data, and AnyEvent::Handle will execute them in order. |
1117 | |
1143 | |
… | |
… | |
1262 | $self->_drain_rbuf if $cb; |
1288 | $self->_drain_rbuf if $cb; |
1263 | } |
1289 | } |
1264 | |
1290 | |
1265 | =item $handle->rbuf |
1291 | =item $handle->rbuf |
1266 | |
1292 | |
1267 | Returns the read buffer (as a modifiable lvalue). |
1293 | Returns the read buffer (as a modifiable lvalue). You can also access the |
|
|
1294 | read buffer directly as the C<< ->{rbuf} >> member, if you want (this is |
|
|
1295 | much faster, and no less clean). |
1268 | |
1296 | |
1269 | You can access the read buffer directly as the C<< ->{rbuf} >> |
1297 | The only operation allowed on the read buffer (apart from looking at it) |
1270 | member, if you want. However, the only operation allowed on the |
1298 | is removing data from its beginning. Otherwise modifying or appending to |
1271 | read buffer (apart from looking at it) is removing data from its |
1299 | it is not allowed and will lead to hard-to-track-down bugs. |
1272 | beginning. Otherwise modifying or appending to it is not allowed and will |
|
|
1273 | lead to hard-to-track-down bugs. |
|
|
1274 | |
1300 | |
1275 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
1301 | NOTE: The read buffer should only be used or modified in the C<on_read> |
1276 | C<push_read> or C<unshift_read> methods are used. The other read methods |
1302 | callback or when C<push_read> or C<unshift_read> are used with a single |
1277 | automatically manage the read buffer. |
1303 | callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods |
|
|
1304 | will manage the read buffer on their own. |
1278 | |
1305 | |
1279 | =cut |
1306 | =cut |
1280 | |
1307 | |
1281 | sub rbuf : lvalue { |
1308 | sub rbuf : lvalue { |
1282 | $_[0]{rbuf} |
1309 | $_[0]{rbuf} |
… | |
… | |
1333 | my $cb = pop; |
1360 | my $cb = pop; |
1334 | |
1361 | |
1335 | if (@_) { |
1362 | if (@_) { |
1336 | my $type = shift; |
1363 | my $type = shift; |
1337 | |
1364 | |
|
|
1365 | $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type" |
1338 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") |
1366 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read") |
1339 | ->($self, $cb, @_); |
1367 | ->($self, $cb, @_); |
1340 | } |
1368 | } |
1341 | |
1369 | |
1342 | unshift @{ $self->{_queue} }, $cb; |
1370 | unshift @{ $self->{_queue} }, $cb; |
1343 | $self->_drain_rbuf; |
1371 | $self->_drain_rbuf; |
… | |
… | |
1451 | the receive buffer when neither C<$accept> nor C<$reject> match, |
1479 | the receive buffer when neither C<$accept> nor C<$reject> match, |
1452 | and everything preceding and including the match will be accepted |
1480 | and everything preceding and including the match will be accepted |
1453 | unconditionally. This is useful to skip large amounts of data that you |
1481 | unconditionally. This is useful to skip large amounts of data that you |
1454 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
1482 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
1455 | have to start matching from the beginning. This is purely an optimisation |
1483 | have to start matching from the beginning. This is purely an optimisation |
1456 | and is usually worth only when you expect more than a few kilobytes. |
1484 | and is usually worth it only when you expect more than a few kilobytes. |
1457 | |
1485 | |
1458 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
1486 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
1459 | expect the header to be very large (it isn't in practise, but...), we use |
1487 | expect the header to be very large (it isn't in practice, but...), we use |
1460 | a skip regex to skip initial portions. The skip regex is tricky in that |
1488 | a skip regex to skip initial portions. The skip regex is tricky in that |
1461 | it only accepts something not ending in either \015 or \012, as these are |
1489 | it only accepts something not ending in either \015 or \012, as these are |
1462 | required for the accept regex. |
1490 | required for the accept regex. |
1463 | |
1491 | |
1464 | $handle->push_read (regex => |
1492 | $handle->push_read (regex => |
… | |
… | |
1734 | unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) { |
1762 | unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) { |
1735 | Scalar::Util::weaken $self; |
1763 | Scalar::Util::weaken $self; |
1736 | |
1764 | |
1737 | $self->{_rw} = AE::io $self->{fh}, 0, sub { |
1765 | $self->{_rw} = AE::io $self->{fh}, 0, sub { |
1738 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1766 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1739 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1767 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf; |
1740 | |
1768 | |
1741 | if ($len > 0) { |
1769 | if ($len > 0) { |
1742 | $self->{_activity} = $self->{_ractivity} = AE::now; |
1770 | $self->{_activity} = $self->{_ractivity} = AE::now; |
1743 | |
1771 | |
1744 | if ($self->{tls}) { |
1772 | if ($self->{tls}) { |
1745 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1773 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1746 | |
1774 | |
1747 | &_dotls ($self); |
1775 | &_dotls ($self); |
1748 | } else { |
1776 | } else { |
1749 | $self->_drain_rbuf; |
1777 | $self->_drain_rbuf; |
|
|
1778 | } |
|
|
1779 | |
|
|
1780 | if ($len == $self->{read_size}) { |
|
|
1781 | $self->{read_size} *= 2; |
|
|
1782 | $self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE |
|
|
1783 | if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE); |
1750 | } |
1784 | } |
1751 | |
1785 | |
1752 | } elsif (defined $len) { |
1786 | } elsif (defined $len) { |
1753 | delete $self->{_rw}; |
1787 | delete $self->{_rw}; |
1754 | $self->{_eof} = 1; |
1788 | $self->{_eof} = 1; |
… | |
… | |
1864 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1898 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1865 | changed to your liking. Note that the handshake might have already started |
1899 | changed to your liking. Note that the handshake might have already started |
1866 | when this function returns. |
1900 | when this function returns. |
1867 | |
1901 | |
1868 | Due to bugs in OpenSSL, it might or might not be possible to do multiple |
1902 | Due to bugs in OpenSSL, it might or might not be possible to do multiple |
1869 | handshakes on the same stream. Best do not attempt to use the stream after |
1903 | handshakes on the same stream. It is best to not attempt to use the |
1870 | stopping TLS. |
1904 | stream after stopping TLS. |
1871 | |
1905 | |
1872 | This method may invoke callbacks (and therefore the handle might be |
1906 | This method may invoke callbacks (and therefore the handle might be |
1873 | destroyed after it returns). |
1907 | destroyed after it returns). |
1874 | |
1908 | |
1875 | =cut |
1909 | =cut |
… | |
… | |
1995 | push @linger, AE::io $fh, 1, sub { |
2029 | push @linger, AE::io $fh, 1, sub { |
1996 | my $len = syswrite $fh, $wbuf, length $wbuf; |
2030 | my $len = syswrite $fh, $wbuf, length $wbuf; |
1997 | |
2031 | |
1998 | if ($len > 0) { |
2032 | if ($len > 0) { |
1999 | substr $wbuf, 0, $len, ""; |
2033 | substr $wbuf, 0, $len, ""; |
2000 | } else { |
2034 | } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) { |
2001 | @linger = (); # end |
2035 | @linger = (); # end |
2002 | } |
2036 | } |
2003 | }; |
2037 | }; |
2004 | push @linger, AE::timer $linger, 0, sub { |
2038 | push @linger, AE::timer $linger, 0, sub { |
2005 | @linger = (); |
2039 | @linger = (); |
… | |
… | |
2105 | |
2139 | |
2106 | =item I get different callback invocations in TLS mode/Why can't I pause |
2140 | =item I get different callback invocations in TLS mode/Why can't I pause |
2107 | reading? |
2141 | reading? |
2108 | |
2142 | |
2109 | Unlike, say, TCP, TLS connections do not consist of two independent |
2143 | Unlike, say, TCP, TLS connections do not consist of two independent |
2110 | communication channels, one for each direction. Or put differently. The |
2144 | communication channels, one for each direction. Or put differently, the |
2111 | read and write directions are not independent of each other: you cannot |
2145 | read and write directions are not independent of each other: you cannot |
2112 | write data unless you are also prepared to read, and vice versa. |
2146 | write data unless you are also prepared to read, and vice versa. |
2113 | |
2147 | |
2114 | This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> |
2148 | This means that, in TLS mode, you might get C<on_error> or C<on_eof> |
2115 | callback invocations when you are not expecting any read data - the reason |
2149 | callback invocations when you are not expecting any read data - the reason |
2116 | is that AnyEvent::Handle always reads in TLS mode. |
2150 | is that AnyEvent::Handle always reads in TLS mode. |
2117 | |
2151 | |
2118 | During the connection, you have to make sure that you always have a |
2152 | During the connection, you have to make sure that you always have a |
2119 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
2153 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
… | |
… | |
2133 | my $data = delete $_[0]{rbuf}; |
2167 | my $data = delete $_[0]{rbuf}; |
2134 | }); |
2168 | }); |
2135 | |
2169 | |
2136 | The reason to use C<on_error> is that TCP connections, due to latencies |
2170 | The reason to use C<on_error> is that TCP connections, due to latencies |
2137 | and packets loss, might get closed quite violently with an error, when in |
2171 | and packets loss, might get closed quite violently with an error, when in |
2138 | fact, all data has been received. |
2172 | fact all data has been received. |
2139 | |
2173 | |
2140 | It is usually better to use acknowledgements when transferring data, |
2174 | It is usually better to use acknowledgements when transferring data, |
2141 | to make sure the other side hasn't just died and you got the data |
2175 | to make sure the other side hasn't just died and you got the data |
2142 | intact. This is also one reason why so many internet protocols have an |
2176 | intact. This is also one reason why so many internet protocols have an |
2143 | explicit QUIT command. |
2177 | explicit QUIT command. |
… | |
… | |
2160 | consider using C<< ->push_shutdown >> instead. |
2194 | consider using C<< ->push_shutdown >> instead. |
2161 | |
2195 | |
2162 | =item I want to contact a TLS/SSL server, I don't care about security. |
2196 | =item I want to contact a TLS/SSL server, I don't care about security. |
2163 | |
2197 | |
2164 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
2198 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
2165 | simply connect to it and then create the AnyEvent::Handle with the C<tls> |
2199 | connect to it and then create the AnyEvent::Handle with the C<tls> |
2166 | parameter: |
2200 | parameter: |
2167 | |
2201 | |
2168 | tcp_connect $host, $port, sub { |
2202 | tcp_connect $host, $port, sub { |
2169 | my ($fh) = @_; |
2203 | my ($fh) = @_; |
2170 | |
2204 | |
… | |
… | |
2270 | |
2304 | |
2271 | =item * all members not documented here and not prefixed with an underscore |
2305 | =item * all members not documented here and not prefixed with an underscore |
2272 | are free to use in subclasses. |
2306 | are free to use in subclasses. |
2273 | |
2307 | |
2274 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
2308 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
2275 | member variables, but thats just life, at least it is documented. |
2309 | member variables, but that's just life. At least it is documented. |
2276 | |
2310 | |
2277 | =back |
2311 | =back |
2278 | |
2312 | |
2279 | =head1 AUTHOR |
2313 | =head1 AUTHOR |
2280 | |
2314 | |