… | |
… | |
11 | |
11 | |
12 | my $hdl; $hdl = new AnyEvent::Handle |
12 | my $hdl; $hdl = new AnyEvent::Handle |
13 | fh => \*STDIN, |
13 | fh => \*STDIN, |
14 | on_error => sub { |
14 | on_error => sub { |
15 | my ($hdl, $fatal, $msg) = @_; |
15 | my ($hdl, $fatal, $msg) = @_; |
16 | warn "got error $msg\n"; |
16 | AE::log error => $msg; |
17 | $hdl->destroy; |
17 | $hdl->destroy; |
18 | $cv->send; |
18 | $cv->send; |
19 | }; |
19 | }; |
20 | |
20 | |
21 | # send some request line |
21 | # send some request line |
22 | $hdl->push_write ("getinfo\015\012"); |
22 | $hdl->push_write ("getinfo\015\012"); |
23 | |
23 | |
24 | # read the response line |
24 | # read the response line |
25 | $hdl->push_read (line => sub { |
25 | $hdl->push_read (line => sub { |
26 | my ($hdl, $line) = @_; |
26 | my ($hdl, $line) = @_; |
27 | warn "got line <$line>\n"; |
27 | say "got line <$line>"; |
28 | $cv->send; |
28 | $cv->send; |
29 | }); |
29 | }); |
30 | |
30 | |
31 | $cv->recv; |
31 | $cv->recv; |
32 | |
32 | |
… | |
… | |
128 | =item on_connect => $cb->($handle, $host, $port, $retry->()) |
128 | =item on_connect => $cb->($handle, $host, $port, $retry->()) |
129 | |
129 | |
130 | This callback is called when a connection has been successfully established. |
130 | This callback is called when a connection has been successfully established. |
131 | |
131 | |
132 | The peer's numeric host and port (the socket peername) are passed as |
132 | The peer's numeric host and port (the socket peername) are passed as |
133 | parameters, together with a retry callback. |
133 | parameters, together with a retry callback. At the time it is called the |
|
|
134 | read and write queues, EOF status, TLS status and similar properties of |
|
|
135 | the handle will have been reset. |
134 | |
136 | |
|
|
137 | It is not allowed to use the read or write queues while the handle object |
|
|
138 | is connecting. |
|
|
139 | |
135 | If, for some reason, the handle is not acceptable, calling C<$retry> |
140 | If, for some reason, the handle is not acceptable, calling C<$retry> will |
136 | will continue with the next connection target (in case of multi-homed |
141 | continue with the next connection target (in case of multi-homed hosts or |
137 | hosts or SRV records there can be multiple connection endpoints). At the |
142 | SRV records there can be multiple connection endpoints). The C<$retry> |
138 | time it is called the read and write queues, eof status, tls status and |
143 | callback can be invoked after the connect callback returns, i.e. one can |
139 | similar properties of the handle will have been reset. |
144 | start a handshake and then decide to retry with the next host if the |
|
|
145 | handshake fails. |
140 | |
146 | |
141 | In most cases, you should ignore the C<$retry> parameter. |
147 | In most cases, you should ignore the C<$retry> parameter. |
142 | |
148 | |
143 | =item on_connect_error => $cb->($handle, $message) |
149 | =item on_connect_error => $cb->($handle, $message) |
144 | |
150 | |
… | |
… | |
164 | with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In |
170 | with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In |
165 | cases where the other side can close the connection at will, it is |
171 | cases where the other side can close the connection at will, it is |
166 | often easiest to not report C<EPIPE> errors in this callback. |
172 | often easiest to not report C<EPIPE> errors in this callback. |
167 | |
173 | |
168 | AnyEvent::Handle tries to find an appropriate error code for you to check |
174 | AnyEvent::Handle tries to find an appropriate error code for you to check |
169 | against, but in some cases (TLS errors), this does not work well. It is |
175 | against, but in some cases (TLS errors), this does not work well. |
170 | recommended to always output the C<$message> argument in human-readable |
176 | |
171 | error messages (it's usually the same as C<"$!">). |
177 | If you report the error to the user, it is recommended to always output |
|
|
178 | the C<$message> argument in human-readable error messages (you don't need |
|
|
179 | to report C<"$!"> if you report C<$message>). |
|
|
180 | |
|
|
181 | If you want to react programmatically to the error, then looking at C<$!> |
|
|
182 | and comparing it against some of the documented C<Errno> values is usually |
|
|
183 | better than looking at the C<$message>. |
172 | |
184 | |
173 | Non-fatal errors can be retried by returning, but it is recommended |
185 | Non-fatal errors can be retried by returning, but it is recommended |
174 | to simply ignore this parameter and instead abondon the handle object |
186 | to simply ignore this parameter and instead abondon the handle object |
175 | when this callback is invoked. Examples of non-fatal errors are timeouts |
187 | when this callback is invoked. Examples of non-fatal errors are timeouts |
176 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
188 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
… | |
… | |
224 | If an EOF condition has been detected but no C<on_eof> callback has been |
236 | If an EOF condition has been detected but no C<on_eof> callback has been |
225 | set, then a fatal error will be raised with C<$!> set to <0>. |
237 | set, then a fatal error will be raised with C<$!> set to <0>. |
226 | |
238 | |
227 | =item on_drain => $cb->($handle) |
239 | =item on_drain => $cb->($handle) |
228 | |
240 | |
229 | This sets the callback that is called when the write buffer becomes empty |
241 | This sets the callback that is called once when the write buffer becomes |
230 | (or immediately if the buffer is empty already). |
242 | empty (and immediately when the handle object is created). |
231 | |
243 | |
232 | To append to the write buffer, use the C<< ->push_write >> method. |
244 | To append to the write buffer, use the C<< ->push_write >> method. |
233 | |
245 | |
234 | This callback is useful when you don't want to put all of your write data |
246 | This callback is useful when you don't want to put all of your write data |
235 | into the queue at once, for example, when you want to write the contents |
247 | into the queue at once, for example, when you want to write the contents |
… | |
… | |
247 | many seconds pass without a successful read or write on the underlying |
259 | many seconds pass without a successful read or write on the underlying |
248 | file handle (or a call to C<timeout_reset>), the C<on_timeout> callback |
260 | file handle (or a call to C<timeout_reset>), the C<on_timeout> callback |
249 | will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT> |
261 | will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT> |
250 | error will be raised). |
262 | error will be raised). |
251 | |
263 | |
252 | There are three variants of the timeouts that work independently |
264 | There are three variants of the timeouts that work independently of each |
253 | of each other, for both read and write, just read, and just write: |
265 | other, for both read and write (triggered when nothing was read I<OR> |
|
|
266 | written), just read (triggered when nothing was read), and just write: |
254 | C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks |
267 | C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks |
255 | C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions |
268 | C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions |
256 | C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. |
269 | C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. |
257 | |
270 | |
258 | Note that timeout processing is active even when you do not have |
271 | Note that timeout processing is active even when you do not have any |
259 | any outstanding read or write requests: If you plan to keep the connection |
272 | outstanding read or write requests: If you plan to keep the connection |
260 | idle then you should disable the timeout temporarily or ignore the timeout |
273 | idle then you should disable the timeout temporarily or ignore the |
261 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
274 | timeout in the corresponding C<on_timeout> callback, in which case |
262 | restart the timeout. |
275 | AnyEvent::Handle will simply restart the timeout. |
263 | |
276 | |
264 | Zero (the default) disables this timeout. |
277 | Zero (the default) disables the corresponding timeout. |
265 | |
278 | |
266 | =item on_timeout => $cb->($handle) |
279 | =item on_timeout => $cb->($handle) |
|
|
280 | |
|
|
281 | =item on_rtimeout => $cb->($handle) |
|
|
282 | |
|
|
283 | =item on_wtimeout => $cb->($handle) |
267 | |
284 | |
268 | Called whenever the inactivity timeout passes. If you return from this |
285 | Called whenever the inactivity timeout passes. If you return from this |
269 | callback, then the timeout will be reset as if some activity had happened, |
286 | callback, then the timeout will be reset as if some activity had happened, |
270 | so this condition is not fatal in any way. |
287 | so this condition is not fatal in any way. |
271 | |
288 | |
… | |
… | |
354 | already have occured on BSD systems), but at least it will protect you |
371 | already have occured on BSD systems), but at least it will protect you |
355 | from most attacks. |
372 | from most attacks. |
356 | |
373 | |
357 | =item read_size => <bytes> |
374 | =item read_size => <bytes> |
358 | |
375 | |
359 | The initial read block size, the number of bytes this module will try to |
376 | The initial read block size, the number of bytes this module will try |
360 | read during each loop iteration. Each handle object will consume at least |
377 | to read during each loop iteration. Each handle object will consume |
361 | this amount of memory for the read buffer as well, so when handling many |
378 | at least this amount of memory for the read buffer as well, so when |
362 | connections requirements). See also C<max_read_size>. Default: C<2048>. |
379 | handling many connections watch out for memory requirements). See also |
|
|
380 | C<max_read_size>. Default: C<2048>. |
363 | |
381 | |
364 | =item max_read_size => <bytes> |
382 | =item max_read_size => <bytes> |
365 | |
383 | |
366 | The maximum read buffer size used by the dynamic adjustment |
384 | The maximum read buffer size used by the dynamic adjustment |
367 | algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in |
385 | algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in |
… | |
… | |
411 | appropriate error message. |
429 | appropriate error message. |
412 | |
430 | |
413 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
431 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
414 | automatically when you try to create a TLS handle): this module doesn't |
432 | automatically when you try to create a TLS handle): this module doesn't |
415 | have a dependency on that module, so if your module requires it, you have |
433 | have a dependency on that module, so if your module requires it, you have |
416 | to add the dependency yourself. |
434 | to add the dependency yourself. If Net::SSLeay cannot be loaded or is too |
|
|
435 | old, you get an C<EPROTO> error. |
417 | |
436 | |
418 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
437 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
419 | C<accept>, and for the TLS client side of a connection, use C<connect> |
438 | C<accept>, and for the TLS client side of a connection, use C<connect> |
420 | mode. |
439 | mode. |
421 | |
440 | |
… | |
… | |
536 | }); |
555 | }); |
537 | |
556 | |
538 | } else { |
557 | } else { |
539 | if ($self->{on_connect_error}) { |
558 | if ($self->{on_connect_error}) { |
540 | $self->{on_connect_error}($self, "$!"); |
559 | $self->{on_connect_error}($self, "$!"); |
541 | $self->destroy; |
560 | $self->destroy if $self; |
542 | } else { |
561 | } else { |
543 | $self->_error ($!, 1); |
562 | $self->_error ($!, 1); |
544 | } |
563 | } |
545 | } |
564 | } |
546 | }, |
565 | }, |
… | |
… | |
765 | |
784 | |
766 | sub rbuf_max { |
785 | sub rbuf_max { |
767 | $_[0]{rbuf_max} = $_[1]; |
786 | $_[0]{rbuf_max} = $_[1]; |
768 | } |
787 | } |
769 | |
788 | |
770 | sub rbuf_max { |
789 | sub wbuf_max { |
771 | $_[0]{wbuf_max} = $_[1]; |
790 | $_[0]{wbuf_max} = $_[1]; |
772 | } |
791 | } |
773 | |
792 | |
774 | ############################################################################# |
793 | ############################################################################# |
775 | |
794 | |
… | |
… | |
778 | =item $handle->rtimeout ($seconds) |
797 | =item $handle->rtimeout ($seconds) |
779 | |
798 | |
780 | =item $handle->wtimeout ($seconds) |
799 | =item $handle->wtimeout ($seconds) |
781 | |
800 | |
782 | Configures (or disables) the inactivity timeout. |
801 | Configures (or disables) the inactivity timeout. |
|
|
802 | |
|
|
803 | The timeout will be checked instantly, so this method might destroy the |
|
|
804 | handle before it returns. |
783 | |
805 | |
784 | =item $handle->timeout_reset |
806 | =item $handle->timeout_reset |
785 | |
807 | |
786 | =item $handle->rtimeout_reset |
808 | =item $handle->rtimeout_reset |
787 | |
809 | |
… | |
… | |
871 | |
893 | |
872 | The write queue is very simple: you can add data to its end, and |
894 | The write queue is very simple: you can add data to its end, and |
873 | AnyEvent::Handle will automatically try to get rid of it for you. |
895 | AnyEvent::Handle will automatically try to get rid of it for you. |
874 | |
896 | |
875 | When data could be written and the write buffer is shorter then the low |
897 | When data could be written and the write buffer is shorter then the low |
876 | water mark, the C<on_drain> callback will be invoked. |
898 | water mark, the C<on_drain> callback will be invoked once. |
877 | |
899 | |
878 | =over 4 |
900 | =over 4 |
879 | |
901 | |
880 | =item $handle->on_drain ($cb) |
902 | =item $handle->on_drain ($cb) |
881 | |
903 | |
… | |
… | |
1072 | =cut |
1094 | =cut |
1073 | |
1095 | |
1074 | register_write_type storable => sub { |
1096 | register_write_type storable => sub { |
1075 | my ($self, $ref) = @_; |
1097 | my ($self, $ref) = @_; |
1076 | |
1098 | |
1077 | require Storable; |
1099 | require Storable unless $Storable::VERSION; |
1078 | |
1100 | |
1079 | pack "w/a*", Storable::nfreeze ($ref) |
1101 | pack "w/a*", Storable::nfreeze ($ref) |
1080 | }; |
1102 | }; |
1081 | |
1103 | |
1082 | =back |
1104 | =back |
… | |
… | |
1119 | |
1141 | |
1120 | Whenever the given C<type> is used, C<push_write> will the function with |
1142 | Whenever the given C<type> is used, C<push_write> will the function with |
1121 | the handle object and the remaining arguments. |
1143 | the handle object and the remaining arguments. |
1122 | |
1144 | |
1123 | The function is supposed to return a single octet string that will be |
1145 | The function is supposed to return a single octet string that will be |
1124 | appended to the write buffer, so you cna mentally treat this function as a |
1146 | appended to the write buffer, so you can mentally treat this function as a |
1125 | "arguments to on-the-wire-format" converter. |
1147 | "arguments to on-the-wire-format" converter. |
1126 | |
1148 | |
1127 | Example: implement a custom write type C<join> that joins the remaining |
1149 | Example: implement a custom write type C<join> that joins the remaining |
1128 | arguments using the first one. |
1150 | arguments using the first one. |
1129 | |
1151 | |
… | |
… | |
1423 | data. |
1445 | data. |
1424 | |
1446 | |
1425 | Example: read 2 bytes. |
1447 | Example: read 2 bytes. |
1426 | |
1448 | |
1427 | $handle->push_read (chunk => 2, sub { |
1449 | $handle->push_read (chunk => 2, sub { |
1428 | warn "yay ", unpack "H*", $_[1]; |
1450 | say "yay " . unpack "H*", $_[1]; |
1429 | }); |
1451 | }); |
1430 | |
1452 | |
1431 | =cut |
1453 | =cut |
1432 | |
1454 | |
1433 | register_read_type chunk => sub { |
1455 | register_read_type chunk => sub { |
… | |
… | |
1467 | if (@_ < 3) { |
1489 | if (@_ < 3) { |
1468 | # this is more than twice as fast as the generic code below |
1490 | # this is more than twice as fast as the generic code below |
1469 | sub { |
1491 | sub { |
1470 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
1492 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
1471 | |
1493 | |
1472 | $cb->($_[0], $1, $2); |
1494 | $cb->($_[0], "$1", "$2"); |
1473 | 1 |
1495 | 1 |
1474 | } |
1496 | } |
1475 | } else { |
1497 | } else { |
1476 | $eol = quotemeta $eol unless ref $eol; |
1498 | $eol = quotemeta $eol unless ref $eol; |
1477 | $eol = qr|^(.*?)($eol)|s; |
1499 | $eol = qr|^(.*?)($eol)|s; |
1478 | |
1500 | |
1479 | sub { |
1501 | sub { |
1480 | $_[0]{rbuf} =~ s/$eol// or return; |
1502 | $_[0]{rbuf} =~ s/$eol// or return; |
1481 | |
1503 | |
1482 | $cb->($_[0], $1, $2); |
1504 | $cb->($_[0], "$1", "$2"); |
1483 | 1 |
1505 | 1 |
1484 | } |
1506 | } |
1485 | } |
1507 | } |
1486 | }; |
1508 | }; |
1487 | |
1509 | |
… | |
… | |
1535 | |
1557 | |
1536 | sub { |
1558 | sub { |
1537 | # accept |
1559 | # accept |
1538 | if ($$rbuf =~ $accept) { |
1560 | if ($$rbuf =~ $accept) { |
1539 | $data .= substr $$rbuf, 0, $+[0], ""; |
1561 | $data .= substr $$rbuf, 0, $+[0], ""; |
1540 | $cb->($self, $data); |
1562 | $cb->($_[0], $data); |
1541 | return 1; |
1563 | return 1; |
1542 | } |
1564 | } |
1543 | |
1565 | |
1544 | # reject |
1566 | # reject |
1545 | if ($reject && $$rbuf =~ $reject) { |
1567 | if ($reject && $$rbuf =~ $reject) { |
1546 | $self->_error (Errno::EBADMSG); |
1568 | $_[0]->_error (Errno::EBADMSG); |
1547 | } |
1569 | } |
1548 | |
1570 | |
1549 | # skip |
1571 | # skip |
1550 | if ($skip && $$rbuf =~ $skip) { |
1572 | if ($skip && $$rbuf =~ $skip) { |
1551 | $data .= substr $$rbuf, 0, $+[0], ""; |
1573 | $data .= substr $$rbuf, 0, $+[0], ""; |
… | |
… | |
1567 | my ($self, $cb) = @_; |
1589 | my ($self, $cb) = @_; |
1568 | |
1590 | |
1569 | sub { |
1591 | sub { |
1570 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1592 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1571 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1593 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1572 | $self->_error (Errno::EBADMSG); |
1594 | $_[0]->_error (Errno::EBADMSG); |
1573 | } |
1595 | } |
1574 | return; |
1596 | return; |
1575 | } |
1597 | } |
1576 | |
1598 | |
1577 | my $len = $1; |
1599 | my $len = $1; |
1578 | |
1600 | |
1579 | $self->unshift_read (chunk => $len, sub { |
1601 | $_[0]->unshift_read (chunk => $len, sub { |
1580 | my $string = $_[1]; |
1602 | my $string = $_[1]; |
1581 | $_[0]->unshift_read (chunk => 1, sub { |
1603 | $_[0]->unshift_read (chunk => 1, sub { |
1582 | if ($_[1] eq ",") { |
1604 | if ($_[1] eq ",") { |
1583 | $cb->($_[0], $string); |
1605 | $cb->($_[0], $string); |
1584 | } else { |
1606 | } else { |
1585 | $self->_error (Errno::EBADMSG); |
1607 | $_[0]->_error (Errno::EBADMSG); |
1586 | } |
1608 | } |
1587 | }); |
1609 | }); |
1588 | }); |
1610 | }); |
1589 | |
1611 | |
1590 | 1 |
1612 | 1 |
… | |
… | |
1663 | |
1685 | |
1664 | my $data; |
1686 | my $data; |
1665 | my $rbuf = \$self->{rbuf}; |
1687 | my $rbuf = \$self->{rbuf}; |
1666 | |
1688 | |
1667 | sub { |
1689 | sub { |
1668 | my $ref = eval { $json->incr_parse ($self->{rbuf}) }; |
1690 | my $ref = eval { $json->incr_parse ($_[0]{rbuf}) }; |
1669 | |
1691 | |
1670 | if ($ref) { |
1692 | if ($ref) { |
1671 | $self->{rbuf} = $json->incr_text; |
1693 | $_[0]{rbuf} = $json->incr_text; |
1672 | $json->incr_text = ""; |
1694 | $json->incr_text = ""; |
1673 | $cb->($self, $ref); |
1695 | $cb->($_[0], $ref); |
1674 | |
1696 | |
1675 | 1 |
1697 | 1 |
1676 | } elsif ($@) { |
1698 | } elsif ($@) { |
1677 | # error case |
1699 | # error case |
1678 | $json->incr_skip; |
1700 | $json->incr_skip; |
1679 | |
1701 | |
1680 | $self->{rbuf} = $json->incr_text; |
1702 | $_[0]{rbuf} = $json->incr_text; |
1681 | $json->incr_text = ""; |
1703 | $json->incr_text = ""; |
1682 | |
1704 | |
1683 | $self->_error (Errno::EBADMSG); |
1705 | $_[0]->_error (Errno::EBADMSG); |
1684 | |
1706 | |
1685 | () |
1707 | () |
1686 | } else { |
1708 | } else { |
1687 | $self->{rbuf} = ""; |
1709 | $_[0]{rbuf} = ""; |
1688 | |
1710 | |
1689 | () |
1711 | () |
1690 | } |
1712 | } |
1691 | } |
1713 | } |
1692 | }; |
1714 | }; |
… | |
… | |
1702 | =cut |
1724 | =cut |
1703 | |
1725 | |
1704 | register_read_type storable => sub { |
1726 | register_read_type storable => sub { |
1705 | my ($self, $cb) = @_; |
1727 | my ($self, $cb) = @_; |
1706 | |
1728 | |
1707 | require Storable; |
1729 | require Storable unless $Storable::VERSION; |
1708 | |
1730 | |
1709 | sub { |
1731 | sub { |
1710 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1732 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1711 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
1733 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
1712 | or return; |
1734 | or return; |
… | |
… | |
1715 | |
1737 | |
1716 | # bypass unshift if we already have the remaining chunk |
1738 | # bypass unshift if we already have the remaining chunk |
1717 | if ($format + $len <= length $_[0]{rbuf}) { |
1739 | if ($format + $len <= length $_[0]{rbuf}) { |
1718 | my $data = substr $_[0]{rbuf}, $format, $len; |
1740 | my $data = substr $_[0]{rbuf}, $format, $len; |
1719 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
1741 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1742 | |
1720 | $cb->($_[0], Storable::thaw ($data)); |
1743 | eval { $cb->($_[0], Storable::thaw ($data)); 1 } |
|
|
1744 | or return $_[0]->_error (Errno::EBADMSG); |
1721 | } else { |
1745 | } else { |
1722 | # remove prefix |
1746 | # remove prefix |
1723 | substr $_[0]{rbuf}, 0, $format, ""; |
1747 | substr $_[0]{rbuf}, 0, $format, ""; |
1724 | |
1748 | |
1725 | # read remaining chunk |
1749 | # read remaining chunk |
1726 | $_[0]->unshift_read (chunk => $len, sub { |
1750 | $_[0]->unshift_read (chunk => $len, sub { |
1727 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1751 | eval { $cb->($_[0], Storable::thaw ($_[1])); 1 } |
1728 | $cb->($_[0], $ref); |
|
|
1729 | } else { |
|
|
1730 | $self->_error (Errno::EBADMSG); |
1752 | or $_[0]->_error (Errno::EBADMSG); |
1731 | } |
|
|
1732 | }); |
1753 | }); |
1733 | } |
1754 | } |
1734 | |
1755 | |
1735 | 1 |
1756 | 1 |
1736 | } |
1757 | } |
|
|
1758 | }; |
|
|
1759 | |
|
|
1760 | =item tls_detect => $cb->($handle, $detect, $major, $minor) |
|
|
1761 | |
|
|
1762 | Checks the input stream for a valid SSL or TLS handshake TLSPaintext |
|
|
1763 | record without consuming anything. Only SSL version 3 or higher |
|
|
1764 | is handled, up to the fictituous protocol 4.x (but both SSL3+ and |
|
|
1765 | SSL2-compatible framing is supported). |
|
|
1766 | |
|
|
1767 | If it detects that the input data is likely TLS, it calls the callback |
|
|
1768 | with a true value for C<$detect> and the (on-wire) TLS version as second |
|
|
1769 | and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL |
|
|
1770 | 3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to |
|
|
1771 | be definitely not TLS, it calls the callback with a false value for |
|
|
1772 | C<$detect>. |
|
|
1773 | |
|
|
1774 | The callback could use this information to decide whether or not to start |
|
|
1775 | TLS negotiation. |
|
|
1776 | |
|
|
1777 | In all cases the data read so far is passed to the following read |
|
|
1778 | handlers. |
|
|
1779 | |
|
|
1780 | Usually you want to use the C<tls_autostart> read type instead. |
|
|
1781 | |
|
|
1782 | If you want to design a protocol that works in the presence of TLS |
|
|
1783 | dtection, make sure that any non-TLS data doesn't start with the octet 22 |
|
|
1784 | (ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this |
|
|
1785 | read type does are a bit more strict, but might losen in the future to |
|
|
1786 | accomodate protocol changes. |
|
|
1787 | |
|
|
1788 | This read type does not rely on L<AnyEvent::TLS> (and thus, not on |
|
|
1789 | L<Net::SSLeay>). |
|
|
1790 | |
|
|
1791 | =item tls_autostart => $tls[, $tls_ctx] |
|
|
1792 | |
|
|
1793 | Tries to detect a valid SSL or TLS handshake. If one is detected, it tries |
|
|
1794 | to start tls by calling C<starttls> with the given arguments. |
|
|
1795 | |
|
|
1796 | In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has |
|
|
1797 | been configured to accept, as servers do not normally send a handshake on |
|
|
1798 | their own and ths cannot be detected in this way. |
|
|
1799 | |
|
|
1800 | See C<tls_detect> above for more details. |
|
|
1801 | |
|
|
1802 | Example: give the client a chance to start TLS before accepting a text |
|
|
1803 | line. |
|
|
1804 | |
|
|
1805 | $hdl->push_read (tls_detect => "accept"); |
|
|
1806 | $hdl->push_read (line => sub { |
|
|
1807 | print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n"; |
|
|
1808 | }); |
|
|
1809 | |
|
|
1810 | =cut |
|
|
1811 | |
|
|
1812 | register_read_type tls_detect => sub { |
|
|
1813 | my ($self, $cb) = @_; |
|
|
1814 | |
|
|
1815 | sub { |
|
|
1816 | # this regex matches a full or partial tls record |
|
|
1817 | if ( |
|
|
1818 | # ssl3+: type(22=handshake) major(=3) minor(any) length_hi |
|
|
1819 | $self->{rbuf} =~ /^(?:\z| \x16 (\z| [\x03\x04] (?:\z| . (?:\z| [\x00-\x40] ))))/xs |
|
|
1820 | # ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength) |
|
|
1821 | or $self->{rbuf} =~ /^(?:\z| [\x80-\xff] (?:\z| . (?:\z| \x01 (\z| [\x03\x04] (?:\z| . (?:\z| . ))))))/xs |
|
|
1822 | ) { |
|
|
1823 | return if 3 != length $1; # partial match, can't decide yet |
|
|
1824 | |
|
|
1825 | # full match, valid TLS record |
|
|
1826 | my ($major, $minor) = unpack "CC", $1; |
|
|
1827 | $cb->($self, "accept", $major + $minor * 0.1); |
|
|
1828 | } else { |
|
|
1829 | # mismatch == guaranteed not TLS |
|
|
1830 | $cb->($self, undef); |
|
|
1831 | } |
|
|
1832 | |
|
|
1833 | 1 |
|
|
1834 | } |
|
|
1835 | }; |
|
|
1836 | |
|
|
1837 | register_read_type tls_autostart => sub { |
|
|
1838 | my ($self, @tls) = @_; |
|
|
1839 | |
|
|
1840 | $RH{tls_detect}($self, sub { |
|
|
1841 | return unless $_[1]; |
|
|
1842 | $_[0]->starttls (@tls); |
|
|
1843 | }) |
1737 | }; |
1844 | }; |
1738 | |
1845 | |
1739 | =back |
1846 | =back |
1740 | |
1847 | |
1741 | =item custom read types - Package::anyevent_read_type $handle, $cb, @args |
1848 | =item custom read types - Package::anyevent_read_type $handle, $cb, @args |
… | |
… | |
1783 | some readings of the the SSL/TLS specifications basically require this |
1890 | some readings of the the SSL/TLS specifications basically require this |
1784 | attack to be working, as SSL/TLS implementations might stall sending data |
1891 | attack to be working, as SSL/TLS implementations might stall sending data |
1785 | during a rehandshake. |
1892 | during a rehandshake. |
1786 | |
1893 | |
1787 | As a guideline, during the initial handshake, you should not stop reading, |
1894 | As a guideline, during the initial handshake, you should not stop reading, |
1788 | and as a client, it might cause problems, depending on your applciation. |
1895 | and as a client, it might cause problems, depending on your application. |
1789 | |
1896 | |
1790 | =cut |
1897 | =cut |
1791 | |
1898 | |
1792 | sub stop_read { |
1899 | sub stop_read { |
1793 | my ($self) = @_; |
1900 | my ($self) = @_; |
… | |
… | |
1841 | my ($self, $err) = @_; |
1948 | my ($self, $err) = @_; |
1842 | |
1949 | |
1843 | return $self->_error ($!, 1) |
1950 | return $self->_error ($!, 1) |
1844 | if $err == Net::SSLeay::ERROR_SYSCALL (); |
1951 | if $err == Net::SSLeay::ERROR_SYSCALL (); |
1845 | |
1952 | |
1846 | my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); |
1953 | my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); |
1847 | |
1954 | |
1848 | # reduce error string to look less scary |
1955 | # reduce error string to look less scary |
1849 | $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; |
1956 | $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; |
1850 | |
1957 | |
1851 | if ($self->{_on_starttls}) { |
1958 | if ($self->{_on_starttls}) { |
… | |
… | |
1917 | |
2024 | |
1918 | =item $handle->starttls ($tls[, $tls_ctx]) |
2025 | =item $handle->starttls ($tls[, $tls_ctx]) |
1919 | |
2026 | |
1920 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
2027 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
1921 | object is created, you can also do that at a later time by calling |
2028 | object is created, you can also do that at a later time by calling |
1922 | C<starttls>. |
2029 | C<starttls>. See the C<tls> constructor argument for general info. |
1923 | |
2030 | |
1924 | Starting TLS is currently an asynchronous operation - when you push some |
2031 | Starting TLS is currently an asynchronous operation - when you push some |
1925 | write data and then call C<< ->starttls >> then TLS negotiation will start |
2032 | write data and then call C<< ->starttls >> then TLS negotiation will start |
1926 | immediately, after which the queued write data is then sent. |
2033 | immediately, after which the queued write data is then sent. This might |
|
|
2034 | change in future versions, so best make sure you have no outstanding write |
|
|
2035 | data when calling this method. |
1927 | |
2036 | |
1928 | The first argument is the same as the C<tls> constructor argument (either |
2037 | The first argument is the same as the C<tls> constructor argument (either |
1929 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
2038 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1930 | |
2039 | |
1931 | The second argument is the optional C<AnyEvent::TLS> object that is used |
2040 | The second argument is the optional C<AnyEvent::TLS> object that is used |
… | |
… | |
1953 | my ($self, $tls, $ctx) = @_; |
2062 | my ($self, $tls, $ctx) = @_; |
1954 | |
2063 | |
1955 | Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught" |
2064 | Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught" |
1956 | if $self->{tls}; |
2065 | if $self->{tls}; |
1957 | |
2066 | |
|
|
2067 | unless (defined $AnyEvent::TLS::VERSION) { |
|
|
2068 | eval { |
|
|
2069 | require Net::SSLeay; |
|
|
2070 | require AnyEvent::TLS; |
|
|
2071 | 1 |
|
|
2072 | } or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system"); |
|
|
2073 | } |
|
|
2074 | |
1958 | $self->{tls} = $tls; |
2075 | $self->{tls} = $tls; |
1959 | $self->{tls_ctx} = $ctx if @_ > 2; |
2076 | $self->{tls_ctx} = $ctx if @_ > 2; |
1960 | |
2077 | |
1961 | return unless $self->{fh}; |
2078 | return unless $self->{fh}; |
1962 | |
2079 | |
1963 | require Net::SSLeay; |
|
|
1964 | |
|
|
1965 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
2080 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
1966 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
2081 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
1967 | |
2082 | |
1968 | $tls = delete $self->{tls}; |
2083 | $tls = delete $self->{tls}; |
1969 | $ctx = $self->{tls_ctx}; |
2084 | $ctx = $self->{tls_ctx}; |
1970 | |
2085 | |
1971 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
2086 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
1972 | |
2087 | |
1973 | if ("HASH" eq ref $ctx) { |
2088 | if ("HASH" eq ref $ctx) { |
1974 | require AnyEvent::TLS; |
|
|
1975 | |
|
|
1976 | if ($ctx->{cache}) { |
2089 | if ($ctx->{cache}) { |
1977 | my $key = $ctx+0; |
2090 | my $key = $ctx+0; |
1978 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
2091 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
1979 | } else { |
2092 | } else { |
1980 | $ctx = new AnyEvent::TLS %$ctx; |
2093 | $ctx = new AnyEvent::TLS %$ctx; |
… | |
… | |
2002 | Net::SSLeay::CTX_set_mode ($tls, 1|2); |
2115 | Net::SSLeay::CTX_set_mode ($tls, 1|2); |
2003 | |
2116 | |
2004 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2117 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2005 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2118 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2006 | |
2119 | |
2007 | Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf}); |
2120 | Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf}); |
|
|
2121 | $self->{rbuf} = ""; |
2008 | |
2122 | |
2009 | Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); |
2123 | Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); |
2010 | |
2124 | |
2011 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
2125 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
2012 | if $self->{on_starttls}; |
2126 | if $self->{on_starttls}; |
… | |
… | |
2049 | $self->{tls_ctx}->_put_session (delete $self->{tls}) |
2163 | $self->{tls_ctx}->_put_session (delete $self->{tls}) |
2050 | if $self->{tls} > 0; |
2164 | if $self->{tls} > 0; |
2051 | |
2165 | |
2052 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
2166 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
2053 | } |
2167 | } |
|
|
2168 | |
|
|
2169 | =item $handle->resettls |
|
|
2170 | |
|
|
2171 | This rarely-used method simply resets and TLS state on the handle, usually |
|
|
2172 | causing data loss. |
|
|
2173 | |
|
|
2174 | One case where it may be useful is when you want to skip over the data in |
|
|
2175 | the stream but you are not interested in interpreting it, so data loss is |
|
|
2176 | no concern. |
|
|
2177 | |
|
|
2178 | =cut |
|
|
2179 | |
|
|
2180 | *resettls = \&_freetls; |
2054 | |
2181 | |
2055 | sub DESTROY { |
2182 | sub DESTROY { |
2056 | my ($self) = @_; |
2183 | my ($self) = @_; |
2057 | |
2184 | |
2058 | &_freetls; |
2185 | &_freetls; |
… | |
… | |
2181 | Probably because your C<on_error> callback is being called instead: When |
2308 | Probably because your C<on_error> callback is being called instead: When |
2182 | you have outstanding requests in your read queue, then an EOF is |
2309 | you have outstanding requests in your read queue, then an EOF is |
2183 | considered an error as you clearly expected some data. |
2310 | considered an error as you clearly expected some data. |
2184 | |
2311 | |
2185 | To avoid this, make sure you have an empty read queue whenever your handle |
2312 | To avoid this, make sure you have an empty read queue whenever your handle |
2186 | is supposed to be "idle" (i.e. connection closes are O.K.). You cna set |
2313 | is supposed to be "idle" (i.e. connection closes are O.K.). You can set |
2187 | an C<on_read> handler that simply pushes the first read requests in the |
2314 | an C<on_read> handler that simply pushes the first read requests in the |
2188 | queue. |
2315 | queue. |
2189 | |
2316 | |
2190 | See also the next question, which explains this in a bit more detail. |
2317 | See also the next question, which explains this in a bit more detail. |
2191 | |
2318 | |
… | |
… | |
2199 | handles requests until the server gets some QUIT command, causing it to |
2326 | handles requests until the server gets some QUIT command, causing it to |
2200 | close the connection first (highly desirable for a busy TCP server). A |
2327 | close the connection first (highly desirable for a busy TCP server). A |
2201 | client dropping the connection is an error, which means this variant can |
2328 | client dropping the connection is an error, which means this variant can |
2202 | detect an unexpected detection close. |
2329 | detect an unexpected detection close. |
2203 | |
2330 | |
2204 | To handle this case, always make sure you have a on-empty read queue, by |
2331 | To handle this case, always make sure you have a non-empty read queue, by |
2205 | pushing the "read request start" handler on it: |
2332 | pushing the "read request start" handler on it: |
2206 | |
2333 | |
2207 | # we assume a request starts with a single line |
2334 | # we assume a request starts with a single line |
2208 | my @start_request; @start_request = (line => sub { |
2335 | my @start_request; @start_request = (line => sub { |
2209 | my ($hdl, $line) = @_; |
2336 | my ($hdl, $line) = @_; |
… | |
… | |
2222 | some data and raises the C<EPIPE> error when the connction is dropped |
2349 | some data and raises the C<EPIPE> error when the connction is dropped |
2223 | unexpectedly. |
2350 | unexpectedly. |
2224 | |
2351 | |
2225 | The second variant is a protocol where the client can drop the connection |
2352 | The second variant is a protocol where the client can drop the connection |
2226 | at any time. For TCP, this means that the server machine may run out of |
2353 | at any time. For TCP, this means that the server machine may run out of |
2227 | sockets easier, and in general, it means you cnanot distinguish a protocl |
2354 | sockets easier, and in general, it means you cannot distinguish a protocl |
2228 | failure/client crash from a normal connection close. Nevertheless, these |
2355 | failure/client crash from a normal connection close. Nevertheless, these |
2229 | kinds of protocols are common (and sometimes even the best solution to the |
2356 | kinds of protocols are common (and sometimes even the best solution to the |
2230 | problem). |
2357 | problem). |
2231 | |
2358 | |
2232 | Having an outstanding read request at all times is possible if you ignore |
2359 | Having an outstanding read request at all times is possible if you ignore |
… | |
… | |
2284 | $handle->on_eof (undef); |
2411 | $handle->on_eof (undef); |
2285 | $handle->on_error (sub { |
2412 | $handle->on_error (sub { |
2286 | my $data = delete $_[0]{rbuf}; |
2413 | my $data = delete $_[0]{rbuf}; |
2287 | }); |
2414 | }); |
2288 | |
2415 | |
|
|
2416 | Note that this example removes the C<rbuf> member from the handle object, |
|
|
2417 | which is not normally allowed by the API. It is expressly permitted in |
|
|
2418 | this case only, as the handle object needs to be destroyed afterwards. |
|
|
2419 | |
2289 | The reason to use C<on_error> is that TCP connections, due to latencies |
2420 | The reason to use C<on_error> is that TCP connections, due to latencies |
2290 | and packets loss, might get closed quite violently with an error, when in |
2421 | and packets loss, might get closed quite violently with an error, when in |
2291 | fact all data has been received. |
2422 | fact all data has been received. |
2292 | |
2423 | |
2293 | It is usually better to use acknowledgements when transferring data, |
2424 | It is usually better to use acknowledgements when transferring data, |
… | |
… | |
2303 | C<low_water_mark> this will be called precisely when all data has been |
2434 | C<low_water_mark> this will be called precisely when all data has been |
2304 | written to the socket: |
2435 | written to the socket: |
2305 | |
2436 | |
2306 | $handle->push_write (...); |
2437 | $handle->push_write (...); |
2307 | $handle->on_drain (sub { |
2438 | $handle->on_drain (sub { |
2308 | warn "all data submitted to the kernel\n"; |
2439 | AE::log debug => "All data submitted to the kernel."; |
2309 | undef $handle; |
2440 | undef $handle; |
2310 | }); |
2441 | }); |
2311 | |
2442 | |
2312 | If you just want to queue some data and then signal EOF to the other side, |
2443 | If you just want to queue some data and then signal EOF to the other side, |
2313 | consider using C<< ->push_shutdown >> instead. |
2444 | consider using C<< ->push_shutdown >> instead. |
… | |
… | |
2397 | When you have intermediate CA certificates that your clients might not |
2528 | When you have intermediate CA certificates that your clients might not |
2398 | know about, just append them to the C<cert_file>. |
2529 | know about, just append them to the C<cert_file>. |
2399 | |
2530 | |
2400 | =back |
2531 | =back |
2401 | |
2532 | |
2402 | |
|
|
2403 | =head1 SUBCLASSING AnyEvent::Handle |
2533 | =head1 SUBCLASSING AnyEvent::Handle |
2404 | |
2534 | |
2405 | In many cases, you might want to subclass AnyEvent::Handle. |
2535 | In many cases, you might want to subclass AnyEvent::Handle. |
2406 | |
2536 | |
2407 | To make this easier, a given version of AnyEvent::Handle uses these |
2537 | To make this easier, a given version of AnyEvent::Handle uses these |
… | |
… | |
2433 | |
2563 | |
2434 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
2564 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
2435 | |
2565 | |
2436 | =cut |
2566 | =cut |
2437 | |
2567 | |
2438 | 1; # End of AnyEvent::Handle |
2568 | 1 |
|
|
2569 | |