… | |
… | |
2 | |
2 | |
3 | no warnings; |
3 | no warnings; |
4 | use strict; |
4 | use strict; |
5 | |
5 | |
6 | use AnyEvent (); |
6 | use AnyEvent (); |
7 | use AnyEvent::Util (); |
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
8 | use Scalar::Util (); |
8 | use Scalar::Util (); |
9 | use Carp (); |
9 | use Carp (); |
10 | use Fcntl (); |
10 | use Fcntl (); |
11 | use Errno qw/EAGAIN EINTR/; |
11 | use Errno qw(EAGAIN EINTR); |
12 | |
12 | |
13 | =head1 NAME |
13 | =head1 NAME |
14 | |
14 | |
15 | AnyEvent::Handle - non-blocking I/O on filehandles via AnyEvent |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
16 | |
16 | |
17 | This module is experimental. |
|
|
18 | |
|
|
19 | =cut |
17 | =cut |
20 | |
18 | |
21 | our $VERSION = '0.04'; |
19 | our $VERSION = 4.151; |
22 | |
20 | |
23 | =head1 SYNOPSIS |
21 | =head1 SYNOPSIS |
24 | |
22 | |
25 | use AnyEvent; |
23 | use AnyEvent; |
26 | use AnyEvent::Handle; |
24 | use AnyEvent::Handle; |
27 | |
25 | |
28 | my $cv = AnyEvent->condvar; |
26 | my $cv = AnyEvent->condvar; |
29 | |
27 | |
30 | my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN); |
28 | my $handle = |
31 | |
|
|
32 | #TODO |
|
|
33 | |
|
|
34 | # or use the constructor to pass the callback: |
|
|
35 | |
|
|
36 | my $ae_fh2 = |
|
|
37 | AnyEvent::Handle->new ( |
29 | AnyEvent::Handle->new ( |
38 | fh => \*STDIN, |
30 | fh => \*STDIN, |
39 | on_eof => sub { |
31 | on_eof => sub { |
40 | $cv->broadcast; |
32 | $cv->broadcast; |
41 | }, |
33 | }, |
42 | #TODO |
|
|
43 | ); |
34 | ); |
44 | |
35 | |
45 | $cv->wait; |
36 | # send some request line |
|
|
37 | $handle->push_write ("getinfo\015\012"); |
|
|
38 | |
|
|
39 | # read the response line |
|
|
40 | $handle->push_read (line => sub { |
|
|
41 | my ($handle, $line) = @_; |
|
|
42 | warn "read line <$line>\n"; |
|
|
43 | $cv->send; |
|
|
44 | }); |
|
|
45 | |
|
|
46 | $cv->recv; |
46 | |
47 | |
47 | =head1 DESCRIPTION |
48 | =head1 DESCRIPTION |
48 | |
49 | |
49 | This module is a helper module to make it easier to do event-based I/O on |
50 | This module is a helper module to make it easier to do event-based I/O on |
50 | filehandles. For utility functions for doing non-blocking connects and accepts |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
… | |
… | |
72 | The filehandle this L<AnyEvent::Handle> object will operate on. |
73 | The filehandle this L<AnyEvent::Handle> object will operate on. |
73 | |
74 | |
74 | NOTE: The filehandle will be set to non-blocking (using |
75 | NOTE: The filehandle will be set to non-blocking (using |
75 | AnyEvent::Util::fh_nonblocking). |
76 | AnyEvent::Util::fh_nonblocking). |
76 | |
77 | |
77 | =item on_eof => $cb->($self) [MANDATORY] |
|
|
78 | |
|
|
79 | Set the callback to be called on EOF. |
|
|
80 | |
|
|
81 | =item on_error => $cb->($self) |
78 | =item on_eof => $cb->($handle) |
82 | |
79 | |
|
|
80 | Set the callback to be called when an end-of-file condition is detcted, |
|
|
81 | i.e. in the case of a socket, when the other side has closed the |
|
|
82 | connection cleanly. |
|
|
83 | |
|
|
84 | While not mandatory, it is highly recommended to set an eof callback, |
|
|
85 | otherwise you might end up with a closed socket while you are still |
|
|
86 | waiting for data. |
|
|
87 | |
|
|
88 | =item on_error => $cb->($handle, $fatal) |
|
|
89 | |
83 | This is the fatal error callback, that is called when, well, a fatal error |
90 | This is the error callback, which is called when, well, some error |
84 | ocurs, such as not being able to resolve the hostname, failure to connect |
91 | occured, such as not being able to resolve the hostname, failure to |
85 | or a read error. |
92 | connect or a read error. |
86 | |
93 | |
87 | The object will not be in a usable state when this callback has been |
94 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
88 | called. |
95 | fatal errors the handle object will be shut down and will not be |
|
|
96 | usable. Non-fatal errors can be retried by simply returning, but it is |
|
|
97 | recommended to simply ignore this parameter and instead abondon the handle |
|
|
98 | object when this callback is invoked. |
89 | |
99 | |
90 | On callback entrance, the value of C<$!> contains the operating system |
100 | On callback entrance, the value of C<$!> contains the operating system |
91 | error (or C<ENOSPC> or C<EPIPE>). |
101 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
92 | |
102 | |
93 | While not mandatory, it is I<highly> recommended to set this callback, as |
103 | While not mandatory, it is I<highly> recommended to set this callback, as |
94 | you will not be notified of errors otherwise. The default simply calls |
104 | you will not be notified of errors otherwise. The default simply calls |
95 | die. |
105 | C<croak>. |
96 | |
106 | |
97 | =item on_read => $cb->($self) |
107 | =item on_read => $cb->($handle) |
98 | |
108 | |
99 | This sets the default read callback, which is called when data arrives |
109 | This sets the default read callback, which is called when data arrives |
100 | and no read request is in the queue. |
110 | and no read request is in the queue (unlike read queue callbacks, this |
|
|
111 | callback will only be called when at least one octet of data is in the |
|
|
112 | read buffer). |
101 | |
113 | |
102 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
114 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
103 | method or acces sthe C<$self->{rbuf}> member directly. |
115 | method or access the C<$handle->{rbuf}> member directly. |
104 | |
116 | |
105 | When an EOF condition is detected then AnyEvent::Handle will first try to |
117 | When an EOF condition is detected then AnyEvent::Handle will first try to |
106 | feed all the remaining data to the queued callbacks and C<on_read> before |
118 | feed all the remaining data to the queued callbacks and C<on_read> before |
107 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
119 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
108 | error will be raised (with C<$!> set to C<EPIPE>). |
120 | error will be raised (with C<$!> set to C<EPIPE>). |
109 | |
121 | |
110 | =item on_drain => $cb->() |
122 | =item on_drain => $cb->($handle) |
111 | |
123 | |
112 | This sets the callback that is called when the write buffer becomes empty |
124 | This sets the callback that is called when the write buffer becomes empty |
113 | (or when the callback is set and the buffer is empty already). |
125 | (or when the callback is set and the buffer is empty already). |
114 | |
126 | |
115 | To append to the write buffer, use the C<< ->push_write >> method. |
127 | To append to the write buffer, use the C<< ->push_write >> method. |
|
|
128 | |
|
|
129 | This callback is useful when you don't want to put all of your write data |
|
|
130 | into the queue at once, for example, when you want to write the contents |
|
|
131 | of some file to the socket you might not want to read the whole file into |
|
|
132 | memory and push it into the queue, but instead only read more data from |
|
|
133 | the file when the write queue becomes empty. |
|
|
134 | |
|
|
135 | =item timeout => $fractional_seconds |
|
|
136 | |
|
|
137 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
|
|
138 | seconds pass without a successful read or write on the underlying file |
|
|
139 | handle, the C<on_timeout> callback will be invoked (and if that one is |
|
|
140 | missing, an C<ETIMEDOUT> error will be raised). |
|
|
141 | |
|
|
142 | Note that timeout processing is also active when you currently do not have |
|
|
143 | any outstanding read or write requests: If you plan to keep the connection |
|
|
144 | idle then you should disable the timout temporarily or ignore the timeout |
|
|
145 | in the C<on_timeout> callback. |
|
|
146 | |
|
|
147 | Zero (the default) disables this timeout. |
|
|
148 | |
|
|
149 | =item on_timeout => $cb->($handle) |
|
|
150 | |
|
|
151 | Called whenever the inactivity timeout passes. If you return from this |
|
|
152 | callback, then the timeout will be reset as if some activity had happened, |
|
|
153 | so this condition is not fatal in any way. |
116 | |
154 | |
117 | =item rbuf_max => <bytes> |
155 | =item rbuf_max => <bytes> |
118 | |
156 | |
119 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
157 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
120 | when the read buffer ever (strictly) exceeds this size. This is useful to |
158 | when the read buffer ever (strictly) exceeds this size. This is useful to |
… | |
… | |
127 | isn't finished). |
165 | isn't finished). |
128 | |
166 | |
129 | =item read_size => <bytes> |
167 | =item read_size => <bytes> |
130 | |
168 | |
131 | The default read block size (the amount of bytes this module will try to read |
169 | The default read block size (the amount of bytes this module will try to read |
132 | on each [loop iteration). Default: C<4096>. |
170 | during each (loop iteration). Default: C<8192>. |
133 | |
171 | |
134 | =item low_water_mark => <bytes> |
172 | =item low_water_mark => <bytes> |
135 | |
173 | |
136 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
174 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
137 | buffer: If the write reaches this size or gets even samller it is |
175 | buffer: If the write reaches this size or gets even samller it is |
138 | considered empty. |
176 | considered empty. |
139 | |
177 | |
|
|
178 | =item linger => <seconds> |
|
|
179 | |
|
|
180 | If non-zero (default: C<3600>), then the destructor of the |
|
|
181 | AnyEvent::Handle object will check wether there is still outstanding write |
|
|
182 | data and will install a watcher that will write out this data. No errors |
|
|
183 | will be reported (this mostly matches how the operating system treats |
|
|
184 | outstanding data at socket close time). |
|
|
185 | |
|
|
186 | This will not work for partial TLS data that could not yet been |
|
|
187 | encoded. This data will be lost. |
|
|
188 | |
|
|
189 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
|
|
190 | |
|
|
191 | When this parameter is given, it enables TLS (SSL) mode, that means it |
|
|
192 | will start making tls handshake and will transparently encrypt/decrypt |
|
|
193 | data. |
|
|
194 | |
|
|
195 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
|
|
196 | automatically when you try to create a TLS handle). |
|
|
197 | |
|
|
198 | For the TLS server side, use C<accept>, and for the TLS client side of a |
|
|
199 | connection, use C<connect> mode. |
|
|
200 | |
|
|
201 | You can also provide your own TLS connection object, but you have |
|
|
202 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
|
|
203 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
|
|
204 | AnyEvent::Handle. |
|
|
205 | |
|
|
206 | See the C<starttls> method if you need to start TLs negotiation later. |
|
|
207 | |
|
|
208 | =item tls_ctx => $ssl_ctx |
|
|
209 | |
|
|
210 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
|
|
211 | (unless a connection object was specified directly). If this parameter is |
|
|
212 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
|
|
213 | |
|
|
214 | =item json => JSON or JSON::XS object |
|
|
215 | |
|
|
216 | This is the json coder object used by the C<json> read and write types. |
|
|
217 | |
|
|
218 | If you don't supply it, then AnyEvent::Handle will create and use a |
|
|
219 | suitable one, which will write and expect UTF-8 encoded JSON texts. |
|
|
220 | |
|
|
221 | Note that you are responsible to depend on the JSON module if you want to |
|
|
222 | use this functionality, as AnyEvent does not have a dependency itself. |
|
|
223 | |
|
|
224 | =item filter_r => $cb |
|
|
225 | |
|
|
226 | =item filter_w => $cb |
|
|
227 | |
|
|
228 | These exist, but are undocumented at this time. |
|
|
229 | |
140 | =back |
230 | =back |
141 | |
231 | |
142 | =cut |
232 | =cut |
143 | |
233 | |
144 | sub new { |
234 | sub new { |
… | |
… | |
148 | |
238 | |
149 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
239 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
150 | |
240 | |
151 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
241 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
152 | |
242 | |
153 | $self->on_eof ((delete $self->{on_eof} ) or Carp::croak "mandatory argument on_eof is missing"); |
243 | if ($self->{tls}) { |
|
|
244 | require Net::SSLeay; |
|
|
245 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
|
|
246 | } |
154 | |
247 | |
155 | $self->on_error (delete $self->{on_error}) if $self->{on_error}; |
248 | $self->{_activity} = AnyEvent->now; |
|
|
249 | $self->_timeout; |
|
|
250 | |
156 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
251 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
157 | $self->on_read (delete $self->{on_read} ) if $self->{on_read}; |
|
|
158 | |
252 | |
159 | $self->start_read; |
253 | $self->start_read |
|
|
254 | if $self->{on_read}; |
160 | |
255 | |
161 | $self |
256 | $self |
162 | } |
257 | } |
163 | |
258 | |
164 | sub _shutdown { |
259 | sub _shutdown { |
165 | my ($self) = @_; |
260 | my ($self) = @_; |
166 | |
261 | |
|
|
262 | delete $self->{_tw}; |
167 | delete $self->{rw}; |
263 | delete $self->{_rw}; |
168 | delete $self->{ww}; |
264 | delete $self->{_ww}; |
169 | delete $self->{fh}; |
265 | delete $self->{fh}; |
170 | } |
|
|
171 | |
266 | |
|
|
267 | $self->stoptls; |
|
|
268 | } |
|
|
269 | |
172 | sub error { |
270 | sub _error { |
173 | my ($self) = @_; |
271 | my ($self, $errno, $fatal) = @_; |
174 | |
272 | |
175 | { |
|
|
176 | local $!; |
|
|
177 | $self->_shutdown; |
273 | $self->_shutdown |
178 | } |
274 | if $fatal; |
|
|
275 | |
|
|
276 | $! = $errno; |
179 | |
277 | |
180 | if ($self->{on_error}) { |
278 | if ($self->{on_error}) { |
181 | $self->{on_error}($self); |
279 | $self->{on_error}($self, $fatal); |
182 | } else { |
280 | } else { |
183 | die "AnyEvent::Handle uncaught fatal error: $!"; |
281 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
184 | } |
282 | } |
185 | } |
283 | } |
186 | |
284 | |
187 | =item $fh = $handle->fh |
285 | =item $fh = $handle->fh |
188 | |
286 | |
189 | This method returns the filehandle of the L<AnyEvent::Handle> object. |
287 | This method returns the file handle of the L<AnyEvent::Handle> object. |
190 | |
288 | |
191 | =cut |
289 | =cut |
192 | |
290 | |
193 | sub fh { $_[0]->{fh} } |
291 | sub fh { $_[0]{fh} } |
194 | |
292 | |
195 | =item $handle->on_error ($cb) |
293 | =item $handle->on_error ($cb) |
196 | |
294 | |
197 | Replace the current C<on_error> callback (see the C<on_error> constructor argument). |
295 | Replace the current C<on_error> callback (see the C<on_error> constructor argument). |
198 | |
296 | |
… | |
… | |
210 | |
308 | |
211 | sub on_eof { |
309 | sub on_eof { |
212 | $_[0]{on_eof} = $_[1]; |
310 | $_[0]{on_eof} = $_[1]; |
213 | } |
311 | } |
214 | |
312 | |
|
|
313 | =item $handle->on_timeout ($cb) |
|
|
314 | |
|
|
315 | Replace the current C<on_timeout> callback, or disables the callback |
|
|
316 | (but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor |
|
|
317 | argument. |
|
|
318 | |
|
|
319 | =cut |
|
|
320 | |
|
|
321 | sub on_timeout { |
|
|
322 | $_[0]{on_timeout} = $_[1]; |
|
|
323 | } |
|
|
324 | |
|
|
325 | ############################################################################# |
|
|
326 | |
|
|
327 | =item $handle->timeout ($seconds) |
|
|
328 | |
|
|
329 | Configures (or disables) the inactivity timeout. |
|
|
330 | |
|
|
331 | =cut |
|
|
332 | |
|
|
333 | sub timeout { |
|
|
334 | my ($self, $timeout) = @_; |
|
|
335 | |
|
|
336 | $self->{timeout} = $timeout; |
|
|
337 | $self->_timeout; |
|
|
338 | } |
|
|
339 | |
|
|
340 | # reset the timeout watcher, as neccessary |
|
|
341 | # also check for time-outs |
|
|
342 | sub _timeout { |
|
|
343 | my ($self) = @_; |
|
|
344 | |
|
|
345 | if ($self->{timeout}) { |
|
|
346 | my $NOW = AnyEvent->now; |
|
|
347 | |
|
|
348 | # when would the timeout trigger? |
|
|
349 | my $after = $self->{_activity} + $self->{timeout} - $NOW; |
|
|
350 | |
|
|
351 | # now or in the past already? |
|
|
352 | if ($after <= 0) { |
|
|
353 | $self->{_activity} = $NOW; |
|
|
354 | |
|
|
355 | if ($self->{on_timeout}) { |
|
|
356 | $self->{on_timeout}($self); |
|
|
357 | } else { |
|
|
358 | $self->_error (&Errno::ETIMEDOUT); |
|
|
359 | } |
|
|
360 | |
|
|
361 | # callback could have changed timeout value, optimise |
|
|
362 | return unless $self->{timeout}; |
|
|
363 | |
|
|
364 | # calculate new after |
|
|
365 | $after = $self->{timeout}; |
|
|
366 | } |
|
|
367 | |
|
|
368 | Scalar::Util::weaken $self; |
|
|
369 | return unless $self; # ->error could have destroyed $self |
|
|
370 | |
|
|
371 | $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { |
|
|
372 | delete $self->{_tw}; |
|
|
373 | $self->_timeout; |
|
|
374 | }); |
|
|
375 | } else { |
|
|
376 | delete $self->{_tw}; |
|
|
377 | } |
|
|
378 | } |
|
|
379 | |
215 | ############################################################################# |
380 | ############################################################################# |
216 | |
381 | |
217 | =back |
382 | =back |
218 | |
383 | |
219 | =head2 WRITE QUEUE |
384 | =head2 WRITE QUEUE |
… | |
… | |
222 | for reading. |
387 | for reading. |
223 | |
388 | |
224 | The write queue is very simple: you can add data to its end, and |
389 | The write queue is very simple: you can add data to its end, and |
225 | AnyEvent::Handle will automatically try to get rid of it for you. |
390 | AnyEvent::Handle will automatically try to get rid of it for you. |
226 | |
391 | |
227 | When data could be writtena nd the write buffer is shorter then the low |
392 | When data could be written and the write buffer is shorter then the low |
228 | water mark, the C<on_drain> callback will be invoked. |
393 | water mark, the C<on_drain> callback will be invoked. |
229 | |
394 | |
230 | =over 4 |
395 | =over 4 |
231 | |
396 | |
232 | =item $handle->on_drain ($cb) |
397 | =item $handle->on_drain ($cb) |
… | |
… | |
251 | want (only limited by the available memory), as C<AnyEvent::Handle> |
416 | want (only limited by the available memory), as C<AnyEvent::Handle> |
252 | buffers it independently of the kernel. |
417 | buffers it independently of the kernel. |
253 | |
418 | |
254 | =cut |
419 | =cut |
255 | |
420 | |
256 | sub push_write { |
421 | sub _drain_wbuf { |
257 | my ($self, $data) = @_; |
422 | my ($self) = @_; |
258 | |
423 | |
259 | $self->{wbuf} .= $data; |
424 | if (!$self->{_ww} && length $self->{wbuf}) { |
260 | |
425 | |
261 | unless ($self->{ww}) { |
|
|
262 | Scalar::Util::weaken $self; |
426 | Scalar::Util::weaken $self; |
|
|
427 | |
263 | my $cb = sub { |
428 | my $cb = sub { |
264 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
429 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
265 | |
430 | |
266 | if ($len > 0) { |
431 | if ($len >= 0) { |
267 | substr $self->{wbuf}, 0, $len, ""; |
432 | substr $self->{wbuf}, 0, $len, ""; |
268 | |
433 | |
|
|
434 | $self->{_activity} = AnyEvent->now; |
269 | |
435 | |
270 | $self->{on_drain}($self) |
436 | $self->{on_drain}($self) |
271 | if $self->{low_water_mark} >= length $self->{wbuf} |
437 | if $self->{low_water_mark} >= length $self->{wbuf} |
272 | && $self->{on_drain}; |
438 | && $self->{on_drain}; |
273 | |
439 | |
274 | delete $self->{ww} unless length $self->{wbuf}; |
440 | delete $self->{_ww} unless length $self->{wbuf}; |
275 | } elsif ($! != EAGAIN && $! != EINTR) { |
441 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
276 | $self->error; |
442 | $self->_error ($!, 1); |
277 | } |
443 | } |
278 | }; |
444 | }; |
279 | |
445 | |
|
|
446 | # try to write data immediately |
|
|
447 | $cb->(); |
|
|
448 | |
|
|
449 | # if still data left in wbuf, we need to poll |
280 | $self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb); |
450 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
281 | |
451 | if length $self->{wbuf}; |
282 | $cb->($self); |
|
|
283 | }; |
452 | }; |
284 | } |
453 | } |
|
|
454 | |
|
|
455 | our %WH; |
|
|
456 | |
|
|
457 | sub register_write_type($$) { |
|
|
458 | $WH{$_[0]} = $_[1]; |
|
|
459 | } |
|
|
460 | |
|
|
461 | sub push_write { |
|
|
462 | my $self = shift; |
|
|
463 | |
|
|
464 | if (@_ > 1) { |
|
|
465 | my $type = shift; |
|
|
466 | |
|
|
467 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
|
|
468 | ->($self, @_); |
|
|
469 | } |
|
|
470 | |
|
|
471 | if ($self->{filter_w}) { |
|
|
472 | $self->{filter_w}($self, \$_[0]); |
|
|
473 | } else { |
|
|
474 | $self->{wbuf} .= $_[0]; |
|
|
475 | $self->_drain_wbuf; |
|
|
476 | } |
|
|
477 | } |
|
|
478 | |
|
|
479 | =item $handle->push_write (type => @args) |
|
|
480 | |
|
|
481 | Instead of formatting your data yourself, you can also let this module do |
|
|
482 | the job by specifying a type and type-specific arguments. |
|
|
483 | |
|
|
484 | Predefined types are (if you have ideas for additional types, feel free to |
|
|
485 | drop by and tell us): |
|
|
486 | |
|
|
487 | =over 4 |
|
|
488 | |
|
|
489 | =item netstring => $string |
|
|
490 | |
|
|
491 | Formats the given value as netstring |
|
|
492 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
|
|
493 | |
|
|
494 | =cut |
|
|
495 | |
|
|
496 | register_write_type netstring => sub { |
|
|
497 | my ($self, $string) = @_; |
|
|
498 | |
|
|
499 | sprintf "%d:%s,", (length $string), $string |
|
|
500 | }; |
|
|
501 | |
|
|
502 | =item packstring => $format, $data |
|
|
503 | |
|
|
504 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
505 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
506 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
507 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
508 | |
|
|
509 | =cut |
|
|
510 | |
|
|
511 | register_write_type packstring => sub { |
|
|
512 | my ($self, $format, $string) = @_; |
|
|
513 | |
|
|
514 | pack "$format/a*", $string |
|
|
515 | }; |
|
|
516 | |
|
|
517 | =item json => $array_or_hashref |
|
|
518 | |
|
|
519 | Encodes the given hash or array reference into a JSON object. Unless you |
|
|
520 | provide your own JSON object, this means it will be encoded to JSON text |
|
|
521 | in UTF-8. |
|
|
522 | |
|
|
523 | JSON objects (and arrays) are self-delimiting, so you can write JSON at |
|
|
524 | one end of a handle and read them at the other end without using any |
|
|
525 | additional framing. |
|
|
526 | |
|
|
527 | The generated JSON text is guaranteed not to contain any newlines: While |
|
|
528 | this module doesn't need delimiters after or between JSON texts to be |
|
|
529 | able to read them, many other languages depend on that. |
|
|
530 | |
|
|
531 | A simple RPC protocol that interoperates easily with others is to send |
|
|
532 | JSON arrays (or objects, although arrays are usually the better choice as |
|
|
533 | they mimic how function argument passing works) and a newline after each |
|
|
534 | JSON text: |
|
|
535 | |
|
|
536 | $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever |
|
|
537 | $handle->push_write ("\012"); |
|
|
538 | |
|
|
539 | An AnyEvent::Handle receiver would simply use the C<json> read type and |
|
|
540 | rely on the fact that the newline will be skipped as leading whitespace: |
|
|
541 | |
|
|
542 | $handle->push_read (json => sub { my $array = $_[1]; ... }); |
|
|
543 | |
|
|
544 | Other languages could read single lines terminated by a newline and pass |
|
|
545 | this line into their JSON decoder of choice. |
|
|
546 | |
|
|
547 | =cut |
|
|
548 | |
|
|
549 | register_write_type json => sub { |
|
|
550 | my ($self, $ref) = @_; |
|
|
551 | |
|
|
552 | require JSON; |
|
|
553 | |
|
|
554 | $self->{json} ? $self->{json}->encode ($ref) |
|
|
555 | : JSON::encode_json ($ref) |
|
|
556 | }; |
|
|
557 | |
|
|
558 | =item storable => $reference |
|
|
559 | |
|
|
560 | Freezes the given reference using L<Storable> and writes it to the |
|
|
561 | handle. Uses the C<nfreeze> format. |
|
|
562 | |
|
|
563 | =cut |
|
|
564 | |
|
|
565 | register_write_type storable => sub { |
|
|
566 | my ($self, $ref) = @_; |
|
|
567 | |
|
|
568 | require Storable; |
|
|
569 | |
|
|
570 | pack "w/a*", Storable::nfreeze ($ref) |
|
|
571 | }; |
|
|
572 | |
|
|
573 | =back |
|
|
574 | |
|
|
575 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
|
|
576 | |
|
|
577 | This function (not method) lets you add your own types to C<push_write>. |
|
|
578 | Whenever the given C<type> is used, C<push_write> will invoke the code |
|
|
579 | reference with the handle object and the remaining arguments. |
|
|
580 | |
|
|
581 | The code reference is supposed to return a single octet string that will |
|
|
582 | be appended to the write buffer. |
|
|
583 | |
|
|
584 | Note that this is a function, and all types registered this way will be |
|
|
585 | global, so try to use unique names. |
|
|
586 | |
|
|
587 | =cut |
285 | |
588 | |
286 | ############################################################################# |
589 | ############################################################################# |
287 | |
590 | |
288 | =back |
591 | =back |
289 | |
592 | |
… | |
… | |
296 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
599 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
297 | a queue. |
600 | a queue. |
298 | |
601 | |
299 | In the simple case, you just install an C<on_read> callback and whenever |
602 | In the simple case, you just install an C<on_read> callback and whenever |
300 | new data arrives, it will be called. You can then remove some data (if |
603 | new data arrives, it will be called. You can then remove some data (if |
301 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
604 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
302 | or not. |
605 | leave the data there if you want to accumulate more (e.g. when only a |
|
|
606 | partial message has been received so far). |
303 | |
607 | |
304 | In the more complex case, you want to queue multiple callbacks. In this |
608 | In the more complex case, you want to queue multiple callbacks. In this |
305 | case, AnyEvent::Handle will call the first queued callback each time new |
609 | case, AnyEvent::Handle will call the first queued callback each time new |
306 | data arrives and removes it when it has done its job (see C<push_read>, |
610 | data arrives (also the first time it is queued) and removes it when it has |
307 | below). |
611 | done its job (see C<push_read>, below). |
308 | |
612 | |
309 | This way you can, for example, push three line-reads, followed by reading |
613 | This way you can, for example, push three line-reads, followed by reading |
310 | a chunk of data, and AnyEvent::Handle will execute them in order. |
614 | a chunk of data, and AnyEvent::Handle will execute them in order. |
311 | |
615 | |
312 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
616 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
313 | the specified number of bytes which give an XML datagram. |
617 | the specified number of bytes which give an XML datagram. |
314 | |
618 | |
315 | # in the default state, expect some header bytes |
619 | # in the default state, expect some header bytes |
316 | $handle->on_read (sub { |
620 | $handle->on_read (sub { |
317 | # some data is here, now queue the length-header-read (4 octets) |
621 | # some data is here, now queue the length-header-read (4 octets) |
318 | shift->unshift_read_chunk (4, sub { |
622 | shift->unshift_read (chunk => 4, sub { |
319 | # header arrived, decode |
623 | # header arrived, decode |
320 | my $len = unpack "N", $_[1]; |
624 | my $len = unpack "N", $_[1]; |
321 | |
625 | |
322 | # now read the payload |
626 | # now read the payload |
323 | shift->unshift_read_chunk ($len, sub { |
627 | shift->unshift_read (chunk => $len, sub { |
324 | my $xml = $_[1]; |
628 | my $xml = $_[1]; |
325 | # handle xml |
629 | # handle xml |
326 | }); |
630 | }); |
327 | }); |
631 | }); |
328 | }); |
632 | }); |
329 | |
633 | |
330 | Example 2: Implement a client for a protocol that replies either with |
634 | Example 2: Implement a client for a protocol that replies either with "OK" |
331 | "OK" and another line or "ERROR" for one request, and 64 bytes for the |
635 | and another line or "ERROR" for the first request that is sent, and 64 |
332 | second request. Due tot he availability of a full queue, we can just |
636 | bytes for the second request. Due to the availability of a queue, we can |
333 | pipeline sending both requests and manipulate the queue as necessary in |
637 | just pipeline sending both requests and manipulate the queue as necessary |
334 | the callbacks: |
638 | in the callbacks. |
335 | |
639 | |
336 | # request one |
640 | When the first callback is called and sees an "OK" response, it will |
|
|
641 | C<unshift> another line-read. This line-read will be queued I<before> the |
|
|
642 | 64-byte chunk callback. |
|
|
643 | |
|
|
644 | # request one, returns either "OK + extra line" or "ERROR" |
337 | $handle->push_write ("request 1\015\012"); |
645 | $handle->push_write ("request 1\015\012"); |
338 | |
646 | |
339 | # we expect "ERROR" or "OK" as response, so push a line read |
647 | # we expect "ERROR" or "OK" as response, so push a line read |
340 | $handle->push_read_line (sub { |
648 | $handle->push_read (line => sub { |
341 | # if we got an "OK", we have to _prepend_ another line, |
649 | # if we got an "OK", we have to _prepend_ another line, |
342 | # so it will be read before the second request reads its 64 bytes |
650 | # so it will be read before the second request reads its 64 bytes |
343 | # which are already in the queue when this callback is called |
651 | # which are already in the queue when this callback is called |
344 | # we don't do this in case we got an error |
652 | # we don't do this in case we got an error |
345 | if ($_[1] eq "OK") { |
653 | if ($_[1] eq "OK") { |
346 | $_[0]->unshift_read_line (sub { |
654 | $_[0]->unshift_read (line => sub { |
347 | my $response = $_[1]; |
655 | my $response = $_[1]; |
348 | ... |
656 | ... |
349 | }); |
657 | }); |
350 | } |
658 | } |
351 | }); |
659 | }); |
352 | |
660 | |
353 | # request two |
661 | # request two, simply returns 64 octets |
354 | $handle->push_write ("request 2\015\012"); |
662 | $handle->push_write ("request 2\015\012"); |
355 | |
663 | |
356 | # simply read 64 bytes, always |
664 | # simply read 64 bytes, always |
357 | $handle->push_read_chunk (64, sub { |
665 | $handle->push_read (chunk => 64, sub { |
358 | my $response = $_[1]; |
666 | my $response = $_[1]; |
359 | ... |
667 | ... |
360 | }); |
668 | }); |
361 | |
669 | |
362 | =over 4 |
670 | =over 4 |
… | |
… | |
364 | =cut |
672 | =cut |
365 | |
673 | |
366 | sub _drain_rbuf { |
674 | sub _drain_rbuf { |
367 | my ($self) = @_; |
675 | my ($self) = @_; |
368 | |
676 | |
369 | return if $self->{in_drain}; |
|
|
370 | local $self->{in_drain} = 1; |
677 | local $self->{_in_drain} = 1; |
371 | |
678 | |
372 | while (my $len = length $self->{rbuf}) { |
679 | if ( |
|
|
680 | defined $self->{rbuf_max} |
|
|
681 | && $self->{rbuf_max} < length $self->{rbuf} |
|
|
682 | ) { |
|
|
683 | return $self->_error (&Errno::ENOSPC, 1); |
|
|
684 | } |
|
|
685 | |
|
|
686 | while () { |
373 | no strict 'refs'; |
687 | no strict 'refs'; |
|
|
688 | |
|
|
689 | my $len = length $self->{rbuf}; |
|
|
690 | |
374 | if (my $cb = shift @{ $self->{queue} }) { |
691 | if (my $cb = shift @{ $self->{_queue} }) { |
375 | if (!$cb->($self)) { |
692 | unless ($cb->($self)) { |
376 | if ($self->{eof}) { |
693 | if ($self->{_eof}) { |
377 | # no progress can be made (not enough data and no data forthcoming) |
694 | # no progress can be made (not enough data and no data forthcoming) |
378 | $! = &Errno::EPIPE; return $self->error; |
695 | $self->_error (&Errno::EPIPE, 1), last; |
379 | } |
696 | } |
380 | |
697 | |
381 | unshift @{ $self->{queue} }, $cb; |
698 | unshift @{ $self->{_queue} }, $cb; |
382 | return; |
699 | last; |
383 | } |
700 | } |
384 | } elsif ($self->{on_read}) { |
701 | } elsif ($self->{on_read}) { |
|
|
702 | last unless $len; |
|
|
703 | |
385 | $self->{on_read}($self); |
704 | $self->{on_read}($self); |
386 | |
705 | |
387 | if ( |
706 | if ( |
388 | $self->{eof} # if no further data will arrive |
|
|
389 | && $len == length $self->{rbuf} # and no data has been consumed |
707 | $len == length $self->{rbuf} # if no data has been consumed |
390 | && !@{ $self->{queue} } # and the queue is still empty |
708 | && !@{ $self->{_queue} } # and the queue is still empty |
391 | && $self->{on_read} # and we still want to read data |
709 | && $self->{on_read} # but we still have on_read |
392 | ) { |
710 | ) { |
|
|
711 | # no further data will arrive |
393 | # then no progress can be made |
712 | # so no progress can be made |
394 | $! = &Errno::EPIPE; return $self->error; |
713 | $self->_error (&Errno::EPIPE, 1), last |
|
|
714 | if $self->{_eof}; |
|
|
715 | |
|
|
716 | last; # more data might arrive |
395 | } |
717 | } |
396 | } else { |
718 | } else { |
397 | # read side becomes idle |
719 | # read side becomes idle |
398 | delete $self->{rw}; |
720 | delete $self->{_rw}; |
399 | return; |
721 | last; |
400 | } |
722 | } |
401 | } |
723 | } |
402 | |
724 | |
403 | if ($self->{eof}) { |
|
|
404 | $self->_shutdown; |
|
|
405 | $self->{on_eof}($self); |
725 | $self->{on_eof}($self) |
|
|
726 | if $self->{_eof} && $self->{on_eof}; |
|
|
727 | |
|
|
728 | # may need to restart read watcher |
|
|
729 | unless ($self->{_rw}) { |
|
|
730 | $self->start_read |
|
|
731 | if $self->{on_read} || @{ $self->{_queue} }; |
406 | } |
732 | } |
407 | } |
733 | } |
408 | |
734 | |
409 | =item $handle->on_read ($cb) |
735 | =item $handle->on_read ($cb) |
410 | |
736 | |
… | |
… | |
416 | |
742 | |
417 | sub on_read { |
743 | sub on_read { |
418 | my ($self, $cb) = @_; |
744 | my ($self, $cb) = @_; |
419 | |
745 | |
420 | $self->{on_read} = $cb; |
746 | $self->{on_read} = $cb; |
|
|
747 | $self->_drain_rbuf if $cb && !$self->{_in_drain}; |
421 | } |
748 | } |
422 | |
749 | |
423 | =item $handle->rbuf |
750 | =item $handle->rbuf |
424 | |
751 | |
425 | Returns the read buffer (as a modifiable lvalue). |
752 | Returns the read buffer (as a modifiable lvalue). |
… | |
… | |
444 | Append the given callback to the end of the queue (C<push_read>) or |
771 | Append the given callback to the end of the queue (C<push_read>) or |
445 | prepend it (C<unshift_read>). |
772 | prepend it (C<unshift_read>). |
446 | |
773 | |
447 | The callback is called each time some additional read data arrives. |
774 | The callback is called each time some additional read data arrives. |
448 | |
775 | |
449 | It must check wether enough data is in the read buffer already. |
776 | It must check whether enough data is in the read buffer already. |
450 | |
777 | |
451 | If not enough data is available, it must return the empty list or a false |
778 | If not enough data is available, it must return the empty list or a false |
452 | value, in which case it will be called repeatedly until enough data is |
779 | value, in which case it will be called repeatedly until enough data is |
453 | available (or an error condition is detected). |
780 | available (or an error condition is detected). |
454 | |
781 | |
… | |
… | |
456 | interested in (which can be none at all) and return a true value. After returning |
783 | interested in (which can be none at all) and return a true value. After returning |
457 | true, it will be removed from the queue. |
784 | true, it will be removed from the queue. |
458 | |
785 | |
459 | =cut |
786 | =cut |
460 | |
787 | |
|
|
788 | our %RH; |
|
|
789 | |
|
|
790 | sub register_read_type($$) { |
|
|
791 | $RH{$_[0]} = $_[1]; |
|
|
792 | } |
|
|
793 | |
461 | sub push_read { |
794 | sub push_read { |
462 | my ($self, $cb) = @_; |
795 | my $self = shift; |
|
|
796 | my $cb = pop; |
463 | |
797 | |
|
|
798 | if (@_) { |
|
|
799 | my $type = shift; |
|
|
800 | |
|
|
801 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
|
|
802 | ->($self, $cb, @_); |
|
|
803 | } |
|
|
804 | |
464 | push @{ $self->{queue} }, $cb; |
805 | push @{ $self->{_queue} }, $cb; |
465 | $self->_drain_rbuf; |
806 | $self->_drain_rbuf unless $self->{_in_drain}; |
466 | } |
807 | } |
467 | |
808 | |
468 | sub unshift_read { |
809 | sub unshift_read { |
469 | my ($self, $cb) = @_; |
810 | my $self = shift; |
|
|
811 | my $cb = pop; |
470 | |
812 | |
|
|
813 | if (@_) { |
|
|
814 | my $type = shift; |
|
|
815 | |
|
|
816 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") |
|
|
817 | ->($self, $cb, @_); |
|
|
818 | } |
|
|
819 | |
|
|
820 | |
471 | push @{ $self->{queue} }, $cb; |
821 | unshift @{ $self->{_queue} }, $cb; |
472 | $self->_drain_rbuf; |
822 | $self->_drain_rbuf unless $self->{_in_drain}; |
473 | } |
823 | } |
474 | |
824 | |
475 | =item $handle->push_read_chunk ($len, $cb->($self, $data)) |
825 | =item $handle->push_read (type => @args, $cb) |
476 | |
826 | |
477 | =item $handle->unshift_read_chunk ($len, $cb->($self, $data)) |
827 | =item $handle->unshift_read (type => @args, $cb) |
478 | |
828 | |
479 | Append the given callback to the end of the queue (C<push_read_chunk>) or |
829 | Instead of providing a callback that parses the data itself you can chose |
480 | prepend it (C<unshift_read_chunk>). |
830 | between a number of predefined parsing formats, for chunks of data, lines |
|
|
831 | etc. |
481 | |
832 | |
482 | The callback will be called only once C<$len> bytes have been read, and |
833 | Predefined types are (if you have ideas for additional types, feel free to |
483 | these C<$len> bytes will be passed to the callback. |
834 | drop by and tell us): |
484 | |
835 | |
485 | =cut |
836 | =over 4 |
486 | |
837 | |
487 | sub _read_chunk($$) { |
838 | =item chunk => $octets, $cb->($handle, $data) |
|
|
839 | |
|
|
840 | Invoke the callback only once C<$octets> bytes have been read. Pass the |
|
|
841 | data read to the callback. The callback will never be called with less |
|
|
842 | data. |
|
|
843 | |
|
|
844 | Example: read 2 bytes. |
|
|
845 | |
|
|
846 | $handle->push_read (chunk => 2, sub { |
|
|
847 | warn "yay ", unpack "H*", $_[1]; |
|
|
848 | }); |
|
|
849 | |
|
|
850 | =cut |
|
|
851 | |
|
|
852 | register_read_type chunk => sub { |
488 | my ($self, $len, $cb) = @_; |
853 | my ($self, $cb, $len) = @_; |
489 | |
854 | |
490 | sub { |
855 | sub { |
491 | $len <= length $_[0]{rbuf} or return; |
856 | $len <= length $_[0]{rbuf} or return; |
492 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
857 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
493 | 1 |
858 | 1 |
494 | } |
859 | } |
495 | } |
860 | }; |
496 | |
861 | |
|
|
862 | # compatibility with older API |
497 | sub push_read_chunk { |
863 | sub push_read_chunk { |
498 | $_[0]->push_read (&_read_chunk); |
864 | $_[0]->push_read (chunk => $_[1], $_[2]); |
499 | } |
865 | } |
500 | |
|
|
501 | |
866 | |
502 | sub unshift_read_chunk { |
867 | sub unshift_read_chunk { |
503 | $_[0]->unshift_read (&_read_chunk); |
868 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
504 | } |
869 | } |
505 | |
870 | |
506 | =item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol)) |
871 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
507 | |
|
|
508 | =item $handle->unshift_read_line ([$eol, ]$cb->($self, $line, $eol)) |
|
|
509 | |
|
|
510 | Append the given callback to the end of the queue (C<push_read_line>) or |
|
|
511 | prepend it (C<unshift_read_line>). |
|
|
512 | |
872 | |
513 | The callback will be called only once a full line (including the end of |
873 | The callback will be called only once a full line (including the end of |
514 | line marker, C<$eol>) has been read. This line (excluding the end of line |
874 | line marker, C<$eol>) has been read. This line (excluding the end of line |
515 | marker) will be passed to the callback as second argument (C<$line>), and |
875 | marker) will be passed to the callback as second argument (C<$line>), and |
516 | the end of line marker as the third argument (C<$eol>). |
876 | the end of line marker as the third argument (C<$eol>). |
… | |
… | |
527 | Partial lines at the end of the stream will never be returned, as they are |
887 | Partial lines at the end of the stream will never be returned, as they are |
528 | not marked by the end of line marker. |
888 | not marked by the end of line marker. |
529 | |
889 | |
530 | =cut |
890 | =cut |
531 | |
891 | |
532 | sub _read_line($$) { |
892 | register_read_type line => sub { |
533 | my $self = shift; |
893 | my ($self, $cb, $eol) = @_; |
534 | my $cb = pop; |
|
|
535 | my $eol = @_ ? shift : qr|(\015?\012)|; |
|
|
536 | my $pos; |
|
|
537 | |
894 | |
|
|
895 | $eol = qr|(\015?\012)| if @_ < 3; |
538 | $eol = quotemeta $eol unless ref $eol; |
896 | $eol = quotemeta $eol unless ref $eol; |
539 | $eol = qr|^(.*?)($eol)|s; |
897 | $eol = qr|^(.*?)($eol)|s; |
540 | |
898 | |
541 | sub { |
899 | sub { |
542 | $_[0]{rbuf} =~ s/$eol// or return; |
900 | $_[0]{rbuf} =~ s/$eol// or return; |
543 | |
901 | |
544 | $cb->($_[0], $1, $2); |
902 | $cb->($_[0], $1, $2); |
545 | 1 |
903 | 1 |
546 | } |
904 | } |
547 | } |
905 | }; |
548 | |
906 | |
|
|
907 | # compatibility with older API |
549 | sub push_read_line { |
908 | sub push_read_line { |
550 | $_[0]->push_read (&_read_line); |
909 | my $self = shift; |
|
|
910 | $self->push_read (line => @_); |
551 | } |
911 | } |
552 | |
912 | |
553 | sub unshift_read_line { |
913 | sub unshift_read_line { |
554 | $_[0]->unshift_read (&_read_line); |
914 | my $self = shift; |
|
|
915 | $self->unshift_read (line => @_); |
555 | } |
916 | } |
|
|
917 | |
|
|
918 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
|
|
919 | |
|
|
920 | Makes a regex match against the regex object C<$accept> and returns |
|
|
921 | everything up to and including the match. |
|
|
922 | |
|
|
923 | Example: read a single line terminated by '\n'. |
|
|
924 | |
|
|
925 | $handle->push_read (regex => qr<\n>, sub { ... }); |
|
|
926 | |
|
|
927 | If C<$reject> is given and not undef, then it determines when the data is |
|
|
928 | to be rejected: it is matched against the data when the C<$accept> regex |
|
|
929 | does not match and generates an C<EBADMSG> error when it matches. This is |
|
|
930 | useful to quickly reject wrong data (to avoid waiting for a timeout or a |
|
|
931 | receive buffer overflow). |
|
|
932 | |
|
|
933 | Example: expect a single decimal number followed by whitespace, reject |
|
|
934 | anything else (not the use of an anchor). |
|
|
935 | |
|
|
936 | $handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... }); |
|
|
937 | |
|
|
938 | If C<$skip> is given and not C<undef>, then it will be matched against |
|
|
939 | the receive buffer when neither C<$accept> nor C<$reject> match, |
|
|
940 | and everything preceding and including the match will be accepted |
|
|
941 | unconditionally. This is useful to skip large amounts of data that you |
|
|
942 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
|
|
943 | have to start matching from the beginning. This is purely an optimisation |
|
|
944 | and is usually worth only when you expect more than a few kilobytes. |
|
|
945 | |
|
|
946 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
|
|
947 | expect the header to be very large (it isn't in practise, but...), we use |
|
|
948 | a skip regex to skip initial portions. The skip regex is tricky in that |
|
|
949 | it only accepts something not ending in either \015 or \012, as these are |
|
|
950 | required for the accept regex. |
|
|
951 | |
|
|
952 | $handle->push_read (regex => |
|
|
953 | qr<\015\012\015\012>, |
|
|
954 | undef, # no reject |
|
|
955 | qr<^.*[^\015\012]>, |
|
|
956 | sub { ... }); |
|
|
957 | |
|
|
958 | =cut |
|
|
959 | |
|
|
960 | register_read_type regex => sub { |
|
|
961 | my ($self, $cb, $accept, $reject, $skip) = @_; |
|
|
962 | |
|
|
963 | my $data; |
|
|
964 | my $rbuf = \$self->{rbuf}; |
|
|
965 | |
|
|
966 | sub { |
|
|
967 | # accept |
|
|
968 | if ($$rbuf =~ $accept) { |
|
|
969 | $data .= substr $$rbuf, 0, $+[0], ""; |
|
|
970 | $cb->($self, $data); |
|
|
971 | return 1; |
|
|
972 | } |
|
|
973 | |
|
|
974 | # reject |
|
|
975 | if ($reject && $$rbuf =~ $reject) { |
|
|
976 | $self->_error (&Errno::EBADMSG); |
|
|
977 | } |
|
|
978 | |
|
|
979 | # skip |
|
|
980 | if ($skip && $$rbuf =~ $skip) { |
|
|
981 | $data .= substr $$rbuf, 0, $+[0], ""; |
|
|
982 | } |
|
|
983 | |
|
|
984 | () |
|
|
985 | } |
|
|
986 | }; |
|
|
987 | |
|
|
988 | =item netstring => $cb->($handle, $string) |
|
|
989 | |
|
|
990 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
991 | |
|
|
992 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
993 | |
|
|
994 | =cut |
|
|
995 | |
|
|
996 | register_read_type netstring => sub { |
|
|
997 | my ($self, $cb) = @_; |
|
|
998 | |
|
|
999 | sub { |
|
|
1000 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
1001 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
1002 | $self->_error (&Errno::EBADMSG); |
|
|
1003 | } |
|
|
1004 | return; |
|
|
1005 | } |
|
|
1006 | |
|
|
1007 | my $len = $1; |
|
|
1008 | |
|
|
1009 | $self->unshift_read (chunk => $len, sub { |
|
|
1010 | my $string = $_[1]; |
|
|
1011 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
1012 | if ($_[1] eq ",") { |
|
|
1013 | $cb->($_[0], $string); |
|
|
1014 | } else { |
|
|
1015 | $self->_error (&Errno::EBADMSG); |
|
|
1016 | } |
|
|
1017 | }); |
|
|
1018 | }); |
|
|
1019 | |
|
|
1020 | 1 |
|
|
1021 | } |
|
|
1022 | }; |
|
|
1023 | |
|
|
1024 | =item packstring => $format, $cb->($handle, $string) |
|
|
1025 | |
|
|
1026 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
1027 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
1028 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
1029 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
1030 | |
|
|
1031 | DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. |
|
|
1032 | |
|
|
1033 | Example: read a block of data prefixed by its length in BER-encoded |
|
|
1034 | format (very efficient). |
|
|
1035 | |
|
|
1036 | $handle->push_read (packstring => "w", sub { |
|
|
1037 | my ($handle, $data) = @_; |
|
|
1038 | }); |
|
|
1039 | |
|
|
1040 | =cut |
|
|
1041 | |
|
|
1042 | register_read_type packstring => sub { |
|
|
1043 | my ($self, $cb, $format) = @_; |
|
|
1044 | |
|
|
1045 | sub { |
|
|
1046 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1047 | defined (my $len = eval { unpack $format, $_[0]->{rbuf} }) |
|
|
1048 | or return; |
|
|
1049 | |
|
|
1050 | # remove prefix |
|
|
1051 | substr $_[0]->{rbuf}, 0, (length pack $format, $len), ""; |
|
|
1052 | |
|
|
1053 | # read rest |
|
|
1054 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1055 | |
|
|
1056 | 1 |
|
|
1057 | } |
|
|
1058 | }; |
|
|
1059 | |
|
|
1060 | =item json => $cb->($handle, $hash_or_arrayref) |
|
|
1061 | |
|
|
1062 | Reads a JSON object or array, decodes it and passes it to the callback. |
|
|
1063 | |
|
|
1064 | If a C<json> object was passed to the constructor, then that will be used |
|
|
1065 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
|
|
1066 | |
|
|
1067 | This read type uses the incremental parser available with JSON version |
|
|
1068 | 2.09 (and JSON::XS version 2.2) and above. You have to provide a |
|
|
1069 | dependency on your own: this module will load the JSON module, but |
|
|
1070 | AnyEvent does not depend on it itself. |
|
|
1071 | |
|
|
1072 | Since JSON texts are fully self-delimiting, the C<json> read and write |
|
|
1073 | types are an ideal simple RPC protocol: just exchange JSON datagrams. See |
|
|
1074 | the C<json> write type description, above, for an actual example. |
|
|
1075 | |
|
|
1076 | =cut |
|
|
1077 | |
|
|
1078 | register_read_type json => sub { |
|
|
1079 | my ($self, $cb) = @_; |
|
|
1080 | |
|
|
1081 | require JSON; |
|
|
1082 | |
|
|
1083 | my $data; |
|
|
1084 | my $rbuf = \$self->{rbuf}; |
|
|
1085 | |
|
|
1086 | my $json = $self->{json} ||= JSON->new->utf8; |
|
|
1087 | |
|
|
1088 | sub { |
|
|
1089 | my $ref = $json->incr_parse ($self->{rbuf}); |
|
|
1090 | |
|
|
1091 | if ($ref) { |
|
|
1092 | $self->{rbuf} = $json->incr_text; |
|
|
1093 | $json->incr_text = ""; |
|
|
1094 | $cb->($self, $ref); |
|
|
1095 | |
|
|
1096 | 1 |
|
|
1097 | } else { |
|
|
1098 | $self->{rbuf} = ""; |
|
|
1099 | () |
|
|
1100 | } |
|
|
1101 | } |
|
|
1102 | }; |
|
|
1103 | |
|
|
1104 | =item storable => $cb->($handle, $ref) |
|
|
1105 | |
|
|
1106 | Deserialises a L<Storable> frozen representation as written by the |
|
|
1107 | C<storable> write type (BER-encoded length prefix followed by nfreeze'd |
|
|
1108 | data). |
|
|
1109 | |
|
|
1110 | Raises C<EBADMSG> error if the data could not be decoded. |
|
|
1111 | |
|
|
1112 | =cut |
|
|
1113 | |
|
|
1114 | register_read_type storable => sub { |
|
|
1115 | my ($self, $cb) = @_; |
|
|
1116 | |
|
|
1117 | require Storable; |
|
|
1118 | |
|
|
1119 | sub { |
|
|
1120 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1121 | defined (my $len = eval { unpack "w", $_[0]->{rbuf} }) |
|
|
1122 | or return; |
|
|
1123 | |
|
|
1124 | # remove prefix |
|
|
1125 | substr $_[0]->{rbuf}, 0, (length pack "w", $len), ""; |
|
|
1126 | |
|
|
1127 | # read rest |
|
|
1128 | $_[0]->unshift_read (chunk => $len, sub { |
|
|
1129 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
|
|
1130 | $cb->($_[0], $ref); |
|
|
1131 | } else { |
|
|
1132 | $self->_error (&Errno::EBADMSG); |
|
|
1133 | } |
|
|
1134 | }); |
|
|
1135 | } |
|
|
1136 | }; |
|
|
1137 | |
|
|
1138 | =back |
|
|
1139 | |
|
|
1140 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
|
|
1141 | |
|
|
1142 | This function (not method) lets you add your own types to C<push_read>. |
|
|
1143 | |
|
|
1144 | Whenever the given C<type> is used, C<push_read> will invoke the code |
|
|
1145 | reference with the handle object, the callback and the remaining |
|
|
1146 | arguments. |
|
|
1147 | |
|
|
1148 | The code reference is supposed to return a callback (usually a closure) |
|
|
1149 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
|
|
1150 | |
|
|
1151 | It should invoke the passed callback when it is done reading (remember to |
|
|
1152 | pass C<$handle> as first argument as all other callbacks do that). |
|
|
1153 | |
|
|
1154 | Note that this is a function, and all types registered this way will be |
|
|
1155 | global, so try to use unique names. |
|
|
1156 | |
|
|
1157 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
|
|
1158 | search for C<register_read_type>)). |
556 | |
1159 | |
557 | =item $handle->stop_read |
1160 | =item $handle->stop_read |
558 | |
1161 | |
559 | =item $handle->start_read |
1162 | =item $handle->start_read |
560 | |
1163 | |
561 | In rare cases you actually do not want to read anything form the |
1164 | In rare cases you actually do not want to read anything from the |
562 | socket. In this case you can call C<stop_read>. Neither C<on_read> no |
1165 | socket. In this case you can call C<stop_read>. Neither C<on_read> nor |
563 | any queued callbacks will be executed then. To start readign again, call |
1166 | any queued callbacks will be executed then. To start reading again, call |
564 | C<start_read>. |
1167 | C<start_read>. |
|
|
1168 | |
|
|
1169 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
|
|
1170 | you change the C<on_read> callback or push/unshift a read callback, and it |
|
|
1171 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
|
|
1172 | there are any read requests in the queue. |
565 | |
1173 | |
566 | =cut |
1174 | =cut |
567 | |
1175 | |
568 | sub stop_read { |
1176 | sub stop_read { |
569 | my ($self) = @_; |
1177 | my ($self) = @_; |
570 | |
1178 | |
571 | delete $self->{rw}; |
1179 | delete $self->{_rw}; |
572 | } |
1180 | } |
573 | |
1181 | |
574 | sub start_read { |
1182 | sub start_read { |
575 | my ($self) = @_; |
1183 | my ($self) = @_; |
576 | |
1184 | |
577 | unless ($self->{rw} || $self->{eof}) { |
1185 | unless ($self->{_rw} || $self->{_eof}) { |
578 | Scalar::Util::weaken $self; |
1186 | Scalar::Util::weaken $self; |
579 | |
1187 | |
580 | $self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1188 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
|
|
1189 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
581 | my $len = sysread $self->{fh}, $self->{rbuf}, $self->{read_size} || 8192, length $self->{rbuf}; |
1190 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
582 | |
1191 | |
583 | if ($len > 0) { |
1192 | if ($len > 0) { |
584 | if (defined $self->{rbuf_max}) { |
1193 | $self->{_activity} = AnyEvent->now; |
585 | if ($self->{rbuf_max} < length $self->{rbuf}) { |
1194 | |
586 | $! = &Errno::ENOSPC; return $self->error; |
1195 | $self->{filter_r} |
587 | } |
1196 | ? $self->{filter_r}($self, $rbuf) |
588 | } |
1197 | : $self->{_in_drain} || $self->_drain_rbuf; |
589 | |
1198 | |
590 | } elsif (defined $len) { |
1199 | } elsif (defined $len) { |
591 | $self->{eof} = 1; |
|
|
592 | delete $self->{rw}; |
1200 | delete $self->{_rw}; |
|
|
1201 | $self->{_eof} = 1; |
|
|
1202 | $self->_drain_rbuf unless $self->{_in_drain}; |
593 | |
1203 | |
594 | } elsif ($! != EAGAIN && $! != EINTR) { |
1204 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
595 | return $self->error; |
1205 | return $self->_error ($!, 1); |
596 | } |
1206 | } |
597 | |
|
|
598 | $self->_drain_rbuf; |
|
|
599 | }); |
1207 | }); |
600 | } |
1208 | } |
601 | } |
1209 | } |
602 | |
1210 | |
|
|
1211 | sub _dotls { |
|
|
1212 | my ($self) = @_; |
|
|
1213 | |
|
|
1214 | my $buf; |
|
|
1215 | |
|
|
1216 | if (length $self->{_tls_wbuf}) { |
|
|
1217 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
|
|
1218 | substr $self->{_tls_wbuf}, 0, $len, ""; |
|
|
1219 | } |
|
|
1220 | } |
|
|
1221 | |
|
|
1222 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
|
|
1223 | $self->{wbuf} .= $buf; |
|
|
1224 | $self->_drain_wbuf; |
|
|
1225 | } |
|
|
1226 | |
|
|
1227 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
|
|
1228 | if (length $buf) { |
|
|
1229 | $self->{rbuf} .= $buf; |
|
|
1230 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1231 | } else { |
|
|
1232 | # let's treat SSL-eof as we treat normal EOF |
|
|
1233 | $self->{_eof} = 1; |
|
|
1234 | $self->_shutdown; |
|
|
1235 | return; |
|
|
1236 | } |
|
|
1237 | } |
|
|
1238 | |
|
|
1239 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
|
|
1240 | |
|
|
1241 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
|
|
1242 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
|
|
1243 | return $self->_error ($!, 1); |
|
|
1244 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
|
|
1245 | return $self->_error (&Errno::EIO, 1); |
|
|
1246 | } |
|
|
1247 | |
|
|
1248 | # all others are fine for our purposes |
|
|
1249 | } |
|
|
1250 | } |
|
|
1251 | |
|
|
1252 | =item $handle->starttls ($tls[, $tls_ctx]) |
|
|
1253 | |
|
|
1254 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
|
|
1255 | object is created, you can also do that at a later time by calling |
|
|
1256 | C<starttls>. |
|
|
1257 | |
|
|
1258 | The first argument is the same as the C<tls> constructor argument (either |
|
|
1259 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
|
|
1260 | |
|
|
1261 | The second argument is the optional C<Net::SSLeay::CTX> object that is |
|
|
1262 | used when AnyEvent::Handle has to create its own TLS connection object. |
|
|
1263 | |
|
|
1264 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
|
|
1265 | call and can be used or changed to your liking. Note that the handshake |
|
|
1266 | might have already started when this function returns. |
|
|
1267 | |
|
|
1268 | =cut |
|
|
1269 | |
|
|
1270 | sub starttls { |
|
|
1271 | my ($self, $ssl, $ctx) = @_; |
|
|
1272 | |
|
|
1273 | $self->stoptls; |
|
|
1274 | |
|
|
1275 | if ($ssl eq "accept") { |
|
|
1276 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
|
|
1277 | Net::SSLeay::set_accept_state ($ssl); |
|
|
1278 | } elsif ($ssl eq "connect") { |
|
|
1279 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
|
|
1280 | Net::SSLeay::set_connect_state ($ssl); |
|
|
1281 | } |
|
|
1282 | |
|
|
1283 | $self->{tls} = $ssl; |
|
|
1284 | |
|
|
1285 | # basically, this is deep magic (because SSL_read should have the same issues) |
|
|
1286 | # but the openssl maintainers basically said: "trust us, it just works". |
|
|
1287 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
|
|
1288 | # and mismaintained ssleay-module doesn't even offer them). |
|
|
1289 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
|
|
1290 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
|
|
1291 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
|
|
1292 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
|
|
1293 | |
|
|
1294 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
|
|
1295 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
|
|
1296 | |
|
|
1297 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
|
|
1298 | |
|
|
1299 | $self->{filter_w} = sub { |
|
|
1300 | $_[0]{_tls_wbuf} .= ${$_[1]}; |
|
|
1301 | &_dotls; |
|
|
1302 | }; |
|
|
1303 | $self->{filter_r} = sub { |
|
|
1304 | Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]}); |
|
|
1305 | &_dotls; |
|
|
1306 | }; |
|
|
1307 | } |
|
|
1308 | |
|
|
1309 | =item $handle->stoptls |
|
|
1310 | |
|
|
1311 | Destroys the SSL connection, if any. Partial read or write data will be |
|
|
1312 | lost. |
|
|
1313 | |
|
|
1314 | =cut |
|
|
1315 | |
|
|
1316 | sub stoptls { |
|
|
1317 | my ($self) = @_; |
|
|
1318 | |
|
|
1319 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
|
|
1320 | |
|
|
1321 | delete $self->{_rbio}; |
|
|
1322 | delete $self->{_wbio}; |
|
|
1323 | delete $self->{_tls_wbuf}; |
|
|
1324 | delete $self->{filter_r}; |
|
|
1325 | delete $self->{filter_w}; |
|
|
1326 | } |
|
|
1327 | |
|
|
1328 | sub DESTROY { |
|
|
1329 | my $self = shift; |
|
|
1330 | |
|
|
1331 | $self->stoptls; |
|
|
1332 | |
|
|
1333 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
|
|
1334 | |
|
|
1335 | if ($linger && length $self->{wbuf}) { |
|
|
1336 | my $fh = delete $self->{fh}; |
|
|
1337 | my $wbuf = delete $self->{wbuf}; |
|
|
1338 | |
|
|
1339 | my @linger; |
|
|
1340 | |
|
|
1341 | push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { |
|
|
1342 | my $len = syswrite $fh, $wbuf, length $wbuf; |
|
|
1343 | |
|
|
1344 | if ($len > 0) { |
|
|
1345 | substr $wbuf, 0, $len, ""; |
|
|
1346 | } else { |
|
|
1347 | @linger = (); # end |
|
|
1348 | } |
|
|
1349 | }); |
|
|
1350 | push @linger, AnyEvent->timer (after => $linger, cb => sub { |
|
|
1351 | @linger = (); |
|
|
1352 | }); |
|
|
1353 | } |
|
|
1354 | } |
|
|
1355 | |
|
|
1356 | =item AnyEvent::Handle::TLS_CTX |
|
|
1357 | |
|
|
1358 | This function creates and returns the Net::SSLeay::CTX object used by |
|
|
1359 | default for TLS mode. |
|
|
1360 | |
|
|
1361 | The context is created like this: |
|
|
1362 | |
|
|
1363 | Net::SSLeay::load_error_strings; |
|
|
1364 | Net::SSLeay::SSLeay_add_ssl_algorithms; |
|
|
1365 | Net::SSLeay::randomize; |
|
|
1366 | |
|
|
1367 | my $CTX = Net::SSLeay::CTX_new; |
|
|
1368 | |
|
|
1369 | Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL |
|
|
1370 | |
|
|
1371 | =cut |
|
|
1372 | |
|
|
1373 | our $TLS_CTX; |
|
|
1374 | |
|
|
1375 | sub TLS_CTX() { |
|
|
1376 | $TLS_CTX || do { |
|
|
1377 | require Net::SSLeay; |
|
|
1378 | |
|
|
1379 | Net::SSLeay::load_error_strings (); |
|
|
1380 | Net::SSLeay::SSLeay_add_ssl_algorithms (); |
|
|
1381 | Net::SSLeay::randomize (); |
|
|
1382 | |
|
|
1383 | $TLS_CTX = Net::SSLeay::CTX_new (); |
|
|
1384 | |
|
|
1385 | Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ()); |
|
|
1386 | |
|
|
1387 | $TLS_CTX |
|
|
1388 | } |
|
|
1389 | } |
|
|
1390 | |
603 | =back |
1391 | =back |
604 | |
1392 | |
|
|
1393 | =head1 SUBCLASSING AnyEvent::Handle |
|
|
1394 | |
|
|
1395 | In many cases, you might want to subclass AnyEvent::Handle. |
|
|
1396 | |
|
|
1397 | To make this easier, a given version of AnyEvent::Handle uses these |
|
|
1398 | conventions: |
|
|
1399 | |
|
|
1400 | =over 4 |
|
|
1401 | |
|
|
1402 | =item * all constructor arguments become object members. |
|
|
1403 | |
|
|
1404 | At least initially, when you pass a C<tls>-argument to the constructor it |
|
|
1405 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
|
|
1406 | mutated later on (for example C<tls> will hold the TLS connection object). |
|
|
1407 | |
|
|
1408 | =item * other object member names are prefixed with an C<_>. |
|
|
1409 | |
|
|
1410 | All object members not explicitly documented (internal use) are prefixed |
|
|
1411 | with an underscore character, so the remaining non-C<_>-namespace is free |
|
|
1412 | for use for subclasses. |
|
|
1413 | |
|
|
1414 | =item * all members not documented here and not prefixed with an underscore |
|
|
1415 | are free to use in subclasses. |
|
|
1416 | |
|
|
1417 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
|
|
1418 | member variables, but thats just life, at least it is documented. |
|
|
1419 | |
|
|
1420 | =back |
|
|
1421 | |
605 | =head1 AUTHOR |
1422 | =head1 AUTHOR |
606 | |
1423 | |
607 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
1424 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
608 | |
1425 | |
609 | =cut |
1426 | =cut |