… | |
… | |
73 | The filehandle this L<AnyEvent::Handle> object will operate on. |
73 | The filehandle this L<AnyEvent::Handle> object will operate on. |
74 | |
74 | |
75 | NOTE: The filehandle will be set to non-blocking (using |
75 | NOTE: The filehandle will be set to non-blocking (using |
76 | AnyEvent::Util::fh_nonblocking). |
76 | AnyEvent::Util::fh_nonblocking). |
77 | |
77 | |
78 | =item on_eof => $cb->($self) |
78 | =item on_eof => $cb->($handle) |
79 | |
79 | |
80 | Set the callback to be called on EOF. |
80 | Set the callback to be called on EOF. |
81 | |
81 | |
82 | While not mandatory, it is highly recommended to set an eof callback, |
82 | While not mandatory, it is highly recommended to set an eof callback, |
83 | otherwise you might end up with a closed socket while you are still |
83 | otherwise you might end up with a closed socket while you are still |
84 | waiting for data. |
84 | waiting for data. |
85 | |
85 | |
86 | =item on_error => $cb->($self) |
86 | =item on_error => $cb->($handle) |
87 | |
87 | |
88 | This is the fatal error callback, that is called when, well, a fatal error |
88 | This is the fatal error callback, that is called when, well, a fatal error |
89 | occurs, such as not being able to resolve the hostname, failure to connect |
89 | occurs, such as not being able to resolve the hostname, failure to connect |
90 | or a read error. |
90 | or a read error. |
91 | |
91 | |
… | |
… | |
100 | |
100 | |
101 | While not mandatory, it is I<highly> recommended to set this callback, as |
101 | While not mandatory, it is I<highly> recommended to set this callback, as |
102 | you will not be notified of errors otherwise. The default simply calls |
102 | you will not be notified of errors otherwise. The default simply calls |
103 | die. |
103 | die. |
104 | |
104 | |
105 | =item on_read => $cb->($self) |
105 | =item on_read => $cb->($handle) |
106 | |
106 | |
107 | This sets the default read callback, which is called when data arrives |
107 | This sets the default read callback, which is called when data arrives |
108 | and no read request is in the queue. |
108 | and no read request is in the queue. |
109 | |
109 | |
110 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
110 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
111 | method or access the C<$self->{rbuf}> member directly. |
111 | method or access the C<$handle->{rbuf}> member directly. |
112 | |
112 | |
113 | When an EOF condition is detected then AnyEvent::Handle will first try to |
113 | When an EOF condition is detected then AnyEvent::Handle will first try to |
114 | feed all the remaining data to the queued callbacks and C<on_read> before |
114 | feed all the remaining data to the queued callbacks and C<on_read> before |
115 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
115 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
116 | error will be raised (with C<$!> set to C<EPIPE>). |
116 | error will be raised (with C<$!> set to C<EPIPE>). |
117 | |
117 | |
118 | =item on_drain => $cb->() |
118 | =item on_drain => $cb->($handle) |
119 | |
119 | |
120 | This sets the callback that is called when the write buffer becomes empty |
120 | This sets the callback that is called when the write buffer becomes empty |
121 | (or when the callback is set and the buffer is empty already). |
121 | (or when the callback is set and the buffer is empty already). |
122 | |
122 | |
123 | To append to the write buffer, use the C<< ->push_write >> method. |
123 | To append to the write buffer, use the C<< ->push_write >> method. |
… | |
… | |
168 | |
168 | |
169 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
169 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
170 | (unless a connection object was specified directly). If this parameter is |
170 | (unless a connection object was specified directly). If this parameter is |
171 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
171 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
172 | |
172 | |
|
|
173 | =item json => JSON or JSON::XS object |
|
|
174 | |
|
|
175 | This is the json coder object used by the C<json> read and write types. |
|
|
176 | |
|
|
177 | If you don't supply it, then AnyEvent::Handle will create and use a |
|
|
178 | suitable one, which will write and expect UTF-8 encoded JSON texts. |
|
|
179 | |
|
|
180 | Note that you are responsible to depend on the JSON module if you want to |
|
|
181 | use this functionality, as AnyEvent does not have a dependency itself. |
|
|
182 | |
173 | =item filter_r => $cb |
183 | =item filter_r => $cb |
174 | |
184 | |
175 | =item filter_w => $cb |
185 | =item filter_w => $cb |
176 | |
186 | |
177 | These exist, but are undocumented at this time. |
187 | These exist, but are undocumented at this time. |
… | |
… | |
378 | sprintf "%d:%s,", (length $string), $string |
388 | sprintf "%d:%s,", (length $string), $string |
379 | }; |
389 | }; |
380 | |
390 | |
381 | =item json => $array_or_hashref |
391 | =item json => $array_or_hashref |
382 | |
392 | |
|
|
393 | Encodes the given hash or array reference into a JSON object. Unless you |
|
|
394 | provide your own JSON object, this means it will be encoded to JSON text |
|
|
395 | in UTF-8. |
|
|
396 | |
|
|
397 | JSON objects (and arrays) are self-delimiting, so you can write JSON at |
|
|
398 | one end of a handle and read them at the other end without using any |
|
|
399 | additional framing. |
|
|
400 | |
|
|
401 | The generated JSON text is guaranteed not to contain any newlines: While |
|
|
402 | this module doesn't need delimiters after or between JSON texts to be |
|
|
403 | able to read them, many other languages depend on that. |
|
|
404 | |
|
|
405 | A simple RPC protocol that interoperates easily with others is to send |
|
|
406 | JSON arrays (or objects, although arrays are usually the better choice as |
|
|
407 | they mimic how function argument passing works) and a newline after each |
|
|
408 | JSON text: |
|
|
409 | |
|
|
410 | $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever |
|
|
411 | $handle->push_write ("\012"); |
|
|
412 | |
|
|
413 | An AnyEvent::Handle receiver would simply use the C<json> read type and |
|
|
414 | rely on the fact that the newline will be skipped as leading whitespace: |
|
|
415 | |
|
|
416 | $handle->push_read (json => sub { my $array = $_[1]; ... }); |
|
|
417 | |
|
|
418 | Other languages could read single lines terminated by a newline and pass |
|
|
419 | this line into their JSON decoder of choice. |
|
|
420 | |
|
|
421 | =cut |
|
|
422 | |
|
|
423 | register_write_type json => sub { |
|
|
424 | my ($self, $ref) = @_; |
|
|
425 | |
|
|
426 | require JSON; |
|
|
427 | |
|
|
428 | $self->{json} ? $self->{json}->encode ($ref) |
|
|
429 | : JSON::encode_json ($ref) |
|
|
430 | }; |
|
|
431 | |
383 | =item AnyEvent::Handle::register_write_type type => $coderef->($self, @args) |
432 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
384 | |
433 | |
385 | This function (not method) lets you add your own types to C<push_write>. |
434 | This function (not method) lets you add your own types to C<push_write>. |
386 | Whenever the given C<type> is used, C<push_write> will invoke the code |
435 | Whenever the given C<type> is used, C<push_write> will invoke the code |
387 | reference with the handle object and the remaining arguments. |
436 | reference with the handle object and the remaining arguments. |
388 | |
437 | |
… | |
… | |
628 | Predefined types are (if you have ideas for additional types, feel free to |
677 | Predefined types are (if you have ideas for additional types, feel free to |
629 | drop by and tell us): |
678 | drop by and tell us): |
630 | |
679 | |
631 | =over 4 |
680 | =over 4 |
632 | |
681 | |
633 | =item chunk => $octets, $cb->($self, $data) |
682 | =item chunk => $octets, $cb->($handle, $data) |
634 | |
683 | |
635 | Invoke the callback only once C<$octets> bytes have been read. Pass the |
684 | Invoke the callback only once C<$octets> bytes have been read. Pass the |
636 | data read to the callback. The callback will never be called with less |
685 | data read to the callback. The callback will never be called with less |
637 | data. |
686 | data. |
638 | |
687 | |
… | |
… | |
661 | |
710 | |
662 | sub unshift_read_chunk { |
711 | sub unshift_read_chunk { |
663 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
712 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
664 | } |
713 | } |
665 | |
714 | |
666 | =item line => [$eol, ]$cb->($self, $line, $eol) |
715 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
667 | |
716 | |
668 | The callback will be called only once a full line (including the end of |
717 | The callback will be called only once a full line (including the end of |
669 | line marker, C<$eol>) has been read. This line (excluding the end of line |
718 | line marker, C<$eol>) has been read. This line (excluding the end of line |
670 | marker) will be passed to the callback as second argument (C<$line>), and |
719 | marker) will be passed to the callback as second argument (C<$line>), and |
671 | the end of line marker as the third argument (C<$eol>). |
720 | the end of line marker as the third argument (C<$eol>). |
… | |
… | |
708 | sub unshift_read_line { |
757 | sub unshift_read_line { |
709 | my $self = shift; |
758 | my $self = shift; |
710 | $self->unshift_read (line => @_); |
759 | $self->unshift_read (line => @_); |
711 | } |
760 | } |
712 | |
761 | |
713 | =item netstring => $cb->($string) |
762 | =item netstring => $cb->($handle, $string) |
714 | |
763 | |
715 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
764 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
716 | |
765 | |
717 | Throws an error with C<$!> set to EBADMSG on format violations. |
766 | Throws an error with C<$!> set to EBADMSG on format violations. |
718 | |
767 | |
… | |
… | |
746 | |
795 | |
747 | 1 |
796 | 1 |
748 | } |
797 | } |
749 | }; |
798 | }; |
750 | |
799 | |
751 | =item regex => $accept[, $reject[, $skip], $cb->($data) |
800 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
752 | |
801 | |
753 | Makes a regex match against the regex object C<$accept> and returns |
802 | Makes a regex match against the regex object C<$accept> and returns |
754 | everything up to and including the match. |
803 | everything up to and including the match. |
755 | |
804 | |
756 | Example: read a single line terminated by '\n'. |
805 | Example: read a single line terminated by '\n'. |
… | |
… | |
817 | |
866 | |
818 | () |
867 | () |
819 | } |
868 | } |
820 | }; |
869 | }; |
821 | |
870 | |
|
|
871 | =item json => $cb->($handle, $hash_or_arrayref) |
|
|
872 | |
|
|
873 | Reads a JSON object or array, decodes it and passes it to the callback. |
|
|
874 | |
|
|
875 | If a C<json> object was passed to the constructor, then that will be used |
|
|
876 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
|
|
877 | |
|
|
878 | This read type uses the incremental parser available with JSON version |
|
|
879 | 2.09 (and JSON::XS version 2.2) and above. You have to provide a |
|
|
880 | dependency on your own: this module will load the JSON module, but |
|
|
881 | AnyEvent does not depend on it itself. |
|
|
882 | |
|
|
883 | Since JSON texts are fully self-delimiting, the C<json> read and write |
|
|
884 | types are an ideal simple RPC protocol: just exchange JSON datagrams. See |
|
|
885 | the C<json> write type description, above, for an actual example. |
|
|
886 | |
|
|
887 | =cut |
|
|
888 | |
|
|
889 | register_read_type json => sub { |
|
|
890 | my ($self, $cb, $accept, $reject, $skip) = @_; |
|
|
891 | |
|
|
892 | require JSON; |
|
|
893 | |
|
|
894 | my $data; |
|
|
895 | my $rbuf = \$self->{rbuf}; |
|
|
896 | |
|
|
897 | my $json = $self->{json} ||= JSON->new->utf8; |
|
|
898 | |
|
|
899 | sub { |
|
|
900 | my $ref = $json->incr_parse ($self->{rbuf}); |
|
|
901 | |
|
|
902 | if ($ref) { |
|
|
903 | $self->{rbuf} = $json->incr_text; |
|
|
904 | $json->incr_text = ""; |
|
|
905 | $cb->($self, $ref); |
|
|
906 | |
|
|
907 | 1 |
|
|
908 | } else { |
|
|
909 | $self->{rbuf} = ""; |
|
|
910 | () |
|
|
911 | } |
|
|
912 | } |
|
|
913 | }; |
|
|
914 | |
822 | =back |
915 | =back |
823 | |
916 | |
824 | =item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args) |
917 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
825 | |
918 | |
826 | This function (not method) lets you add your own types to C<push_read>. |
919 | This function (not method) lets you add your own types to C<push_read>. |
827 | |
920 | |
828 | Whenever the given C<type> is used, C<push_read> will invoke the code |
921 | Whenever the given C<type> is used, C<push_read> will invoke the code |
829 | reference with the handle object, the callback and the remaining |
922 | reference with the handle object, the callback and the remaining |
… | |
… | |
831 | |
924 | |
832 | The code reference is supposed to return a callback (usually a closure) |
925 | The code reference is supposed to return a callback (usually a closure) |
833 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
926 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
834 | |
927 | |
835 | It should invoke the passed callback when it is done reading (remember to |
928 | It should invoke the passed callback when it is done reading (remember to |
836 | pass C<$self> as first argument as all other callbacks do that). |
929 | pass C<$handle> as first argument as all other callbacks do that). |
837 | |
930 | |
838 | Note that this is a function, and all types registered this way will be |
931 | Note that this is a function, and all types registered this way will be |
839 | global, so try to use unique names. |
932 | global, so try to use unique names. |
840 | |
933 | |
841 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
934 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |