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 | |
… | |
… | |
79 | |
79 | |
80 | =head1 METHODS |
80 | =head1 METHODS |
81 | |
81 | |
82 | =over 4 |
82 | =over 4 |
83 | |
83 | |
84 | =item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value... |
84 | =item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value... |
85 | |
85 | |
86 | The constructor supports these arguments (all as C<< key => value >> pairs). |
86 | The constructor supports these arguments (all as C<< key => value >> pairs). |
87 | |
87 | |
88 | =over 4 |
88 | =over 4 |
89 | |
89 | |
… | |
… | |
118 | prepare the file handle with parameters required for the actual connect |
118 | 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 |
119 | (as opposed to settings that can be changed when the connection is already |
120 | established). |
120 | established). |
121 | |
121 | |
122 | The return value of this callback should be the connect timeout value in |
122 | 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 |
123 | seconds (or C<0>, or C<undef>, or the empty list, to indicate that the |
124 | timeout is to be used). |
124 | default timeout is to be used). |
125 | |
125 | |
126 | =item on_connect => $cb->($handle, $host, $port, $retry->()) |
126 | =item on_connect => $cb->($handle, $host, $port, $retry->()) |
127 | |
127 | |
128 | This callback is called when a connection has been successfully established. |
128 | This callback is called when a connection has been successfully established. |
129 | |
129 | |
130 | The actual numeric host and port (the socket peername) are passed as |
130 | The peer's numeric host and port (the socket peername) are passed as |
131 | parameters, together with a retry callback. |
131 | parameters, together with a retry callback. |
132 | |
132 | |
133 | When, for some reason, the handle is not acceptable, then calling |
133 | 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 |
134 | will continue with the next connection target (in case of multi-homed |
135 | multi-homed hosts or SRV records there can be multiple connection |
135 | 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 |
136 | 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 |
137 | similar properties of the handle will have been reset. |
138 | reset. |
|
|
139 | |
138 | |
140 | In most cases, ignoring the C<$retry> parameter is the way to go. |
139 | In most cases, you should ignore the C<$retry> parameter. |
141 | |
140 | |
142 | =item on_connect_error => $cb->($handle, $message) |
141 | =item on_connect_error => $cb->($handle, $message) |
143 | |
142 | |
144 | This callback is called when the connection could not be |
143 | This callback is called when the connection could not be |
145 | established. C<$!> will contain the relevant error code, and C<$message> a |
144 | established. C<$!> will contain the relevant error code, and C<$message> a |
… | |
… | |
152 | |
151 | |
153 | =item on_error => $cb->($handle, $fatal, $message) |
152 | =item on_error => $cb->($handle, $fatal, $message) |
154 | |
153 | |
155 | This is the error callback, which is called when, well, some error |
154 | 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 |
155 | occured, such as not being able to resolve the hostname, failure to |
157 | connect or a read error. |
156 | connect, or a read error. |
158 | |
157 | |
159 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
158 | 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<< -> |
159 | 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 |
160 | 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 |
161 | 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 |
162 | with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In |
164 | cases where the other side can close the connection at their will it is |
163 | 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. |
164 | often easiest to not report C<EPIPE> errors in this callback. |
166 | |
165 | |
167 | AnyEvent::Handle tries to find an appropriate error code for you to check |
166 | 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 |
167 | 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 |
168 | recommended to always output the C<$message> argument in human-readable |
170 | error messages (it's usually the same as C<"$!">). |
169 | error messages (it's usually the same as C<"$!">). |
171 | |
170 | |
172 | Non-fatal errors can be retried by simply returning, but it is recommended |
171 | Non-fatal errors can be retried by returning, but it is recommended |
173 | to simply ignore this parameter and instead abondon the handle object |
172 | to simply ignore this parameter and instead abondon the handle object |
174 | when this callback is invoked. Examples of non-fatal errors are timeouts |
173 | when this callback is invoked. Examples of non-fatal errors are timeouts |
175 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
174 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
176 | |
175 | |
177 | On callback entrance, the value of C<$!> contains the operating system |
176 | 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 |
177 | system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or |
179 | C<EPROTO>). |
178 | C<EPROTO>). |
180 | |
179 | |
181 | While not mandatory, it is I<highly> recommended to set this callback, as |
180 | 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 |
181 | you will not be notified of errors otherwise. The default just calls |
183 | C<croak>. |
182 | C<croak>. |
184 | |
183 | |
185 | =item on_read => $cb->($handle) |
184 | =item on_read => $cb->($handle) |
186 | |
185 | |
187 | This sets the default read callback, which is called when data arrives |
186 | 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 >> |
191 | 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 |
192 | 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 |
193 | must not enlarge or modify the read buffer, you can only remove data at |
195 | the beginning from it. |
194 | the beginning from it. |
196 | |
195 | |
|
|
196 | You can also call C<< ->push_read (...) >> or any other function that |
|
|
197 | modifies the read queue. Or do both. Or ... |
|
|
198 | |
197 | When an EOF condition is detected then AnyEvent::Handle will first try to |
199 | 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 |
200 | 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 |
201 | 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>). |
202 | error will be raised (with C<$!> set to C<EPIPE>). |
201 | |
203 | |
202 | Note that, unlike requests in the read queue, an C<on_read> callback |
204 | 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>. |
223 | set, then a fatal error will be raised with C<$!> set to <0>. |
222 | |
224 | |
223 | =item on_drain => $cb->($handle) |
225 | =item on_drain => $cb->($handle) |
224 | |
226 | |
225 | This sets the callback that is called when the write buffer becomes empty |
227 | 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). |
228 | (or immediately if the buffer is empty already). |
227 | |
229 | |
228 | To append to the write buffer, use the C<< ->push_write >> method. |
230 | To append to the write buffer, use the C<< ->push_write >> method. |
229 | |
231 | |
230 | This callback is useful when you don't want to put all of your write data |
232 | 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 |
233 | 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 |
245 | 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 |
246 | 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> |
247 | will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT> |
246 | error will be raised). |
248 | error will be raised). |
247 | |
249 | |
248 | There are three variants of the timeouts that work fully independent |
250 | There are three variants of the timeouts that work independently |
249 | of each other, for both read and write, just read, and just write: |
251 | of each other, for both read and write, just read, and just write: |
250 | C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks |
252 | C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks |
251 | C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions |
253 | C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions |
252 | C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. |
254 | C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. |
253 | |
255 | |
254 | Note that timeout processing is also active when you currently do not have |
256 | 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 |
257 | 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 |
258 | 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 |
259 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
258 | restart the timeout. |
260 | restart the timeout. |
259 | |
261 | |
260 | Zero (the default) disables this timeout. |
262 | Zero (the default) disables this timeout. |
261 | |
263 | |
… | |
… | |
277 | amount of data without a callback ever being called as long as the line |
279 | amount of data without a callback ever being called as long as the line |
278 | isn't finished). |
280 | isn't finished). |
279 | |
281 | |
280 | =item autocork => <boolean> |
282 | =item autocork => <boolean> |
281 | |
283 | |
282 | When disabled (the default), then C<push_write> will try to immediately |
284 | 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 |
285 | 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 |
286 | 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 |
287 | be inefficient if you write multiple small chunks (on the wire, this |
286 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
288 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
287 | C<no_delay>, but this option can save costly syscalls). |
289 | C<no_delay>, but this option can save costly syscalls). |
288 | |
290 | |
289 | When enabled, then writes will always be queued till the next event loop |
291 | 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, |
292 | 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 |
293 | 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. |
294 | the write buffer often is full). It also increases write latency. |
293 | |
295 | |
294 | =item no_delay => <boolean> |
296 | =item no_delay => <boolean> |
… | |
… | |
298 | the Nagle algorithm, and usually it is beneficial. |
300 | the Nagle algorithm, and usually it is beneficial. |
299 | |
301 | |
300 | In some situations you want as low a delay as possible, which can be |
302 | In some situations you want as low a delay as possible, which can be |
301 | accomplishd by setting this option to a true value. |
303 | accomplishd by setting this option to a true value. |
302 | |
304 | |
303 | The default is your opertaing system's default behaviour (most likely |
305 | The default is your operating system's default behaviour (most likely |
304 | enabled), this option explicitly enables or disables it, if possible. |
306 | enabled). This option explicitly enables or disables it, if possible. |
305 | |
307 | |
306 | =item keepalive => <boolean> |
308 | =item keepalive => <boolean> |
307 | |
309 | |
308 | Enables (default disable) the SO_KEEPALIVE option on the stream socket: |
310 | Enables (default disable) the SO_KEEPALIVE option on the stream socket: |
309 | normally, TCP connections have no time-out once established, so TCP |
311 | normally, TCP connections have no time-out once established, so TCP |
310 | connections, once established, can stay alive forever even when the other |
312 | 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 |
313 | 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 |
314 | TCP connections when the other side becomes unreachable. While the default |
313 | is OS-dependent, TCP keepalives usually kick in after around two hours, |
315 | 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 |
316 | and, if the other side doesn't reply, take down the TCP connection some 10 |
315 | to 15 minutes later. |
317 | to 15 minutes later. |
316 | |
318 | |
317 | It is harmless to specify this option for file handles that do not support |
319 | 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 |
337 | already have occured on BSD systems), but at least it will protect you |
336 | from most attacks. |
338 | from most attacks. |
337 | |
339 | |
338 | =item read_size => <bytes> |
340 | =item read_size => <bytes> |
339 | |
341 | |
340 | The default read block size (the amount of bytes this module will |
342 | The default read block size (the number of bytes this module will |
341 | try to read during each loop iteration, which affects memory |
343 | try to read during each loop iteration, which affects memory |
342 | requirements). Default: C<8192>. |
344 | requirements). Default: C<8192>. |
343 | |
345 | |
344 | =item low_water_mark => <bytes> |
346 | =item low_water_mark => <bytes> |
345 | |
347 | |
346 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
348 | 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 |
349 | buffer: If the buffer reaches this size or gets even samller it is |
348 | considered empty. |
350 | considered empty. |
349 | |
351 | |
350 | Sometimes it can be beneficial (for performance reasons) to add data to |
352 | 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 |
353 | 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 |
354 | the operating system kernel usually buffers data as well, so the default |
353 | is good in almost all cases. |
355 | is good in almost all cases. |
354 | |
356 | |
355 | =item linger => <seconds> |
357 | =item linger => <seconds> |
356 | |
358 | |
357 | If non-zero (default: C<3600>), then the destructor of the |
359 | If this is non-zero (default: C<3600>), the destructor of the |
358 | AnyEvent::Handle object will check whether there is still outstanding |
360 | 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 |
361 | 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 |
362 | socket. No errors will be reported (this mostly matches how the operating |
361 | system treats outstanding data at socket close time). |
363 | system treats outstanding data at socket close time). |
362 | |
364 | |
… | |
… | |
369 | A string used to identify the remote site - usually the DNS hostname |
371 | 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. |
372 | (I<not> IDN!) used to create the connection, rarely the IP address. |
371 | |
373 | |
372 | Apart from being useful in error messages, this string is also used in TLS |
374 | 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 |
375 | peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This |
374 | verification will be skipped when C<peername> is not specified or |
376 | verification will be skipped when C<peername> is not specified or is |
375 | C<undef>. |
377 | C<undef>. |
376 | |
378 | |
377 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
379 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
378 | |
380 | |
379 | When this parameter is given, it enables TLS (SSL) mode, that means |
381 | When this parameter is given, it enables TLS (SSL) mode, that means |
… | |
… | |
405 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
407 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
406 | passing in the wrong integer will lead to certain crash. This most often |
408 | 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 |
409 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
408 | segmentation fault. |
410 | segmentation fault. |
409 | |
411 | |
410 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
412 | Use the C<< ->starttls >> method if you need to start TLS negotiation later. |
411 | |
413 | |
412 | =item tls_ctx => $anyevent_tls |
414 | =item tls_ctx => $anyevent_tls |
413 | |
415 | |
414 | Use the given C<AnyEvent::TLS> object to create the new TLS connection |
416 | 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 |
417 | (unless a connection object was specified directly). If this parameter is |
… | |
… | |
430 | |
432 | |
431 | TLS handshake failures will not cause C<on_error> to be invoked when this |
433 | 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>. |
434 | callback is in effect, instead, the error message will be passed to C<on_starttls>. |
433 | |
435 | |
434 | Without this callback, handshake failures lead to C<on_error> being |
436 | Without this callback, handshake failures lead to C<on_error> being |
435 | called, as normal. |
437 | called as usual. |
436 | |
438 | |
437 | Note that you cannot call C<starttls> right again in this callback. If you |
439 | 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 |
440 | need to do that, start an zero-second timer instead whose callback can |
439 | then call C<< ->starttls >> again. |
441 | then call C<< ->starttls >> again. |
440 | |
442 | |
441 | =item on_stoptls => $cb->($handle) |
443 | =item on_stoptls => $cb->($handle) |
442 | |
444 | |
… | |
… | |
532 | } |
534 | } |
533 | |
535 | |
534 | sub _start { |
536 | sub _start { |
535 | my ($self) = @_; |
537 | my ($self) = @_; |
536 | |
538 | |
|
|
539 | # too many clueless people try to use udp and similar sockets |
|
|
540 | # with AnyEvent::Handle, do them a favour. |
|
|
541 | my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE (); |
|
|
542 | Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!" |
|
|
543 | if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type; |
|
|
544 | |
537 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
545 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
538 | |
546 | |
539 | $self->{_activity} = |
547 | $self->{_activity} = |
540 | $self->{_ractivity} = |
548 | $self->{_ractivity} = |
541 | $self->{_wactivity} = AE::now; |
549 | $self->{_wactivity} = AE::now; |
… | |
… | |
550 | $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1); |
558 | $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1); |
551 | |
559 | |
552 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
560 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
553 | if $self->{tls}; |
561 | if $self->{tls}; |
554 | |
562 | |
555 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
563 | $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain}; |
556 | |
564 | |
557 | $self->start_read |
565 | $self->start_read |
558 | if $self->{on_read} || @{ $self->{_queue} }; |
566 | if $self->{on_read} || @{ $self->{_queue} }; |
559 | |
567 | |
560 | $self->_drain_wbuf; |
568 | $self->_drain_wbuf; |
… | |
… | |
636 | =cut |
644 | =cut |
637 | |
645 | |
638 | sub no_delay { |
646 | sub no_delay { |
639 | $_[0]{no_delay} = $_[1]; |
647 | $_[0]{no_delay} = $_[1]; |
640 | |
648 | |
641 | eval { |
|
|
642 | local $SIG{__DIE__}; |
|
|
643 | setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1] |
649 | setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1] |
644 | if $_[0]{fh}; |
650 | if $_[0]{fh}; |
645 | }; |
|
|
646 | } |
651 | } |
647 | |
652 | |
648 | =item $handle->keepalive ($boolean) |
653 | =item $handle->keepalive ($boolean) |
649 | |
654 | |
650 | Enables or disables the C<keepalive> setting (see constructor argument of |
655 | Enables or disables the C<keepalive> setting (see constructor argument of |
… | |
… | |
832 | =item $handle->on_drain ($cb) |
837 | =item $handle->on_drain ($cb) |
833 | |
838 | |
834 | Sets the C<on_drain> callback or clears it (see the description of |
839 | Sets the C<on_drain> callback or clears it (see the description of |
835 | C<on_drain> in the constructor). |
840 | C<on_drain> in the constructor). |
836 | |
841 | |
|
|
842 | This method may invoke callbacks (and therefore the handle might be |
|
|
843 | destroyed after it returns). |
|
|
844 | |
837 | =cut |
845 | =cut |
838 | |
846 | |
839 | sub on_drain { |
847 | sub on_drain { |
840 | my ($self, $cb) = @_; |
848 | my ($self, $cb) = @_; |
841 | |
849 | |
… | |
… | |
848 | =item $handle->push_write ($data) |
856 | =item $handle->push_write ($data) |
849 | |
857 | |
850 | Queues the given scalar to be written. You can push as much data as you |
858 | 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> |
859 | want (only limited by the available memory), as C<AnyEvent::Handle> |
852 | buffers it independently of the kernel. |
860 | buffers it independently of the kernel. |
|
|
861 | |
|
|
862 | This method may invoke callbacks (and therefore the handle might be |
|
|
863 | destroyed after it returns). |
853 | |
864 | |
854 | =cut |
865 | =cut |
855 | |
866 | |
856 | sub _drain_wbuf { |
867 | sub _drain_wbuf { |
857 | my ($self) = @_; |
868 | my ($self) = @_; |
… | |
… | |
903 | @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type" |
914 | @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type" |
904 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write") |
915 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write") |
905 | ->($self, @_); |
916 | ->($self, @_); |
906 | } |
917 | } |
907 | |
918 | |
|
|
919 | # we downgrade here to avoid hard-to-track-down bugs, |
|
|
920 | # and diagnose the problem earlier and better. |
|
|
921 | |
908 | if ($self->{tls}) { |
922 | if ($self->{tls}) { |
909 | $self->{_tls_wbuf} .= $_[0]; |
923 | utf8::downgrade $self->{_tls_wbuf} .= $_[0]; |
910 | &_dotls ($self) if $self->{fh}; |
924 | &_dotls ($self) if $self->{fh}; |
911 | } else { |
925 | } else { |
912 | $self->{wbuf} .= $_[0]; |
926 | utf8::downgrade $self->{wbuf} .= $_[0]; |
913 | $self->_drain_wbuf if $self->{fh}; |
927 | $self->_drain_wbuf if $self->{fh}; |
914 | } |
928 | } |
915 | } |
929 | } |
916 | |
930 | |
917 | =item $handle->push_write (type => @args) |
931 | =item $handle->push_write (type => @args) |
918 | |
932 | |
919 | Instead of formatting your data yourself, you can also let this module |
933 | 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 |
934 | 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 |
935 | 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 |
936 | 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). |
937 | C<anyevent_write_type> function inside (see "custom write types", below). |
924 | |
938 | |
925 | Predefined types are (if you have ideas for additional types, feel free to |
939 | Predefined types are (if you have ideas for additional types, feel free to |
926 | drop by and tell us): |
940 | drop by and tell us): |
927 | |
941 | |
928 | =over 4 |
942 | =over 4 |
… | |
… | |
1031 | the peer. |
1045 | the peer. |
1032 | |
1046 | |
1033 | You can rely on the normal read queue and C<on_eof> handling |
1047 | You can rely on the normal read queue and C<on_eof> handling |
1034 | afterwards. This is the cleanest way to close a connection. |
1048 | afterwards. This is the cleanest way to close a connection. |
1035 | |
1049 | |
|
|
1050 | This method may invoke callbacks (and therefore the handle might be |
|
|
1051 | destroyed after it returns). |
|
|
1052 | |
1036 | =cut |
1053 | =cut |
1037 | |
1054 | |
1038 | sub push_shutdown { |
1055 | sub push_shutdown { |
1039 | my ($self) = @_; |
1056 | my ($self) = @_; |
1040 | |
1057 | |
… | |
… | |
1089 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
1106 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
1090 | a queue. |
1107 | a queue. |
1091 | |
1108 | |
1092 | In the simple case, you just install an C<on_read> callback and whenever |
1109 | 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 |
1110 | 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 |
1111 | 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 |
1112 | leave the data there if you want to accumulate more (e.g. when only a |
1096 | partial message has been received so far). |
1113 | partial message has been received so far), or change the read queue with |
|
|
1114 | e.g. C<push_read>. |
1097 | |
1115 | |
1098 | In the more complex case, you want to queue multiple callbacks. In this |
1116 | 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 |
1117 | 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 |
1118 | data arrives (also the first time it is queued) and remove it when it has |
1101 | done its job (see C<push_read>, below). |
1119 | done its job (see C<push_read>, below). |
1102 | |
1120 | |
1103 | This way you can, for example, push three line-reads, followed by reading |
1121 | 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. |
1122 | a chunk of data, and AnyEvent::Handle will execute them in order. |
1105 | |
1123 | |
… | |
… | |
1236 | |
1254 | |
1237 | This replaces the currently set C<on_read> callback, or clears it (when |
1255 | 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 |
1256 | the new callback is C<undef>). See the description of C<on_read> in the |
1239 | constructor. |
1257 | constructor. |
1240 | |
1258 | |
|
|
1259 | This method may invoke callbacks (and therefore the handle might be |
|
|
1260 | destroyed after it returns). |
|
|
1261 | |
1241 | =cut |
1262 | =cut |
1242 | |
1263 | |
1243 | sub on_read { |
1264 | sub on_read { |
1244 | my ($self, $cb) = @_; |
1265 | my ($self, $cb) = @_; |
1245 | |
1266 | |
… | |
… | |
1247 | $self->_drain_rbuf if $cb; |
1268 | $self->_drain_rbuf if $cb; |
1248 | } |
1269 | } |
1249 | |
1270 | |
1250 | =item $handle->rbuf |
1271 | =item $handle->rbuf |
1251 | |
1272 | |
1252 | Returns the read buffer (as a modifiable lvalue). |
1273 | Returns the read buffer (as a modifiable lvalue). You can also access the |
|
|
1274 | read buffer directly as the C<< ->{rbuf} >> member, if you want (this is |
|
|
1275 | much faster, and no less clean). |
1253 | |
1276 | |
1254 | You can access the read buffer directly as the C<< ->{rbuf} >> |
1277 | 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 |
1278 | is removing data from its beginning. Otherwise modifying or appending to |
1256 | read buffer (apart from looking at it) is removing data from its |
1279 | 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 | |
1280 | |
1260 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
1281 | 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 |
1282 | callback or when C<push_read> or C<unshift_read> are used with a single |
1262 | automatically manage the read buffer. |
1283 | callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods |
|
|
1284 | will manage the read buffer on their own. |
1263 | |
1285 | |
1264 | =cut |
1286 | =cut |
1265 | |
1287 | |
1266 | sub rbuf : lvalue { |
1288 | sub rbuf : lvalue { |
1267 | $_[0]{rbuf} |
1289 | $_[0]{rbuf} |
… | |
… | |
1284 | |
1306 | |
1285 | If enough data was available, then the callback must remove all data it is |
1307 | 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 |
1308 | interested in (which can be none at all) and return a true value. After returning |
1287 | true, it will be removed from the queue. |
1309 | true, it will be removed from the queue. |
1288 | |
1310 | |
|
|
1311 | These methods may invoke callbacks (and therefore the handle might be |
|
|
1312 | destroyed after it returns). |
|
|
1313 | |
1289 | =cut |
1314 | =cut |
1290 | |
1315 | |
1291 | our %RH; |
1316 | our %RH; |
1292 | |
1317 | |
1293 | sub register_read_type($$) { |
1318 | sub register_read_type($$) { |
… | |
… | |
1315 | my $cb = pop; |
1340 | my $cb = pop; |
1316 | |
1341 | |
1317 | if (@_) { |
1342 | if (@_) { |
1318 | my $type = shift; |
1343 | my $type = shift; |
1319 | |
1344 | |
|
|
1345 | $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type" |
1320 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") |
1346 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read") |
1321 | ->($self, $cb, @_); |
1347 | ->($self, $cb, @_); |
1322 | } |
1348 | } |
1323 | |
1349 | |
1324 | unshift @{ $self->{_queue} }, $cb; |
1350 | unshift @{ $self->{_queue} }, $cb; |
1325 | $self->_drain_rbuf; |
1351 | $self->_drain_rbuf; |
… | |
… | |
1433 | the receive buffer when neither C<$accept> nor C<$reject> match, |
1459 | the receive buffer when neither C<$accept> nor C<$reject> match, |
1434 | and everything preceding and including the match will be accepted |
1460 | and everything preceding and including the match will be accepted |
1435 | unconditionally. This is useful to skip large amounts of data that you |
1461 | 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 |
1462 | 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 |
1463 | 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. |
1464 | and is usually worth it only when you expect more than a few kilobytes. |
1439 | |
1465 | |
1440 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
1466 | 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 |
1467 | 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 |
1468 | 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 |
1469 | it only accepts something not ending in either \015 or \012, as these are |
1444 | required for the accept regex. |
1470 | required for the accept regex. |
1445 | |
1471 | |
1446 | $handle->push_read (regex => |
1472 | $handle->push_read (regex => |
… | |
… | |
1711 | } |
1737 | } |
1712 | |
1738 | |
1713 | sub start_read { |
1739 | sub start_read { |
1714 | my ($self) = @_; |
1740 | my ($self) = @_; |
1715 | |
1741 | |
1716 | unless ($self->{_rw} || $self->{_eof}) { |
1742 | unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) { |
1717 | Scalar::Util::weaken $self; |
1743 | Scalar::Util::weaken $self; |
1718 | |
1744 | |
1719 | $self->{_rw} = AE::io $self->{fh}, 0, sub { |
1745 | $self->{_rw} = AE::io $self->{fh}, 0, sub { |
1720 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1746 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1721 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1747 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
… | |
… | |
1814 | && ($tmp != $ERROR_SYSCALL || $!); |
1840 | && ($tmp != $ERROR_SYSCALL || $!); |
1815 | |
1841 | |
1816 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1842 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1817 | $self->{wbuf} .= $tmp; |
1843 | $self->{wbuf} .= $tmp; |
1818 | $self->_drain_wbuf; |
1844 | $self->_drain_wbuf; |
|
|
1845 | $self->{tls} or return; # tls session might have gone away in callback |
1819 | } |
1846 | } |
1820 | |
1847 | |
1821 | $self->{_on_starttls} |
1848 | $self->{_on_starttls} |
1822 | and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () |
1849 | and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () |
1823 | and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); |
1850 | 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 |
1872 | 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 |
1873 | changed to your liking. Note that the handshake might have already started |
1847 | when this function returns. |
1874 | when this function returns. |
1848 | |
1875 | |
1849 | Due to bugs in OpenSSL, it might or might not be possible to do multiple |
1876 | 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 |
1877 | handshakes on the same stream. It is best to not attempt to use the |
1851 | stopping TLS. |
1878 | stream after stopping TLS. |
|
|
1879 | |
|
|
1880 | This method may invoke callbacks (and therefore the handle might be |
|
|
1881 | destroyed after it returns). |
1852 | |
1882 | |
1853 | =cut |
1883 | =cut |
1854 | |
1884 | |
1855 | our %TLS_CACHE; #TODO not yet documented, should we? |
1885 | our %TLS_CACHE; #TODO not yet documented, should we? |
1856 | |
1886 | |
… | |
… | |
1922 | |
1952 | |
1923 | =item $handle->stoptls |
1953 | =item $handle->stoptls |
1924 | |
1954 | |
1925 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1955 | 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 |
1956 | 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 |
1957 | support non-blocking shut downs, it is not guaranteed that you can re-use |
1928 | the stream afterwards. |
1958 | the stream afterwards. |
|
|
1959 | |
|
|
1960 | This method may invoke callbacks (and therefore the handle might be |
|
|
1961 | destroyed after it returns). |
1929 | |
1962 | |
1930 | =cut |
1963 | =cut |
1931 | |
1964 | |
1932 | sub stoptls { |
1965 | sub stoptls { |
1933 | my ($self) = @_; |
1966 | my ($self) = @_; |
1934 | |
1967 | |
1935 | if ($self->{tls}) { |
1968 | if ($self->{tls} && $self->{fh}) { |
1936 | Net::SSLeay::shutdown ($self->{tls}); |
1969 | Net::SSLeay::shutdown ($self->{tls}); |
1937 | |
1970 | |
1938 | &_dotls; |
1971 | &_dotls; |
1939 | |
1972 | |
1940 | # # we don't give a shit. no, we do, but we can't. no...#d# |
1973 | # # we don't give a shit. no, we do, but we can't. no...#d# |
… | |
… | |
2017 | |
2050 | |
2018 | sub AnyEvent::Handle::destroyed::AUTOLOAD { |
2051 | sub AnyEvent::Handle::destroyed::AUTOLOAD { |
2019 | #nop |
2052 | #nop |
2020 | } |
2053 | } |
2021 | |
2054 | |
|
|
2055 | =item $handle->destroyed |
|
|
2056 | |
|
|
2057 | Returns false as long as the handle hasn't been destroyed by a call to C<< |
|
|
2058 | ->destroy >>, true otherwise. |
|
|
2059 | |
|
|
2060 | Can be useful to decide whether the handle is still valid after some |
|
|
2061 | callback possibly destroyed the handle. For example, C<< ->push_write >>, |
|
|
2062 | C<< ->starttls >> and other methods can call user callbacks, which in turn |
|
|
2063 | can destroy the handle, so work can be avoided by checking sometimes: |
|
|
2064 | |
|
|
2065 | $hdl->starttls ("accept"); |
|
|
2066 | return if $hdl->destroyed; |
|
|
2067 | $hdl->push_write (... |
|
|
2068 | |
|
|
2069 | Note that the call to C<push_write> will silently be ignored if the handle |
|
|
2070 | has been destroyed, so often you can just ignore the possibility of the |
|
|
2071 | handle being destroyed. |
|
|
2072 | |
|
|
2073 | =cut |
|
|
2074 | |
|
|
2075 | sub destroyed { 0 } |
|
|
2076 | sub AnyEvent::Handle::destroyed::destroyed { 1 } |
|
|
2077 | |
2022 | =item AnyEvent::Handle::TLS_CTX |
2078 | =item AnyEvent::Handle::TLS_CTX |
2023 | |
2079 | |
2024 | This function creates and returns the AnyEvent::TLS object used by default |
2080 | This function creates and returns the AnyEvent::TLS object used by default |
2025 | for TLS mode. |
2081 | for TLS mode. |
2026 | |
2082 | |
… | |
… | |
2057 | |
2113 | |
2058 | =item I get different callback invocations in TLS mode/Why can't I pause |
2114 | =item I get different callback invocations in TLS mode/Why can't I pause |
2059 | reading? |
2115 | reading? |
2060 | |
2116 | |
2061 | Unlike, say, TCP, TLS connections do not consist of two independent |
2117 | Unlike, say, TCP, TLS connections do not consist of two independent |
2062 | communication channels, one for each direction. Or put differently. The |
2118 | communication channels, one for each direction. Or put differently, the |
2063 | read and write directions are not independent of each other: you cannot |
2119 | 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. |
2120 | write data unless you are also prepared to read, and vice versa. |
2065 | |
2121 | |
2066 | This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> |
2122 | 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 |
2123 | callback invocations when you are not expecting any read data - the reason |
2068 | is that AnyEvent::Handle always reads in TLS mode. |
2124 | is that AnyEvent::Handle always reads in TLS mode. |
2069 | |
2125 | |
2070 | During the connection, you have to make sure that you always have a |
2126 | 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 |
2127 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
… | |
… | |
2085 | my $data = delete $_[0]{rbuf}; |
2141 | my $data = delete $_[0]{rbuf}; |
2086 | }); |
2142 | }); |
2087 | |
2143 | |
2088 | The reason to use C<on_error> is that TCP connections, due to latencies |
2144 | 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 |
2145 | and packets loss, might get closed quite violently with an error, when in |
2090 | fact, all data has been received. |
2146 | fact all data has been received. |
2091 | |
2147 | |
2092 | It is usually better to use acknowledgements when transferring data, |
2148 | 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 |
2149 | 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 |
2150 | intact. This is also one reason why so many internet protocols have an |
2095 | explicit QUIT command. |
2151 | explicit QUIT command. |
… | |
… | |
2112 | consider using C<< ->push_shutdown >> instead. |
2168 | consider using C<< ->push_shutdown >> instead. |
2113 | |
2169 | |
2114 | =item I want to contact a TLS/SSL server, I don't care about security. |
2170 | =item I want to contact a TLS/SSL server, I don't care about security. |
2115 | |
2171 | |
2116 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
2172 | 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> |
2173 | connect to it and then create the AnyEvent::Handle with the C<tls> |
2118 | parameter: |
2174 | parameter: |
2119 | |
2175 | |
2120 | tcp_connect $host, $port, sub { |
2176 | tcp_connect $host, $port, sub { |
2121 | my ($fh) = @_; |
2177 | my ($fh) = @_; |
2122 | |
2178 | |
… | |
… | |
2222 | |
2278 | |
2223 | =item * all members not documented here and not prefixed with an underscore |
2279 | =item * all members not documented here and not prefixed with an underscore |
2224 | are free to use in subclasses. |
2280 | are free to use in subclasses. |
2225 | |
2281 | |
2226 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
2282 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
2227 | member variables, but thats just life, at least it is documented. |
2283 | member variables, but that's just life. At least it is documented. |
2228 | |
2284 | |
2229 | =back |
2285 | =back |
2230 | |
2286 | |
2231 | =head1 AUTHOR |
2287 | =head1 AUTHOR |
2232 | |
2288 | |