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(WSAWOULDBLOCK); |
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
8 | use Scalar::Util (); |
8 | use Scalar::Util (); |
9 | use Carp (); |
9 | use Carp (); |
10 | use Fcntl (); |
10 | use Fcntl (); |
11 | use Errno qw/EAGAIN EINTR/; |
11 | use Errno qw(EAGAIN EINTR); |
12 | |
12 | |
13 | =head1 NAME |
13 | =head1 NAME |
14 | |
14 | |
15 | AnyEvent::Handle - non-blocking I/O on 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 = '0.04'; |
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->($self) |
90 | =item on_eof => $cb->($handle) |
79 | |
91 | |
80 | Set the callback to be called on EOF. |
92 | Set the callback to be called when an end-of-file condition is detected, |
|
|
93 | i.e. in the case of a socket, when the other side has closed the |
|
|
94 | connection cleanly. |
81 | |
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 | |
82 | 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, |
83 | 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 |
84 | waiting for data. |
103 | waiting for data. |
85 | |
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>. |
|
|
107 | |
86 | =item on_error => $cb->($self) |
108 | =item on_error => $cb->($handle, $fatal) |
87 | |
109 | |
88 | This is the fatal error callback, that is called when, well, a fatal error |
110 | This is the error callback, which is called when, well, some error |
89 | occurs, such as not being able to resolve the hostname, failure to connect |
111 | occured, such as not being able to resolve the hostname, failure to |
90 | or a read error. |
112 | connect or a read error. |
91 | |
113 | |
92 | The object will not be in a usable state when this callback has been |
114 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
93 | called. |
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 | |
|
|
120 | Non-fatal errors can be retried by simply returning, but it is recommended |
|
|
121 | to simply ignore this parameter and instead abondon the handle object |
|
|
122 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
123 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
94 | |
124 | |
95 | On callback entrance, the value of C<$!> contains the operating system |
125 | On callback entrance, the value of C<$!> contains the operating system |
96 | error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>). |
126 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
97 | |
|
|
98 | The callback should throw an exception. If it returns, then |
|
|
99 | AnyEvent::Handle will C<croak> for you. |
|
|
100 | |
127 | |
101 | 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 |
102 | you will not be notified of errors otherwise. The default simply calls |
129 | you will not be notified of errors otherwise. The default simply calls |
103 | die. |
130 | C<croak>. |
104 | |
131 | |
105 | =item on_read => $cb->($self) |
132 | =item on_read => $cb->($handle) |
106 | |
133 | |
107 | 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 |
108 | 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). |
109 | |
138 | |
110 | 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 >> |
111 | method or access the C<$self->{rbuf}> member directly. |
140 | method or access the C<$handle->{rbuf}> member directly. |
112 | |
141 | |
113 | 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 |
114 | feed all the remaining data to the queued callbacks and C<on_read> before |
143 | feed all the remaining data to the queued callbacks and C<on_read> before |
115 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
144 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
116 | error will be raised (with C<$!> set to C<EPIPE>). |
145 | error will be raised (with C<$!> set to C<EPIPE>). |
117 | |
146 | |
118 | =item on_drain => $cb->() |
147 | =item on_drain => $cb->($handle) |
119 | |
148 | |
120 | 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 |
121 | (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). |
122 | |
151 | |
123 | 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. |
124 | |
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 | |
|
|
160 | =item timeout => $fractional_seconds |
|
|
161 | |
|
|
162 | If non-zero, then this enables an "inactivity" timeout: whenever this many |
|
|
163 | seconds pass without a successful read or write on the underlying file |
|
|
164 | handle, the C<on_timeout> callback will be invoked (and if that one is |
|
|
165 | missing, a non-fatal C<ETIMEDOUT> error will be raised). |
|
|
166 | |
|
|
167 | Note that timeout processing is also active when you currently do not have |
|
|
168 | any outstanding read or write requests: If you plan to keep the connection |
|
|
169 | idle then you should disable the timout temporarily or ignore the timeout |
|
|
170 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
|
|
171 | restart the timeout. |
|
|
172 | |
|
|
173 | Zero (the default) disables this timeout. |
|
|
174 | |
|
|
175 | =item on_timeout => $cb->($handle) |
|
|
176 | |
|
|
177 | Called whenever the inactivity timeout passes. If you return from this |
|
|
178 | callback, then the timeout will be reset as if some activity had happened, |
|
|
179 | so this condition is not fatal in any way. |
|
|
180 | |
125 | =item rbuf_max => <bytes> |
181 | =item rbuf_max => <bytes> |
126 | |
182 | |
127 | 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>) |
128 | 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 |
129 | avoid denial-of-service attacks. |
185 | avoid some forms of denial-of-service attacks. |
130 | |
186 | |
131 | For example, a server accepting connections from untrusted sources should |
187 | For example, a server accepting connections from untrusted sources should |
132 | 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 |
133 | (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 |
134 | 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 |
135 | isn't finished). |
191 | isn't finished). |
136 | |
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 | |
137 | =item read_size => <bytes> |
219 | =item read_size => <bytes> |
138 | |
220 | |
139 | 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 |
140 | on each [loop iteration). Default: C<4096>. |
222 | try to read during each loop iteration, which affects memory |
|
|
223 | requirements). Default: C<8192>. |
141 | |
224 | |
142 | =item low_water_mark => <bytes> |
225 | =item low_water_mark => <bytes> |
143 | |
226 | |
144 | 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 |
145 | 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 |
146 | considered empty. |
229 | considered empty. |
147 | |
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 | |
148 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
248 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
149 | |
249 | |
150 | 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 |
151 | will start making tls handshake and will transparently encrypt/decrypt |
251 | AnyEvent will start a TLS handshake as soon as the conenction has been |
152 | data. |
252 | established and will transparently encrypt/decrypt data afterwards. |
153 | |
253 | |
154 | 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 |
155 | 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. |
156 | |
258 | |
157 | 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 |
158 | connection, use C<connect> mode. |
260 | C<accept>, and for the TLS client side of a connection, use C<connect> |
|
|
261 | mode. |
159 | |
262 | |
160 | 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 |
161 | 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> |
162 | 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 |
163 | AnyEvent::Handle. |
266 | AnyEvent::Handle. |
164 | |
267 | |
165 | 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. |
166 | |
269 | |
167 | =item tls_ctx => $ssl_ctx |
270 | =item tls_ctx => $ssl_ctx |
168 | |
271 | |
169 | 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 |
170 | (unless a connection object was specified directly). If this parameter is |
273 | (unless a connection object was specified directly). If this parameter is |
171 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
274 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
172 | |
275 | |
173 | =item filter_r => $cb |
276 | =item json => JSON or JSON::XS object |
174 | |
277 | |
175 | =item filter_w => $cb |
278 | This is the json coder object used by the C<json> read and write types. |
176 | |
279 | |
177 | These exist, but are undocumented at this time. |
280 | If you don't supply it, then AnyEvent::Handle will create and use a |
|
|
281 | suitable one (on demand), which will write and expect UTF-8 encoded JSON |
|
|
282 | texts. |
|
|
283 | |
|
|
284 | Note that you are responsible to depend on the JSON module if you want to |
|
|
285 | use this functionality, as AnyEvent does not have a dependency itself. |
178 | |
286 | |
179 | =back |
287 | =back |
180 | |
288 | |
181 | =cut |
289 | =cut |
182 | |
290 | |
… | |
… | |
187 | |
295 | |
188 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
296 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
189 | |
297 | |
190 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
298 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
191 | |
299 | |
192 | if ($self->{tls}) { |
|
|
193 | require Net::SSLeay; |
|
|
194 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
300 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
195 | } |
301 | if $self->{tls}; |
196 | |
302 | |
197 | $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; |
303 | $self->{_activity} = AnyEvent->now; |
198 | $self->on_error (delete $self->{on_error}) if $self->{on_error}; |
304 | $self->_timeout; |
|
|
305 | |
199 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
306 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
200 | $self->on_read (delete $self->{on_read} ) if $self->{on_read}; |
307 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
201 | |
308 | |
202 | $self->start_read; |
309 | $self->start_read |
|
|
310 | if $self->{on_read}; |
203 | |
311 | |
204 | $self |
312 | $self |
205 | } |
313 | } |
206 | |
314 | |
207 | sub _shutdown { |
315 | sub _shutdown { |
208 | my ($self) = @_; |
316 | my ($self) = @_; |
209 | |
317 | |
|
|
318 | delete $self->{_tw}; |
210 | delete $self->{_rw}; |
319 | delete $self->{_rw}; |
211 | delete $self->{_ww}; |
320 | delete $self->{_ww}; |
212 | delete $self->{fh}; |
321 | delete $self->{fh}; |
213 | } |
|
|
214 | |
322 | |
|
|
323 | &_freetls; |
|
|
324 | |
|
|
325 | delete $self->{on_read}; |
|
|
326 | delete $self->{_queue}; |
|
|
327 | } |
|
|
328 | |
215 | sub error { |
329 | sub _error { |
216 | my ($self) = @_; |
330 | my ($self, $errno, $fatal) = @_; |
217 | |
331 | |
218 | { |
|
|
219 | local $!; |
|
|
220 | $self->_shutdown; |
332 | $self->_shutdown |
221 | } |
333 | if $fatal; |
222 | |
334 | |
223 | $self->{on_error}($self) |
335 | $! = $errno; |
|
|
336 | |
224 | if $self->{on_error}; |
337 | if ($self->{on_error}) { |
225 | |
338 | $self->{on_error}($self, $fatal); |
|
|
339 | } else { |
226 | Carp::croak "AnyEvent::Handle uncaught fatal error: $!"; |
340 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
|
|
341 | } |
227 | } |
342 | } |
228 | |
343 | |
229 | =item $fh = $handle->fh |
344 | =item $fh = $handle->fh |
230 | |
345 | |
231 | 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. |
232 | |
347 | |
233 | =cut |
348 | =cut |
234 | |
349 | |
235 | sub fh { $_[0]{fh} } |
350 | sub fh { $_[0]{fh} } |
236 | |
351 | |
… | |
… | |
252 | |
367 | |
253 | sub on_eof { |
368 | sub on_eof { |
254 | $_[0]{on_eof} = $_[1]; |
369 | $_[0]{on_eof} = $_[1]; |
255 | } |
370 | } |
256 | |
371 | |
|
|
372 | =item $handle->on_timeout ($cb) |
|
|
373 | |
|
|
374 | Replace the current C<on_timeout> callback, or disables the callback (but |
|
|
375 | not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor |
|
|
376 | argument and method. |
|
|
377 | |
|
|
378 | =cut |
|
|
379 | |
|
|
380 | sub on_timeout { |
|
|
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 | }; |
|
|
405 | } |
|
|
406 | |
|
|
407 | ############################################################################# |
|
|
408 | |
|
|
409 | =item $handle->timeout ($seconds) |
|
|
410 | |
|
|
411 | Configures (or disables) the inactivity timeout. |
|
|
412 | |
|
|
413 | =cut |
|
|
414 | |
|
|
415 | sub timeout { |
|
|
416 | my ($self, $timeout) = @_; |
|
|
417 | |
|
|
418 | $self->{timeout} = $timeout; |
|
|
419 | $self->_timeout; |
|
|
420 | } |
|
|
421 | |
|
|
422 | # reset the timeout watcher, as neccessary |
|
|
423 | # also check for time-outs |
|
|
424 | sub _timeout { |
|
|
425 | my ($self) = @_; |
|
|
426 | |
|
|
427 | if ($self->{timeout}) { |
|
|
428 | my $NOW = AnyEvent->now; |
|
|
429 | |
|
|
430 | # when would the timeout trigger? |
|
|
431 | my $after = $self->{_activity} + $self->{timeout} - $NOW; |
|
|
432 | |
|
|
433 | # now or in the past already? |
|
|
434 | if ($after <= 0) { |
|
|
435 | $self->{_activity} = $NOW; |
|
|
436 | |
|
|
437 | if ($self->{on_timeout}) { |
|
|
438 | $self->{on_timeout}($self); |
|
|
439 | } else { |
|
|
440 | $self->_error (&Errno::ETIMEDOUT); |
|
|
441 | } |
|
|
442 | |
|
|
443 | # callback could have changed timeout value, optimise |
|
|
444 | return unless $self->{timeout}; |
|
|
445 | |
|
|
446 | # calculate new after |
|
|
447 | $after = $self->{timeout}; |
|
|
448 | } |
|
|
449 | |
|
|
450 | Scalar::Util::weaken $self; |
|
|
451 | return unless $self; # ->error could have destroyed $self |
|
|
452 | |
|
|
453 | $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub { |
|
|
454 | delete $self->{_tw}; |
|
|
455 | $self->_timeout; |
|
|
456 | }); |
|
|
457 | } else { |
|
|
458 | delete $self->{_tw}; |
|
|
459 | } |
|
|
460 | } |
|
|
461 | |
257 | ############################################################################# |
462 | ############################################################################# |
258 | |
463 | |
259 | =back |
464 | =back |
260 | |
465 | |
261 | =head2 WRITE QUEUE |
466 | =head2 WRITE QUEUE |
… | |
… | |
282 | my ($self, $cb) = @_; |
487 | my ($self, $cb) = @_; |
283 | |
488 | |
284 | $self->{on_drain} = $cb; |
489 | $self->{on_drain} = $cb; |
285 | |
490 | |
286 | $cb->($self) |
491 | $cb->($self) |
287 | if $cb && $self->{low_water_mark} >= length $self->{wbuf}; |
492 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
288 | } |
493 | } |
289 | |
494 | |
290 | =item $handle->push_write ($data) |
495 | =item $handle->push_write ($data) |
291 | |
496 | |
292 | 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 |
… | |
… | |
306 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
511 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
307 | |
512 | |
308 | if ($len >= 0) { |
513 | if ($len >= 0) { |
309 | substr $self->{wbuf}, 0, $len, ""; |
514 | substr $self->{wbuf}, 0, $len, ""; |
310 | |
515 | |
|
|
516 | $self->{_activity} = AnyEvent->now; |
|
|
517 | |
311 | $self->{on_drain}($self) |
518 | $self->{on_drain}($self) |
312 | if $self->{low_water_mark} >= length $self->{wbuf} |
519 | if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) |
313 | && $self->{on_drain}; |
520 | && $self->{on_drain}; |
314 | |
521 | |
315 | delete $self->{_ww} unless length $self->{wbuf}; |
522 | delete $self->{_ww} unless length $self->{wbuf}; |
316 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) { |
523 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
317 | $self->error; |
524 | $self->_error ($!, 1); |
318 | } |
525 | } |
319 | }; |
526 | }; |
320 | |
527 | |
321 | # try to write data immediately |
528 | # try to write data immediately |
322 | $cb->(); |
529 | $cb->() unless $self->{autocork}; |
323 | |
530 | |
324 | # if still data left in wbuf, we need to poll |
531 | # if still data left in wbuf, we need to poll |
325 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
532 | $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) |
326 | if length $self->{wbuf}; |
533 | if length $self->{wbuf}; |
327 | }; |
534 | }; |
… | |
… | |
341 | |
548 | |
342 | @_ = ($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") |
343 | ->($self, @_); |
550 | ->($self, @_); |
344 | } |
551 | } |
345 | |
552 | |
346 | if ($self->{filter_w}) { |
553 | if ($self->{tls}) { |
347 | $self->{filter_w}->($self, \$_[0]); |
554 | $self->{_tls_wbuf} .= $_[0]; |
|
|
555 | |
|
|
556 | &_dotls ($self); |
348 | } else { |
557 | } else { |
349 | $self->{wbuf} .= $_[0]; |
558 | $self->{wbuf} .= $_[0]; |
350 | $self->_drain_wbuf; |
559 | $self->_drain_wbuf; |
351 | } |
560 | } |
352 | } |
561 | } |
353 | |
562 | |
354 | =item $handle->push_write (type => @args) |
563 | =item $handle->push_write (type => @args) |
355 | |
564 | |
356 | =item $handle->unshift_write (type => @args) |
|
|
357 | |
|
|
358 | Instead of formatting your data yourself, you can also let this module do |
565 | Instead of formatting your data yourself, you can also let this module do |
359 | the job by specifying a type and type-specific arguments. |
566 | the job by specifying a type and type-specific arguments. |
360 | |
567 | |
361 | Predefined types are (if you have ideas for additional types, feel free to |
568 | Predefined types are (if you have ideas for additional types, feel free to |
362 | drop by and tell us): |
569 | drop by and tell us): |
… | |
… | |
366 | =item netstring => $string |
573 | =item netstring => $string |
367 | |
574 | |
368 | Formats the given value as netstring |
575 | Formats the given value as netstring |
369 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
576 | (http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them). |
370 | |
577 | |
371 | =back |
|
|
372 | |
|
|
373 | =cut |
578 | =cut |
374 | |
579 | |
375 | register_write_type netstring => sub { |
580 | register_write_type netstring => sub { |
376 | my ($self, $string) = @_; |
581 | my ($self, $string) = @_; |
377 | |
582 | |
378 | sprintf "%d:%s,", (length $string), $string |
583 | (length $string) . ":$string," |
379 | }; |
584 | }; |
380 | |
585 | |
|
|
586 | =item packstring => $format, $data |
|
|
587 | |
|
|
588 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
589 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
590 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
591 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
592 | |
|
|
593 | =cut |
|
|
594 | |
|
|
595 | register_write_type packstring => sub { |
|
|
596 | my ($self, $format, $string) = @_; |
|
|
597 | |
|
|
598 | pack "$format/a*", $string |
|
|
599 | }; |
|
|
600 | |
381 | =item json => $array_or_hashref |
601 | =item json => $array_or_hashref |
382 | |
602 | |
|
|
603 | Encodes the given hash or array reference into a JSON object. Unless you |
|
|
604 | provide your own JSON object, this means it will be encoded to JSON text |
|
|
605 | in UTF-8. |
|
|
606 | |
|
|
607 | JSON objects (and arrays) are self-delimiting, so you can write JSON at |
|
|
608 | one end of a handle and read them at the other end without using any |
|
|
609 | additional framing. |
|
|
610 | |
|
|
611 | The generated JSON text is guaranteed not to contain any newlines: While |
|
|
612 | this module doesn't need delimiters after or between JSON texts to be |
|
|
613 | able to read them, many other languages depend on that. |
|
|
614 | |
|
|
615 | A simple RPC protocol that interoperates easily with others is to send |
|
|
616 | JSON arrays (or objects, although arrays are usually the better choice as |
|
|
617 | they mimic how function argument passing works) and a newline after each |
|
|
618 | JSON text: |
|
|
619 | |
|
|
620 | $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever |
|
|
621 | $handle->push_write ("\012"); |
|
|
622 | |
|
|
623 | An AnyEvent::Handle receiver would simply use the C<json> read type and |
|
|
624 | rely on the fact that the newline will be skipped as leading whitespace: |
|
|
625 | |
|
|
626 | $handle->push_read (json => sub { my $array = $_[1]; ... }); |
|
|
627 | |
|
|
628 | Other languages could read single lines terminated by a newline and pass |
|
|
629 | this line into their JSON decoder of choice. |
|
|
630 | |
|
|
631 | =cut |
|
|
632 | |
|
|
633 | register_write_type json => sub { |
|
|
634 | my ($self, $ref) = @_; |
|
|
635 | |
|
|
636 | require JSON; |
|
|
637 | |
|
|
638 | $self->{json} ? $self->{json}->encode ($ref) |
|
|
639 | : JSON::encode_json ($ref) |
|
|
640 | }; |
|
|
641 | |
|
|
642 | =item storable => $reference |
|
|
643 | |
|
|
644 | Freezes the given reference using L<Storable> and writes it to the |
|
|
645 | handle. Uses the C<nfreeze> format. |
|
|
646 | |
|
|
647 | =cut |
|
|
648 | |
|
|
649 | register_write_type storable => sub { |
|
|
650 | my ($self, $ref) = @_; |
|
|
651 | |
|
|
652 | require Storable; |
|
|
653 | |
|
|
654 | pack "w/a*", Storable::nfreeze ($ref) |
|
|
655 | }; |
|
|
656 | |
|
|
657 | =back |
|
|
658 | |
383 | =item AnyEvent::Handle::register_write_type type => $coderef->($self, @args) |
659 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
384 | |
660 | |
385 | This function (not method) lets you add your own types to C<push_write>. |
661 | This function (not method) lets you add your own types to C<push_write>. |
386 | Whenever the given C<type> is used, C<push_write> will invoke the code |
662 | Whenever the given C<type> is used, C<push_write> will invoke the code |
387 | reference with the handle object and the remaining arguments. |
663 | reference with the handle object and the remaining arguments. |
388 | |
664 | |
… | |
… | |
407 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
683 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
408 | a queue. |
684 | a queue. |
409 | |
685 | |
410 | In the simple case, you just install an C<on_read> callback and whenever |
686 | In the simple case, you just install an C<on_read> callback and whenever |
411 | new data arrives, it will be called. You can then remove some data (if |
687 | new data arrives, it will be called. You can then remove some data (if |
412 | enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
688 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
413 | or not. |
689 | leave the data there if you want to accumulate more (e.g. when only a |
|
|
690 | partial message has been received so far). |
414 | |
691 | |
415 | In the more complex case, you want to queue multiple callbacks. In this |
692 | In the more complex case, you want to queue multiple callbacks. In this |
416 | case, AnyEvent::Handle will call the first queued callback each time new |
693 | case, AnyEvent::Handle will call the first queued callback each time new |
417 | data arrives and removes it when it has done its job (see C<push_read>, |
694 | data arrives (also the first time it is queued) and removes it when it has |
418 | below). |
695 | done its job (see C<push_read>, below). |
419 | |
696 | |
420 | This way you can, for example, push three line-reads, followed by reading |
697 | This way you can, for example, push three line-reads, followed by reading |
421 | a chunk of data, and AnyEvent::Handle will execute them in order. |
698 | a chunk of data, and AnyEvent::Handle will execute them in order. |
422 | |
699 | |
423 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
700 | Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
424 | the specified number of bytes which give an XML datagram. |
701 | the specified number of bytes which give an XML datagram. |
425 | |
702 | |
426 | # in the default state, expect some header bytes |
703 | # in the default state, expect some header bytes |
427 | $handle->on_read (sub { |
704 | $handle->on_read (sub { |
428 | # some data is here, now queue the length-header-read (4 octets) |
705 | # some data is here, now queue the length-header-read (4 octets) |
429 | shift->unshift_read_chunk (4, sub { |
706 | shift->unshift_read (chunk => 4, sub { |
430 | # header arrived, decode |
707 | # header arrived, decode |
431 | my $len = unpack "N", $_[1]; |
708 | my $len = unpack "N", $_[1]; |
432 | |
709 | |
433 | # now read the payload |
710 | # now read the payload |
434 | shift->unshift_read_chunk ($len, sub { |
711 | shift->unshift_read (chunk => $len, sub { |
435 | my $xml = $_[1]; |
712 | my $xml = $_[1]; |
436 | # handle xml |
713 | # handle xml |
437 | }); |
714 | }); |
438 | }); |
715 | }); |
439 | }); |
716 | }); |
440 | |
717 | |
441 | Example 2: Implement a client for a protocol that replies either with |
718 | Example 2: Implement a client for a protocol that replies either with "OK" |
442 | "OK" and another line or "ERROR" for one request, and 64 bytes for the |
719 | and another line or "ERROR" for the first request that is sent, and 64 |
443 | second request. Due tot he availability of a full queue, we can just |
720 | bytes for the second request. Due to the availability of a queue, we can |
444 | pipeline sending both requests and manipulate the queue as necessary in |
721 | just pipeline sending both requests and manipulate the queue as necessary |
445 | the callbacks: |
722 | in the callbacks. |
446 | |
723 | |
447 | # request one |
724 | When the first callback is called and sees an "OK" response, it will |
|
|
725 | C<unshift> another line-read. This line-read will be queued I<before> the |
|
|
726 | 64-byte chunk callback. |
|
|
727 | |
|
|
728 | # request one, returns either "OK + extra line" or "ERROR" |
448 | $handle->push_write ("request 1\015\012"); |
729 | $handle->push_write ("request 1\015\012"); |
449 | |
730 | |
450 | # we expect "ERROR" or "OK" as response, so push a line read |
731 | # we expect "ERROR" or "OK" as response, so push a line read |
451 | $handle->push_read_line (sub { |
732 | $handle->push_read (line => sub { |
452 | # if we got an "OK", we have to _prepend_ another line, |
733 | # if we got an "OK", we have to _prepend_ another line, |
453 | # so it will be read before the second request reads its 64 bytes |
734 | # so it will be read before the second request reads its 64 bytes |
454 | # which are already in the queue when this callback is called |
735 | # which are already in the queue when this callback is called |
455 | # we don't do this in case we got an error |
736 | # we don't do this in case we got an error |
456 | if ($_[1] eq "OK") { |
737 | if ($_[1] eq "OK") { |
457 | $_[0]->unshift_read_line (sub { |
738 | $_[0]->unshift_read (line => sub { |
458 | my $response = $_[1]; |
739 | my $response = $_[1]; |
459 | ... |
740 | ... |
460 | }); |
741 | }); |
461 | } |
742 | } |
462 | }); |
743 | }); |
463 | |
744 | |
464 | # request two |
745 | # request two, simply returns 64 octets |
465 | $handle->push_write ("request 2\015\012"); |
746 | $handle->push_write ("request 2\015\012"); |
466 | |
747 | |
467 | # simply read 64 bytes, always |
748 | # simply read 64 bytes, always |
468 | $handle->push_read_chunk (64, sub { |
749 | $handle->push_read (chunk => 64, sub { |
469 | my $response = $_[1]; |
750 | my $response = $_[1]; |
470 | ... |
751 | ... |
471 | }); |
752 | }); |
472 | |
753 | |
473 | =over 4 |
754 | =over 4 |
474 | |
755 | |
475 | =cut |
756 | =cut |
476 | |
757 | |
477 | sub _drain_rbuf { |
758 | sub _drain_rbuf { |
478 | my ($self) = @_; |
759 | my ($self) = @_; |
|
|
760 | |
|
|
761 | local $self->{_in_drain} = 1; |
479 | |
762 | |
480 | if ( |
763 | if ( |
481 | defined $self->{rbuf_max} |
764 | defined $self->{rbuf_max} |
482 | && $self->{rbuf_max} < length $self->{rbuf} |
765 | && $self->{rbuf_max} < length $self->{rbuf} |
483 | ) { |
766 | ) { |
484 | $! = &Errno::ENOSPC; |
767 | $self->_error (&Errno::ENOSPC, 1), return; |
485 | $self->error; |
|
|
486 | } |
768 | } |
487 | |
769 | |
488 | return if $self->{in_drain}; |
770 | while () { |
489 | local $self->{in_drain} = 1; |
|
|
490 | |
|
|
491 | while (my $len = length $self->{rbuf}) { |
771 | my $len = length $self->{rbuf}; |
492 | no strict 'refs'; |
772 | |
493 | if (my $cb = shift @{ $self->{_queue} }) { |
773 | if (my $cb = shift @{ $self->{_queue} }) { |
494 | unless ($cb->($self)) { |
774 | unless ($cb->($self)) { |
495 | if ($self->{_eof}) { |
775 | if ($self->{_eof}) { |
496 | # no progress can be made (not enough data and no data forthcoming) |
776 | # no progress can be made (not enough data and no data forthcoming) |
497 | $! = &Errno::EPIPE; |
777 | $self->_error (&Errno::EPIPE, 1), return; |
498 | $self->error; |
|
|
499 | } |
778 | } |
500 | |
779 | |
501 | unshift @{ $self->{_queue} }, $cb; |
780 | unshift @{ $self->{_queue} }, $cb; |
502 | return; |
781 | last; |
503 | } |
782 | } |
504 | } elsif ($self->{on_read}) { |
783 | } elsif ($self->{on_read}) { |
|
|
784 | last unless $len; |
|
|
785 | |
505 | $self->{on_read}($self); |
786 | $self->{on_read}($self); |
506 | |
787 | |
507 | if ( |
788 | if ( |
508 | $self->{_eof} # if no further data will arrive |
|
|
509 | && $len == length $self->{rbuf} # and no data has been consumed |
789 | $len == length $self->{rbuf} # if no data has been consumed |
510 | && !@{ $self->{_queue} } # and the queue is still empty |
790 | && !@{ $self->{_queue} } # and the queue is still empty |
511 | && $self->{on_read} # and we still want to read data |
791 | && $self->{on_read} # but we still have on_read |
512 | ) { |
792 | ) { |
|
|
793 | # no further data will arrive |
513 | # then no progress can be made |
794 | # so no progress can be made |
514 | $! = &Errno::EPIPE; |
795 | $self->_error (&Errno::EPIPE, 1), return |
515 | $self->error; |
796 | if $self->{_eof}; |
|
|
797 | |
|
|
798 | last; # more data might arrive |
516 | } |
799 | } |
517 | } else { |
800 | } else { |
518 | # read side becomes idle |
801 | # read side becomes idle |
519 | delete $self->{_rw}; |
802 | delete $self->{_rw} unless $self->{tls}; |
520 | return; |
803 | last; |
521 | } |
804 | } |
522 | } |
805 | } |
523 | |
806 | |
524 | if ($self->{_eof}) { |
807 | if ($self->{_eof}) { |
525 | $self->_shutdown; |
808 | if ($self->{on_eof}) { |
526 | $self->{on_eof}($self) |
809 | $self->{on_eof}($self) |
527 | if $self->{on_eof}; |
810 | } else { |
|
|
811 | $self->_error (0, 1); |
|
|
812 | } |
|
|
813 | } |
|
|
814 | |
|
|
815 | # may need to restart read watcher |
|
|
816 | unless ($self->{_rw}) { |
|
|
817 | $self->start_read |
|
|
818 | if $self->{on_read} || @{ $self->{_queue} }; |
528 | } |
819 | } |
529 | } |
820 | } |
530 | |
821 | |
531 | =item $handle->on_read ($cb) |
822 | =item $handle->on_read ($cb) |
532 | |
823 | |
… | |
… | |
538 | |
829 | |
539 | sub on_read { |
830 | sub on_read { |
540 | my ($self, $cb) = @_; |
831 | my ($self, $cb) = @_; |
541 | |
832 | |
542 | $self->{on_read} = $cb; |
833 | $self->{on_read} = $cb; |
|
|
834 | $self->_drain_rbuf if $cb && !$self->{_in_drain}; |
543 | } |
835 | } |
544 | |
836 | |
545 | =item $handle->rbuf |
837 | =item $handle->rbuf |
546 | |
838 | |
547 | Returns the read buffer (as a modifiable lvalue). |
839 | Returns the read buffer (as a modifiable lvalue). |
… | |
… | |
596 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
888 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
597 | ->($self, $cb, @_); |
889 | ->($self, $cb, @_); |
598 | } |
890 | } |
599 | |
891 | |
600 | push @{ $self->{_queue} }, $cb; |
892 | push @{ $self->{_queue} }, $cb; |
601 | $self->_drain_rbuf; |
893 | $self->_drain_rbuf unless $self->{_in_drain}; |
602 | } |
894 | } |
603 | |
895 | |
604 | sub unshift_read { |
896 | sub unshift_read { |
605 | my $self = shift; |
897 | my $self = shift; |
606 | my $cb = pop; |
898 | my $cb = pop; |
… | |
… | |
612 | ->($self, $cb, @_); |
904 | ->($self, $cb, @_); |
613 | } |
905 | } |
614 | |
906 | |
615 | |
907 | |
616 | unshift @{ $self->{_queue} }, $cb; |
908 | unshift @{ $self->{_queue} }, $cb; |
617 | $self->_drain_rbuf; |
909 | $self->_drain_rbuf unless $self->{_in_drain}; |
618 | } |
910 | } |
619 | |
911 | |
620 | =item $handle->push_read (type => @args, $cb) |
912 | =item $handle->push_read (type => @args, $cb) |
621 | |
913 | |
622 | =item $handle->unshift_read (type => @args, $cb) |
914 | =item $handle->unshift_read (type => @args, $cb) |
… | |
… | |
628 | Predefined types are (if you have ideas for additional types, feel free to |
920 | Predefined types are (if you have ideas for additional types, feel free to |
629 | drop by and tell us): |
921 | drop by and tell us): |
630 | |
922 | |
631 | =over 4 |
923 | =over 4 |
632 | |
924 | |
633 | =item chunk => $octets, $cb->($self, $data) |
925 | =item chunk => $octets, $cb->($handle, $data) |
634 | |
926 | |
635 | Invoke the callback only once C<$octets> bytes have been read. Pass the |
927 | Invoke the callback only once C<$octets> bytes have been read. Pass the |
636 | data read to the callback. The callback will never be called with less |
928 | data read to the callback. The callback will never be called with less |
637 | data. |
929 | data. |
638 | |
930 | |
… | |
… | |
652 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
944 | $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
653 | 1 |
945 | 1 |
654 | } |
946 | } |
655 | }; |
947 | }; |
656 | |
948 | |
657 | # compatibility with older API |
|
|
658 | sub push_read_chunk { |
|
|
659 | $_[0]->push_read (chunk => $_[1], $_[2]); |
|
|
660 | } |
|
|
661 | |
|
|
662 | sub unshift_read_chunk { |
|
|
663 | $_[0]->unshift_read (chunk => $_[1], $_[2]); |
|
|
664 | } |
|
|
665 | |
|
|
666 | =item line => [$eol, ]$cb->($self, $line, $eol) |
949 | =item line => [$eol, ]$cb->($handle, $line, $eol) |
667 | |
950 | |
668 | The callback will be called only once a full line (including the end of |
951 | The callback will be called only once a full line (including the end of |
669 | line marker, C<$eol>) has been read. This line (excluding the end of line |
952 | line marker, C<$eol>) has been read. This line (excluding the end of line |
670 | marker) will be passed to the callback as second argument (C<$line>), and |
953 | marker) will be passed to the callback as second argument (C<$line>), and |
671 | the end of line marker as the third argument (C<$eol>). |
954 | the end of line marker as the third argument (C<$eol>). |
… | |
… | |
685 | =cut |
968 | =cut |
686 | |
969 | |
687 | register_read_type line => sub { |
970 | register_read_type line => sub { |
688 | my ($self, $cb, $eol) = @_; |
971 | my ($self, $cb, $eol) = @_; |
689 | |
972 | |
690 | $eol = qr|(\015?\012)| if @_ < 3; |
973 | if (@_ < 3) { |
|
|
974 | # this is more than twice as fast as the generic code below |
|
|
975 | sub { |
|
|
976 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
|
|
977 | |
|
|
978 | $cb->($_[0], $1, $2); |
|
|
979 | 1 |
|
|
980 | } |
|
|
981 | } else { |
691 | $eol = quotemeta $eol unless ref $eol; |
982 | $eol = quotemeta $eol unless ref $eol; |
692 | $eol = qr|^(.*?)($eol)|s; |
983 | $eol = qr|^(.*?)($eol)|s; |
693 | |
984 | |
694 | sub { |
985 | sub { |
695 | $_[0]{rbuf} =~ s/$eol// or return; |
986 | $_[0]{rbuf} =~ s/$eol// or return; |
696 | |
987 | |
697 | $cb->($_[0], $1, $2); |
988 | $cb->($_[0], $1, $2); |
|
|
989 | 1 |
698 | 1 |
990 | } |
699 | } |
991 | } |
700 | }; |
992 | }; |
701 | |
993 | |
702 | # compatibility with older API |
|
|
703 | sub push_read_line { |
|
|
704 | my $self = shift; |
|
|
705 | $self->push_read (line => @_); |
|
|
706 | } |
|
|
707 | |
|
|
708 | sub unshift_read_line { |
|
|
709 | my $self = shift; |
|
|
710 | $self->unshift_read (line => @_); |
|
|
711 | } |
|
|
712 | |
|
|
713 | =item netstring => $cb->($string) |
|
|
714 | |
|
|
715 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
716 | |
|
|
717 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
718 | |
|
|
719 | =cut |
|
|
720 | |
|
|
721 | register_read_type netstring => sub { |
|
|
722 | my ($self, $cb) = @_; |
|
|
723 | |
|
|
724 | sub { |
|
|
725 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
726 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
727 | $! = &Errno::EBADMSG; |
|
|
728 | $self->error; |
|
|
729 | } |
|
|
730 | return; |
|
|
731 | } |
|
|
732 | |
|
|
733 | my $len = $1; |
|
|
734 | |
|
|
735 | $self->unshift_read (chunk => $len, sub { |
|
|
736 | my $string = $_[1]; |
|
|
737 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
738 | if ($_[1] eq ",") { |
|
|
739 | $cb->($_[0], $string); |
|
|
740 | } else { |
|
|
741 | $! = &Errno::EBADMSG; |
|
|
742 | $self->error; |
|
|
743 | } |
|
|
744 | }); |
|
|
745 | }); |
|
|
746 | |
|
|
747 | 1 |
|
|
748 | } |
|
|
749 | }; |
|
|
750 | |
|
|
751 | =item regex => $accept[, $reject[, $skip], $cb->($data) |
994 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
752 | |
995 | |
753 | Makes a regex match against the regex object C<$accept> and returns |
996 | Makes a regex match against the regex object C<$accept> and returns |
754 | everything up to and including the match. |
997 | everything up to and including the match. |
755 | |
998 | |
756 | Example: read a single line terminated by '\n'. |
999 | Example: read a single line terminated by '\n'. |
… | |
… | |
804 | return 1; |
1047 | return 1; |
805 | } |
1048 | } |
806 | |
1049 | |
807 | # reject |
1050 | # reject |
808 | if ($reject && $$rbuf =~ $reject) { |
1051 | if ($reject && $$rbuf =~ $reject) { |
809 | $! = &Errno::EBADMSG; |
1052 | $self->_error (&Errno::EBADMSG); |
810 | $self->error; |
|
|
811 | } |
1053 | } |
812 | |
1054 | |
813 | # skip |
1055 | # skip |
814 | if ($skip && $$rbuf =~ $skip) { |
1056 | if ($skip && $$rbuf =~ $skip) { |
815 | $data .= substr $$rbuf, 0, $+[0], ""; |
1057 | $data .= substr $$rbuf, 0, $+[0], ""; |
… | |
… | |
817 | |
1059 | |
818 | () |
1060 | () |
819 | } |
1061 | } |
820 | }; |
1062 | }; |
821 | |
1063 | |
|
|
1064 | =item netstring => $cb->($handle, $string) |
|
|
1065 | |
|
|
1066 | A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement). |
|
|
1067 | |
|
|
1068 | Throws an error with C<$!> set to EBADMSG on format violations. |
|
|
1069 | |
|
|
1070 | =cut |
|
|
1071 | |
|
|
1072 | register_read_type netstring => sub { |
|
|
1073 | my ($self, $cb) = @_; |
|
|
1074 | |
|
|
1075 | sub { |
|
|
1076 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
|
|
1077 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
|
|
1078 | $self->_error (&Errno::EBADMSG); |
|
|
1079 | } |
|
|
1080 | return; |
|
|
1081 | } |
|
|
1082 | |
|
|
1083 | my $len = $1; |
|
|
1084 | |
|
|
1085 | $self->unshift_read (chunk => $len, sub { |
|
|
1086 | my $string = $_[1]; |
|
|
1087 | $_[0]->unshift_read (chunk => 1, sub { |
|
|
1088 | if ($_[1] eq ",") { |
|
|
1089 | $cb->($_[0], $string); |
|
|
1090 | } else { |
|
|
1091 | $self->_error (&Errno::EBADMSG); |
|
|
1092 | } |
|
|
1093 | }); |
|
|
1094 | }); |
|
|
1095 | |
|
|
1096 | 1 |
|
|
1097 | } |
|
|
1098 | }; |
|
|
1099 | |
|
|
1100 | =item packstring => $format, $cb->($handle, $string) |
|
|
1101 | |
|
|
1102 | An octet string prefixed with an encoded length. The encoding C<$format> |
|
|
1103 | uses the same format as a Perl C<pack> format, but must specify a single |
|
|
1104 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
|
|
1105 | optional C<!>, C<< < >> or C<< > >> modifier). |
|
|
1106 | |
|
|
1107 | For example, DNS over TCP uses a prefix of C<n> (2 octet network order), |
|
|
1108 | EPP uses a prefix of C<N> (4 octtes). |
|
|
1109 | |
|
|
1110 | Example: read a block of data prefixed by its length in BER-encoded |
|
|
1111 | format (very efficient). |
|
|
1112 | |
|
|
1113 | $handle->push_read (packstring => "w", sub { |
|
|
1114 | my ($handle, $data) = @_; |
|
|
1115 | }); |
|
|
1116 | |
|
|
1117 | =cut |
|
|
1118 | |
|
|
1119 | register_read_type packstring => sub { |
|
|
1120 | my ($self, $cb, $format) = @_; |
|
|
1121 | |
|
|
1122 | sub { |
|
|
1123 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1124 | defined (my $len = eval { unpack $format, $_[0]{rbuf} }) |
|
|
1125 | or return; |
|
|
1126 | |
|
|
1127 | $format = length pack $format, $len; |
|
|
1128 | |
|
|
1129 | # bypass unshift if we already have the remaining chunk |
|
|
1130 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1131 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1132 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1133 | $cb->($_[0], $data); |
|
|
1134 | } else { |
|
|
1135 | # remove prefix |
|
|
1136 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1137 | |
|
|
1138 | # read remaining chunk |
|
|
1139 | $_[0]->unshift_read (chunk => $len, $cb); |
|
|
1140 | } |
|
|
1141 | |
|
|
1142 | 1 |
|
|
1143 | } |
|
|
1144 | }; |
|
|
1145 | |
|
|
1146 | =item json => $cb->($handle, $hash_or_arrayref) |
|
|
1147 | |
|
|
1148 | Reads a JSON object or array, decodes it and passes it to the callback. |
|
|
1149 | |
|
|
1150 | If a C<json> object was passed to the constructor, then that will be used |
|
|
1151 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
|
|
1152 | |
|
|
1153 | This read type uses the incremental parser available with JSON version |
|
|
1154 | 2.09 (and JSON::XS version 2.2) and above. You have to provide a |
|
|
1155 | dependency on your own: this module will load the JSON module, but |
|
|
1156 | AnyEvent does not depend on it itself. |
|
|
1157 | |
|
|
1158 | Since JSON texts are fully self-delimiting, the C<json> read and write |
|
|
1159 | types are an ideal simple RPC protocol: just exchange JSON datagrams. See |
|
|
1160 | the C<json> write type description, above, for an actual example. |
|
|
1161 | |
|
|
1162 | =cut |
|
|
1163 | |
|
|
1164 | register_read_type json => sub { |
|
|
1165 | my ($self, $cb) = @_; |
|
|
1166 | |
|
|
1167 | require JSON; |
|
|
1168 | |
|
|
1169 | my $data; |
|
|
1170 | my $rbuf = \$self->{rbuf}; |
|
|
1171 | |
|
|
1172 | my $json = $self->{json} ||= JSON->new->utf8; |
|
|
1173 | |
|
|
1174 | sub { |
|
|
1175 | my $ref = $json->incr_parse ($self->{rbuf}); |
|
|
1176 | |
|
|
1177 | if ($ref) { |
|
|
1178 | $self->{rbuf} = $json->incr_text; |
|
|
1179 | $json->incr_text = ""; |
|
|
1180 | $cb->($self, $ref); |
|
|
1181 | |
|
|
1182 | 1 |
|
|
1183 | } else { |
|
|
1184 | $self->{rbuf} = ""; |
|
|
1185 | () |
|
|
1186 | } |
|
|
1187 | } |
|
|
1188 | }; |
|
|
1189 | |
|
|
1190 | =item storable => $cb->($handle, $ref) |
|
|
1191 | |
|
|
1192 | Deserialises a L<Storable> frozen representation as written by the |
|
|
1193 | C<storable> write type (BER-encoded length prefix followed by nfreeze'd |
|
|
1194 | data). |
|
|
1195 | |
|
|
1196 | Raises C<EBADMSG> error if the data could not be decoded. |
|
|
1197 | |
|
|
1198 | =cut |
|
|
1199 | |
|
|
1200 | register_read_type storable => sub { |
|
|
1201 | my ($self, $cb) = @_; |
|
|
1202 | |
|
|
1203 | require Storable; |
|
|
1204 | |
|
|
1205 | sub { |
|
|
1206 | # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method |
|
|
1207 | defined (my $len = eval { unpack "w", $_[0]{rbuf} }) |
|
|
1208 | or return; |
|
|
1209 | |
|
|
1210 | my $format = length pack "w", $len; |
|
|
1211 | |
|
|
1212 | # bypass unshift if we already have the remaining chunk |
|
|
1213 | if ($format + $len <= length $_[0]{rbuf}) { |
|
|
1214 | my $data = substr $_[0]{rbuf}, $format, $len; |
|
|
1215 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1216 | $cb->($_[0], Storable::thaw ($data)); |
|
|
1217 | } else { |
|
|
1218 | # remove prefix |
|
|
1219 | substr $_[0]{rbuf}, 0, $format, ""; |
|
|
1220 | |
|
|
1221 | # read remaining chunk |
|
|
1222 | $_[0]->unshift_read (chunk => $len, sub { |
|
|
1223 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
|
|
1224 | $cb->($_[0], $ref); |
|
|
1225 | } else { |
|
|
1226 | $self->_error (&Errno::EBADMSG); |
|
|
1227 | } |
|
|
1228 | }); |
|
|
1229 | } |
|
|
1230 | |
|
|
1231 | 1 |
|
|
1232 | } |
|
|
1233 | }; |
|
|
1234 | |
822 | =back |
1235 | =back |
823 | |
1236 | |
824 | =item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args) |
1237 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
825 | |
1238 | |
826 | This function (not method) lets you add your own types to C<push_read>. |
1239 | This function (not method) lets you add your own types to C<push_read>. |
827 | |
1240 | |
828 | Whenever the given C<type> is used, C<push_read> will invoke the code |
1241 | Whenever the given C<type> is used, C<push_read> will invoke the code |
829 | reference with the handle object, the callback and the remaining |
1242 | reference with the handle object, the callback and the remaining |
… | |
… | |
831 | |
1244 | |
832 | The code reference is supposed to return a callback (usually a closure) |
1245 | The code reference is supposed to return a callback (usually a closure) |
833 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
1246 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
834 | |
1247 | |
835 | It should invoke the passed callback when it is done reading (remember to |
1248 | It should invoke the passed callback when it is done reading (remember to |
836 | pass C<$self> as first argument as all other callbacks do that). |
1249 | pass C<$handle> as first argument as all other callbacks do that). |
837 | |
1250 | |
838 | Note that this is a function, and all types registered this way will be |
1251 | Note that this is a function, and all types registered this way will be |
839 | global, so try to use unique names. |
1252 | global, so try to use unique names. |
840 | |
1253 | |
841 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
1254 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
… | |
… | |
844 | =item $handle->stop_read |
1257 | =item $handle->stop_read |
845 | |
1258 | |
846 | =item $handle->start_read |
1259 | =item $handle->start_read |
847 | |
1260 | |
848 | In rare cases you actually do not want to read anything from the |
1261 | In rare cases you actually do not want to read anything from the |
849 | socket. In this case you can call C<stop_read>. Neither C<on_read> no |
1262 | socket. In this case you can call C<stop_read>. Neither C<on_read> nor |
850 | any queued callbacks will be executed then. To start reading again, call |
1263 | any queued callbacks will be executed then. To start reading again, call |
851 | C<start_read>. |
1264 | C<start_read>. |
852 | |
1265 | |
|
|
1266 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
|
|
1267 | you change the C<on_read> callback or push/unshift a read callback, and it |
|
|
1268 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
|
|
1269 | there are any read requests in the queue. |
|
|
1270 | |
|
|
1271 | These methods will have no effect when in TLS mode (as TLS doesn't support |
|
|
1272 | half-duplex connections). |
|
|
1273 | |
853 | =cut |
1274 | =cut |
854 | |
1275 | |
855 | sub stop_read { |
1276 | sub stop_read { |
856 | my ($self) = @_; |
1277 | my ($self) = @_; |
857 | |
1278 | |
858 | delete $self->{_rw}; |
1279 | delete $self->{_rw} unless $self->{tls}; |
859 | } |
1280 | } |
860 | |
1281 | |
861 | sub start_read { |
1282 | sub start_read { |
862 | my ($self) = @_; |
1283 | my ($self) = @_; |
863 | |
1284 | |
864 | unless ($self->{_rw} || $self->{_eof}) { |
1285 | unless ($self->{_rw} || $self->{_eof}) { |
865 | Scalar::Util::weaken $self; |
1286 | Scalar::Util::weaken $self; |
866 | |
1287 | |
867 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1288 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
868 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
1289 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
869 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1290 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
870 | |
1291 | |
871 | if ($len > 0) { |
1292 | if ($len > 0) { |
872 | $self->{filter_r} |
1293 | $self->{_activity} = AnyEvent->now; |
873 | ? $self->{filter_r}->($self, $rbuf) |
1294 | |
874 | : $self->_drain_rbuf; |
1295 | if ($self->{tls}) { |
|
|
1296 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
|
|
1297 | |
|
|
1298 | &_dotls ($self); |
|
|
1299 | } else { |
|
|
1300 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1301 | } |
875 | |
1302 | |
876 | } elsif (defined $len) { |
1303 | } elsif (defined $len) { |
877 | delete $self->{_rw}; |
1304 | delete $self->{_rw}; |
878 | $self->{_eof} = 1; |
1305 | $self->{_eof} = 1; |
879 | $self->_drain_rbuf; |
1306 | $self->_drain_rbuf unless $self->{_in_drain}; |
880 | |
1307 | |
881 | } elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) { |
1308 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
882 | return $self->error; |
1309 | return $self->_error ($!, 1); |
883 | } |
1310 | } |
884 | }); |
1311 | }); |
885 | } |
1312 | } |
886 | } |
1313 | } |
887 | |
1314 | |
|
|
1315 | # poll the write BIO and send the data if applicable |
888 | sub _dotls { |
1316 | sub _dotls { |
889 | my ($self) = @_; |
1317 | my ($self) = @_; |
890 | |
1318 | |
|
|
1319 | my $tmp; |
|
|
1320 | |
891 | if (length $self->{_tls_wbuf}) { |
1321 | if (length $self->{_tls_wbuf}) { |
892 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1322 | while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
893 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1323 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
894 | } |
1324 | } |
895 | } |
1325 | } |
896 | |
1326 | |
|
|
1327 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
|
|
1328 | unless (length $tmp) { |
|
|
1329 | # let's treat SSL-eof as we treat normal EOF |
|
|
1330 | delete $self->{_rw}; |
|
|
1331 | $self->{_eof} = 1; |
|
|
1332 | &_freetls; |
|
|
1333 | } |
|
|
1334 | |
|
|
1335 | $self->{rbuf} .= $tmp; |
|
|
1336 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1337 | $self->{tls} or return; # tls session might have gone away in callback |
|
|
1338 | } |
|
|
1339 | |
|
|
1340 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
|
|
1341 | |
|
|
1342 | if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) { |
|
|
1343 | if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) { |
|
|
1344 | return $self->_error ($!, 1); |
|
|
1345 | } elsif ($tmp == Net::SSLeay::ERROR_SSL ()) { |
|
|
1346 | return $self->_error (&Errno::EIO, 1); |
|
|
1347 | } |
|
|
1348 | |
|
|
1349 | # all other errors are fine for our purposes |
|
|
1350 | } |
|
|
1351 | |
897 | if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1352 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
898 | $self->{wbuf} .= $buf; |
1353 | $self->{wbuf} .= $tmp; |
899 | $self->_drain_wbuf; |
1354 | $self->_drain_wbuf; |
900 | } |
|
|
901 | |
|
|
902 | while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { |
|
|
903 | $self->{rbuf} .= $buf; |
|
|
904 | $self->_drain_rbuf; |
|
|
905 | } |
|
|
906 | |
|
|
907 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
|
|
908 | |
|
|
909 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
|
|
910 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
|
|
911 | $self->error; |
|
|
912 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
|
|
913 | $! = &Errno::EIO; |
|
|
914 | $self->error; |
|
|
915 | } |
|
|
916 | |
|
|
917 | # all others are fine for our purposes |
|
|
918 | } |
1355 | } |
919 | } |
1356 | } |
920 | |
1357 | |
921 | =item $handle->starttls ($tls[, $tls_ctx]) |
1358 | =item $handle->starttls ($tls[, $tls_ctx]) |
922 | |
1359 | |
… | |
… | |
932 | |
1369 | |
933 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
1370 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
934 | call and can be used or changed to your liking. Note that the handshake |
1371 | call and can be used or changed to your liking. Note that the handshake |
935 | might have already started when this function returns. |
1372 | might have already started when this function returns. |
936 | |
1373 | |
937 | =cut |
1374 | If it an error to start a TLS handshake more than once per |
|
|
1375 | AnyEvent::Handle object (this is due to bugs in OpenSSL). |
938 | |
1376 | |
939 | # TODO: maybe document... |
1377 | =cut |
|
|
1378 | |
940 | sub starttls { |
1379 | sub starttls { |
941 | my ($self, $ssl, $ctx) = @_; |
1380 | my ($self, $ssl, $ctx) = @_; |
942 | |
1381 | |
943 | $self->stoptls; |
1382 | require Net::SSLeay; |
944 | |
1383 | |
|
|
1384 | Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object" |
|
|
1385 | if $self->{tls}; |
|
|
1386 | |
945 | if ($ssl eq "accept") { |
1387 | if ($ssl eq "accept") { |
946 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1388 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
947 | Net::SSLeay::set_accept_state ($ssl); |
1389 | Net::SSLeay::set_accept_state ($ssl); |
948 | } elsif ($ssl eq "connect") { |
1390 | } elsif ($ssl eq "connect") { |
949 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1391 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
… | |
… | |
955 | # basically, this is deep magic (because SSL_read should have the same issues) |
1397 | # basically, this is deep magic (because SSL_read should have the same issues) |
956 | # but the openssl maintainers basically said: "trust us, it just works". |
1398 | # but the openssl maintainers basically said: "trust us, it just works". |
957 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1399 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
958 | # and mismaintained ssleay-module doesn't even offer them). |
1400 | # and mismaintained ssleay-module doesn't even offer them). |
959 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
1401 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
|
|
1402 | # |
|
|
1403 | # in short: this is a mess. |
|
|
1404 | # |
|
|
1405 | # note that we do not try to keep the length constant between writes as we are required to do. |
|
|
1406 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
|
|
1407 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
|
|
1408 | # have identity issues in that area. |
960 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1409 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
961 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1410 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
962 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1411 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
963 | |
1412 | |
964 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1413 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
965 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1414 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
966 | |
1415 | |
967 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1416 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
968 | |
1417 | |
969 | $self->{filter_w} = sub { |
1418 | &_dotls; # need to trigger the initial handshake |
970 | $_[0]{_tls_wbuf} .= ${$_[1]}; |
1419 | $self->start_read; # make sure we actually do read |
971 | &_dotls; |
|
|
972 | }; |
|
|
973 | $self->{filter_r} = sub { |
|
|
974 | Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]}); |
|
|
975 | &_dotls; |
|
|
976 | }; |
|
|
977 | } |
1420 | } |
978 | |
1421 | |
979 | =item $handle->stoptls |
1422 | =item $handle->stoptls |
980 | |
1423 | |
981 | Destroys the SSL connection, if any. Partial read or write data will be |
1424 | Shuts down the SSL connection - this makes a proper EOF handshake by |
982 | lost. |
1425 | sending a close notify to the other side, but since OpenSSL doesn't |
|
|
1426 | support non-blocking shut downs, it is not possible to re-use the stream |
|
|
1427 | afterwards. |
983 | |
1428 | |
984 | =cut |
1429 | =cut |
985 | |
1430 | |
986 | sub stoptls { |
1431 | sub stoptls { |
987 | my ($self) = @_; |
1432 | my ($self) = @_; |
988 | |
1433 | |
|
|
1434 | if ($self->{tls}) { |
|
|
1435 | Net::SSLeay::shutdown ($self->{tls}); |
|
|
1436 | |
|
|
1437 | &_dotls; |
|
|
1438 | |
|
|
1439 | # we don't give a shit. no, we do, but we can't. no... |
|
|
1440 | # we, we... have to use openssl :/ |
|
|
1441 | &_freetls; |
|
|
1442 | } |
|
|
1443 | } |
|
|
1444 | |
|
|
1445 | sub _freetls { |
|
|
1446 | my ($self) = @_; |
|
|
1447 | |
|
|
1448 | return unless $self->{tls}; |
|
|
1449 | |
989 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
1450 | Net::SSLeay::free (delete $self->{tls}); |
990 | |
1451 | |
991 | delete $self->{_rbio}; |
1452 | delete @$self{qw(_rbio _wbio _tls_wbuf)}; |
992 | delete $self->{_wbio}; |
|
|
993 | delete $self->{_tls_wbuf}; |
|
|
994 | delete $self->{filter_r}; |
|
|
995 | delete $self->{filter_w}; |
|
|
996 | } |
1453 | } |
997 | |
1454 | |
998 | sub DESTROY { |
1455 | sub DESTROY { |
999 | my $self = shift; |
1456 | my $self = shift; |
1000 | |
1457 | |
1001 | $self->stoptls; |
1458 | &_freetls; |
|
|
1459 | |
|
|
1460 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
|
|
1461 | |
|
|
1462 | if ($linger && length $self->{wbuf}) { |
|
|
1463 | my $fh = delete $self->{fh}; |
|
|
1464 | my $wbuf = delete $self->{wbuf}; |
|
|
1465 | |
|
|
1466 | my @linger; |
|
|
1467 | |
|
|
1468 | push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { |
|
|
1469 | my $len = syswrite $fh, $wbuf, length $wbuf; |
|
|
1470 | |
|
|
1471 | if ($len > 0) { |
|
|
1472 | substr $wbuf, 0, $len, ""; |
|
|
1473 | } else { |
|
|
1474 | @linger = (); # end |
|
|
1475 | } |
|
|
1476 | }); |
|
|
1477 | push @linger, AnyEvent->timer (after => $linger, cb => sub { |
|
|
1478 | @linger = (); |
|
|
1479 | }); |
|
|
1480 | } |
1002 | } |
1481 | } |
1003 | |
1482 | |
1004 | =item AnyEvent::Handle::TLS_CTX |
1483 | =item AnyEvent::Handle::TLS_CTX |
1005 | |
1484 | |
1006 | This function creates and returns the Net::SSLeay::CTX object used by |
1485 | This function creates and returns the Net::SSLeay::CTX object used by |
… | |
… | |
1036 | } |
1515 | } |
1037 | } |
1516 | } |
1038 | |
1517 | |
1039 | =back |
1518 | =back |
1040 | |
1519 | |
|
|
1520 | |
|
|
1521 | =head1 NONFREQUENTLY ASKED QUESTIONS |
|
|
1522 | |
|
|
1523 | =over 4 |
|
|
1524 | |
|
|
1525 | =item How do I read data until the other side closes the connection? |
|
|
1526 | |
|
|
1527 | If you just want to read your data into a perl scalar, the easiest way |
|
|
1528 | to achieve this is by setting an C<on_read> callback that does nothing, |
|
|
1529 | clearing the C<on_eof> callback and in the C<on_error> callback, the data |
|
|
1530 | will be in C<$_[0]{rbuf}>: |
|
|
1531 | |
|
|
1532 | $handle->on_read (sub { }); |
|
|
1533 | $handle->on_eof (undef); |
|
|
1534 | $handle->on_error (sub { |
|
|
1535 | my $data = delete $_[0]{rbuf}; |
|
|
1536 | undef $handle; |
|
|
1537 | }); |
|
|
1538 | |
|
|
1539 | The reason to use C<on_error> is that TCP connections, due to latencies |
|
|
1540 | and packets loss, might get closed quite violently with an error, when in |
|
|
1541 | fact, all data has been received. |
|
|
1542 | |
|
|
1543 | It is usually better to use acknowledgements when transfering data, |
|
|
1544 | to make sure the other side hasn't just died and you got the data |
|
|
1545 | intact. This is also one reason why so many internet protocols have an |
|
|
1546 | explicit QUIT command. |
|
|
1547 | |
|
|
1548 | |
|
|
1549 | =item I don't want to destroy the handle too early - how do I wait until |
|
|
1550 | all data has been written? |
|
|
1551 | |
|
|
1552 | After writing your last bits of data, set the C<on_drain> callback |
|
|
1553 | and destroy the handle in there - with the default setting of |
|
|
1554 | C<low_water_mark> this will be called precisely when all data has been |
|
|
1555 | written to the socket: |
|
|
1556 | |
|
|
1557 | $handle->push_write (...); |
|
|
1558 | $handle->on_drain (sub { |
|
|
1559 | warn "all data submitted to the kernel\n"; |
|
|
1560 | undef $handle; |
|
|
1561 | }); |
|
|
1562 | |
|
|
1563 | =back |
|
|
1564 | |
|
|
1565 | |
1041 | =head1 SUBCLASSING AnyEvent::Handle |
1566 | =head1 SUBCLASSING AnyEvent::Handle |
1042 | |
1567 | |
1043 | In many cases, you might want to subclass AnyEvent::Handle. |
1568 | In many cases, you might want to subclass AnyEvent::Handle. |
1044 | |
1569 | |
1045 | To make this easier, a given version of AnyEvent::Handle uses these |
1570 | To make this easier, a given version of AnyEvent::Handle uses these |
… | |
… | |
1048 | =over 4 |
1573 | =over 4 |
1049 | |
1574 | |
1050 | =item * all constructor arguments become object members. |
1575 | =item * all constructor arguments become object members. |
1051 | |
1576 | |
1052 | At least initially, when you pass a C<tls>-argument to the constructor it |
1577 | At least initially, when you pass a C<tls>-argument to the constructor it |
1053 | will end up in C<< $handle->{tls} >>. Those members might be changes or |
1578 | will end up in C<< $handle->{tls} >>. Those members might be changed or |
1054 | mutated later on (for example C<tls> will hold the TLS connection object). |
1579 | mutated later on (for example C<tls> will hold the TLS connection object). |
1055 | |
1580 | |
1056 | =item * other object member names are prefixed with an C<_>. |
1581 | =item * other object member names are prefixed with an C<_>. |
1057 | |
1582 | |
1058 | All object members not explicitly documented (internal use) are prefixed |
1583 | All object members not explicitly documented (internal use) are prefixed |