1 | package AnyEvent::Handle; |
1 | package AnyEvent::Handle; |
2 | |
2 | |
3 | no warnings; |
3 | no warnings; |
4 | use strict; |
4 | use strict qw(subs vars); |
5 | |
5 | |
6 | use AnyEvent (); |
6 | use AnyEvent (); |
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
8 | use Scalar::Util (); |
8 | use Scalar::Util (); |
9 | use Carp (); |
9 | use Carp (); |
… | |
… | |
14 | |
14 | |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
16 | |
16 | |
17 | =cut |
17 | =cut |
18 | |
18 | |
19 | our $VERSION = 4.13; |
19 | our $VERSION = 4.3; |
20 | |
20 | |
21 | =head1 SYNOPSIS |
21 | =head1 SYNOPSIS |
22 | |
22 | |
23 | use AnyEvent; |
23 | use AnyEvent; |
24 | use AnyEvent::Handle; |
24 | use AnyEvent::Handle; |
… | |
… | |
49 | |
49 | |
50 | 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 |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
52 | on sockets see L<AnyEvent::Util>. |
52 | on sockets see L<AnyEvent::Util>. |
53 | |
53 | |
|
|
54 | The L<AnyEvent::Intro> tutorial contains some well-documented |
|
|
55 | AnyEvent::Handle examples. |
|
|
56 | |
54 | In the following, when the documentation refers to of "bytes" then this |
57 | In the following, when the documentation refers to of "bytes" then this |
55 | means characters. As sysread and syswrite are used for all I/O, their |
58 | means characters. As sysread and syswrite are used for all I/O, their |
56 | treatment of characters applies to this module as well. |
59 | treatment of characters applies to this module as well. |
57 | |
60 | |
58 | All callbacks will be invoked with the handle object as their first |
61 | All callbacks will be invoked with the handle object as their first |
… | |
… | |
70 | |
73 | |
71 | =item fh => $filehandle [MANDATORY] |
74 | =item fh => $filehandle [MANDATORY] |
72 | |
75 | |
73 | The filehandle this L<AnyEvent::Handle> object will operate on. |
76 | The filehandle this L<AnyEvent::Handle> object will operate on. |
74 | |
77 | |
75 | NOTE: The filehandle will be set to non-blocking (using |
78 | NOTE: The filehandle will be set to non-blocking mode (using |
76 | AnyEvent::Util::fh_nonblocking). |
79 | C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in |
|
|
80 | that mode. |
77 | |
81 | |
78 | =item on_eof => $cb->($handle) |
82 | =item on_eof => $cb->($handle) |
79 | |
83 | |
80 | Set the callback to be called when an end-of-file condition is detcted, |
84 | Set the callback to be called when an end-of-file condition is detected, |
81 | i.e. in the case of a socket, when the other side has closed the |
85 | i.e. in the case of a socket, when the other side has closed the |
82 | connection cleanly. |
86 | connection cleanly. |
83 | |
87 | |
|
|
88 | For sockets, this just means that the other side has stopped sending data, |
|
|
89 | you can still try to write data, and, in fact, one can return from the EOF |
|
|
90 | callback and continue writing data, as only the read part has been shut |
|
|
91 | down. |
|
|
92 | |
84 | While not mandatory, it is highly recommended to set an eof callback, |
93 | While not mandatory, it is I<highly> recommended to set an EOF callback, |
85 | otherwise you might end up with a closed socket while you are still |
94 | otherwise you might end up with a closed socket while you are still |
86 | waiting for data. |
95 | waiting for data. |
|
|
96 | |
|
|
97 | If an EOF condition has been detected but no C<on_eof> callback has been |
|
|
98 | set, then a fatal error will be raised with C<$!> set to <0>. |
87 | |
99 | |
88 | =item on_error => $cb->($handle, $fatal) |
100 | =item on_error => $cb->($handle, $fatal) |
89 | |
101 | |
90 | This is the error callback, which is called when, well, some error |
102 | This is the error callback, which is called when, well, some error |
91 | occured, such as not being able to resolve the hostname, failure to |
103 | occured, such as not being able to resolve the hostname, failure to |
92 | connect or a read error. |
104 | connect or a read error. |
93 | |
105 | |
94 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
106 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
95 | fatal errors the handle object will be shut down and will not be |
107 | fatal errors the handle object will be shut down and will not be usable |
|
|
108 | (but you are free to look at the current C<< ->rbuf >>). Examples of fatal |
|
|
109 | errors are an EOF condition with active (but unsatisifable) read watchers |
|
|
110 | (C<EPIPE>) or I/O errors. |
|
|
111 | |
96 | usable. Non-fatal errors can be retried by simply returning, but it is |
112 | Non-fatal errors can be retried by simply returning, but it is recommended |
97 | recommended to simply ignore this parameter and instead abondon the handle |
113 | to simply ignore this parameter and instead abondon the handle object |
98 | object when this callback is invoked. |
114 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
115 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
99 | |
116 | |
100 | On callback entrance, the value of C<$!> contains the operating system |
117 | On callback entrance, the value of C<$!> contains the operating system |
101 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
118 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
102 | |
119 | |
103 | While not mandatory, it is I<highly> recommended to set this callback, as |
120 | While not mandatory, it is I<highly> recommended to set this callback, as |
… | |
… | |
105 | C<croak>. |
122 | C<croak>. |
106 | |
123 | |
107 | =item on_read => $cb->($handle) |
124 | =item on_read => $cb->($handle) |
108 | |
125 | |
109 | This sets the default read callback, which is called when data arrives |
126 | This sets the default read callback, which is called when data arrives |
110 | and no read request is in the queue. |
127 | and no read request is in the queue (unlike read queue callbacks, this |
|
|
128 | callback will only be called when at least one octet of data is in the |
|
|
129 | read buffer). |
111 | |
130 | |
112 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
131 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
113 | method or access the C<$handle->{rbuf}> member directly. |
132 | method or access the C<$handle->{rbuf}> member directly. |
114 | |
133 | |
115 | When an EOF condition is detected then AnyEvent::Handle will first try to |
134 | When an EOF condition is detected then AnyEvent::Handle will first try to |
… | |
… | |
122 | This sets the callback that is called when the write buffer becomes empty |
141 | This sets the callback that is called when the write buffer becomes empty |
123 | (or when the callback is set and the buffer is empty already). |
142 | (or when the callback is set and the buffer is empty already). |
124 | |
143 | |
125 | To append to the write buffer, use the C<< ->push_write >> method. |
144 | To append to the write buffer, use the C<< ->push_write >> method. |
126 | |
145 | |
|
|
146 | This callback is useful when you don't want to put all of your write data |
|
|
147 | into the queue at once, for example, when you want to write the contents |
|
|
148 | of some file to the socket you might not want to read the whole file into |
|
|
149 | memory and push it into the queue, but instead only read more data from |
|
|
150 | the file when the write queue becomes empty. |
|
|
151 | |
127 | =item timeout => $fractional_seconds |
152 | =item timeout => $fractional_seconds |
128 | |
153 | |
129 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
154 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
130 | seconds pass without a successful read or write on the underlying file |
155 | seconds pass without a successful read or write on the underlying file |
131 | handle, the C<on_timeout> callback will be invoked (and if that one is |
156 | handle, the C<on_timeout> callback will be invoked (and if that one is |
132 | missing, an C<ETIMEDOUT> error will be raised). |
157 | missing, a non-fatal C<ETIMEDOUT> error will be raised). |
133 | |
158 | |
134 | Note that timeout processing is also active when you currently do not have |
159 | Note that timeout processing is also active when you currently do not have |
135 | any outstanding read or write requests: If you plan to keep the connection |
160 | any outstanding read or write requests: If you plan to keep the connection |
136 | idle then you should disable the timout temporarily or ignore the timeout |
161 | idle then you should disable the timout temporarily or ignore the timeout |
137 | in the C<on_timeout> callback. |
162 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
|
|
163 | restart the timeout. |
138 | |
164 | |
139 | Zero (the default) disables this timeout. |
165 | Zero (the default) disables this timeout. |
140 | |
166 | |
141 | =item on_timeout => $cb->($handle) |
167 | =item on_timeout => $cb->($handle) |
142 | |
168 | |
… | |
… | |
146 | |
172 | |
147 | =item rbuf_max => <bytes> |
173 | =item rbuf_max => <bytes> |
148 | |
174 | |
149 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
175 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
150 | when the read buffer ever (strictly) exceeds this size. This is useful to |
176 | when the read buffer ever (strictly) exceeds this size. This is useful to |
151 | avoid denial-of-service attacks. |
177 | avoid some forms of denial-of-service attacks. |
152 | |
178 | |
153 | For example, a server accepting connections from untrusted sources should |
179 | For example, a server accepting connections from untrusted sources should |
154 | be configured to accept only so-and-so much data that it cannot act on |
180 | be configured to accept only so-and-so much data that it cannot act on |
155 | (for example, when expecting a line, an attacker could send an unlimited |
181 | (for example, when expecting a line, an attacker could send an unlimited |
156 | amount of data without a callback ever being called as long as the line |
182 | amount of data without a callback ever being called as long as the line |
157 | isn't finished). |
183 | isn't finished). |
158 | |
184 | |
|
|
185 | =item autocork => <boolean> |
|
|
186 | |
|
|
187 | When disabled (the default), then C<push_write> will try to immediately |
|
|
188 | write the data to the handle, if possible. This avoids having to register |
|
|
189 | a write watcher and wait for the next event loop iteration, but can |
|
|
190 | be inefficient if you write multiple small chunks (on the wire, this |
|
|
191 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
|
|
192 | C<no_delay>, but this option can save costly syscalls). |
|
|
193 | |
|
|
194 | When enabled, then writes will always be queued till the next event loop |
|
|
195 | iteration. This is efficient when you do many small writes per iteration, |
|
|
196 | but less efficient when you do a single write only per iteration (or when |
|
|
197 | the write buffer often is full). It also increases write latency. |
|
|
198 | |
|
|
199 | =item no_delay => <boolean> |
|
|
200 | |
|
|
201 | When doing small writes on sockets, your operating system kernel might |
|
|
202 | wait a bit for more data before actually sending it out. This is called |
|
|
203 | the Nagle algorithm, and usually it is beneficial. |
|
|
204 | |
|
|
205 | In some situations you want as low a delay as possible, which can be |
|
|
206 | accomplishd by setting this option to a true value. |
|
|
207 | |
|
|
208 | The default is your opertaing system's default behaviour (most likely |
|
|
209 | enabled), this option explicitly enables or disables it, if possible. |
|
|
210 | |
159 | =item read_size => <bytes> |
211 | =item read_size => <bytes> |
160 | |
212 | |
161 | The default read block size (the amount of bytes this module will try to read |
213 | The default read block size (the amount of bytes this module will |
162 | during each (loop iteration). Default: C<8192>. |
214 | try to read during each loop iteration, which affects memory |
|
|
215 | requirements). Default: C<8192>. |
163 | |
216 | |
164 | =item low_water_mark => <bytes> |
217 | =item low_water_mark => <bytes> |
165 | |
218 | |
166 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
219 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
167 | buffer: If the write reaches this size or gets even samller it is |
220 | buffer: If the write reaches this size or gets even samller it is |
168 | considered empty. |
221 | considered empty. |
169 | |
222 | |
|
|
223 | Sometimes it can be beneficial (for performance reasons) to add data to |
|
|
224 | the write buffer before it is fully drained, but this is a rare case, as |
|
|
225 | the operating system kernel usually buffers data as well, so the default |
|
|
226 | is good in almost all cases. |
|
|
227 | |
|
|
228 | =item linger => <seconds> |
|
|
229 | |
|
|
230 | If non-zero (default: C<3600>), then the destructor of the |
|
|
231 | AnyEvent::Handle object will check whether there is still outstanding |
|
|
232 | write data and will install a watcher that will write this data to the |
|
|
233 | socket. No errors will be reported (this mostly matches how the operating |
|
|
234 | system treats outstanding data at socket close time). |
|
|
235 | |
|
|
236 | This will not work for partial TLS data that could not be encoded |
|
|
237 | yet. This data will be lost. Calling the C<stoptls> method in time might |
|
|
238 | help. |
|
|
239 | |
170 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
240 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
171 | |
241 | |
172 | When this parameter is given, it enables TLS (SSL) mode, that means it |
242 | When this parameter is given, it enables TLS (SSL) mode, that means |
173 | will start making tls handshake and will transparently encrypt/decrypt |
243 | AnyEvent will start a TLS handshake as soon as the conenction has been |
174 | data. |
244 | established and will transparently encrypt/decrypt data afterwards. |
175 | |
245 | |
176 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
246 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
177 | automatically when you try to create a TLS handle). |
247 | automatically when you try to create a TLS handle): this module doesn't |
|
|
248 | have a dependency on that module, so if your module requires it, you have |
|
|
249 | to add the dependency yourself. |
178 | |
250 | |
179 | For the TLS server side, use C<accept>, and for the TLS client side of a |
251 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
180 | connection, use C<connect> mode. |
252 | C<accept>, and for the TLS client side of a connection, use C<connect> |
|
|
253 | mode. |
181 | |
254 | |
182 | You can also provide your own TLS connection object, but you have |
255 | You can also provide your own TLS connection object, but you have |
183 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
256 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
184 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
257 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
185 | AnyEvent::Handle. |
258 | AnyEvent::Handle. |
186 | |
259 | |
187 | See the C<starttls> method if you need to start TLs negotiation later. |
260 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
188 | |
261 | |
189 | =item tls_ctx => $ssl_ctx |
262 | =item tls_ctx => $ssl_ctx |
190 | |
263 | |
191 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
264 | Use the given C<Net::SSLeay::CTX> object to create the new TLS connection |
192 | (unless a connection object was specified directly). If this parameter is |
265 | (unless a connection object was specified directly). If this parameter is |
193 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
266 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
194 | |
267 | |
195 | =item json => JSON or JSON::XS object |
268 | =item json => JSON or JSON::XS object |
196 | |
269 | |
197 | This is the json coder object used by the C<json> read and write types. |
270 | This is the json coder object used by the C<json> read and write types. |
198 | |
271 | |
199 | If you don't supply it, then AnyEvent::Handle will create and use a |
272 | If you don't supply it, then AnyEvent::Handle will create and use a |
200 | suitable one, which will write and expect UTF-8 encoded JSON texts. |
273 | suitable one (on demand), which will write and expect UTF-8 encoded JSON |
|
|
274 | texts. |
201 | |
275 | |
202 | Note that you are responsible to depend on the JSON module if you want to |
276 | Note that you are responsible to depend on the JSON module if you want to |
203 | use this functionality, as AnyEvent does not have a dependency itself. |
277 | use this functionality, as AnyEvent does not have a dependency itself. |
204 | |
278 | |
205 | =item filter_r => $cb |
|
|
206 | |
|
|
207 | =item filter_w => $cb |
|
|
208 | |
|
|
209 | These exist, but are undocumented at this time. |
|
|
210 | |
|
|
211 | =back |
279 | =back |
212 | |
280 | |
213 | =cut |
281 | =cut |
214 | |
282 | |
215 | sub new { |
283 | sub new { |
… | |
… | |
219 | |
287 | |
220 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
288 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
221 | |
289 | |
222 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
290 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
223 | |
291 | |
224 | if ($self->{tls}) { |
|
|
225 | require Net::SSLeay; |
|
|
226 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
292 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
227 | } |
293 | if $self->{tls}; |
228 | |
294 | |
229 | $self->{_activity} = AnyEvent->now; |
295 | $self->{_activity} = AnyEvent->now; |
230 | $self->_timeout; |
296 | $self->_timeout; |
231 | |
297 | |
232 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
298 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
233 | $self->on_read (delete $self->{on_read} ) if $self->{on_read}; |
299 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
|
|
300 | |
|
|
301 | $self->start_read |
|
|
302 | if $self->{on_read}; |
234 | |
303 | |
235 | $self |
304 | $self |
236 | } |
305 | } |
237 | |
306 | |
238 | sub _shutdown { |
307 | sub _shutdown { |
… | |
… | |
241 | delete $self->{_tw}; |
310 | delete $self->{_tw}; |
242 | delete $self->{_rw}; |
311 | delete $self->{_rw}; |
243 | delete $self->{_ww}; |
312 | delete $self->{_ww}; |
244 | delete $self->{fh}; |
313 | delete $self->{fh}; |
245 | |
314 | |
246 | $self->stoptls; |
315 | &_freetls; |
|
|
316 | |
|
|
317 | delete $self->{on_read}; |
|
|
318 | delete $self->{_queue}; |
247 | } |
319 | } |
248 | |
320 | |
249 | sub _error { |
321 | sub _error { |
250 | my ($self, $errno, $fatal) = @_; |
322 | my ($self, $errno, $fatal) = @_; |
251 | |
323 | |
… | |
… | |
254 | |
326 | |
255 | $! = $errno; |
327 | $! = $errno; |
256 | |
328 | |
257 | if ($self->{on_error}) { |
329 | if ($self->{on_error}) { |
258 | $self->{on_error}($self, $fatal); |
330 | $self->{on_error}($self, $fatal); |
259 | } else { |
331 | } elsif ($self->{fh}) { |
260 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
332 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
261 | } |
333 | } |
262 | } |
334 | } |
263 | |
335 | |
264 | =item $fh = $handle->fh |
336 | =item $fh = $handle->fh |
265 | |
337 | |
266 | This method returns the file handle of the L<AnyEvent::Handle> object. |
338 | This method returns the file handle used to create the L<AnyEvent::Handle> object. |
267 | |
339 | |
268 | =cut |
340 | =cut |
269 | |
341 | |
270 | sub fh { $_[0]{fh} } |
342 | sub fh { $_[0]{fh} } |
271 | |
343 | |
… | |
… | |
289 | $_[0]{on_eof} = $_[1]; |
361 | $_[0]{on_eof} = $_[1]; |
290 | } |
362 | } |
291 | |
363 | |
292 | =item $handle->on_timeout ($cb) |
364 | =item $handle->on_timeout ($cb) |
293 | |
365 | |
294 | Replace the current C<on_timeout> callback, or disables the callback |
366 | Replace the current C<on_timeout> callback, or disables the callback (but |
295 | (but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor |
367 | not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor |
296 | argument. |
368 | argument and method. |
297 | |
369 | |
298 | =cut |
370 | =cut |
299 | |
371 | |
300 | sub on_timeout { |
372 | sub on_timeout { |
301 | $_[0]{on_timeout} = $_[1]; |
373 | $_[0]{on_timeout} = $_[1]; |
|
|
374 | } |
|
|
375 | |
|
|
376 | =item $handle->autocork ($boolean) |
|
|
377 | |
|
|
378 | Enables or disables the current autocork behaviour (see C<autocork> |
|
|
379 | constructor argument). |
|
|
380 | |
|
|
381 | =cut |
|
|
382 | |
|
|
383 | =item $handle->no_delay ($boolean) |
|
|
384 | |
|
|
385 | Enables or disables the C<no_delay> setting (see constructor argument of |
|
|
386 | the same name for details). |
|
|
387 | |
|
|
388 | =cut |
|
|
389 | |
|
|
390 | sub no_delay { |
|
|
391 | $_[0]{no_delay} = $_[1]; |
|
|
392 | |
|
|
393 | eval { |
|
|
394 | local $SIG{__DIE__}; |
|
|
395 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
|
|
396 | }; |
302 | } |
397 | } |
303 | |
398 | |
304 | ############################################################################# |
399 | ############################################################################# |
305 | |
400 | |
306 | =item $handle->timeout ($seconds) |
401 | =item $handle->timeout ($seconds) |
… | |
… | |
384 | my ($self, $cb) = @_; |
479 | my ($self, $cb) = @_; |
385 | |
480 | |
386 | $self->{on_drain} = $cb; |
481 | $self->{on_drain} = $cb; |
387 | |
482 | |
388 | $cb->($self) |
483 | $cb->($self) |
389 | if $cb && $self->{low_water_mark} >= length $self->{wbuf}; |
484 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
390 | } |
485 | } |
391 | |
486 | |
392 | =item $handle->push_write ($data) |
487 | =item $handle->push_write ($data) |
393 | |
488 | |
394 | Queues the given scalar to be written. You can push as much data as you |
489 | Queues the given scalar to be written. You can push as much data as you |
… | |
… | |
411 | substr $self->{wbuf}, 0, $len, ""; |
506 | substr $self->{wbuf}, 0, $len, ""; |
412 | |
507 | |
413 | $self->{_activity} = AnyEvent->now; |
508 | $self->{_activity} = AnyEvent->now; |
414 | |
509 | |
415 | $self->{on_drain}($self) |
510 | $self->{on_drain}($self) |
416 | if $self->{low_water_mark} >= length $self->{wbuf} |
511 | if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) |
417 | && $self->{on_drain}; |
512 | && $self->{on_drain}; |
418 | |
513 | |
419 | delete $self->{_ww} unless length $self->{wbuf}; |
514 | delete $self->{_ww} unless length $self->{wbuf}; |
420 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
515 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
421 | $self->_error ($!, 1); |
516 | $self->_error ($!, 1); |
422 | } |
517 | } |
423 | }; |
518 | }; |
424 | |
519 | |
425 | # try to write data immediately |
520 | # try to write data immediately |
426 | $cb->(); |
521 | $cb->() unless $self->{autocork}; |
427 | |
522 | |
428 | # if still data left in wbuf, we need to poll |
523 | # if still data left in wbuf, we need to poll |
429 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
524 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
430 | if length $self->{wbuf}; |
525 | if length $self->{wbuf}; |
431 | }; |
526 | }; |
… | |
… | |
445 | |
540 | |
446 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
541 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
447 | ->($self, @_); |
542 | ->($self, @_); |
448 | } |
543 | } |
449 | |
544 | |
450 | if ($self->{filter_w}) { |
545 | if ($self->{tls}) { |
451 | $self->{filter_w}($self, \$_[0]); |
546 | $self->{_tls_wbuf} .= $_[0]; |
|
|
547 | |
|
|
548 | &_dotls ($self); |
452 | } else { |
549 | } else { |
453 | $self->{wbuf} .= $_[0]; |
550 | $self->{wbuf} .= $_[0]; |
454 | $self->_drain_wbuf; |
551 | $self->_drain_wbuf; |
455 | } |
552 | } |
456 | } |
553 | } |
… | |
… | |
473 | =cut |
570 | =cut |
474 | |
571 | |
475 | register_write_type netstring => sub { |
572 | register_write_type netstring => sub { |
476 | my ($self, $string) = @_; |
573 | my ($self, $string) = @_; |
477 | |
574 | |
478 | sprintf "%d:%s,", (length $string), $string |
575 | (length $string) . ":$string," |
|
|
576 | }; |
|
|
577 | |
|
|
578 | =item packstring => $format, $data |
|
|
579 | |
|
|
580 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
581 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
582 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
583 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
584 | |
|
|
585 | =cut |
|
|
586 | |
|
|
587 | register_write_type packstring => sub { |
|
|
588 | my ($self, $format, $string) = @_; |
|
|
589 | |
|
|
590 | pack "$format/a*", $string |
479 | }; |
591 | }; |
480 | |
592 | |
481 | =item json => $array_or_hashref |
593 | =item json => $array_or_hashref |
482 | |
594 | |
483 | Encodes the given hash or array reference into a JSON object. Unless you |
595 | Encodes the given hash or array reference into a JSON object. Unless you |
… | |
… | |
517 | |
629 | |
518 | $self->{json} ? $self->{json}->encode ($ref) |
630 | $self->{json} ? $self->{json}->encode ($ref) |
519 | : JSON::encode_json ($ref) |
631 | : JSON::encode_json ($ref) |
520 | }; |
632 | }; |
521 | |
633 | |
|
|
634 | =item storable => $reference |
|
|
635 | |
|
|
636 | Freezes the given reference using L<Storable> and writes it to the |
|
|
637 | handle. Uses the C<nfreeze> format. |
|
|
638 | |
|
|
639 | =cut |
|
|
640 | |
|
|
641 | register_write_type storable => sub { |
|
|
642 | my ($self, $ref) = @_; |
|
|
643 | |
|
|
644 | require Storable; |
|
|
645 | |
|
|
646 | pack "w/a*", Storable::nfreeze ($ref) |
|
|
647 | }; |
|
|
648 | |
522 | =back |
649 | =back |
523 | |
650 | |
524 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
651 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
525 | |
652 | |
526 | This function (not method) lets you add your own types to C<push_write>. |
653 | This function (not method) lets you add your own types to C<push_write>. |
… | |
… | |
548 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
675 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
549 | a queue. |
676 | a queue. |
550 | |
677 | |
551 | In the simple case, you just install an C<on_read> callback and whenever |
678 | In the simple case, you just install an C<on_read> callback and whenever |
552 | new data arrives, it will be called. You can then remove some data (if |
679 | new data arrives, it will be called. You can then remove some data (if |
553 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
680 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
554 | or not. |
681 | leave the data there if you want to accumulate more (e.g. when only a |
|
|
682 | partial message has been received so far). |
555 | |
683 | |
556 | In the more complex case, you want to queue multiple callbacks. In this |
684 | In the more complex case, you want to queue multiple callbacks. In this |
557 | case, AnyEvent::Handle will call the first queued callback each time new |
685 | case, AnyEvent::Handle will call the first queued callback each time new |
558 | data arrives and removes it when it has done its job (see C<push_read>, |
686 | data arrives (also the first time it is queued) and removes it when it has |
559 | below). |
687 | done its job (see C<push_read>, below). |
560 | |
688 | |
561 | This way you can, for example, push three line-reads, followed by reading |
689 | This way you can, for example, push three line-reads, followed by reading |
562 | a chunk of data, and AnyEvent::Handle will execute them in order. |
690 | a chunk of data, and AnyEvent::Handle will execute them in order. |
563 | |
691 | |
564 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
692 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
… | |
… | |
577 | # handle xml |
705 | # handle xml |
578 | }); |
706 | }); |
579 | }); |
707 | }); |
580 | }); |
708 | }); |
581 | |
709 | |
582 | Example 2: Implement a client for a protocol that replies either with |
710 | Example 2: Implement a client for a protocol that replies either with "OK" |
583 | "OK" and another line or "ERROR" for one request, and 64 bytes for the |
711 | and another line or "ERROR" for the first request that is sent, and 64 |
584 | second request. Due tot he availability of a full queue, we can just |
712 | bytes for the second request. Due to the availability of a queue, we can |
585 | pipeline sending both requests and manipulate the queue as necessary in |
713 | just pipeline sending both requests and manipulate the queue as necessary |
586 | the callbacks: |
714 | in the callbacks. |
587 | |
715 | |
588 | # request one |
716 | When the first callback is called and sees an "OK" response, it will |
|
|
717 | C<unshift> another line-read. This line-read will be queued I<before> the |
|
|
718 | 64-byte chunk callback. |
|
|
719 | |
|
|
720 | # request one, returns either "OK + extra line" or "ERROR" |
589 | $handle->push_write ("request 1\015\012"); |
721 | $handle->push_write ("request 1\015\012"); |
590 | |
722 | |
591 | # we expect "ERROR" or "OK" as response, so push a line read |
723 | # we expect "ERROR" or "OK" as response, so push a line read |
592 | $handle->push_read (line => sub { |
724 | $handle->push_read (line => sub { |
593 | # if we got an "OK", we have to _prepend_ another line, |
725 | # if we got an "OK", we have to _prepend_ another line, |
… | |
… | |
600 | ... |
732 | ... |
601 | }); |
733 | }); |
602 | } |
734 | } |
603 | }); |
735 | }); |
604 | |
736 | |
605 | # request two |
737 | # request two, simply returns 64 octets |
606 | $handle->push_write ("request 2\015\012"); |
738 | $handle->push_write ("request 2\015\012"); |
607 | |
739 | |
608 | # simply read 64 bytes, always |
740 | # simply read 64 bytes, always |
609 | $handle->push_read (chunk => 64, sub { |
741 | $handle->push_read (chunk => 64, sub { |
610 | my $response = $_[1]; |
742 | my $response = $_[1]; |
… | |
… | |
622 | |
754 | |
623 | if ( |
755 | if ( |
624 | defined $self->{rbuf_max} |
756 | defined $self->{rbuf_max} |
625 | && $self->{rbuf_max} < length $self->{rbuf} |
757 | && $self->{rbuf_max} < length $self->{rbuf} |
626 | ) { |
758 | ) { |
627 | return $self->_error (&Errno::ENOSPC, 1); |
759 | $self->_error (&Errno::ENOSPC, 1), return; |
628 | } |
760 | } |
629 | |
761 | |
630 | while () { |
762 | while () { |
631 | no strict 'refs'; |
|
|
632 | |
|
|
633 | my $len = length $self->{rbuf}; |
763 | my $len = length $self->{rbuf}; |
634 | |
764 | |
635 | if (my $cb = shift @{ $self->{_queue} }) { |
765 | if (my $cb = shift @{ $self->{_queue} }) { |
636 | unless ($cb->($self)) { |
766 | unless ($cb->($self)) { |
637 | if ($self->{_eof}) { |
767 | if ($self->{_eof}) { |
638 | # no progress can be made (not enough data and no data forthcoming) |
768 | # no progress can be made (not enough data and no data forthcoming) |
639 | return $self->_error (&Errno::EPIPE, 1); |
769 | $self->_error (&Errno::EPIPE, 1), return; |
640 | } |
770 | } |
641 | |
771 | |
642 | unshift @{ $self->{_queue} }, $cb; |
772 | unshift @{ $self->{_queue} }, $cb; |
643 | last; |
773 | last; |
644 | } |
774 | } |
645 | } elsif ($self->{on_read}) { |
775 | } elsif ($self->{on_read}) { |
|
|
776 | last unless $len; |
|
|
777 | |
646 | $self->{on_read}($self); |
778 | $self->{on_read}($self); |
647 | |
779 | |
648 | if ( |
780 | if ( |
649 | $len == length $self->{rbuf} # if no data has been consumed |
781 | $len == length $self->{rbuf} # if no data has been consumed |
650 | && !@{ $self->{_queue} } # and the queue is still empty |
782 | && !@{ $self->{_queue} } # and the queue is still empty |
651 | && $self->{on_read} # but we still have on_read |
783 | && $self->{on_read} # but we still have on_read |
652 | ) { |
784 | ) { |
653 | # no further data will arrive |
785 | # no further data will arrive |
654 | # so no progress can be made |
786 | # so no progress can be made |
655 | return $self->_error (&Errno::EPIPE, 1) |
787 | $self->_error (&Errno::EPIPE, 1), return |
656 | if $self->{_eof}; |
788 | if $self->{_eof}; |
657 | |
789 | |
658 | last; # more data might arrive |
790 | last; # more data might arrive |
659 | } |
791 | } |
660 | } else { |
792 | } else { |
661 | # read side becomes idle |
793 | # read side becomes idle |
662 | delete $self->{_rw}; |
794 | delete $self->{_rw} unless $self->{tls}; |
663 | last; |
795 | last; |
664 | } |
796 | } |
665 | } |
797 | } |
666 | |
798 | |
|
|
799 | if ($self->{_eof}) { |
|
|
800 | if ($self->{on_eof}) { |
667 | $self->{on_eof}($self) |
801 | $self->{on_eof}($self) |
668 | if $self->{_eof} && $self->{on_eof}; |
802 | } else { |
|
|
803 | $self->_error (0, 1); |
|
|
804 | } |
|
|
805 | } |
669 | |
806 | |
670 | # may need to restart read watcher |
807 | # may need to restart read watcher |
671 | unless ($self->{_rw}) { |
808 | unless ($self->{_rw}) { |
672 | $self->start_read |
809 | $self->start_read |
673 | if $self->{on_read} || @{ $self->{_queue} }; |
810 | if $self->{on_read} || @{ $self->{_queue} }; |
… | |
… | |
799 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
936 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
800 | 1 |
937 | 1 |
801 | } |
938 | } |
802 | }; |
939 | }; |
803 | |
940 | |
804 | # compatibility with older API |
|
|
805 | sub push_read_chunk { |
|
|
806 | $_[0]->push_read (chunk => $_[1], $_[2]); |
|
|
807 | } |
|
|
808 | |
|
|
809 | sub unshift_read_chunk { |
|
|
810 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
|
|
811 | } |
|
|
812 | |
|
|
813 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
941 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
814 | |
942 | |
815 | The callback will be called only once a full line (including the end of |
943 | The callback will be called only once a full line (including the end of |
816 | line marker, C<$eol>) has been read. This line (excluding the end of line |
944 | line marker, C<$eol>) has been read. This line (excluding the end of line |
817 | marker) will be passed to the callback as second argument (C<$line>), and |
945 | marker) will be passed to the callback as second argument (C<$line>), and |
… | |
… | |
832 | =cut |
960 | =cut |
833 | |
961 | |
834 | register_read_type line => sub { |
962 | register_read_type line => sub { |
835 | my ($self, $cb, $eol) = @_; |
963 | my ($self, $cb, $eol) = @_; |
836 | |
964 | |
837 | $eol = qr|(\015?\012)| if @_ < 3; |
965 | if (@_ < 3) { |
838 | $eol = quotemeta $eol unless ref $eol; |
966 | # this is more than twice as fast as the generic code below |
839 | $eol = qr|^(.*?)($eol)|s; |
|
|
840 | |
|
|
841 | sub { |
967 | sub { |
842 | $_[0]{rbuf} =~ s/$eol// or return; |
968 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
843 | |
969 | |
844 | $cb->($_[0], $1, $2); |
970 | $cb->($_[0], $1, $2); |
845 | 1 |
|
|
846 | } |
|
|
847 | }; |
|
|
848 | |
|
|
849 | # compatibility with older API |
|
|
850 | sub push_read_line { |
|
|
851 | my $self = shift; |
|
|
852 | $self->push_read (line => @_); |
|
|
853 | } |
|
|
854 | |
|
|
855 | sub unshift_read_line { |
|
|
856 | my $self = shift; |
|
|
857 | $self->unshift_read (line => @_); |
|
|
858 | } |
|
|
859 | |
|
|
860 | =item netstring => $cb->($handle, $string) |
|
|
861 | |
|
|
862 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
863 | |
|
|
864 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
865 | |
|
|
866 | =cut |
|
|
867 | |
|
|
868 | register_read_type netstring => sub { |
|
|
869 | my ($self, $cb) = @_; |
|
|
870 | |
|
|
871 | sub { |
|
|
872 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
873 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
874 | $self->_error (&Errno::EBADMSG); |
|
|
875 | } |
971 | 1 |
876 | return; |
|
|
877 | } |
972 | } |
|
|
973 | } else { |
|
|
974 | $eol = quotemeta $eol unless ref $eol; |
|
|
975 | $eol = qr|^(.*?)($eol)|s; |
878 | |
976 | |
879 | my $len = $1; |
977 | sub { |
|
|
978 | $_[0]{rbuf} =~ s/$eol// or return; |
880 | |
979 | |
881 | $self->unshift_read (chunk => $len, sub { |
980 | $cb->($_[0], $1, $2); |
882 | my $string = $_[1]; |
|
|
883 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
884 | if ($_[1] eq ",") { |
|
|
885 | $cb->($_[0], $string); |
|
|
886 | } else { |
|
|
887 | $self->_error (&Errno::EBADMSG); |
|
|
888 | } |
|
|
889 | }); |
981 | 1 |
890 | }); |
982 | } |
891 | |
|
|
892 | 1 |
|
|
893 | } |
983 | } |
894 | }; |
984 | }; |
895 | |
985 | |
896 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
986 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
897 | |
987 | |
… | |
… | |
961 | |
1051 | |
962 | () |
1052 | () |
963 | } |
1053 | } |
964 | }; |
1054 | }; |
965 | |
1055 | |
|
|
1056 | =item netstring => $cb->($handle, $string) |
|
|
1057 | |
|
|
1058 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
1059 | |
|
|
1060 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
1061 | |
|
|
1062 | =cut |
|
|
1063 | |
|
|
1064 | register_read_type netstring => sub { |
|
|
1065 | my ($self, $cb) = @_; |
|
|
1066 | |
|
|
1067 | sub { |
|
|
1068 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
1069 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
1070 | $self->_error (&Errno::EBADMSG); |
|
|
1071 | } |
|
|
1072 | return; |
|
|
1073 | } |
|
|
1074 | |
|
|
1075 | my $len = $1; |
|
|
1076 | |
|
|
1077 | $self->unshift_read (chunk => $len, sub { |
|
|
1078 | my $string = $_[1]; |
|
|
1079 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
1080 | if ($_[1] eq ",") { |
|
|
1081 | $cb->($_[0], $string); |
|
|
1082 | } else { |
|
|
1083 | $self->_error (&Errno::EBADMSG); |
|
|
1084 | } |
|
|
1085 | }); |
|
|
1086 | }); |
|
|
1087 | |
|
|
1088 | 1 |
|
|
1089 | } |
|
|
1090 | }; |
|
|
1091 | |
|
|
1092 | =item packstring => $format, $cb->($handle, $string) |
|
|
1093 | |
|
|
1094 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
1095 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
1096 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
1097 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
1098 | |
|
|
1099 | For example, DNS over TCP uses a prefix of C<n> (2 octet network order), |
|
|
1100 | EPP uses a prefix of C<N> (4 octtes). |
|
|
1101 | |
|
|
1102 | Example: read a block of data prefixed by its length in BER-encoded |
|
|
1103 | format (very efficient). |
|
|
1104 | |
|
|
1105 | $handle->push_read (packstring => "w", sub { |
|
|
1106 | my ($handle, $data) = @_; |
|
|
1107 | }); |
|
|
1108 | |
|
|
1109 | =cut |
|
|
1110 | |
|
|
1111 | register_read_type packstring => sub { |
|
|
1112 | my ($self, $cb, $format) = @_; |
|
|
1113 | |
|
|
1114 | sub { |
|
|
1115 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1116 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
|
|
1117 | or return; |
|
|
1118 | |
|
|
1119 | $format = length pack $format, $len; |
|
|
1120 | |
|
|
1121 | # bypass unshift if we already have the remaining chunk |
|
|
1122 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1123 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1124 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1125 | $cb->($_[0], $data); |
|
|
1126 | } else { |
|
|
1127 | # remove prefix |
|
|
1128 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1129 | |
|
|
1130 | # read remaining chunk |
|
|
1131 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1132 | } |
|
|
1133 | |
|
|
1134 | 1 |
|
|
1135 | } |
|
|
1136 | }; |
|
|
1137 | |
966 | =item json => $cb->($handle, $hash_or_arrayref) |
1138 | =item json => $cb->($handle, $hash_or_arrayref) |
967 | |
1139 | |
968 | Reads a JSON object or array, decodes it and passes it to the callback. |
1140 | Reads a JSON object or array, decodes it and passes it to the callback. |
969 | |
1141 | |
970 | If a C<json> object was passed to the constructor, then that will be used |
1142 | If a C<json> object was passed to the constructor, then that will be used |
… | |
… | |
980 | the C<json> write type description, above, for an actual example. |
1152 | the C<json> write type description, above, for an actual example. |
981 | |
1153 | |
982 | =cut |
1154 | =cut |
983 | |
1155 | |
984 | register_read_type json => sub { |
1156 | register_read_type json => sub { |
985 | my ($self, $cb, $accept, $reject, $skip) = @_; |
1157 | my ($self, $cb) = @_; |
986 | |
1158 | |
987 | require JSON; |
1159 | require JSON; |
988 | |
1160 | |
989 | my $data; |
1161 | my $data; |
990 | my $rbuf = \$self->{rbuf}; |
1162 | my $rbuf = \$self->{rbuf}; |
… | |
… | |
1005 | () |
1177 | () |
1006 | } |
1178 | } |
1007 | } |
1179 | } |
1008 | }; |
1180 | }; |
1009 | |
1181 | |
|
|
1182 | =item storable => $cb->($handle, $ref) |
|
|
1183 | |
|
|
1184 | Deserialises a L<Storable> frozen representation as written by the |
|
|
1185 | C<storable> write type (BER-encoded length prefix followed by nfreeze'd |
|
|
1186 | data). |
|
|
1187 | |
|
|
1188 | Raises C<EBADMSG> error if the data could not be decoded. |
|
|
1189 | |
|
|
1190 | =cut |
|
|
1191 | |
|
|
1192 | register_read_type storable => sub { |
|
|
1193 | my ($self, $cb) = @_; |
|
|
1194 | |
|
|
1195 | require Storable; |
|
|
1196 | |
|
|
1197 | sub { |
|
|
1198 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1199 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
|
|
1200 | or return; |
|
|
1201 | |
|
|
1202 | my $format = length pack "w", $len; |
|
|
1203 | |
|
|
1204 | # bypass unshift if we already have the remaining chunk |
|
|
1205 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1206 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1207 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1208 | $cb->($_[0], Storable::thaw ($data)); |
|
|
1209 | } else { |
|
|
1210 | # remove prefix |
|
|
1211 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1212 | |
|
|
1213 | # read remaining chunk |
|
|
1214 | $_[0]->unshift_read (chunk => $len, sub { |
|
|
1215 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
|
|
1216 | $cb->($_[0], $ref); |
|
|
1217 | } else { |
|
|
1218 | $self->_error (&Errno::EBADMSG); |
|
|
1219 | } |
|
|
1220 | }); |
|
|
1221 | } |
|
|
1222 | |
|
|
1223 | 1 |
|
|
1224 | } |
|
|
1225 | }; |
|
|
1226 | |
1010 | =back |
1227 | =back |
1011 | |
1228 | |
1012 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1229 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1013 | |
1230 | |
1014 | This function (not method) lets you add your own types to C<push_read>. |
1231 | This function (not method) lets you add your own types to C<push_read>. |
… | |
… | |
1041 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1258 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1042 | you change the C<on_read> callback or push/unshift a read callback, and it |
1259 | you change the C<on_read> callback or push/unshift a read callback, and it |
1043 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1260 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1044 | there are any read requests in the queue. |
1261 | there are any read requests in the queue. |
1045 | |
1262 | |
|
|
1263 | These methods will have no effect when in TLS mode (as TLS doesn't support |
|
|
1264 | half-duplex connections). |
|
|
1265 | |
1046 | =cut |
1266 | =cut |
1047 | |
1267 | |
1048 | sub stop_read { |
1268 | sub stop_read { |
1049 | my ($self) = @_; |
1269 | my ($self) = @_; |
1050 | |
1270 | |
1051 | delete $self->{_rw}; |
1271 | delete $self->{_rw} unless $self->{tls}; |
1052 | } |
1272 | } |
1053 | |
1273 | |
1054 | sub start_read { |
1274 | sub start_read { |
1055 | my ($self) = @_; |
1275 | my ($self) = @_; |
1056 | |
1276 | |
1057 | unless ($self->{_rw} || $self->{_eof}) { |
1277 | unless ($self->{_rw} || $self->{_eof}) { |
1058 | Scalar::Util::weaken $self; |
1278 | Scalar::Util::weaken $self; |
1059 | |
1279 | |
1060 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1280 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1061 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
1281 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1062 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1282 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1063 | |
1283 | |
1064 | if ($len > 0) { |
1284 | if ($len > 0) { |
1065 | $self->{_activity} = AnyEvent->now; |
1285 | $self->{_activity} = AnyEvent->now; |
1066 | |
1286 | |
1067 | $self->{filter_r} |
1287 | if ($self->{tls}) { |
1068 | ? $self->{filter_r}($self, $rbuf) |
1288 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1069 | : $self->{_in_drain} || $self->_drain_rbuf; |
1289 | |
|
|
1290 | &_dotls ($self); |
|
|
1291 | } else { |
|
|
1292 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1293 | } |
1070 | |
1294 | |
1071 | } elsif (defined $len) { |
1295 | } elsif (defined $len) { |
1072 | delete $self->{_rw}; |
1296 | delete $self->{_rw}; |
1073 | $self->{_eof} = 1; |
1297 | $self->{_eof} = 1; |
1074 | $self->_drain_rbuf unless $self->{_in_drain}; |
1298 | $self->_drain_rbuf unless $self->{_in_drain}; |
… | |
… | |
1078 | } |
1302 | } |
1079 | }); |
1303 | }); |
1080 | } |
1304 | } |
1081 | } |
1305 | } |
1082 | |
1306 | |
|
|
1307 | # poll the write BIO and send the data if applicable |
1083 | sub _dotls { |
1308 | sub _dotls { |
1084 | my ($self) = @_; |
1309 | my ($self) = @_; |
1085 | |
1310 | |
1086 | my $buf; |
1311 | my $tmp; |
1087 | |
1312 | |
1088 | if (length $self->{_tls_wbuf}) { |
1313 | if (length $self->{_tls_wbuf}) { |
1089 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1314 | while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1090 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1315 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
1091 | } |
1316 | } |
1092 | } |
1317 | } |
1093 | |
1318 | |
1094 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
|
|
1095 | $self->{wbuf} .= $buf; |
|
|
1096 | $self->_drain_wbuf; |
|
|
1097 | } |
|
|
1098 | |
|
|
1099 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
1319 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
1100 | if (length $buf) { |
1320 | unless (length $tmp) { |
1101 | $self->{rbuf} .= $buf; |
|
|
1102 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1103 | } else { |
|
|
1104 | # let's treat SSL-eof as we treat normal EOF |
1321 | # let's treat SSL-eof as we treat normal EOF |
|
|
1322 | delete $self->{_rw}; |
1105 | $self->{_eof} = 1; |
1323 | $self->{_eof} = 1; |
1106 | $self->_shutdown; |
1324 | &_freetls; |
1107 | return; |
|
|
1108 | } |
1325 | } |
1109 | } |
|
|
1110 | |
1326 | |
|
|
1327 | $self->{rbuf} .= $tmp; |
|
|
1328 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1329 | $self->{tls} or return; # tls session might have gone away in callback |
|
|
1330 | } |
|
|
1331 | |
1111 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1332 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
1112 | |
1333 | |
1113 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1334 | if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) { |
1114 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
1335 | if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) { |
1115 | return $self->_error ($!, 1); |
1336 | return $self->_error ($!, 1); |
1116 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1337 | } elsif ($tmp == Net::SSLeay::ERROR_SSL ()) { |
1117 | return $self->_error (&Errno::EIO, 1); |
1338 | return $self->_error (&Errno::EIO, 1); |
1118 | } |
1339 | } |
1119 | |
1340 | |
1120 | # all others are fine for our purposes |
1341 | # all other errors are fine for our purposes |
|
|
1342 | } |
|
|
1343 | |
|
|
1344 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
|
|
1345 | $self->{wbuf} .= $tmp; |
|
|
1346 | $self->_drain_wbuf; |
1121 | } |
1347 | } |
1122 | } |
1348 | } |
1123 | |
1349 | |
1124 | =item $handle->starttls ($tls[, $tls_ctx]) |
1350 | =item $handle->starttls ($tls[, $tls_ctx]) |
1125 | |
1351 | |
… | |
… | |
1135 | |
1361 | |
1136 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
1362 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
1137 | call and can be used or changed to your liking. Note that the handshake |
1363 | call and can be used or changed to your liking. Note that the handshake |
1138 | might have already started when this function returns. |
1364 | might have already started when this function returns. |
1139 | |
1365 | |
|
|
1366 | If it an error to start a TLS handshake more than once per |
|
|
1367 | AnyEvent::Handle object (this is due to bugs in OpenSSL). |
|
|
1368 | |
1140 | =cut |
1369 | =cut |
1141 | |
1370 | |
1142 | sub starttls { |
1371 | sub starttls { |
1143 | my ($self, $ssl, $ctx) = @_; |
1372 | my ($self, $ssl, $ctx) = @_; |
1144 | |
1373 | |
1145 | $self->stoptls; |
1374 | require Net::SSLeay; |
1146 | |
1375 | |
|
|
1376 | Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object" |
|
|
1377 | if $self->{tls}; |
|
|
1378 | |
1147 | if ($ssl eq "accept") { |
1379 | if ($ssl eq "accept") { |
1148 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1380 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1149 | Net::SSLeay::set_accept_state ($ssl); |
1381 | Net::SSLeay::set_accept_state ($ssl); |
1150 | } elsif ($ssl eq "connect") { |
1382 | } elsif ($ssl eq "connect") { |
1151 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1383 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
… | |
… | |
1157 | # basically, this is deep magic (because SSL_read should have the same issues) |
1389 | # basically, this is deep magic (because SSL_read should have the same issues) |
1158 | # but the openssl maintainers basically said: "trust us, it just works". |
1390 | # but the openssl maintainers basically said: "trust us, it just works". |
1159 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1391 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1160 | # and mismaintained ssleay-module doesn't even offer them). |
1392 | # and mismaintained ssleay-module doesn't even offer them). |
1161 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
1393 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
|
|
1394 | # |
|
|
1395 | # in short: this is a mess. |
|
|
1396 | # |
|
|
1397 | # note that we do not try to keep the length constant between writes as we are required to do. |
|
|
1398 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
|
|
1399 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
|
|
1400 | # have identity issues in that area. |
1162 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1401 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1163 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1402 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1164 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1403 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1165 | |
1404 | |
1166 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1405 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1167 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1406 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1168 | |
1407 | |
1169 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1408 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1170 | |
1409 | |
1171 | $self->{filter_w} = sub { |
1410 | &_dotls; # need to trigger the initial handshake |
1172 | $_[0]{_tls_wbuf} .= ${$_[1]}; |
1411 | $self->start_read; # make sure we actually do read |
1173 | &_dotls; |
|
|
1174 | }; |
|
|
1175 | $self->{filter_r} = sub { |
|
|
1176 | Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]}); |
|
|
1177 | &_dotls; |
|
|
1178 | }; |
|
|
1179 | } |
1412 | } |
1180 | |
1413 | |
1181 | =item $handle->stoptls |
1414 | =item $handle->stoptls |
1182 | |
1415 | |
1183 | Destroys the SSL connection, if any. Partial read or write data will be |
1416 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1184 | lost. |
1417 | sending a close notify to the other side, but since OpenSSL doesn't |
|
|
1418 | support non-blocking shut downs, it is not possible to re-use the stream |
|
|
1419 | afterwards. |
1185 | |
1420 | |
1186 | =cut |
1421 | =cut |
1187 | |
1422 | |
1188 | sub stoptls { |
1423 | sub stoptls { |
1189 | my ($self) = @_; |
1424 | my ($self) = @_; |
1190 | |
1425 | |
|
|
1426 | if ($self->{tls}) { |
|
|
1427 | Net::SSLeay::shutdown ($self->{tls}); |
|
|
1428 | |
|
|
1429 | &_dotls; |
|
|
1430 | |
|
|
1431 | # we don't give a shit. no, we do, but we can't. no... |
|
|
1432 | # we, we... have to use openssl :/ |
|
|
1433 | &_freetls; |
|
|
1434 | } |
|
|
1435 | } |
|
|
1436 | |
|
|
1437 | sub _freetls { |
|
|
1438 | my ($self) = @_; |
|
|
1439 | |
|
|
1440 | return unless $self->{tls}; |
|
|
1441 | |
1191 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
1442 | Net::SSLeay::free (delete $self->{tls}); |
1192 | |
1443 | |
1193 | delete $self->{_rbio}; |
1444 | delete @$self{qw(_rbio _wbio _tls_wbuf)}; |
1194 | delete $self->{_wbio}; |
|
|
1195 | delete $self->{_tls_wbuf}; |
|
|
1196 | delete $self->{filter_r}; |
|
|
1197 | delete $self->{filter_w}; |
|
|
1198 | } |
1445 | } |
1199 | |
1446 | |
1200 | sub DESTROY { |
1447 | sub DESTROY { |
1201 | my $self = shift; |
1448 | my $self = shift; |
1202 | |
1449 | |
1203 | $self->stoptls; |
1450 | &_freetls; |
|
|
1451 | |
|
|
1452 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
|
|
1453 | |
|
|
1454 | if ($linger && length $self->{wbuf}) { |
|
|
1455 | my $fh = delete $self->{fh}; |
|
|
1456 | my $wbuf = delete $self->{wbuf}; |
|
|
1457 | |
|
|
1458 | my @linger; |
|
|
1459 | |
|
|
1460 | push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { |
|
|
1461 | my $len = syswrite $fh, $wbuf, length $wbuf; |
|
|
1462 | |
|
|
1463 | if ($len > 0) { |
|
|
1464 | substr $wbuf, 0, $len, ""; |
|
|
1465 | } else { |
|
|
1466 | @linger = (); # end |
|
|
1467 | } |
|
|
1468 | }); |
|
|
1469 | push @linger, AnyEvent->timer (after => $linger, cb => sub { |
|
|
1470 | @linger = (); |
|
|
1471 | }); |
|
|
1472 | } |
|
|
1473 | } |
|
|
1474 | |
|
|
1475 | =item $handle->destroy |
|
|
1476 | |
|
|
1477 | Shuts down the handle object as much as possible - this call ensures that |
|
|
1478 | no further callbacks will be invoked and resources will be freed as much |
|
|
1479 | as possible. You must not call any methods on the object afterwards. |
|
|
1480 | |
|
|
1481 | Normally, you can just "forget" any references to an AnyEvent::Handle |
|
|
1482 | object and it will simply shut down. This works in fatal error and EOF |
|
|
1483 | callbacks, as well as code outside. It does I<NOT> work in a read or write |
|
|
1484 | callback, so when you want to destroy the AnyEvent::Handle object from |
|
|
1485 | within such an callback. You I<MUST> call C<< ->destroy >> explicitly in |
|
|
1486 | that case. |
|
|
1487 | |
|
|
1488 | The handle might still linger in the background and write out remaining |
|
|
1489 | data, as specified by the C<linger> option, however. |
|
|
1490 | |
|
|
1491 | =cut |
|
|
1492 | |
|
|
1493 | sub destroy { |
|
|
1494 | my ($self) = @_; |
|
|
1495 | |
|
|
1496 | $self->DESTROY; |
|
|
1497 | %$self = (); |
1204 | } |
1498 | } |
1205 | |
1499 | |
1206 | =item AnyEvent::Handle::TLS_CTX |
1500 | =item AnyEvent::Handle::TLS_CTX |
1207 | |
1501 | |
1208 | This function creates and returns the Net::SSLeay::CTX object used by |
1502 | This function creates and returns the Net::SSLeay::CTX object used by |
… | |
… | |
1238 | } |
1532 | } |
1239 | } |
1533 | } |
1240 | |
1534 | |
1241 | =back |
1535 | =back |
1242 | |
1536 | |
|
|
1537 | |
|
|
1538 | =head1 NONFREQUENTLY ASKED QUESTIONS |
|
|
1539 | |
|
|
1540 | =over 4 |
|
|
1541 | |
|
|
1542 | =item I C<undef> the AnyEvent::Handle reference inside my callback and |
|
|
1543 | still get further invocations! |
|
|
1544 | |
|
|
1545 | That's because AnyEvent::Handle keeps a reference to itself when handling |
|
|
1546 | read or write callbacks. |
|
|
1547 | |
|
|
1548 | It is only safe to "forget" the reference inside EOF or error callbacks, |
|
|
1549 | from within all other callbacks, you need to explicitly call the C<< |
|
|
1550 | ->destroy >> method. |
|
|
1551 | |
|
|
1552 | =item I get different callback invocations in TLS mode/Why can't I pause |
|
|
1553 | reading? |
|
|
1554 | |
|
|
1555 | Unlike, say, TCP, TLS connections do not consist of two independent |
|
|
1556 | communication channels, one for each direction. Or put differently. The |
|
|
1557 | read and write directions are not independent of each other: you cannot |
|
|
1558 | write data unless you are also prepared to read, and vice versa. |
|
|
1559 | |
|
|
1560 | This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> |
|
|
1561 | callback invocations when you are not expecting any read data - the reason |
|
|
1562 | is that AnyEvent::Handle always reads in TLS mode. |
|
|
1563 | |
|
|
1564 | During the connection, you have to make sure that you always have a |
|
|
1565 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
|
|
1566 | connection (or when you no longer want to use it) you can call the |
|
|
1567 | C<destroy> method. |
|
|
1568 | |
|
|
1569 | =item How do I read data until the other side closes the connection? |
|
|
1570 | |
|
|
1571 | If you just want to read your data into a perl scalar, the easiest way |
|
|
1572 | to achieve this is by setting an C<on_read> callback that does nothing, |
|
|
1573 | clearing the C<on_eof> callback and in the C<on_error> callback, the data |
|
|
1574 | will be in C<$_[0]{rbuf}>: |
|
|
1575 | |
|
|
1576 | $handle->on_read (sub { }); |
|
|
1577 | $handle->on_eof (undef); |
|
|
1578 | $handle->on_error (sub { |
|
|
1579 | my $data = delete $_[0]{rbuf}; |
|
|
1580 | undef $handle; |
|
|
1581 | }); |
|
|
1582 | |
|
|
1583 | The reason to use C<on_error> is that TCP connections, due to latencies |
|
|
1584 | and packets loss, might get closed quite violently with an error, when in |
|
|
1585 | fact, all data has been received. |
|
|
1586 | |
|
|
1587 | It is usually better to use acknowledgements when transferring data, |
|
|
1588 | to make sure the other side hasn't just died and you got the data |
|
|
1589 | intact. This is also one reason why so many internet protocols have an |
|
|
1590 | explicit QUIT command. |
|
|
1591 | |
|
|
1592 | =item I don't want to destroy the handle too early - how do I wait until |
|
|
1593 | all data has been written? |
|
|
1594 | |
|
|
1595 | After writing your last bits of data, set the C<on_drain> callback |
|
|
1596 | and destroy the handle in there - with the default setting of |
|
|
1597 | C<low_water_mark> this will be called precisely when all data has been |
|
|
1598 | written to the socket: |
|
|
1599 | |
|
|
1600 | $handle->push_write (...); |
|
|
1601 | $handle->on_drain (sub { |
|
|
1602 | warn "all data submitted to the kernel\n"; |
|
|
1603 | undef $handle; |
|
|
1604 | }); |
|
|
1605 | |
|
|
1606 | =back |
|
|
1607 | |
|
|
1608 | |
1243 | =head1 SUBCLASSING AnyEvent::Handle |
1609 | =head1 SUBCLASSING AnyEvent::Handle |
1244 | |
1610 | |
1245 | In many cases, you might want to subclass AnyEvent::Handle. |
1611 | In many cases, you might want to subclass AnyEvent::Handle. |
1246 | |
1612 | |
1247 | To make this easier, a given version of AnyEvent::Handle uses these |
1613 | To make this easier, a given version of AnyEvent::Handle uses these |
… | |
… | |
1250 | =over 4 |
1616 | =over 4 |
1251 | |
1617 | |
1252 | =item * all constructor arguments become object members. |
1618 | =item * all constructor arguments become object members. |
1253 | |
1619 | |
1254 | At least initially, when you pass a C<tls>-argument to the constructor it |
1620 | At least initially, when you pass a C<tls>-argument to the constructor it |
1255 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
1621 | will end up in C<< $handle->{tls} >>. Those members might be changed or |
1256 | mutated later on (for example C<tls> will hold the TLS connection object). |
1622 | mutated later on (for example C<tls> will hold the TLS connection object). |
1257 | |
1623 | |
1258 | =item * other object member names are prefixed with an C<_>. |
1624 | =item * other object member names are prefixed with an C<_>. |
1259 | |
1625 | |
1260 | All object members not explicitly documented (internal use) are prefixed |
1626 | All object members not explicitly documented (internal use) are prefixed |