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 |
59 | argument. |
62 | argument. |
60 | |
63 | |
|
|
64 | =head2 SIGPIPE is not handled by this module |
|
|
65 | |
|
|
66 | SIGPIPE is not handled by this module, so one of the practical |
|
|
67 | requirements of using it is to ignore SIGPIPE (C<$SIG{PIPE} = |
|
|
68 | 'IGNORE'>). At least, this is highly recommend in a networked program: If |
|
|
69 | you use AnyEvent::Handle in a filter program (like sort), exiting on |
|
|
70 | SIGPIPE is probably the right thing to do. |
|
|
71 | |
61 | =head1 METHODS |
72 | =head1 METHODS |
62 | |
73 | |
63 | =over 4 |
74 | =over 4 |
64 | |
75 | |
65 | =item B<new (%args)> |
76 | =item B<new (%args)> |
… | |
… | |
70 | |
81 | |
71 | =item fh => $filehandle [MANDATORY] |
82 | =item fh => $filehandle [MANDATORY] |
72 | |
83 | |
73 | The filehandle this L<AnyEvent::Handle> object will operate on. |
84 | The filehandle this L<AnyEvent::Handle> object will operate on. |
74 | |
85 | |
75 | NOTE: The filehandle will be set to non-blocking (using |
86 | NOTE: The filehandle will be set to non-blocking mode (using |
76 | AnyEvent::Util::fh_nonblocking). |
87 | C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in |
|
|
88 | that mode. |
77 | |
89 | |
78 | =item on_eof => $cb->($handle) |
90 | =item on_eof => $cb->($handle) |
79 | |
91 | |
80 | Set the callback to be called when an end-of-file condition is detcted, |
92 | 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 |
93 | i.e. in the case of a socket, when the other side has closed the |
82 | connection cleanly. |
94 | connection cleanly. |
83 | |
95 | |
|
|
96 | For sockets, this just means that the other side has stopped sending data, |
|
|
97 | you can still try to write data, and, in fact, one can return from the eof |
|
|
98 | callback and continue writing data, as only the read part has been shut |
|
|
99 | down. |
|
|
100 | |
84 | While not mandatory, it is highly recommended to set an eof callback, |
101 | 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 |
102 | otherwise you might end up with a closed socket while you are still |
86 | waiting for data. |
103 | waiting for data. |
|
|
104 | |
|
|
105 | If an EOF condition has been detected but no C<on_eof> callback has been |
|
|
106 | set, then a fatal error will be raised with C<$!> set to <0>. |
87 | |
107 | |
88 | =item on_error => $cb->($handle, $fatal) |
108 | =item on_error => $cb->($handle, $fatal) |
89 | |
109 | |
90 | This is the error callback, which is called when, well, some error |
110 | 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 |
111 | occured, such as not being able to resolve the hostname, failure to |
92 | connect or a read error. |
112 | connect or a read error. |
93 | |
113 | |
94 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
114 | 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 |
115 | fatal errors the handle object will be shut down and will not be usable |
|
|
116 | (but you are free to look at the current C<< ->rbuf >>). Examples of fatal |
|
|
117 | errors are an EOF condition with active (but unsatisifable) read watchers |
|
|
118 | (C<EPIPE>) or I/O errors. |
|
|
119 | |
96 | usable. Non-fatal errors can be retried by simply returning, but it is |
120 | 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 |
121 | to simply ignore this parameter and instead abondon the handle object |
98 | object when this callback is invoked. |
122 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
123 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
99 | |
124 | |
100 | On callback entrance, the value of C<$!> contains the operating system |
125 | On callback entrance, the value of C<$!> contains the operating system |
101 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
126 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
102 | |
127 | |
103 | While not mandatory, it is I<highly> recommended to set this callback, as |
128 | While not mandatory, it is I<highly> recommended to set this callback, as |
… | |
… | |
105 | C<croak>. |
130 | C<croak>. |
106 | |
131 | |
107 | =item on_read => $cb->($handle) |
132 | =item on_read => $cb->($handle) |
108 | |
133 | |
109 | This sets the default read callback, which is called when data arrives |
134 | This sets the default read callback, which is called when data arrives |
110 | and no read request is in the queue. |
135 | and no read request is in the queue (unlike read queue callbacks, this |
|
|
136 | callback will only be called when at least one octet of data is in the |
|
|
137 | read buffer). |
111 | |
138 | |
112 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
139 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
113 | method or access the C<$handle->{rbuf}> member directly. |
140 | method or access the C<$handle->{rbuf}> member directly. |
114 | |
141 | |
115 | When an EOF condition is detected then AnyEvent::Handle will first try to |
142 | 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 |
149 | 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). |
150 | (or when the callback is set and the buffer is empty already). |
124 | |
151 | |
125 | To append to the write buffer, use the C<< ->push_write >> method. |
152 | To append to the write buffer, use the C<< ->push_write >> method. |
126 | |
153 | |
|
|
154 | This callback is useful when you don't want to put all of your write data |
|
|
155 | into the queue at once, for example, when you want to write the contents |
|
|
156 | of some file to the socket you might not want to read the whole file into |
|
|
157 | memory and push it into the queue, but instead only read more data from |
|
|
158 | the file when the write queue becomes empty. |
|
|
159 | |
127 | =item timeout => $fractional_seconds |
160 | =item timeout => $fractional_seconds |
128 | |
161 | |
129 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
162 | 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 |
163 | 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 |
164 | handle, the C<on_timeout> callback will be invoked (and if that one is |
132 | missing, an C<ETIMEDOUT> error will be raised). |
165 | missing, a non-fatal C<ETIMEDOUT> error will be raised). |
133 | |
166 | |
134 | Note that timeout processing is also active when you currently do not have |
167 | 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 |
168 | 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 |
169 | idle then you should disable the timout temporarily or ignore the timeout |
137 | in the C<on_timeout> callback. |
170 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
|
|
171 | restart the timeout. |
138 | |
172 | |
139 | Zero (the default) disables this timeout. |
173 | Zero (the default) disables this timeout. |
140 | |
174 | |
141 | =item on_timeout => $cb->($handle) |
175 | =item on_timeout => $cb->($handle) |
142 | |
176 | |
… | |
… | |
146 | |
180 | |
147 | =item rbuf_max => <bytes> |
181 | =item rbuf_max => <bytes> |
148 | |
182 | |
149 | If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
183 | 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 |
184 | when the read buffer ever (strictly) exceeds this size. This is useful to |
151 | avoid denial-of-service attacks. |
185 | avoid some forms of denial-of-service attacks. |
152 | |
186 | |
153 | For example, a server accepting connections from untrusted sources should |
187 | 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 |
188 | 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 |
189 | (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 |
190 | amount of data without a callback ever being called as long as the line |
157 | isn't finished). |
191 | isn't finished). |
158 | |
192 | |
|
|
193 | =item autocork => <boolean> |
|
|
194 | |
|
|
195 | When disabled (the default), then C<push_write> will try to immediately |
|
|
196 | write the data to the handle, if possible. This avoids having to register |
|
|
197 | a write watcher and wait for the next event loop iteration, but can |
|
|
198 | be inefficient if you write multiple small chunks (on the wire, this |
|
|
199 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
|
|
200 | C<no_delay>, but this option can save costly syscalls). |
|
|
201 | |
|
|
202 | When enabled, then writes will always be queued till the next event loop |
|
|
203 | iteration. This is efficient when you do many small writes per iteration, |
|
|
204 | but less efficient when you do a single write only per iteration (or when |
|
|
205 | the write buffer often is full). It also increases write latency. |
|
|
206 | |
|
|
207 | =item no_delay => <boolean> |
|
|
208 | |
|
|
209 | When doing small writes on sockets, your operating system kernel might |
|
|
210 | wait a bit for more data before actually sending it out. This is called |
|
|
211 | the Nagle algorithm, and usually it is beneficial. |
|
|
212 | |
|
|
213 | In some situations you want as low a delay as possible, which can be |
|
|
214 | accomplishd by setting this option to a true value. |
|
|
215 | |
|
|
216 | The default is your opertaing system's default behaviour (most likely |
|
|
217 | enabled), this option explicitly enables or disables it, if possible. |
|
|
218 | |
159 | =item read_size => <bytes> |
219 | =item read_size => <bytes> |
160 | |
220 | |
161 | The default read block size (the amount of bytes this module will try to read |
221 | The default read block size (the amount of bytes this module will |
162 | during each (loop iteration). Default: C<8192>. |
222 | try to read during each loop iteration, which affects memory |
|
|
223 | requirements). Default: C<8192>. |
163 | |
224 | |
164 | =item low_water_mark => <bytes> |
225 | =item low_water_mark => <bytes> |
165 | |
226 | |
166 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
227 | 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 |
228 | buffer: If the write reaches this size or gets even samller it is |
168 | considered empty. |
229 | considered empty. |
169 | |
230 | |
|
|
231 | Sometimes it can be beneficial (for performance reasons) to add data to |
|
|
232 | the write buffer before it is fully drained, but this is a rare case, as |
|
|
233 | the operating system kernel usually buffers data as well, so the default |
|
|
234 | is good in almost all cases. |
|
|
235 | |
|
|
236 | =item linger => <seconds> |
|
|
237 | |
|
|
238 | If non-zero (default: C<3600>), then the destructor of the |
|
|
239 | AnyEvent::Handle object will check whether there is still outstanding |
|
|
240 | write data and will install a watcher that will write this data to the |
|
|
241 | socket. No errors will be reported (this mostly matches how the operating |
|
|
242 | system treats outstanding data at socket close time). |
|
|
243 | |
|
|
244 | This will not work for partial TLS data that could not be encoded |
|
|
245 | yet. This data will be lost. Calling the C<stoptls> method in time might |
|
|
246 | help. |
|
|
247 | |
170 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
248 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
171 | |
249 | |
172 | When this parameter is given, it enables TLS (SSL) mode, that means it |
250 | When this parameter is given, it enables TLS (SSL) mode, that means |
173 | will start making tls handshake and will transparently encrypt/decrypt |
251 | AnyEvent will start a TLS handshake as soon as the conenction has been |
174 | data. |
252 | established and will transparently encrypt/decrypt data afterwards. |
175 | |
253 | |
176 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
254 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
177 | automatically when you try to create a TLS handle). |
255 | automatically when you try to create a TLS handle): this module doesn't |
|
|
256 | have a dependency on that module, so if your module requires it, you have |
|
|
257 | to add the dependency yourself. |
178 | |
258 | |
179 | For the TLS server side, use C<accept>, and for the TLS client side of a |
259 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
180 | connection, use C<connect> mode. |
260 | C<accept>, and for the TLS client side of a connection, use C<connect> |
|
|
261 | mode. |
181 | |
262 | |
182 | You can also provide your own TLS connection object, but you have |
263 | 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> |
264 | 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 |
265 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
185 | AnyEvent::Handle. |
266 | AnyEvent::Handle. |
186 | |
267 | |
187 | See the C<starttls> method if you need to start TLs negotiation later. |
268 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
188 | |
269 | |
189 | =item tls_ctx => $ssl_ctx |
270 | =item tls_ctx => $ssl_ctx |
190 | |
271 | |
191 | Use the given Net::SSLeay::CTX object to create the new TLS connection |
272 | 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 |
273 | (unless a connection object was specified directly). If this parameter is |
193 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
274 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
194 | |
275 | |
195 | =item json => JSON or JSON::XS object |
276 | =item json => JSON or JSON::XS object |
196 | |
277 | |
197 | This is the json coder object used by the C<json> read and write types. |
278 | This is the json coder object used by the C<json> read and write types. |
198 | |
279 | |
199 | If you don't supply it, then AnyEvent::Handle will create and use a |
280 | 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. |
281 | suitable one (on demand), which will write and expect UTF-8 encoded JSON |
|
|
282 | texts. |
201 | |
283 | |
202 | Note that you are responsible to depend on the JSON module if you want to |
284 | 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. |
285 | use this functionality, as AnyEvent does not have a dependency itself. |
204 | |
286 | |
205 | =item filter_r => $cb |
|
|
206 | |
|
|
207 | =item filter_w => $cb |
|
|
208 | |
|
|
209 | These exist, but are undocumented at this time. |
|
|
210 | |
|
|
211 | =back |
287 | =back |
212 | |
288 | |
213 | =cut |
289 | =cut |
214 | |
290 | |
215 | sub new { |
291 | sub new { |
… | |
… | |
219 | |
295 | |
220 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
296 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
221 | |
297 | |
222 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
298 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
223 | |
299 | |
224 | if ($self->{tls}) { |
|
|
225 | require Net::SSLeay; |
|
|
226 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
300 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
227 | } |
301 | if $self->{tls}; |
228 | |
302 | |
229 | $self->{_activity} = AnyEvent->now; |
303 | $self->{_activity} = AnyEvent->now; |
230 | $self->_timeout; |
304 | $self->_timeout; |
231 | |
305 | |
232 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
306 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
233 | $self->on_read (delete $self->{on_read} ) if $self->{on_read}; |
307 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
|
|
308 | |
|
|
309 | $self->start_read |
|
|
310 | if $self->{on_read}; |
234 | |
311 | |
235 | $self |
312 | $self |
236 | } |
313 | } |
237 | |
314 | |
238 | sub _shutdown { |
315 | sub _shutdown { |
… | |
… | |
241 | delete $self->{_tw}; |
318 | delete $self->{_tw}; |
242 | delete $self->{_rw}; |
319 | delete $self->{_rw}; |
243 | delete $self->{_ww}; |
320 | delete $self->{_ww}; |
244 | delete $self->{fh}; |
321 | delete $self->{fh}; |
245 | |
322 | |
246 | $self->stoptls; |
323 | &_freetls; |
|
|
324 | |
|
|
325 | delete $self->{on_read}; |
|
|
326 | delete $self->{_queue}; |
247 | } |
327 | } |
248 | |
328 | |
249 | sub _error { |
329 | sub _error { |
250 | my ($self, $errno, $fatal) = @_; |
330 | my ($self, $errno, $fatal) = @_; |
251 | |
331 | |
… | |
… | |
261 | } |
341 | } |
262 | } |
342 | } |
263 | |
343 | |
264 | =item $fh = $handle->fh |
344 | =item $fh = $handle->fh |
265 | |
345 | |
266 | This method returns the file handle of the L<AnyEvent::Handle> object. |
346 | This method returns the file handle used to create the L<AnyEvent::Handle> object. |
267 | |
347 | |
268 | =cut |
348 | =cut |
269 | |
349 | |
270 | sub fh { $_[0]{fh} } |
350 | sub fh { $_[0]{fh} } |
271 | |
351 | |
… | |
… | |
289 | $_[0]{on_eof} = $_[1]; |
369 | $_[0]{on_eof} = $_[1]; |
290 | } |
370 | } |
291 | |
371 | |
292 | =item $handle->on_timeout ($cb) |
372 | =item $handle->on_timeout ($cb) |
293 | |
373 | |
294 | Replace the current C<on_timeout> callback, or disables the callback |
374 | 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 |
375 | not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor |
296 | argument. |
376 | argument and method. |
297 | |
377 | |
298 | =cut |
378 | =cut |
299 | |
379 | |
300 | sub on_timeout { |
380 | sub on_timeout { |
301 | $_[0]{on_timeout} = $_[1]; |
381 | $_[0]{on_timeout} = $_[1]; |
|
|
382 | } |
|
|
383 | |
|
|
384 | =item $handle->autocork ($boolean) |
|
|
385 | |
|
|
386 | Enables or disables the current autocork behaviour (see C<autocork> |
|
|
387 | constructor argument). |
|
|
388 | |
|
|
389 | =cut |
|
|
390 | |
|
|
391 | =item $handle->no_delay ($boolean) |
|
|
392 | |
|
|
393 | Enables or disables the C<no_delay> setting (see constructor argument of |
|
|
394 | the same name for details). |
|
|
395 | |
|
|
396 | =cut |
|
|
397 | |
|
|
398 | sub no_delay { |
|
|
399 | $_[0]{no_delay} = $_[1]; |
|
|
400 | |
|
|
401 | eval { |
|
|
402 | local $SIG{__DIE__}; |
|
|
403 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
|
|
404 | }; |
302 | } |
405 | } |
303 | |
406 | |
304 | ############################################################################# |
407 | ############################################################################# |
305 | |
408 | |
306 | =item $handle->timeout ($seconds) |
409 | =item $handle->timeout ($seconds) |
… | |
… | |
384 | my ($self, $cb) = @_; |
487 | my ($self, $cb) = @_; |
385 | |
488 | |
386 | $self->{on_drain} = $cb; |
489 | $self->{on_drain} = $cb; |
387 | |
490 | |
388 | $cb->($self) |
491 | $cb->($self) |
389 | if $cb && $self->{low_water_mark} >= length $self->{wbuf}; |
492 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
390 | } |
493 | } |
391 | |
494 | |
392 | =item $handle->push_write ($data) |
495 | =item $handle->push_write ($data) |
393 | |
496 | |
394 | Queues the given scalar to be written. You can push as much data as you |
497 | Queues the given scalar to be written. You can push as much data as you |
… | |
… | |
411 | substr $self->{wbuf}, 0, $len, ""; |
514 | substr $self->{wbuf}, 0, $len, ""; |
412 | |
515 | |
413 | $self->{_activity} = AnyEvent->now; |
516 | $self->{_activity} = AnyEvent->now; |
414 | |
517 | |
415 | $self->{on_drain}($self) |
518 | $self->{on_drain}($self) |
416 | if $self->{low_water_mark} >= length $self->{wbuf} |
519 | if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) |
417 | && $self->{on_drain}; |
520 | && $self->{on_drain}; |
418 | |
521 | |
419 | delete $self->{_ww} unless length $self->{wbuf}; |
522 | delete $self->{_ww} unless length $self->{wbuf}; |
420 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
523 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
421 | $self->_error ($!, 1); |
524 | $self->_error ($!, 1); |
422 | } |
525 | } |
423 | }; |
526 | }; |
424 | |
527 | |
425 | # try to write data immediately |
528 | # try to write data immediately |
426 | $cb->(); |
529 | $cb->() unless $self->{autocork}; |
427 | |
530 | |
428 | # if still data left in wbuf, we need to poll |
531 | # if still data left in wbuf, we need to poll |
429 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
532 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
430 | if length $self->{wbuf}; |
533 | if length $self->{wbuf}; |
431 | }; |
534 | }; |
… | |
… | |
445 | |
548 | |
446 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
549 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
447 | ->($self, @_); |
550 | ->($self, @_); |
448 | } |
551 | } |
449 | |
552 | |
450 | if ($self->{filter_w}) { |
553 | if ($self->{tls}) { |
451 | $self->{filter_w}($self, \$_[0]); |
554 | $self->{_tls_wbuf} .= $_[0]; |
|
|
555 | &_dotls ($self); |
452 | } else { |
556 | } else { |
453 | $self->{wbuf} .= $_[0]; |
557 | $self->{wbuf} .= $_[0]; |
454 | $self->_drain_wbuf; |
558 | $self->_drain_wbuf; |
455 | } |
559 | } |
456 | } |
560 | } |
… | |
… | |
474 | |
578 | |
475 | register_write_type netstring => sub { |
579 | register_write_type netstring => sub { |
476 | my ($self, $string) = @_; |
580 | my ($self, $string) = @_; |
477 | |
581 | |
478 | sprintf "%d:%s,", (length $string), $string |
582 | sprintf "%d:%s,", (length $string), $string |
|
|
583 | }; |
|
|
584 | |
|
|
585 | =item packstring => $format, $data |
|
|
586 | |
|
|
587 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
588 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
589 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
590 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
591 | |
|
|
592 | =cut |
|
|
593 | |
|
|
594 | register_write_type packstring => sub { |
|
|
595 | my ($self, $format, $string) = @_; |
|
|
596 | |
|
|
597 | pack "$format/a*", $string |
479 | }; |
598 | }; |
480 | |
599 | |
481 | =item json => $array_or_hashref |
600 | =item json => $array_or_hashref |
482 | |
601 | |
483 | Encodes the given hash or array reference into a JSON object. Unless you |
602 | Encodes the given hash or array reference into a JSON object. Unless you |
… | |
… | |
517 | |
636 | |
518 | $self->{json} ? $self->{json}->encode ($ref) |
637 | $self->{json} ? $self->{json}->encode ($ref) |
519 | : JSON::encode_json ($ref) |
638 | : JSON::encode_json ($ref) |
520 | }; |
639 | }; |
521 | |
640 | |
|
|
641 | =item storable => $reference |
|
|
642 | |
|
|
643 | Freezes the given reference using L<Storable> and writes it to the |
|
|
644 | handle. Uses the C<nfreeze> format. |
|
|
645 | |
|
|
646 | =cut |
|
|
647 | |
|
|
648 | register_write_type storable => sub { |
|
|
649 | my ($self, $ref) = @_; |
|
|
650 | |
|
|
651 | require Storable; |
|
|
652 | |
|
|
653 | pack "w/a*", Storable::nfreeze ($ref) |
|
|
654 | }; |
|
|
655 | |
522 | =back |
656 | =back |
523 | |
657 | |
524 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
658 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
525 | |
659 | |
526 | This function (not method) lets you add your own types to C<push_write>. |
660 | 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 |
682 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
549 | a queue. |
683 | a queue. |
550 | |
684 | |
551 | In the simple case, you just install an C<on_read> callback and whenever |
685 | 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 |
686 | 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 |
687 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
554 | or not. |
688 | leave the data there if you want to accumulate more (e.g. when only a |
|
|
689 | partial message has been received so far). |
555 | |
690 | |
556 | In the more complex case, you want to queue multiple callbacks. In this |
691 | 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 |
692 | 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>, |
693 | data arrives (also the first time it is queued) and removes it when it has |
559 | below). |
694 | done its job (see C<push_read>, below). |
560 | |
695 | |
561 | This way you can, for example, push three line-reads, followed by reading |
696 | 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. |
697 | a chunk of data, and AnyEvent::Handle will execute them in order. |
563 | |
698 | |
564 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
699 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
… | |
… | |
577 | # handle xml |
712 | # handle xml |
578 | }); |
713 | }); |
579 | }); |
714 | }); |
580 | }); |
715 | }); |
581 | |
716 | |
582 | Example 2: Implement a client for a protocol that replies either with |
717 | 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 |
718 | 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 |
719 | 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 |
720 | just pipeline sending both requests and manipulate the queue as necessary |
586 | the callbacks: |
721 | in the callbacks. |
587 | |
722 | |
588 | # request one |
723 | When the first callback is called and sees an "OK" response, it will |
|
|
724 | C<unshift> another line-read. This line-read will be queued I<before> the |
|
|
725 | 64-byte chunk callback. |
|
|
726 | |
|
|
727 | # request one, returns either "OK + extra line" or "ERROR" |
589 | $handle->push_write ("request 1\015\012"); |
728 | $handle->push_write ("request 1\015\012"); |
590 | |
729 | |
591 | # we expect "ERROR" or "OK" as response, so push a line read |
730 | # we expect "ERROR" or "OK" as response, so push a line read |
592 | $handle->push_read (line => sub { |
731 | $handle->push_read (line => sub { |
593 | # if we got an "OK", we have to _prepend_ another line, |
732 | # if we got an "OK", we have to _prepend_ another line, |
… | |
… | |
600 | ... |
739 | ... |
601 | }); |
740 | }); |
602 | } |
741 | } |
603 | }); |
742 | }); |
604 | |
743 | |
605 | # request two |
744 | # request two, simply returns 64 octets |
606 | $handle->push_write ("request 2\015\012"); |
745 | $handle->push_write ("request 2\015\012"); |
607 | |
746 | |
608 | # simply read 64 bytes, always |
747 | # simply read 64 bytes, always |
609 | $handle->push_read (chunk => 64, sub { |
748 | $handle->push_read (chunk => 64, sub { |
610 | my $response = $_[1]; |
749 | my $response = $_[1]; |
… | |
… | |
622 | |
761 | |
623 | if ( |
762 | if ( |
624 | defined $self->{rbuf_max} |
763 | defined $self->{rbuf_max} |
625 | && $self->{rbuf_max} < length $self->{rbuf} |
764 | && $self->{rbuf_max} < length $self->{rbuf} |
626 | ) { |
765 | ) { |
627 | return $self->_error (&Errno::ENOSPC, 1); |
766 | $self->_error (&Errno::ENOSPC, 1), return; |
628 | } |
767 | } |
629 | |
768 | |
630 | while () { |
769 | while () { |
631 | no strict 'refs'; |
|
|
632 | |
|
|
633 | my $len = length $self->{rbuf}; |
770 | my $len = length $self->{rbuf}; |
634 | |
771 | |
635 | if (my $cb = shift @{ $self->{_queue} }) { |
772 | if (my $cb = shift @{ $self->{_queue} }) { |
636 | unless ($cb->($self)) { |
773 | unless ($cb->($self)) { |
637 | if ($self->{_eof}) { |
774 | if ($self->{_eof}) { |
638 | # no progress can be made (not enough data and no data forthcoming) |
775 | # no progress can be made (not enough data and no data forthcoming) |
639 | return $self->_error (&Errno::EPIPE, 1); |
776 | $self->_error (&Errno::EPIPE, 1), return; |
640 | } |
777 | } |
641 | |
778 | |
642 | unshift @{ $self->{_queue} }, $cb; |
779 | unshift @{ $self->{_queue} }, $cb; |
643 | last; |
780 | last; |
644 | } |
781 | } |
645 | } elsif ($self->{on_read}) { |
782 | } elsif ($self->{on_read}) { |
|
|
783 | last unless $len; |
|
|
784 | |
646 | $self->{on_read}($self); |
785 | $self->{on_read}($self); |
647 | |
786 | |
648 | if ( |
787 | if ( |
649 | $len == length $self->{rbuf} # if no data has been consumed |
788 | $len == length $self->{rbuf} # if no data has been consumed |
650 | && !@{ $self->{_queue} } # and the queue is still empty |
789 | && !@{ $self->{_queue} } # and the queue is still empty |
651 | && $self->{on_read} # but we still have on_read |
790 | && $self->{on_read} # but we still have on_read |
652 | ) { |
791 | ) { |
653 | # no further data will arrive |
792 | # no further data will arrive |
654 | # so no progress can be made |
793 | # so no progress can be made |
655 | return $self->_error (&Errno::EPIPE, 1) |
794 | $self->_error (&Errno::EPIPE, 1), return |
656 | if $self->{_eof}; |
795 | if $self->{_eof}; |
657 | |
796 | |
658 | last; # more data might arrive |
797 | last; # more data might arrive |
659 | } |
798 | } |
660 | } else { |
799 | } else { |
661 | # read side becomes idle |
800 | # read side becomes idle |
662 | delete $self->{_rw}; |
801 | delete $self->{_rw} unless $self->{tls}; |
663 | last; |
802 | last; |
664 | } |
803 | } |
665 | } |
804 | } |
666 | |
805 | |
|
|
806 | if ($self->{_eof}) { |
|
|
807 | if ($self->{on_eof}) { |
667 | $self->{on_eof}($self) |
808 | $self->{on_eof}($self) |
668 | if $self->{_eof} && $self->{on_eof}; |
809 | } else { |
|
|
810 | $self->_error (0, 1); |
|
|
811 | } |
|
|
812 | } |
669 | |
813 | |
670 | # may need to restart read watcher |
814 | # may need to restart read watcher |
671 | unless ($self->{_rw}) { |
815 | unless ($self->{_rw}) { |
672 | $self->start_read |
816 | $self->start_read |
673 | if $self->{on_read} || @{ $self->{_queue} }; |
817 | if $self->{on_read} || @{ $self->{_queue} }; |
… | |
… | |
799 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
943 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
800 | 1 |
944 | 1 |
801 | } |
945 | } |
802 | }; |
946 | }; |
803 | |
947 | |
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) |
948 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
814 | |
949 | |
815 | The callback will be called only once a full line (including the end of |
950 | 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 |
951 | 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 |
952 | marker) will be passed to the callback as second argument (C<$line>), and |
… | |
… | |
832 | =cut |
967 | =cut |
833 | |
968 | |
834 | register_read_type line => sub { |
969 | register_read_type line => sub { |
835 | my ($self, $cb, $eol) = @_; |
970 | my ($self, $cb, $eol) = @_; |
836 | |
971 | |
837 | $eol = qr|(\015?\012)| if @_ < 3; |
972 | if (@_ < 3) { |
838 | $eol = quotemeta $eol unless ref $eol; |
973 | # this is more than twice as fast as the generic code below |
839 | $eol = qr|^(.*?)($eol)|s; |
|
|
840 | |
|
|
841 | sub { |
974 | sub { |
842 | $_[0]{rbuf} =~ s/$eol// or return; |
975 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
843 | |
976 | |
844 | $cb->($_[0], $1, $2); |
977 | $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 | } |
978 | 1 |
876 | return; |
|
|
877 | } |
979 | } |
|
|
980 | } else { |
|
|
981 | $eol = quotemeta $eol unless ref $eol; |
|
|
982 | $eol = qr|^(.*?)($eol)|s; |
878 | |
983 | |
879 | my $len = $1; |
984 | sub { |
|
|
985 | $_[0]{rbuf} =~ s/$eol// or return; |
880 | |
986 | |
881 | $self->unshift_read (chunk => $len, sub { |
987 | $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 | }); |
988 | 1 |
890 | }); |
989 | } |
891 | |
|
|
892 | 1 |
|
|
893 | } |
990 | } |
894 | }; |
991 | }; |
895 | |
992 | |
896 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
993 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
897 | |
994 | |
… | |
… | |
961 | |
1058 | |
962 | () |
1059 | () |
963 | } |
1060 | } |
964 | }; |
1061 | }; |
965 | |
1062 | |
|
|
1063 | =item netstring => $cb->($handle, $string) |
|
|
1064 | |
|
|
1065 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
1066 | |
|
|
1067 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
1068 | |
|
|
1069 | =cut |
|
|
1070 | |
|
|
1071 | register_read_type netstring => sub { |
|
|
1072 | my ($self, $cb) = @_; |
|
|
1073 | |
|
|
1074 | sub { |
|
|
1075 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
1076 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
1077 | $self->_error (&Errno::EBADMSG); |
|
|
1078 | } |
|
|
1079 | return; |
|
|
1080 | } |
|
|
1081 | |
|
|
1082 | my $len = $1; |
|
|
1083 | |
|
|
1084 | $self->unshift_read (chunk => $len, sub { |
|
|
1085 | my $string = $_[1]; |
|
|
1086 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
1087 | if ($_[1] eq ",") { |
|
|
1088 | $cb->($_[0], $string); |
|
|
1089 | } else { |
|
|
1090 | $self->_error (&Errno::EBADMSG); |
|
|
1091 | } |
|
|
1092 | }); |
|
|
1093 | }); |
|
|
1094 | |
|
|
1095 | 1 |
|
|
1096 | } |
|
|
1097 | }; |
|
|
1098 | |
|
|
1099 | =item packstring => $format, $cb->($handle, $string) |
|
|
1100 | |
|
|
1101 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
1102 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
1103 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
1104 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
1105 | |
|
|
1106 | DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. |
|
|
1107 | |
|
|
1108 | Example: read a block of data prefixed by its length in BER-encoded |
|
|
1109 | format (very efficient). |
|
|
1110 | |
|
|
1111 | $handle->push_read (packstring => "w", sub { |
|
|
1112 | my ($handle, $data) = @_; |
|
|
1113 | }); |
|
|
1114 | |
|
|
1115 | =cut |
|
|
1116 | |
|
|
1117 | register_read_type packstring => sub { |
|
|
1118 | my ($self, $cb, $format) = @_; |
|
|
1119 | |
|
|
1120 | sub { |
|
|
1121 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1122 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
|
|
1123 | or return; |
|
|
1124 | |
|
|
1125 | $format = length pack $format, $len; |
|
|
1126 | |
|
|
1127 | # bypass unshift if we already have the remaining chunk |
|
|
1128 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1129 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1130 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1131 | $cb->($_[0], $data); |
|
|
1132 | } else { |
|
|
1133 | # remove prefix |
|
|
1134 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1135 | |
|
|
1136 | # read remaining chunk |
|
|
1137 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1138 | } |
|
|
1139 | |
|
|
1140 | 1 |
|
|
1141 | } |
|
|
1142 | }; |
|
|
1143 | |
966 | =item json => $cb->($handle, $hash_or_arrayref) |
1144 | =item json => $cb->($handle, $hash_or_arrayref) |
967 | |
1145 | |
968 | Reads a JSON object or array, decodes it and passes it to the callback. |
1146 | Reads a JSON object or array, decodes it and passes it to the callback. |
969 | |
1147 | |
970 | If a C<json> object was passed to the constructor, then that will be used |
1148 | 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. |
1158 | the C<json> write type description, above, for an actual example. |
981 | |
1159 | |
982 | =cut |
1160 | =cut |
983 | |
1161 | |
984 | register_read_type json => sub { |
1162 | register_read_type json => sub { |
985 | my ($self, $cb, $accept, $reject, $skip) = @_; |
1163 | my ($self, $cb) = @_; |
986 | |
1164 | |
987 | require JSON; |
1165 | require JSON; |
988 | |
1166 | |
989 | my $data; |
1167 | my $data; |
990 | my $rbuf = \$self->{rbuf}; |
1168 | my $rbuf = \$self->{rbuf}; |
… | |
… | |
1005 | () |
1183 | () |
1006 | } |
1184 | } |
1007 | } |
1185 | } |
1008 | }; |
1186 | }; |
1009 | |
1187 | |
|
|
1188 | =item storable => $cb->($handle, $ref) |
|
|
1189 | |
|
|
1190 | Deserialises a L<Storable> frozen representation as written by the |
|
|
1191 | C<storable> write type (BER-encoded length prefix followed by nfreeze'd |
|
|
1192 | data). |
|
|
1193 | |
|
|
1194 | Raises C<EBADMSG> error if the data could not be decoded. |
|
|
1195 | |
|
|
1196 | =cut |
|
|
1197 | |
|
|
1198 | register_read_type storable => sub { |
|
|
1199 | my ($self, $cb) = @_; |
|
|
1200 | |
|
|
1201 | require Storable; |
|
|
1202 | |
|
|
1203 | sub { |
|
|
1204 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1205 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
|
|
1206 | or return; |
|
|
1207 | |
|
|
1208 | my $format = length pack "w", $len; |
|
|
1209 | |
|
|
1210 | # bypass unshift if we already have the remaining chunk |
|
|
1211 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1212 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1213 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1214 | $cb->($_[0], Storable::thaw ($data)); |
|
|
1215 | } else { |
|
|
1216 | # remove prefix |
|
|
1217 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1218 | |
|
|
1219 | # read remaining chunk |
|
|
1220 | $_[0]->unshift_read (chunk => $len, sub { |
|
|
1221 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
|
|
1222 | $cb->($_[0], $ref); |
|
|
1223 | } else { |
|
|
1224 | $self->_error (&Errno::EBADMSG); |
|
|
1225 | } |
|
|
1226 | }); |
|
|
1227 | } |
|
|
1228 | |
|
|
1229 | 1 |
|
|
1230 | } |
|
|
1231 | }; |
|
|
1232 | |
1010 | =back |
1233 | =back |
1011 | |
1234 | |
1012 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1235 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1013 | |
1236 | |
1014 | This function (not method) lets you add your own types to C<push_read>. |
1237 | 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 |
1264 | 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 |
1265 | 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 |
1266 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1044 | there are any read requests in the queue. |
1267 | there are any read requests in the queue. |
1045 | |
1268 | |
|
|
1269 | These methods will have no effect when in TLS mode (as TLS doesn't support |
|
|
1270 | half-duplex connections). |
|
|
1271 | |
1046 | =cut |
1272 | =cut |
1047 | |
1273 | |
1048 | sub stop_read { |
1274 | sub stop_read { |
1049 | my ($self) = @_; |
1275 | my ($self) = @_; |
1050 | |
1276 | |
1051 | delete $self->{_rw}; |
1277 | delete $self->{_rw} unless $self->{tls}; |
1052 | } |
1278 | } |
1053 | |
1279 | |
1054 | sub start_read { |
1280 | sub start_read { |
1055 | my ($self) = @_; |
1281 | my ($self) = @_; |
1056 | |
1282 | |
1057 | unless ($self->{_rw} || $self->{_eof}) { |
1283 | unless ($self->{_rw} || $self->{_eof}) { |
1058 | Scalar::Util::weaken $self; |
1284 | Scalar::Util::weaken $self; |
1059 | |
1285 | |
1060 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1286 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1061 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
1287 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1062 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1288 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1063 | |
1289 | |
1064 | if ($len > 0) { |
1290 | if ($len > 0) { |
1065 | $self->{_activity} = AnyEvent->now; |
1291 | $self->{_activity} = AnyEvent->now; |
1066 | |
1292 | |
1067 | $self->{filter_r} |
1293 | if ($self->{tls}) { |
1068 | ? $self->{filter_r}($self, $rbuf) |
1294 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1069 | : $self->{_in_drain} || $self->_drain_rbuf; |
1295 | &_dotls ($self); |
|
|
1296 | } else { |
|
|
1297 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1298 | } |
1070 | |
1299 | |
1071 | } elsif (defined $len) { |
1300 | } elsif (defined $len) { |
1072 | delete $self->{_rw}; |
1301 | delete $self->{_rw}; |
1073 | $self->{_eof} = 1; |
1302 | $self->{_eof} = 1; |
1074 | $self->_drain_rbuf unless $self->{_in_drain}; |
1303 | $self->_drain_rbuf unless $self->{_in_drain}; |
… | |
… | |
1089 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1318 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1090 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1319 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1091 | } |
1320 | } |
1092 | } |
1321 | } |
1093 | |
1322 | |
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}))) { |
1323 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
1100 | if (length $buf) { |
1324 | unless (length $buf) { |
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 |
1325 | # let's treat SSL-eof as we treat normal EOF |
|
|
1326 | delete $self->{_rw}; |
1105 | $self->{_eof} = 1; |
1327 | $self->{_eof} = 1; |
1106 | $self->_shutdown; |
1328 | &_freetls; |
1107 | return; |
|
|
1108 | } |
1329 | } |
|
|
1330 | |
|
|
1331 | $self->{rbuf} .= $buf; |
|
|
1332 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1333 | $self->{tls} or return; # tls session might have gone away in callback |
1109 | } |
1334 | } |
1110 | |
1335 | |
1111 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1336 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1112 | |
1337 | |
1113 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
1338 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
… | |
… | |
1117 | return $self->_error (&Errno::EIO, 1); |
1342 | return $self->_error (&Errno::EIO, 1); |
1118 | } |
1343 | } |
1119 | |
1344 | |
1120 | # all others are fine for our purposes |
1345 | # all others are fine for our purposes |
1121 | } |
1346 | } |
|
|
1347 | |
|
|
1348 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
|
|
1349 | $self->{wbuf} .= $buf; |
|
|
1350 | $self->_drain_wbuf; |
|
|
1351 | } |
1122 | } |
1352 | } |
1123 | |
1353 | |
1124 | =item $handle->starttls ($tls[, $tls_ctx]) |
1354 | =item $handle->starttls ($tls[, $tls_ctx]) |
1125 | |
1355 | |
1126 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
1356 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
… | |
… | |
1135 | |
1365 | |
1136 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
1366 | 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 |
1367 | call and can be used or changed to your liking. Note that the handshake |
1138 | might have already started when this function returns. |
1368 | might have already started when this function returns. |
1139 | |
1369 | |
|
|
1370 | If it an error to start a TLS handshake more than once per |
|
|
1371 | AnyEvent::Handle object (this is due to bugs in OpenSSL). |
|
|
1372 | |
1140 | =cut |
1373 | =cut |
1141 | |
1374 | |
1142 | sub starttls { |
1375 | sub starttls { |
1143 | my ($self, $ssl, $ctx) = @_; |
1376 | my ($self, $ssl, $ctx) = @_; |
1144 | |
1377 | |
1145 | $self->stoptls; |
1378 | require Net::SSLeay; |
1146 | |
1379 | |
|
|
1380 | Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object" |
|
|
1381 | if $self->{tls}; |
|
|
1382 | |
1147 | if ($ssl eq "accept") { |
1383 | if ($ssl eq "accept") { |
1148 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1384 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1149 | Net::SSLeay::set_accept_state ($ssl); |
1385 | Net::SSLeay::set_accept_state ($ssl); |
1150 | } elsif ($ssl eq "connect") { |
1386 | } elsif ($ssl eq "connect") { |
1151 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1387 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
… | |
… | |
1157 | # basically, this is deep magic (because SSL_read should have the same issues) |
1393 | # 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". |
1394 | # but the openssl maintainers basically said: "trust us, it just works". |
1159 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1395 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1160 | # and mismaintained ssleay-module doesn't even offer them). |
1396 | # and mismaintained ssleay-module doesn't even offer them). |
1161 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
1397 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
|
|
1398 | # |
|
|
1399 | # in short: this is a mess. |
|
|
1400 | # |
|
|
1401 | # note that we do not try to keep the length constant between writes as we are required to do. |
|
|
1402 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
|
|
1403 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
|
|
1404 | # have identity issues in that area. |
1162 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1405 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1163 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1406 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1164 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1407 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1165 | |
1408 | |
1166 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1409 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1167 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1410 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1168 | |
1411 | |
1169 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1412 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1170 | |
1413 | |
1171 | $self->{filter_w} = sub { |
1414 | &_dotls; # need to trigger the initial handshake |
1172 | $_[0]{_tls_wbuf} .= ${$_[1]}; |
1415 | $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 | } |
1416 | } |
1180 | |
1417 | |
1181 | =item $handle->stoptls |
1418 | =item $handle->stoptls |
1182 | |
1419 | |
1183 | Destroys the SSL connection, if any. Partial read or write data will be |
1420 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1184 | lost. |
1421 | sending a close notify to the other side, but since OpenSSL doesn't |
|
|
1422 | support non-blocking shut downs, it is not possible to re-use the stream |
|
|
1423 | afterwards. |
1185 | |
1424 | |
1186 | =cut |
1425 | =cut |
1187 | |
1426 | |
1188 | sub stoptls { |
1427 | sub stoptls { |
1189 | my ($self) = @_; |
1428 | my ($self) = @_; |
1190 | |
1429 | |
|
|
1430 | if ($self->{tls}) { |
|
|
1431 | Net::SSLeay::shutdown ($self->{tls}); |
|
|
1432 | |
|
|
1433 | &_dotls; |
|
|
1434 | |
|
|
1435 | # we don't give a shit. no, we do, but we can't. no... |
|
|
1436 | # we, we... have to use openssl :/ |
|
|
1437 | &_freetls; |
|
|
1438 | } |
|
|
1439 | } |
|
|
1440 | |
|
|
1441 | sub _freetls { |
|
|
1442 | my ($self) = @_; |
|
|
1443 | |
|
|
1444 | return unless $self->{tls}; |
|
|
1445 | |
1191 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
1446 | Net::SSLeay::free (delete $self->{tls}); |
1192 | |
1447 | |
1193 | delete $self->{_rbio}; |
1448 | 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 | } |
1449 | } |
1199 | |
1450 | |
1200 | sub DESTROY { |
1451 | sub DESTROY { |
1201 | my $self = shift; |
1452 | my $self = shift; |
1202 | |
1453 | |
1203 | $self->stoptls; |
1454 | &_freetls; |
|
|
1455 | |
|
|
1456 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
|
|
1457 | |
|
|
1458 | if ($linger && length $self->{wbuf}) { |
|
|
1459 | my $fh = delete $self->{fh}; |
|
|
1460 | my $wbuf = delete $self->{wbuf}; |
|
|
1461 | |
|
|
1462 | my @linger; |
|
|
1463 | |
|
|
1464 | push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { |
|
|
1465 | my $len = syswrite $fh, $wbuf, length $wbuf; |
|
|
1466 | |
|
|
1467 | if ($len > 0) { |
|
|
1468 | substr $wbuf, 0, $len, ""; |
|
|
1469 | } else { |
|
|
1470 | @linger = (); # end |
|
|
1471 | } |
|
|
1472 | }); |
|
|
1473 | push @linger, AnyEvent->timer (after => $linger, cb => sub { |
|
|
1474 | @linger = (); |
|
|
1475 | }); |
|
|
1476 | } |
1204 | } |
1477 | } |
1205 | |
1478 | |
1206 | =item AnyEvent::Handle::TLS_CTX |
1479 | =item AnyEvent::Handle::TLS_CTX |
1207 | |
1480 | |
1208 | This function creates and returns the Net::SSLeay::CTX object used by |
1481 | This function creates and returns the Net::SSLeay::CTX object used by |
… | |
… | |
1250 | =over 4 |
1523 | =over 4 |
1251 | |
1524 | |
1252 | =item * all constructor arguments become object members. |
1525 | =item * all constructor arguments become object members. |
1253 | |
1526 | |
1254 | At least initially, when you pass a C<tls>-argument to the constructor it |
1527 | 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 |
1528 | 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). |
1529 | mutated later on (for example C<tls> will hold the TLS connection object). |
1257 | |
1530 | |
1258 | =item * other object member names are prefixed with an C<_>. |
1531 | =item * other object member names are prefixed with an C<_>. |
1259 | |
1532 | |
1260 | All object members not explicitly documented (internal use) are prefixed |
1533 | All object members not explicitly documented (internal use) are prefixed |