… | |
… | |
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 | |
… | |
… | |
477 | callback. |
496 | callback. |
478 | |
497 | |
479 | This callback will only be called on TLS shutdowns, not when the |
498 | This callback will only be called on TLS shutdowns, not when the |
480 | underlying handle signals EOF. |
499 | underlying handle signals EOF. |
481 | |
500 | |
482 | =item json => JSON or JSON::XS object |
501 | =item json => L<JSON>, L<JSON::PP> or L<JSON::XS> object |
483 | |
502 | |
484 | This is the json coder object used by the C<json> read and write types. |
503 | This is the json coder object used by the C<json> read and write types. |
485 | |
504 | |
486 | If you don't supply it, then AnyEvent::Handle will create and use a |
505 | If you don't supply it, then AnyEvent::Handle will create and use a |
487 | suitable one (on demand), which will write and expect UTF-8 encoded JSON |
506 | suitable one (on demand), which will write and expect UTF-8 encoded |
|
|
507 | JSON texts (either using L<JSON::XS> or L<JSON>). The written texts are |
|
|
508 | guaranteed not to contain any newline character. |
|
|
509 | |
|
|
510 | For security reasons, this encoder will likely I<not> handle numbers and |
|
|
511 | strings, only arrays and objects/hashes. The reason is that originally |
|
|
512 | JSON was self-delimited, but Dougles Crockford thought it was a splendid |
|
|
513 | idea to redefine JSON incompatibly, so this is no longer true. |
|
|
514 | |
|
|
515 | For protocols that used back-to-back JSON texts, this might lead to |
|
|
516 | run-ins, where two or more JSON texts will be interpreted as one JSON |
488 | texts. |
517 | text. |
489 | |
518 | |
|
|
519 | For this reason, if the default encoder uses L<JSON::XS>, it will default |
|
|
520 | to not allowing anything but arrays and objects/hashes, at least for the |
|
|
521 | forseeable future (it will change at some point). This might or might not |
|
|
522 | be true for the L<JSON> module, so this might cause a security issue. |
|
|
523 | |
|
|
524 | If you depend on either behaviour, you should create your own json object |
|
|
525 | and pass it in explicitly. |
|
|
526 | |
|
|
527 | =item cbor => L<CBOR::XS> object |
|
|
528 | |
|
|
529 | This is the cbor coder object used by the C<cbor> read and write types. |
|
|
530 | |
|
|
531 | If you don't supply it, then AnyEvent::Handle will create and use a |
|
|
532 | suitable one (on demand), which will write CBOR without using extensions, |
|
|
533 | if possible. |
|
|
534 | |
490 | Note that you are responsible to depend on the JSON module if you want to |
535 | Note that you are responsible to depend on the L<CBOR::XS> module if you |
491 | use this functionality, as AnyEvent does not have a dependency itself. |
536 | want to use this functionality, as AnyEvent does not have a dependency on |
|
|
537 | it itself. |
492 | |
538 | |
493 | =back |
539 | =back |
494 | |
540 | |
495 | =cut |
541 | =cut |
496 | |
542 | |
… | |
… | |
536 | }); |
582 | }); |
537 | |
583 | |
538 | } else { |
584 | } else { |
539 | if ($self->{on_connect_error}) { |
585 | if ($self->{on_connect_error}) { |
540 | $self->{on_connect_error}($self, "$!"); |
586 | $self->{on_connect_error}($self, "$!"); |
541 | $self->destroy; |
587 | $self->destroy if $self; |
542 | } else { |
588 | } else { |
543 | $self->_error ($!, 1); |
589 | $self->_error ($!, 1); |
544 | } |
590 | } |
545 | } |
591 | } |
546 | }, |
592 | }, |
… | |
… | |
779 | |
825 | |
780 | =item $handle->wtimeout ($seconds) |
826 | =item $handle->wtimeout ($seconds) |
781 | |
827 | |
782 | Configures (or disables) the inactivity timeout. |
828 | Configures (or disables) the inactivity timeout. |
783 | |
829 | |
|
|
830 | The timeout will be checked instantly, so this method might destroy the |
|
|
831 | handle before it returns. |
|
|
832 | |
784 | =item $handle->timeout_reset |
833 | =item $handle->timeout_reset |
785 | |
834 | |
786 | =item $handle->rtimeout_reset |
835 | =item $handle->rtimeout_reset |
787 | |
836 | |
788 | =item $handle->wtimeout_reset |
837 | =item $handle->wtimeout_reset |
… | |
… | |
871 | |
920 | |
872 | The write queue is very simple: you can add data to its end, and |
921 | 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. |
922 | AnyEvent::Handle will automatically try to get rid of it for you. |
874 | |
923 | |
875 | When data could be written and the write buffer is shorter then the low |
924 | 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. |
925 | water mark, the C<on_drain> callback will be invoked once. |
877 | |
926 | |
878 | =over 4 |
927 | =over 4 |
879 | |
928 | |
880 | =item $handle->on_drain ($cb) |
929 | =item $handle->on_drain ($cb) |
881 | |
930 | |
… | |
… | |
1023 | |
1072 | |
1024 | Encodes the given hash or array reference into a JSON object. Unless you |
1073 | Encodes the given hash or array reference into a JSON object. Unless you |
1025 | provide your own JSON object, this means it will be encoded to JSON text |
1074 | provide your own JSON object, this means it will be encoded to JSON text |
1026 | in UTF-8. |
1075 | in UTF-8. |
1027 | |
1076 | |
|
|
1077 | The default encoder might or might not handle every type of JSON value - |
|
|
1078 | it might be limited to arrays and objects for security reasons. See the |
|
|
1079 | C<json> constructor attribute for more details. |
|
|
1080 | |
1028 | JSON objects (and arrays) are self-delimiting, so you can write JSON at |
1081 | JSON objects (and arrays) are self-delimiting, so if you only use arrays |
1029 | one end of a handle and read them at the other end without using any |
1082 | and hashes, you can write JSON at one end of a handle and read them at the |
1030 | additional framing. |
1083 | other end without using any additional framing. |
1031 | |
1084 | |
1032 | The generated JSON text is guaranteed not to contain any newlines: While |
1085 | The JSON text generated by the default encoder is guaranteed not to |
1033 | this module doesn't need delimiters after or between JSON texts to be |
1086 | contain any newlines: While this module doesn't need delimiters after or |
1034 | able to read them, many other languages depend on that. |
1087 | between JSON texts to be able to read them, many other languages depend on |
|
|
1088 | them. |
1035 | |
1089 | |
1036 | A simple RPC protocol that interoperates easily with others is to send |
1090 | A simple RPC protocol that interoperates easily with other languages is |
1037 | JSON arrays (or objects, although arrays are usually the better choice as |
1091 | to send JSON arrays (or objects, although arrays are usually the better |
1038 | they mimic how function argument passing works) and a newline after each |
1092 | choice as they mimic how function argument passing works) and a newline |
1039 | JSON text: |
1093 | after each JSON text: |
1040 | |
1094 | |
1041 | $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever |
1095 | $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever |
1042 | $handle->push_write ("\012"); |
1096 | $handle->push_write ("\012"); |
1043 | |
1097 | |
1044 | An AnyEvent::Handle receiver would simply use the C<json> read type and |
1098 | An AnyEvent::Handle receiver would simply use the C<json> read type and |
… | |
… | |
1047 | $handle->push_read (json => sub { my $array = $_[1]; ... }); |
1101 | $handle->push_read (json => sub { my $array = $_[1]; ... }); |
1048 | |
1102 | |
1049 | Other languages could read single lines terminated by a newline and pass |
1103 | Other languages could read single lines terminated by a newline and pass |
1050 | this line into their JSON decoder of choice. |
1104 | this line into their JSON decoder of choice. |
1051 | |
1105 | |
|
|
1106 | =item cbor => $perl_scalar |
|
|
1107 | |
|
|
1108 | Encodes the given scalar into a CBOR value. Unless you provide your own |
|
|
1109 | L<CBOR::XS> object, this means it will be encoded to a CBOR string not |
|
|
1110 | using any extensions, if possible. |
|
|
1111 | |
|
|
1112 | CBOR values are self-delimiting, so you can write CBOR at one end of |
|
|
1113 | a handle and read them at the other end without using any additional |
|
|
1114 | framing. |
|
|
1115 | |
|
|
1116 | A simple nd very very fast RPC protocol that interoperates with |
|
|
1117 | other languages is to send CBOR and receive CBOR values (arrays are |
|
|
1118 | recommended): |
|
|
1119 | |
|
|
1120 | $handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever |
|
|
1121 | |
|
|
1122 | An AnyEvent::Handle receiver would simply use the C<cbor> read type: |
|
|
1123 | |
|
|
1124 | $handle->push_read (cbor => sub { my $array = $_[1]; ... }); |
|
|
1125 | |
1052 | =cut |
1126 | =cut |
1053 | |
1127 | |
1054 | sub json_coder() { |
1128 | sub json_coder() { |
1055 | eval { require JSON::XS; JSON::XS->new->utf8 } |
1129 | eval { require JSON::XS; JSON::XS->new->utf8 } |
1056 | || do { require JSON; JSON->new->utf8 } |
1130 | || do { require JSON::PP; JSON::PP->new->utf8 } |
1057 | } |
1131 | } |
1058 | |
1132 | |
1059 | register_write_type json => sub { |
1133 | register_write_type json => sub { |
1060 | my ($self, $ref) = @_; |
1134 | my ($self, $ref) = @_; |
1061 | |
1135 | |
1062 | my $json = $self->{json} ||= json_coder; |
1136 | ($self->{json} ||= json_coder) |
1063 | |
|
|
1064 | $json->encode ($ref) |
1137 | ->encode ($ref) |
|
|
1138 | }; |
|
|
1139 | |
|
|
1140 | sub cbor_coder() { |
|
|
1141 | require CBOR::XS; |
|
|
1142 | CBOR::XS->new |
|
|
1143 | } |
|
|
1144 | |
|
|
1145 | register_write_type cbor => sub { |
|
|
1146 | my ($self, $scalar) = @_; |
|
|
1147 | |
|
|
1148 | ($self->{cbor} ||= cbor_coder) |
|
|
1149 | ->encode ($scalar) |
1065 | }; |
1150 | }; |
1066 | |
1151 | |
1067 | =item storable => $reference |
1152 | =item storable => $reference |
1068 | |
1153 | |
1069 | Freezes the given reference using L<Storable> and writes it to the |
1154 | Freezes the given reference using L<Storable> and writes it to the |
… | |
… | |
1072 | =cut |
1157 | =cut |
1073 | |
1158 | |
1074 | register_write_type storable => sub { |
1159 | register_write_type storable => sub { |
1075 | my ($self, $ref) = @_; |
1160 | my ($self, $ref) = @_; |
1076 | |
1161 | |
1077 | require Storable; |
1162 | require Storable unless $Storable::VERSION; |
1078 | |
1163 | |
1079 | pack "w/a*", Storable::nfreeze ($ref) |
1164 | pack "w/a*", Storable::nfreeze ($ref) |
1080 | }; |
1165 | }; |
1081 | |
1166 | |
1082 | =back |
1167 | =back |
… | |
… | |
1119 | |
1204 | |
1120 | Whenever the given C<type> is used, C<push_write> will the function with |
1205 | Whenever the given C<type> is used, C<push_write> will the function with |
1121 | the handle object and the remaining arguments. |
1206 | the handle object and the remaining arguments. |
1122 | |
1207 | |
1123 | The function is supposed to return a single octet string that will be |
1208 | 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 |
1209 | appended to the write buffer, so you can mentally treat this function as a |
1125 | "arguments to on-the-wire-format" converter. |
1210 | "arguments to on-the-wire-format" converter. |
1126 | |
1211 | |
1127 | Example: implement a custom write type C<join> that joins the remaining |
1212 | Example: implement a custom write type C<join> that joins the remaining |
1128 | arguments using the first one. |
1213 | arguments using the first one. |
1129 | |
1214 | |
… | |
… | |
1423 | data. |
1508 | data. |
1424 | |
1509 | |
1425 | Example: read 2 bytes. |
1510 | Example: read 2 bytes. |
1426 | |
1511 | |
1427 | $handle->push_read (chunk => 2, sub { |
1512 | $handle->push_read (chunk => 2, sub { |
1428 | warn "yay ", unpack "H*", $_[1]; |
1513 | say "yay " . unpack "H*", $_[1]; |
1429 | }); |
1514 | }); |
1430 | |
1515 | |
1431 | =cut |
1516 | =cut |
1432 | |
1517 | |
1433 | register_read_type chunk => sub { |
1518 | register_read_type chunk => sub { |
… | |
… | |
1463 | |
1548 | |
1464 | register_read_type line => sub { |
1549 | register_read_type line => sub { |
1465 | my ($self, $cb, $eol) = @_; |
1550 | my ($self, $cb, $eol) = @_; |
1466 | |
1551 | |
1467 | if (@_ < 3) { |
1552 | if (@_ < 3) { |
1468 | # this is more than twice as fast as the generic code below |
1553 | # this is faster then the generic code below |
1469 | sub { |
1554 | sub { |
1470 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
1555 | (my $pos = index $_[0]{rbuf}, "\012") >= 0 |
|
|
1556 | or return; |
1471 | |
1557 | |
|
|
1558 | (my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die; |
1472 | $cb->($_[0], $1, $2); |
1559 | $cb->($_[0], $str, "$1"); |
1473 | 1 |
1560 | 1 |
1474 | } |
1561 | } |
1475 | } else { |
1562 | } else { |
1476 | $eol = quotemeta $eol unless ref $eol; |
1563 | $eol = quotemeta $eol unless ref $eol; |
1477 | $eol = qr|^(.*?)($eol)|s; |
1564 | $eol = qr|^(.*?)($eol)|s; |
1478 | |
1565 | |
1479 | sub { |
1566 | sub { |
1480 | $_[0]{rbuf} =~ s/$eol// or return; |
1567 | $_[0]{rbuf} =~ s/$eol// or return; |
1481 | |
1568 | |
1482 | $cb->($_[0], $1, $2); |
1569 | $cb->($_[0], "$1", "$2"); |
1483 | 1 |
1570 | 1 |
1484 | } |
1571 | } |
1485 | } |
1572 | } |
1486 | }; |
1573 | }; |
1487 | |
1574 | |
… | |
… | |
1535 | |
1622 | |
1536 | sub { |
1623 | sub { |
1537 | # accept |
1624 | # accept |
1538 | if ($$rbuf =~ $accept) { |
1625 | if ($$rbuf =~ $accept) { |
1539 | $data .= substr $$rbuf, 0, $+[0], ""; |
1626 | $data .= substr $$rbuf, 0, $+[0], ""; |
1540 | $cb->($self, $data); |
1627 | $cb->($_[0], $data); |
1541 | return 1; |
1628 | return 1; |
1542 | } |
1629 | } |
1543 | |
1630 | |
1544 | # reject |
1631 | # reject |
1545 | if ($reject && $$rbuf =~ $reject) { |
1632 | if ($reject && $$rbuf =~ $reject) { |
1546 | $self->_error (Errno::EBADMSG); |
1633 | $_[0]->_error (Errno::EBADMSG); |
1547 | } |
1634 | } |
1548 | |
1635 | |
1549 | # skip |
1636 | # skip |
1550 | if ($skip && $$rbuf =~ $skip) { |
1637 | if ($skip && $$rbuf =~ $skip) { |
1551 | $data .= substr $$rbuf, 0, $+[0], ""; |
1638 | $data .= substr $$rbuf, 0, $+[0], ""; |
… | |
… | |
1567 | my ($self, $cb) = @_; |
1654 | my ($self, $cb) = @_; |
1568 | |
1655 | |
1569 | sub { |
1656 | sub { |
1570 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1657 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1571 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1658 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1572 | $self->_error (Errno::EBADMSG); |
1659 | $_[0]->_error (Errno::EBADMSG); |
1573 | } |
1660 | } |
1574 | return; |
1661 | return; |
1575 | } |
1662 | } |
1576 | |
1663 | |
1577 | my $len = $1; |
1664 | my $len = $1; |
1578 | |
1665 | |
1579 | $self->unshift_read (chunk => $len, sub { |
1666 | $_[0]->unshift_read (chunk => $len, sub { |
1580 | my $string = $_[1]; |
1667 | my $string = $_[1]; |
1581 | $_[0]->unshift_read (chunk => 1, sub { |
1668 | $_[0]->unshift_read (chunk => 1, sub { |
1582 | if ($_[1] eq ",") { |
1669 | if ($_[1] eq ",") { |
1583 | $cb->($_[0], $string); |
1670 | $cb->($_[0], $string); |
1584 | } else { |
1671 | } else { |
1585 | $self->_error (Errno::EBADMSG); |
1672 | $_[0]->_error (Errno::EBADMSG); |
1586 | } |
1673 | } |
1587 | }); |
1674 | }); |
1588 | }); |
1675 | }); |
1589 | |
1676 | |
1590 | 1 |
1677 | 1 |
… | |
… | |
1640 | =item json => $cb->($handle, $hash_or_arrayref) |
1727 | =item json => $cb->($handle, $hash_or_arrayref) |
1641 | |
1728 | |
1642 | Reads a JSON object or array, decodes it and passes it to the |
1729 | Reads a JSON object or array, decodes it and passes it to the |
1643 | callback. When a parse error occurs, an C<EBADMSG> error will be raised. |
1730 | callback. When a parse error occurs, an C<EBADMSG> error will be raised. |
1644 | |
1731 | |
1645 | If a C<json> object was passed to the constructor, then that will be used |
1732 | If a C<json> object was passed to the constructor, then that will be |
1646 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
1733 | used for the final decode, otherwise it will create a L<JSON::XS> or |
|
|
1734 | L<JSON::PP> coder object expecting UTF-8. |
1647 | |
1735 | |
1648 | This read type uses the incremental parser available with JSON version |
1736 | This read type uses the incremental parser available with JSON version |
1649 | 2.09 (and JSON::XS version 2.2) and above. You have to provide a |
1737 | 2.09 (and JSON::XS version 2.2) and above. |
1650 | dependency on your own: this module will load the JSON module, but |
|
|
1651 | AnyEvent does not depend on it itself. |
|
|
1652 | |
1738 | |
1653 | Since JSON texts are fully self-delimiting, the C<json> read and write |
1739 | Since JSON texts are fully self-delimiting, the C<json> read and write |
1654 | types are an ideal simple RPC protocol: just exchange JSON datagrams. See |
1740 | types are an ideal simple RPC protocol: just exchange JSON datagrams. See |
1655 | the C<json> write type description, above, for an actual example. |
1741 | the C<json> write type description, above, for an actual example. |
1656 | |
1742 | |
… | |
… | |
1660 | my ($self, $cb) = @_; |
1746 | my ($self, $cb) = @_; |
1661 | |
1747 | |
1662 | my $json = $self->{json} ||= json_coder; |
1748 | my $json = $self->{json} ||= json_coder; |
1663 | |
1749 | |
1664 | my $data; |
1750 | my $data; |
1665 | my $rbuf = \$self->{rbuf}; |
|
|
1666 | |
1751 | |
1667 | sub { |
1752 | sub { |
1668 | my $ref = eval { $json->incr_parse ($self->{rbuf}) }; |
1753 | my $ref = eval { $json->incr_parse ($_[0]{rbuf}) }; |
1669 | |
1754 | |
1670 | if ($ref) { |
1755 | if ($ref) { |
1671 | $self->{rbuf} = $json->incr_text; |
1756 | $_[0]{rbuf} = $json->incr_text; |
1672 | $json->incr_text = ""; |
1757 | $json->incr_text = ""; |
1673 | $cb->($self, $ref); |
1758 | $cb->($_[0], $ref); |
1674 | |
1759 | |
1675 | 1 |
1760 | 1 |
1676 | } elsif ($@) { |
1761 | } elsif ($@) { |
1677 | # error case |
1762 | # error case |
1678 | $json->incr_skip; |
1763 | $json->incr_skip; |
1679 | |
1764 | |
1680 | $self->{rbuf} = $json->incr_text; |
1765 | $_[0]{rbuf} = $json->incr_text; |
1681 | $json->incr_text = ""; |
1766 | $json->incr_text = ""; |
1682 | |
1767 | |
1683 | $self->_error (Errno::EBADMSG); |
1768 | $_[0]->_error (Errno::EBADMSG); |
1684 | |
1769 | |
1685 | () |
1770 | () |
1686 | } else { |
1771 | } else { |
1687 | $self->{rbuf} = ""; |
1772 | $_[0]{rbuf} = ""; |
1688 | |
1773 | |
|
|
1774 | () |
|
|
1775 | } |
|
|
1776 | } |
|
|
1777 | }; |
|
|
1778 | |
|
|
1779 | =item cbor => $cb->($handle, $scalar) |
|
|
1780 | |
|
|
1781 | Reads a CBOR value, decodes it and passes it to the callback. When a parse |
|
|
1782 | error occurs, an C<EBADMSG> error will be raised. |
|
|
1783 | |
|
|
1784 | If a L<CBOR::XS> object was passed to the constructor, then that will be |
|
|
1785 | used for the final decode, otherwise it will create a CBOR coder without |
|
|
1786 | enabling any options. |
|
|
1787 | |
|
|
1788 | You have to provide a dependency to L<CBOR::XS> on your own: this module |
|
|
1789 | will load the L<CBOR::XS> module, but AnyEvent does not depend on it |
|
|
1790 | itself. |
|
|
1791 | |
|
|
1792 | Since CBOR values are fully self-delimiting, the C<cbor> read and write |
|
|
1793 | types are an ideal simple RPC protocol: just exchange CBOR datagrams. See |
|
|
1794 | the C<cbor> write type description, above, for an actual example. |
|
|
1795 | |
|
|
1796 | =cut |
|
|
1797 | |
|
|
1798 | register_read_type cbor => sub { |
|
|
1799 | my ($self, $cb) = @_; |
|
|
1800 | |
|
|
1801 | my $cbor = $self->{cbor} ||= cbor_coder; |
|
|
1802 | |
|
|
1803 | my $data; |
|
|
1804 | |
|
|
1805 | sub { |
|
|
1806 | my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) }; |
|
|
1807 | |
|
|
1808 | if (@value) { |
|
|
1809 | $cb->($_[0], @value); |
|
|
1810 | |
|
|
1811 | 1 |
|
|
1812 | } elsif ($@) { |
|
|
1813 | # error case |
|
|
1814 | $cbor->incr_reset; |
|
|
1815 | |
|
|
1816 | $_[0]->_error (Errno::EBADMSG); |
|
|
1817 | |
|
|
1818 | () |
|
|
1819 | } else { |
1689 | () |
1820 | () |
1690 | } |
1821 | } |
1691 | } |
1822 | } |
1692 | }; |
1823 | }; |
1693 | |
1824 | |
… | |
… | |
1702 | =cut |
1833 | =cut |
1703 | |
1834 | |
1704 | register_read_type storable => sub { |
1835 | register_read_type storable => sub { |
1705 | my ($self, $cb) = @_; |
1836 | my ($self, $cb) = @_; |
1706 | |
1837 | |
1707 | require Storable; |
1838 | require Storable unless $Storable::VERSION; |
1708 | |
1839 | |
1709 | sub { |
1840 | sub { |
1710 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
1841 | # 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} }) |
1842 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
1712 | or return; |
1843 | or return; |
… | |
… | |
1715 | |
1846 | |
1716 | # bypass unshift if we already have the remaining chunk |
1847 | # bypass unshift if we already have the remaining chunk |
1717 | if ($format + $len <= length $_[0]{rbuf}) { |
1848 | if ($format + $len <= length $_[0]{rbuf}) { |
1718 | my $data = substr $_[0]{rbuf}, $format, $len; |
1849 | my $data = substr $_[0]{rbuf}, $format, $len; |
1719 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
1850 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1851 | |
1720 | $cb->($_[0], Storable::thaw ($data)); |
1852 | eval { $cb->($_[0], Storable::thaw ($data)); 1 } |
|
|
1853 | or return $_[0]->_error (Errno::EBADMSG); |
1721 | } else { |
1854 | } else { |
1722 | # remove prefix |
1855 | # remove prefix |
1723 | substr $_[0]{rbuf}, 0, $format, ""; |
1856 | substr $_[0]{rbuf}, 0, $format, ""; |
1724 | |
1857 | |
1725 | # read remaining chunk |
1858 | # read remaining chunk |
1726 | $_[0]->unshift_read (chunk => $len, sub { |
1859 | $_[0]->unshift_read (chunk => $len, sub { |
1727 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1860 | eval { $cb->($_[0], Storable::thaw ($_[1])); 1 } |
1728 | $cb->($_[0], $ref); |
|
|
1729 | } else { |
|
|
1730 | $self->_error (Errno::EBADMSG); |
1861 | or $_[0]->_error (Errno::EBADMSG); |
1731 | } |
|
|
1732 | }); |
1862 | }); |
1733 | } |
1863 | } |
1734 | |
1864 | |
1735 | 1 |
1865 | 1 |
1736 | } |
1866 | } |
|
|
1867 | }; |
|
|
1868 | |
|
|
1869 | =item tls_detect => $cb->($handle, $detect, $major, $minor) |
|
|
1870 | |
|
|
1871 | Checks the input stream for a valid SSL or TLS handshake TLSPaintext |
|
|
1872 | record without consuming anything. Only SSL version 3 or higher |
|
|
1873 | is handled, up to the fictituous protocol 4.x (but both SSL3+ and |
|
|
1874 | SSL2-compatible framing is supported). |
|
|
1875 | |
|
|
1876 | If it detects that the input data is likely TLS, it calls the callback |
|
|
1877 | with a true value for C<$detect> and the (on-wire) TLS version as second |
|
|
1878 | and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL |
|
|
1879 | 3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to |
|
|
1880 | be definitely not TLS, it calls the callback with a false value for |
|
|
1881 | C<$detect>. |
|
|
1882 | |
|
|
1883 | The callback could use this information to decide whether or not to start |
|
|
1884 | TLS negotiation. |
|
|
1885 | |
|
|
1886 | In all cases the data read so far is passed to the following read |
|
|
1887 | handlers. |
|
|
1888 | |
|
|
1889 | Usually you want to use the C<tls_autostart> read type instead. |
|
|
1890 | |
|
|
1891 | If you want to design a protocol that works in the presence of TLS |
|
|
1892 | dtection, make sure that any non-TLS data doesn't start with the octet 22 |
|
|
1893 | (ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this |
|
|
1894 | read type does are a bit more strict, but might losen in the future to |
|
|
1895 | accomodate protocol changes. |
|
|
1896 | |
|
|
1897 | This read type does not rely on L<AnyEvent::TLS> (and thus, not on |
|
|
1898 | L<Net::SSLeay>). |
|
|
1899 | |
|
|
1900 | =item tls_autostart => $tls[, $tls_ctx] |
|
|
1901 | |
|
|
1902 | Tries to detect a valid SSL or TLS handshake. If one is detected, it tries |
|
|
1903 | to start tls by calling C<starttls> with the given arguments. |
|
|
1904 | |
|
|
1905 | In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has |
|
|
1906 | been configured to accept, as servers do not normally send a handshake on |
|
|
1907 | their own and ths cannot be detected in this way. |
|
|
1908 | |
|
|
1909 | See C<tls_detect> above for more details. |
|
|
1910 | |
|
|
1911 | Example: give the client a chance to start TLS before accepting a text |
|
|
1912 | line. |
|
|
1913 | |
|
|
1914 | $hdl->push_read (tls_detect => "accept"); |
|
|
1915 | $hdl->push_read (line => sub { |
|
|
1916 | print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n"; |
|
|
1917 | }); |
|
|
1918 | |
|
|
1919 | =cut |
|
|
1920 | |
|
|
1921 | register_read_type tls_detect => sub { |
|
|
1922 | my ($self, $cb) = @_; |
|
|
1923 | |
|
|
1924 | sub { |
|
|
1925 | # this regex matches a full or partial tls record |
|
|
1926 | if ( |
|
|
1927 | # ssl3+: type(22=handshake) major(=3) minor(any) length_hi |
|
|
1928 | $self->{rbuf} =~ /^(?:\z| \x16 (\z| [\x03\x04] (?:\z| . (?:\z| [\x00-\x40] ))))/xs |
|
|
1929 | # ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength) |
|
|
1930 | or $self->{rbuf} =~ /^(?:\z| [\x80-\xff] (?:\z| . (?:\z| \x01 (\z| [\x03\x04] (?:\z| . (?:\z| . ))))))/xs |
|
|
1931 | ) { |
|
|
1932 | return if 3 != length $1; # partial match, can't decide yet |
|
|
1933 | |
|
|
1934 | # full match, valid TLS record |
|
|
1935 | my ($major, $minor) = unpack "CC", $1; |
|
|
1936 | $cb->($self, "accept", $major + $minor * 0.1); |
|
|
1937 | } else { |
|
|
1938 | # mismatch == guaranteed not TLS |
|
|
1939 | $cb->($self, undef); |
|
|
1940 | } |
|
|
1941 | |
|
|
1942 | 1 |
|
|
1943 | } |
|
|
1944 | }; |
|
|
1945 | |
|
|
1946 | register_read_type tls_autostart => sub { |
|
|
1947 | my ($self, @tls) = @_; |
|
|
1948 | |
|
|
1949 | $RH{tls_detect}($self, sub { |
|
|
1950 | return unless $_[1]; |
|
|
1951 | $_[0]->starttls (@tls); |
|
|
1952 | }) |
1737 | }; |
1953 | }; |
1738 | |
1954 | |
1739 | =back |
1955 | =back |
1740 | |
1956 | |
1741 | =item custom read types - Package::anyevent_read_type $handle, $cb, @args |
1957 | =item custom read types - Package::anyevent_read_type $handle, $cb, @args |
… | |
… | |
1783 | some readings of the the SSL/TLS specifications basically require this |
1999 | some readings of the the SSL/TLS specifications basically require this |
1784 | attack to be working, as SSL/TLS implementations might stall sending data |
2000 | attack to be working, as SSL/TLS implementations might stall sending data |
1785 | during a rehandshake. |
2001 | during a rehandshake. |
1786 | |
2002 | |
1787 | As a guideline, during the initial handshake, you should not stop reading, |
2003 | 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. |
2004 | and as a client, it might cause problems, depending on your application. |
1789 | |
2005 | |
1790 | =cut |
2006 | =cut |
1791 | |
2007 | |
1792 | sub stop_read { |
2008 | sub stop_read { |
1793 | my ($self) = @_; |
2009 | my ($self) = @_; |
… | |
… | |
1841 | my ($self, $err) = @_; |
2057 | my ($self, $err) = @_; |
1842 | |
2058 | |
1843 | return $self->_error ($!, 1) |
2059 | return $self->_error ($!, 1) |
1844 | if $err == Net::SSLeay::ERROR_SYSCALL (); |
2060 | if $err == Net::SSLeay::ERROR_SYSCALL (); |
1845 | |
2061 | |
1846 | my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); |
2062 | my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); |
1847 | |
2063 | |
1848 | # reduce error string to look less scary |
2064 | # reduce error string to look less scary |
1849 | $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; |
2065 | $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; |
1850 | |
2066 | |
1851 | if ($self->{_on_starttls}) { |
2067 | if ($self->{_on_starttls}) { |
… | |
… | |
1865 | sub _dotls { |
2081 | sub _dotls { |
1866 | my ($self) = @_; |
2082 | my ($self) = @_; |
1867 | |
2083 | |
1868 | my $tmp; |
2084 | my $tmp; |
1869 | |
2085 | |
1870 | if (length $self->{_tls_wbuf}) { |
2086 | while (length $self->{_tls_wbuf}) { |
1871 | while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
2087 | if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) { |
1872 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
2088 | $tmp = Net::SSLeay::get_error ($self->{tls}, $tmp); |
|
|
2089 | |
|
|
2090 | return $self->_tls_error ($tmp) |
|
|
2091 | if $tmp != $ERROR_WANT_READ |
|
|
2092 | && ($tmp != $ERROR_SYSCALL || $!); |
|
|
2093 | |
|
|
2094 | last; |
1873 | } |
2095 | } |
1874 | |
2096 | |
1875 | $tmp = Net::SSLeay::get_error ($self->{tls}, $tmp); |
2097 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
1876 | return $self->_tls_error ($tmp) |
|
|
1877 | if $tmp != $ERROR_WANT_READ |
|
|
1878 | && ($tmp != $ERROR_SYSCALL || $!); |
|
|
1879 | } |
2098 | } |
1880 | |
2099 | |
1881 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
2100 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
1882 | unless (length $tmp) { |
2101 | unless (length $tmp) { |
1883 | $self->{_on_starttls} |
2102 | $self->{_on_starttls} |
… | |
… | |
1897 | $self->{_tls_rbuf} .= $tmp; |
2116 | $self->{_tls_rbuf} .= $tmp; |
1898 | $self->_drain_rbuf; |
2117 | $self->_drain_rbuf; |
1899 | $self->{tls} or return; # tls session might have gone away in callback |
2118 | $self->{tls} or return; # tls session might have gone away in callback |
1900 | } |
2119 | } |
1901 | |
2120 | |
1902 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
2121 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); # -1 is not neccessarily correct, but Net::SSLeay doesn't tell us |
1903 | return $self->_tls_error ($tmp) |
2122 | return $self->_tls_error ($tmp) |
1904 | if $tmp != $ERROR_WANT_READ |
2123 | if $tmp != $ERROR_WANT_READ |
1905 | && ($tmp != $ERROR_SYSCALL || $!); |
2124 | && ($tmp != $ERROR_SYSCALL || $!); |
1906 | |
2125 | |
1907 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
2126 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
… | |
… | |
1917 | |
2136 | |
1918 | =item $handle->starttls ($tls[, $tls_ctx]) |
2137 | =item $handle->starttls ($tls[, $tls_ctx]) |
1919 | |
2138 | |
1920 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
2139 | 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 |
2140 | object is created, you can also do that at a later time by calling |
1922 | C<starttls>. |
2141 | C<starttls>. See the C<tls> constructor argument for general info. |
1923 | |
2142 | |
1924 | Starting TLS is currently an asynchronous operation - when you push some |
2143 | Starting TLS is currently an asynchronous operation - when you push some |
1925 | write data and then call C<< ->starttls >> then TLS negotiation will start |
2144 | write data and then call C<< ->starttls >> then TLS negotiation will start |
1926 | immediately, after which the queued write data is then sent. |
2145 | immediately, after which the queued write data is then sent. This might |
|
|
2146 | change in future versions, so best make sure you have no outstanding write |
|
|
2147 | data when calling this method. |
1927 | |
2148 | |
1928 | The first argument is the same as the C<tls> constructor argument (either |
2149 | The first argument is the same as the C<tls> constructor argument (either |
1929 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
2150 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1930 | |
2151 | |
1931 | The second argument is the optional C<AnyEvent::TLS> object that is used |
2152 | The second argument is the optional C<AnyEvent::TLS> object that is used |
… | |
… | |
1953 | my ($self, $tls, $ctx) = @_; |
2174 | my ($self, $tls, $ctx) = @_; |
1954 | |
2175 | |
1955 | Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught" |
2176 | Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught" |
1956 | if $self->{tls}; |
2177 | if $self->{tls}; |
1957 | |
2178 | |
|
|
2179 | unless (defined $AnyEvent::TLS::VERSION) { |
|
|
2180 | eval { |
|
|
2181 | require Net::SSLeay; |
|
|
2182 | require AnyEvent::TLS; |
|
|
2183 | 1 |
|
|
2184 | } or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system"); |
|
|
2185 | } |
|
|
2186 | |
1958 | $self->{tls} = $tls; |
2187 | $self->{tls} = $tls; |
1959 | $self->{tls_ctx} = $ctx if @_ > 2; |
2188 | $self->{tls_ctx} = $ctx if @_ > 2; |
1960 | |
2189 | |
1961 | return unless $self->{fh}; |
2190 | return unless $self->{fh}; |
1962 | |
2191 | |
1963 | require Net::SSLeay; |
|
|
1964 | |
|
|
1965 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
2192 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
1966 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
2193 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
1967 | |
2194 | |
1968 | $tls = delete $self->{tls}; |
2195 | $tls = delete $self->{tls}; |
1969 | $ctx = $self->{tls_ctx}; |
2196 | $ctx = $self->{tls_ctx}; |
1970 | |
2197 | |
1971 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
2198 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
1972 | |
2199 | |
1973 | if ("HASH" eq ref $ctx) { |
2200 | if ("HASH" eq ref $ctx) { |
1974 | require AnyEvent::TLS; |
|
|
1975 | |
|
|
1976 | if ($ctx->{cache}) { |
2201 | if ($ctx->{cache}) { |
1977 | my $key = $ctx+0; |
2202 | my $key = $ctx+0; |
1978 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
2203 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
1979 | } else { |
2204 | } else { |
1980 | $ctx = new AnyEvent::TLS %$ctx; |
2205 | $ctx = new AnyEvent::TLS %$ctx; |
… | |
… | |
2002 | Net::SSLeay::CTX_set_mode ($tls, 1|2); |
2227 | Net::SSLeay::CTX_set_mode ($tls, 1|2); |
2003 | |
2228 | |
2004 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2229 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2005 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2230 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2006 | |
2231 | |
2007 | Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf}); |
2232 | Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf}); |
|
|
2233 | $self->{rbuf} = ""; |
2008 | |
2234 | |
2009 | Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); |
2235 | Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); |
2010 | |
2236 | |
2011 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
2237 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
2012 | if $self->{on_starttls}; |
2238 | if $self->{on_starttls}; |
… | |
… | |
2194 | Probably because your C<on_error> callback is being called instead: When |
2420 | Probably because your C<on_error> callback is being called instead: When |
2195 | you have outstanding requests in your read queue, then an EOF is |
2421 | you have outstanding requests in your read queue, then an EOF is |
2196 | considered an error as you clearly expected some data. |
2422 | considered an error as you clearly expected some data. |
2197 | |
2423 | |
2198 | To avoid this, make sure you have an empty read queue whenever your handle |
2424 | To avoid this, make sure you have an empty read queue whenever your handle |
2199 | is supposed to be "idle" (i.e. connection closes are O.K.). You cna set |
2425 | is supposed to be "idle" (i.e. connection closes are O.K.). You can set |
2200 | an C<on_read> handler that simply pushes the first read requests in the |
2426 | an C<on_read> handler that simply pushes the first read requests in the |
2201 | queue. |
2427 | queue. |
2202 | |
2428 | |
2203 | See also the next question, which explains this in a bit more detail. |
2429 | See also the next question, which explains this in a bit more detail. |
2204 | |
2430 | |
… | |
… | |
2212 | handles requests until the server gets some QUIT command, causing it to |
2438 | handles requests until the server gets some QUIT command, causing it to |
2213 | close the connection first (highly desirable for a busy TCP server). A |
2439 | close the connection first (highly desirable for a busy TCP server). A |
2214 | client dropping the connection is an error, which means this variant can |
2440 | client dropping the connection is an error, which means this variant can |
2215 | detect an unexpected detection close. |
2441 | detect an unexpected detection close. |
2216 | |
2442 | |
2217 | To handle this case, always make sure you have a on-empty read queue, by |
2443 | To handle this case, always make sure you have a non-empty read queue, by |
2218 | pushing the "read request start" handler on it: |
2444 | pushing the "read request start" handler on it: |
2219 | |
2445 | |
2220 | # we assume a request starts with a single line |
2446 | # we assume a request starts with a single line |
2221 | my @start_request; @start_request = (line => sub { |
2447 | my @start_request; @start_request = (line => sub { |
2222 | my ($hdl, $line) = @_; |
2448 | my ($hdl, $line) = @_; |
… | |
… | |
2235 | some data and raises the C<EPIPE> error when the connction is dropped |
2461 | some data and raises the C<EPIPE> error when the connction is dropped |
2236 | unexpectedly. |
2462 | unexpectedly. |
2237 | |
2463 | |
2238 | The second variant is a protocol where the client can drop the connection |
2464 | The second variant is a protocol where the client can drop the connection |
2239 | at any time. For TCP, this means that the server machine may run out of |
2465 | at any time. For TCP, this means that the server machine may run out of |
2240 | sockets easier, and in general, it means you cnanot distinguish a protocl |
2466 | sockets easier, and in general, it means you cannot distinguish a protocl |
2241 | failure/client crash from a normal connection close. Nevertheless, these |
2467 | failure/client crash from a normal connection close. Nevertheless, these |
2242 | kinds of protocols are common (and sometimes even the best solution to the |
2468 | kinds of protocols are common (and sometimes even the best solution to the |
2243 | problem). |
2469 | problem). |
2244 | |
2470 | |
2245 | Having an outstanding read request at all times is possible if you ignore |
2471 | Having an outstanding read request at all times is possible if you ignore |
… | |
… | |
2297 | $handle->on_eof (undef); |
2523 | $handle->on_eof (undef); |
2298 | $handle->on_error (sub { |
2524 | $handle->on_error (sub { |
2299 | my $data = delete $_[0]{rbuf}; |
2525 | my $data = delete $_[0]{rbuf}; |
2300 | }); |
2526 | }); |
2301 | |
2527 | |
|
|
2528 | Note that this example removes the C<rbuf> member from the handle object, |
|
|
2529 | which is not normally allowed by the API. It is expressly permitted in |
|
|
2530 | this case only, as the handle object needs to be destroyed afterwards. |
|
|
2531 | |
2302 | The reason to use C<on_error> is that TCP connections, due to latencies |
2532 | The reason to use C<on_error> is that TCP connections, due to latencies |
2303 | and packets loss, might get closed quite violently with an error, when in |
2533 | and packets loss, might get closed quite violently with an error, when in |
2304 | fact all data has been received. |
2534 | fact all data has been received. |
2305 | |
2535 | |
2306 | It is usually better to use acknowledgements when transferring data, |
2536 | It is usually better to use acknowledgements when transferring data, |
… | |
… | |
2316 | C<low_water_mark> this will be called precisely when all data has been |
2546 | C<low_water_mark> this will be called precisely when all data has been |
2317 | written to the socket: |
2547 | written to the socket: |
2318 | |
2548 | |
2319 | $handle->push_write (...); |
2549 | $handle->push_write (...); |
2320 | $handle->on_drain (sub { |
2550 | $handle->on_drain (sub { |
2321 | warn "all data submitted to the kernel\n"; |
2551 | AE::log debug => "All data submitted to the kernel."; |
2322 | undef $handle; |
2552 | undef $handle; |
2323 | }); |
2553 | }); |
2324 | |
2554 | |
2325 | If you just want to queue some data and then signal EOF to the other side, |
2555 | If you just want to queue some data and then signal EOF to the other side, |
2326 | consider using C<< ->push_shutdown >> instead. |
2556 | consider using C<< ->push_shutdown >> instead. |
… | |
… | |
2410 | When you have intermediate CA certificates that your clients might not |
2640 | When you have intermediate CA certificates that your clients might not |
2411 | know about, just append them to the C<cert_file>. |
2641 | know about, just append them to the C<cert_file>. |
2412 | |
2642 | |
2413 | =back |
2643 | =back |
2414 | |
2644 | |
2415 | |
|
|
2416 | =head1 SUBCLASSING AnyEvent::Handle |
2645 | =head1 SUBCLASSING AnyEvent::Handle |
2417 | |
2646 | |
2418 | In many cases, you might want to subclass AnyEvent::Handle. |
2647 | In many cases, you might want to subclass AnyEvent::Handle. |
2419 | |
2648 | |
2420 | To make this easier, a given version of AnyEvent::Handle uses these |
2649 | To make this easier, a given version of AnyEvent::Handle uses these |
… | |
… | |
2446 | |
2675 | |
2447 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
2676 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
2448 | |
2677 | |
2449 | =cut |
2678 | =cut |
2450 | |
2679 | |
2451 | 1; # End of AnyEvent::Handle |
2680 | 1 |
|
|
2681 | |