1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
3 | AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | use AnyEvent; |
7 | use AnyEvent; |
8 | use AnyEvent::Handle; |
8 | use AnyEvent::Handle; |
… | |
… | |
14 | on_error => sub { |
14 | on_error => sub { |
15 | my ($hdl, $fatal, $msg) = @_; |
15 | my ($hdl, $fatal, $msg) = @_; |
16 | warn "got error $msg\n"; |
16 | warn "got error $msg\n"; |
17 | $hdl->destroy; |
17 | $hdl->destroy; |
18 | $cv->send; |
18 | $cv->send; |
19 | ); |
19 | }; |
20 | |
20 | |
21 | # send some request line |
21 | # send some request line |
22 | $hdl->push_write ("getinfo\015\012"); |
22 | $hdl->push_write ("getinfo\015\012"); |
23 | |
23 | |
24 | # read the response line |
24 | # read the response line |
… | |
… | |
30 | |
30 | |
31 | $cv->recv; |
31 | $cv->recv; |
32 | |
32 | |
33 | =head1 DESCRIPTION |
33 | =head1 DESCRIPTION |
34 | |
34 | |
35 | This module is a helper module to make it easier to do event-based I/O on |
35 | This is a helper module to make it easier to do event-based I/O on |
36 | filehandles. |
36 | stream-based filehandles (sockets, pipes, and other stream things). |
37 | |
37 | |
38 | The L<AnyEvent::Intro> tutorial contains some well-documented |
38 | The L<AnyEvent::Intro> tutorial contains some well-documented |
39 | AnyEvent::Handle examples. |
39 | AnyEvent::Handle examples. |
40 | |
40 | |
41 | In the following, when the documentation refers to of "bytes" then this |
41 | In the following, where the documentation refers to "bytes", it means |
42 | means characters. As sysread and syswrite are used for all I/O, their |
42 | characters. As sysread and syswrite are used for all I/O, their |
43 | treatment of characters applies to this module as well. |
43 | treatment of characters applies to this module as well. |
44 | |
44 | |
45 | At the very minimum, you should specify C<fh> or C<connect>, and the |
45 | At the very minimum, you should specify C<fh> or C<connect>, and the |
46 | C<on_error> callback. |
46 | C<on_error> callback. |
47 | |
47 | |
… | |
… | |
60 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
60 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
61 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
61 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
62 | |
62 | |
63 | our $VERSION = $AnyEvent::VERSION; |
63 | our $VERSION = $AnyEvent::VERSION; |
64 | |
64 | |
|
|
65 | sub _load_func($) { |
|
|
66 | my $func = $_[0]; |
|
|
67 | |
|
|
68 | unless (defined &$func) { |
|
|
69 | my $pkg = $func; |
|
|
70 | do { |
|
|
71 | $pkg =~ s/::[^:]+$// |
|
|
72 | or return; |
|
|
73 | eval "require $pkg"; |
|
|
74 | } until defined &$func; |
|
|
75 | } |
|
|
76 | |
|
|
77 | \&$func |
|
|
78 | } |
|
|
79 | |
|
|
80 | sub MAX_READ_SIZE() { 131072 } |
|
|
81 | |
65 | =head1 METHODS |
82 | =head1 METHODS |
66 | |
83 | |
67 | =over 4 |
84 | =over 4 |
68 | |
85 | |
69 | =item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value... |
86 | =item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value... |
70 | |
87 | |
71 | The constructor supports these arguments (all as C<< key => value >> pairs). |
88 | The constructor supports these arguments (all as C<< key => value >> pairs). |
72 | |
89 | |
73 | =over 4 |
90 | =over 4 |
74 | |
91 | |
… | |
… | |
103 | prepare the file handle with parameters required for the actual connect |
120 | prepare the file handle with parameters required for the actual connect |
104 | (as opposed to settings that can be changed when the connection is already |
121 | (as opposed to settings that can be changed when the connection is already |
105 | established). |
122 | established). |
106 | |
123 | |
107 | The return value of this callback should be the connect timeout value in |
124 | The return value of this callback should be the connect timeout value in |
108 | seconds (or C<0>, or C<undef>, or the empty list, to indicate the default |
125 | seconds (or C<0>, or C<undef>, or the empty list, to indicate that the |
109 | timeout is to be used). |
126 | default timeout is to be used). |
110 | |
127 | |
111 | =item on_connect => $cb->($handle, $host, $port, $retry->()) |
128 | =item on_connect => $cb->($handle, $host, $port, $retry->()) |
112 | |
129 | |
113 | This callback is called when a connection has been successfully established. |
130 | This callback is called when a connection has been successfully established. |
114 | |
131 | |
115 | The actual numeric host and port (the socket peername) are passed as |
132 | The peer's numeric host and port (the socket peername) are passed as |
116 | parameters, together with a retry callback. |
133 | parameters, together with a retry callback. |
117 | |
134 | |
118 | When, for some reason, the handle is not acceptable, then calling |
135 | If, for some reason, the handle is not acceptable, calling C<$retry> |
119 | C<$retry> will continue with the next conenction target (in case of |
136 | will continue with the next connection target (in case of multi-homed |
120 | multi-homed hosts or SRV records there can be multiple connection |
137 | hosts or SRV records there can be multiple connection endpoints). At the |
121 | endpoints). When it is called then the read and write queues, eof status, |
138 | time it is called the read and write queues, eof status, tls status and |
122 | tls status and similar properties of the handle are being reset. |
139 | similar properties of the handle will have been reset. |
123 | |
140 | |
124 | In most cases, ignoring the C<$retry> parameter is the way to go. |
141 | In most cases, you should ignore the C<$retry> parameter. |
125 | |
142 | |
126 | =item on_connect_error => $cb->($handle, $message) |
143 | =item on_connect_error => $cb->($handle, $message) |
127 | |
144 | |
128 | This callback is called when the conenction could not be |
145 | This callback is called when the connection could not be |
129 | established. C<$!> will contain the relevant error code, and C<$message> a |
146 | established. C<$!> will contain the relevant error code, and C<$message> a |
130 | message describing it (usually the same as C<"$!">). |
147 | message describing it (usually the same as C<"$!">). |
131 | |
148 | |
132 | If this callback isn't specified, then C<on_error> will be called with a |
149 | If this callback isn't specified, then C<on_error> will be called with a |
133 | fatal error instead. |
150 | fatal error instead. |
… | |
… | |
136 | |
153 | |
137 | =item on_error => $cb->($handle, $fatal, $message) |
154 | =item on_error => $cb->($handle, $fatal, $message) |
138 | |
155 | |
139 | This is the error callback, which is called when, well, some error |
156 | This is the error callback, which is called when, well, some error |
140 | occured, such as not being able to resolve the hostname, failure to |
157 | occured, such as not being able to resolve the hostname, failure to |
141 | connect or a read error. |
158 | connect, or a read error. |
142 | |
159 | |
143 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
160 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
144 | fatal errors the handle object will be destroyed (by a call to C<< -> |
161 | fatal errors the handle object will be destroyed (by a call to C<< -> |
145 | destroy >>) after invoking the error callback (which means you are free to |
162 | destroy >>) after invoking the error callback (which means you are free to |
146 | examine the handle object). Examples of fatal errors are an EOF condition |
163 | examine the handle object). Examples of fatal errors are an EOF condition |
147 | with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In |
164 | with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In |
148 | cases where the other side can close the connection at their will it is |
165 | cases where the other side can close the connection at will, it is |
149 | often easiest to not report C<EPIPE> errors in this callback. |
166 | often easiest to not report C<EPIPE> errors in this callback. |
150 | |
167 | |
151 | AnyEvent::Handle tries to find an appropriate error code for you to check |
168 | AnyEvent::Handle tries to find an appropriate error code for you to check |
152 | against, but in some cases (TLS errors), this does not work well. It is |
169 | against, but in some cases (TLS errors), this does not work well. It is |
153 | recommended to always output the C<$message> argument in human-readable |
170 | recommended to always output the C<$message> argument in human-readable |
154 | error messages (it's usually the same as C<"$!">). |
171 | error messages (it's usually the same as C<"$!">). |
155 | |
172 | |
156 | Non-fatal errors can be retried by simply returning, but it is recommended |
173 | Non-fatal errors can be retried by returning, but it is recommended |
157 | to simply ignore this parameter and instead abondon the handle object |
174 | to simply ignore this parameter and instead abondon the handle object |
158 | when this callback is invoked. Examples of non-fatal errors are timeouts |
175 | when this callback is invoked. Examples of non-fatal errors are timeouts |
159 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
176 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
160 | |
177 | |
161 | On callback entrance, the value of C<$!> contains the operating system |
178 | On entry to the callback, the value of C<$!> contains the operating |
162 | error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or |
179 | system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or |
163 | C<EPROTO>). |
180 | C<EPROTO>). |
164 | |
181 | |
165 | While not mandatory, it is I<highly> recommended to set this callback, as |
182 | While not mandatory, it is I<highly> recommended to set this callback, as |
166 | you will not be notified of errors otherwise. The default simply calls |
183 | you will not be notified of errors otherwise. The default just calls |
167 | C<croak>. |
184 | C<croak>. |
168 | |
185 | |
169 | =item on_read => $cb->($handle) |
186 | =item on_read => $cb->($handle) |
170 | |
187 | |
171 | This sets the default read callback, which is called when data arrives |
188 | This sets the default read callback, which is called when data arrives |
… | |
… | |
176 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
193 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
177 | method or access the C<< $handle->{rbuf} >> member directly. Note that you |
194 | method or access the C<< $handle->{rbuf} >> member directly. Note that you |
178 | must not enlarge or modify the read buffer, you can only remove data at |
195 | must not enlarge or modify the read buffer, you can only remove data at |
179 | the beginning from it. |
196 | the beginning from it. |
180 | |
197 | |
|
|
198 | You can also call C<< ->push_read (...) >> or any other function that |
|
|
199 | modifies the read queue. Or do both. Or ... |
|
|
200 | |
181 | When an EOF condition is detected then AnyEvent::Handle will first try to |
201 | When an EOF condition is detected, AnyEvent::Handle will first try to |
182 | feed all the remaining data to the queued callbacks and C<on_read> before |
202 | feed all the remaining data to the queued callbacks and C<on_read> before |
183 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
203 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
184 | error will be raised (with C<$!> set to C<EPIPE>). |
204 | error will be raised (with C<$!> set to C<EPIPE>). |
185 | |
205 | |
186 | Note that, unlike requests in the read queue, an C<on_read> callback |
206 | Note that, unlike requests in the read queue, an C<on_read> callback |
… | |
… | |
205 | set, then a fatal error will be raised with C<$!> set to <0>. |
225 | set, then a fatal error will be raised with C<$!> set to <0>. |
206 | |
226 | |
207 | =item on_drain => $cb->($handle) |
227 | =item on_drain => $cb->($handle) |
208 | |
228 | |
209 | This sets the callback that is called when the write buffer becomes empty |
229 | This sets the callback that is called when the write buffer becomes empty |
210 | (or when the callback is set and the buffer is empty already). |
230 | (or immediately if the buffer is empty already). |
211 | |
231 | |
212 | To append to the write buffer, use the C<< ->push_write >> method. |
232 | To append to the write buffer, use the C<< ->push_write >> method. |
213 | |
233 | |
214 | This callback is useful when you don't want to put all of your write data |
234 | This callback is useful when you don't want to put all of your write data |
215 | into the queue at once, for example, when you want to write the contents |
235 | into the queue at once, for example, when you want to write the contents |
… | |
… | |
227 | many seconds pass without a successful read or write on the underlying |
247 | many seconds pass without a successful read or write on the underlying |
228 | file handle (or a call to C<timeout_reset>), the C<on_timeout> callback |
248 | file handle (or a call to C<timeout_reset>), the C<on_timeout> callback |
229 | will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT> |
249 | will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT> |
230 | error will be raised). |
250 | error will be raised). |
231 | |
251 | |
232 | There are three variants of the timeouts that work fully independent |
252 | There are three variants of the timeouts that work independently |
233 | of each other, for both read and write, just read, and just write: |
253 | of each other, for both read and write, just read, and just write: |
234 | C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks |
254 | C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks |
235 | C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions |
255 | C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions |
236 | C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. |
256 | C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. |
237 | |
257 | |
238 | Note that timeout processing is also active when you currently do not have |
258 | Note that timeout processing is active even when you do not have |
239 | any outstanding read or write requests: If you plan to keep the connection |
259 | any outstanding read or write requests: If you plan to keep the connection |
240 | idle then you should disable the timout temporarily or ignore the timeout |
260 | idle then you should disable the timeout temporarily or ignore the timeout |
241 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
261 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
242 | restart the timeout. |
262 | restart the timeout. |
243 | |
263 | |
244 | Zero (the default) disables this timeout. |
264 | Zero (the default) disables this timeout. |
245 | |
265 | |
… | |
… | |
261 | amount of data without a callback ever being called as long as the line |
281 | amount of data without a callback ever being called as long as the line |
262 | isn't finished). |
282 | isn't finished). |
263 | |
283 | |
264 | =item autocork => <boolean> |
284 | =item autocork => <boolean> |
265 | |
285 | |
266 | When disabled (the default), then C<push_write> will try to immediately |
286 | When disabled (the default), C<push_write> will try to immediately |
267 | write the data to the handle, if possible. This avoids having to register |
287 | write the data to the handle if possible. This avoids having to register |
268 | a write watcher and wait for the next event loop iteration, but can |
288 | a write watcher and wait for the next event loop iteration, but can |
269 | be inefficient if you write multiple small chunks (on the wire, this |
289 | be inefficient if you write multiple small chunks (on the wire, this |
270 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
290 | disadvantage is usually avoided by your kernel's nagle algorithm, see |
271 | C<no_delay>, but this option can save costly syscalls). |
291 | C<no_delay>, but this option can save costly syscalls). |
272 | |
292 | |
273 | When enabled, then writes will always be queued till the next event loop |
293 | When enabled, writes will always be queued till the next event loop |
274 | iteration. This is efficient when you do many small writes per iteration, |
294 | iteration. This is efficient when you do many small writes per iteration, |
275 | but less efficient when you do a single write only per iteration (or when |
295 | but less efficient when you do a single write only per iteration (or when |
276 | the write buffer often is full). It also increases write latency. |
296 | the write buffer often is full). It also increases write latency. |
277 | |
297 | |
278 | =item no_delay => <boolean> |
298 | =item no_delay => <boolean> |
… | |
… | |
282 | the Nagle algorithm, and usually it is beneficial. |
302 | the Nagle algorithm, and usually it is beneficial. |
283 | |
303 | |
284 | In some situations you want as low a delay as possible, which can be |
304 | In some situations you want as low a delay as possible, which can be |
285 | accomplishd by setting this option to a true value. |
305 | accomplishd by setting this option to a true value. |
286 | |
306 | |
287 | The default is your opertaing system's default behaviour (most likely |
307 | The default is your operating system's default behaviour (most likely |
288 | enabled), this option explicitly enables or disables it, if possible. |
308 | enabled). This option explicitly enables or disables it, if possible. |
|
|
309 | |
|
|
310 | =item keepalive => <boolean> |
|
|
311 | |
|
|
312 | Enables (default disable) the SO_KEEPALIVE option on the stream socket: |
|
|
313 | normally, TCP connections have no time-out once established, so TCP |
|
|
314 | connections, once established, can stay alive forever even when the other |
|
|
315 | side has long gone. TCP keepalives are a cheap way to take down long-lived |
|
|
316 | TCP connections when the other side becomes unreachable. While the default |
|
|
317 | is OS-dependent, TCP keepalives usually kick in after around two hours, |
|
|
318 | and, if the other side doesn't reply, take down the TCP connection some 10 |
|
|
319 | to 15 minutes later. |
|
|
320 | |
|
|
321 | It is harmless to specify this option for file handles that do not support |
|
|
322 | keepalives, and enabling it on connections that are potentially long-lived |
|
|
323 | is usually a good idea. |
|
|
324 | |
|
|
325 | =item oobinline => <boolean> |
|
|
326 | |
|
|
327 | BSD majorly fucked up the implementation of TCP urgent data. The result |
|
|
328 | is that almost no OS implements TCP according to the specs, and every OS |
|
|
329 | implements it slightly differently. |
|
|
330 | |
|
|
331 | If you want to handle TCP urgent data, then setting this flag (the default |
|
|
332 | is enabled) gives you the most portable way of getting urgent data, by |
|
|
333 | putting it into the stream. |
|
|
334 | |
|
|
335 | Since BSD emulation of OOB data on top of TCP's urgent data can have |
|
|
336 | security implications, AnyEvent::Handle sets this flag automatically |
|
|
337 | unless explicitly specified. Note that setting this flag after |
|
|
338 | establishing a connection I<may> be a bit too late (data loss could |
|
|
339 | already have occured on BSD systems), but at least it will protect you |
|
|
340 | from most attacks. |
289 | |
341 | |
290 | =item read_size => <bytes> |
342 | =item read_size => <bytes> |
291 | |
343 | |
292 | The default read block size (the amount of bytes this module will |
344 | The initial read block size, the number of bytes this module will try to |
293 | try to read during each loop iteration, which affects memory |
345 | read during each loop iteration. Each handle object will consume at least |
294 | requirements). Default: C<8192>. |
346 | this amount of memory for the read buffer as well, so when handling many |
|
|
347 | connections requirements). See also C<max_read_size>. Default: C<2048>. |
|
|
348 | |
|
|
349 | =item max_read_size => <bytes> |
|
|
350 | |
|
|
351 | The maximum read buffer size used by the dynamic adjustment |
|
|
352 | algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in |
|
|
353 | one go it will double C<read_size> up to the maximum given by this |
|
|
354 | option. Default: C<131072> or C<read_size>, whichever is higher. |
295 | |
355 | |
296 | =item low_water_mark => <bytes> |
356 | =item low_water_mark => <bytes> |
297 | |
357 | |
298 | Sets the amount of bytes (default: C<0>) that make up an "empty" write |
358 | Sets the number of bytes (default: C<0>) that make up an "empty" write |
299 | buffer: If the write reaches this size or gets even samller it is |
359 | buffer: If the buffer reaches this size or gets even samller it is |
300 | considered empty. |
360 | considered empty. |
301 | |
361 | |
302 | Sometimes it can be beneficial (for performance reasons) to add data to |
362 | Sometimes it can be beneficial (for performance reasons) to add data to |
303 | the write buffer before it is fully drained, but this is a rare case, as |
363 | the write buffer before it is fully drained, but this is a rare case, as |
304 | the operating system kernel usually buffers data as well, so the default |
364 | the operating system kernel usually buffers data as well, so the default |
305 | is good in almost all cases. |
365 | is good in almost all cases. |
306 | |
366 | |
307 | =item linger => <seconds> |
367 | =item linger => <seconds> |
308 | |
368 | |
309 | If non-zero (default: C<3600>), then the destructor of the |
369 | If this is non-zero (default: C<3600>), the destructor of the |
310 | AnyEvent::Handle object will check whether there is still outstanding |
370 | AnyEvent::Handle object will check whether there is still outstanding |
311 | write data and will install a watcher that will write this data to the |
371 | write data and will install a watcher that will write this data to the |
312 | socket. No errors will be reported (this mostly matches how the operating |
372 | socket. No errors will be reported (this mostly matches how the operating |
313 | system treats outstanding data at socket close time). |
373 | system treats outstanding data at socket close time). |
314 | |
374 | |
… | |
… | |
321 | A string used to identify the remote site - usually the DNS hostname |
381 | A string used to identify the remote site - usually the DNS hostname |
322 | (I<not> IDN!) used to create the connection, rarely the IP address. |
382 | (I<not> IDN!) used to create the connection, rarely the IP address. |
323 | |
383 | |
324 | Apart from being useful in error messages, this string is also used in TLS |
384 | Apart from being useful in error messages, this string is also used in TLS |
325 | peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This |
385 | peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This |
326 | verification will be skipped when C<peername> is not specified or |
386 | verification will be skipped when C<peername> is not specified or is |
327 | C<undef>. |
387 | C<undef>. |
328 | |
388 | |
329 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
389 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
330 | |
390 | |
331 | When this parameter is given, it enables TLS (SSL) mode, that means |
391 | When this parameter is given, it enables TLS (SSL) mode, that means |
332 | AnyEvent will start a TLS handshake as soon as the conenction has been |
392 | AnyEvent will start a TLS handshake as soon as the connection has been |
333 | established and will transparently encrypt/decrypt data afterwards. |
393 | established and will transparently encrypt/decrypt data afterwards. |
334 | |
394 | |
335 | All TLS protocol errors will be signalled as C<EPROTO>, with an |
395 | All TLS protocol errors will be signalled as C<EPROTO>, with an |
336 | appropriate error message. |
396 | appropriate error message. |
337 | |
397 | |
… | |
… | |
357 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
417 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
358 | passing in the wrong integer will lead to certain crash. This most often |
418 | passing in the wrong integer will lead to certain crash. This most often |
359 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
419 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
360 | segmentation fault. |
420 | segmentation fault. |
361 | |
421 | |
362 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
422 | Use the C<< ->starttls >> method if you need to start TLS negotiation later. |
363 | |
423 | |
364 | =item tls_ctx => $anyevent_tls |
424 | =item tls_ctx => $anyevent_tls |
365 | |
425 | |
366 | Use the given C<AnyEvent::TLS> object to create the new TLS connection |
426 | Use the given C<AnyEvent::TLS> object to create the new TLS connection |
367 | (unless a connection object was specified directly). If this parameter is |
427 | (unless a connection object was specified directly). If this |
368 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
428 | parameter is missing (or C<undef>), then AnyEvent::Handle will use |
|
|
429 | C<AnyEvent::Handle::TLS_CTX>. |
369 | |
430 | |
370 | Instead of an object, you can also specify a hash reference with C<< key |
431 | Instead of an object, you can also specify a hash reference with C<< key |
371 | => value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a |
432 | => value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a |
372 | new TLS context object. |
433 | new TLS context object. |
373 | |
434 | |
… | |
… | |
382 | |
443 | |
383 | TLS handshake failures will not cause C<on_error> to be invoked when this |
444 | TLS handshake failures will not cause C<on_error> to be invoked when this |
384 | callback is in effect, instead, the error message will be passed to C<on_starttls>. |
445 | callback is in effect, instead, the error message will be passed to C<on_starttls>. |
385 | |
446 | |
386 | Without this callback, handshake failures lead to C<on_error> being |
447 | Without this callback, handshake failures lead to C<on_error> being |
387 | called, as normal. |
448 | called as usual. |
388 | |
449 | |
389 | Note that you cannot call C<starttls> right again in this callback. If you |
450 | Note that you cannot just call C<starttls> again in this callback. If you |
390 | need to do that, start an zero-second timer instead whose callback can |
451 | need to do that, start an zero-second timer instead whose callback can |
391 | then call C<< ->starttls >> again. |
452 | then call C<< ->starttls >> again. |
392 | |
453 | |
393 | =item on_stoptls => $cb->($handle) |
454 | =item on_stoptls => $cb->($handle) |
394 | |
455 | |
… | |
… | |
441 | AnyEvent::Socket::tcp_connect ( |
502 | AnyEvent::Socket::tcp_connect ( |
442 | $self->{connect}[0], |
503 | $self->{connect}[0], |
443 | $self->{connect}[1], |
504 | $self->{connect}[1], |
444 | sub { |
505 | sub { |
445 | my ($fh, $host, $port, $retry) = @_; |
506 | my ($fh, $host, $port, $retry) = @_; |
|
|
507 | |
|
|
508 | delete $self->{_connect}; # no longer needed |
446 | |
509 | |
447 | if ($fh) { |
510 | if ($fh) { |
448 | $self->{fh} = $fh; |
511 | $self->{fh} = $fh; |
449 | |
512 | |
450 | delete $self->{_skip_drain_rbuf}; |
513 | delete $self->{_skip_drain_rbuf}; |
… | |
… | |
484 | } |
547 | } |
485 | |
548 | |
486 | sub _start { |
549 | sub _start { |
487 | my ($self) = @_; |
550 | my ($self) = @_; |
488 | |
551 | |
|
|
552 | # too many clueless people try to use udp and similar sockets |
|
|
553 | # with AnyEvent::Handle, do them a favour. |
|
|
554 | my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE (); |
|
|
555 | Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!" |
|
|
556 | if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type; |
|
|
557 | |
489 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
558 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
490 | |
559 | |
491 | $self->{_activity} = |
560 | $self->{_activity} = |
492 | $self->{_ractivity} = |
561 | $self->{_ractivity} = |
493 | $self->{_wactivity} = AE::now; |
562 | $self->{_wactivity} = AE::now; |
494 | |
563 | |
|
|
564 | $self->{read_size} ||= 2048; |
|
|
565 | $self->{max_read_size} = $self->{read_size} |
|
|
566 | if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE); |
|
|
567 | |
495 | $self->timeout (delete $self->{timeout} ) if $self->{timeout}; |
568 | $self->timeout (delete $self->{timeout} ) if $self->{timeout}; |
496 | $self->rtimeout (delete $self->{rtimeout}) if $self->{rtimeout}; |
569 | $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout}; |
497 | $self->wtimeout (delete $self->{wtimeout}) if $self->{wtimeout}; |
570 | $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout}; |
498 | |
571 | |
499 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
572 | $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay}; |
|
|
573 | $self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive}; |
500 | |
574 | |
|
|
575 | $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1); |
|
|
576 | |
501 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
577 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
502 | if $self->{tls}; |
578 | if $self->{tls}; |
503 | |
579 | |
504 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
580 | $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain}; |
505 | |
581 | |
506 | $self->start_read |
582 | $self->start_read |
507 | if $self->{on_read} || @{ $self->{_queue} }; |
583 | if $self->{on_read} || @{ $self->{_queue} }; |
508 | |
584 | |
509 | $self->_drain_wbuf; |
585 | $self->_drain_wbuf; |
… | |
… | |
516 | $message ||= "$!"; |
592 | $message ||= "$!"; |
517 | |
593 | |
518 | if ($self->{on_error}) { |
594 | if ($self->{on_error}) { |
519 | $self->{on_error}($self, $fatal, $message); |
595 | $self->{on_error}($self, $fatal, $message); |
520 | $self->destroy if $fatal; |
596 | $self->destroy if $fatal; |
521 | } elsif ($self->{fh}) { |
597 | } elsif ($self->{fh} || $self->{connect}) { |
522 | $self->destroy; |
598 | $self->destroy; |
523 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
599 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
524 | } |
600 | } |
525 | } |
601 | } |
526 | |
602 | |
… | |
… | |
585 | =cut |
661 | =cut |
586 | |
662 | |
587 | sub no_delay { |
663 | sub no_delay { |
588 | $_[0]{no_delay} = $_[1]; |
664 | $_[0]{no_delay} = $_[1]; |
589 | |
665 | |
|
|
666 | setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1] |
|
|
667 | if $_[0]{fh}; |
|
|
668 | } |
|
|
669 | |
|
|
670 | =item $handle->keepalive ($boolean) |
|
|
671 | |
|
|
672 | Enables or disables the C<keepalive> setting (see constructor argument of |
|
|
673 | the same name for details). |
|
|
674 | |
|
|
675 | =cut |
|
|
676 | |
|
|
677 | sub keepalive { |
|
|
678 | $_[0]{keepalive} = $_[1]; |
|
|
679 | |
590 | eval { |
680 | eval { |
591 | local $SIG{__DIE__}; |
681 | local $SIG{__DIE__}; |
592 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1] |
682 | setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1] |
593 | if $_[0]{fh}; |
683 | if $_[0]{fh}; |
594 | }; |
684 | }; |
595 | } |
685 | } |
596 | |
686 | |
|
|
687 | =item $handle->oobinline ($boolean) |
|
|
688 | |
|
|
689 | Enables or disables the C<oobinline> setting (see constructor argument of |
|
|
690 | the same name for details). |
|
|
691 | |
|
|
692 | =cut |
|
|
693 | |
|
|
694 | sub oobinline { |
|
|
695 | $_[0]{oobinline} = $_[1]; |
|
|
696 | |
|
|
697 | eval { |
|
|
698 | local $SIG{__DIE__}; |
|
|
699 | setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1] |
|
|
700 | if $_[0]{fh}; |
|
|
701 | }; |
|
|
702 | } |
|
|
703 | |
|
|
704 | =item $handle->keepalive ($boolean) |
|
|
705 | |
|
|
706 | Enables or disables the C<keepalive> setting (see constructor argument of |
|
|
707 | the same name for details). |
|
|
708 | |
|
|
709 | =cut |
|
|
710 | |
|
|
711 | sub keepalive { |
|
|
712 | $_[0]{keepalive} = $_[1]; |
|
|
713 | |
|
|
714 | eval { |
|
|
715 | local $SIG{__DIE__}; |
|
|
716 | setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1] |
|
|
717 | if $_[0]{fh}; |
|
|
718 | }; |
|
|
719 | } |
|
|
720 | |
597 | =item $handle->on_starttls ($cb) |
721 | =item $handle->on_starttls ($cb) |
598 | |
722 | |
599 | Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument). |
723 | Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument). |
600 | |
724 | |
601 | =cut |
725 | =cut |
… | |
… | |
608 | |
732 | |
609 | Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). |
733 | Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). |
610 | |
734 | |
611 | =cut |
735 | =cut |
612 | |
736 | |
613 | sub on_starttls { |
737 | sub on_stoptls { |
614 | $_[0]{on_stoptls} = $_[1]; |
738 | $_[0]{on_stoptls} = $_[1]; |
615 | } |
739 | } |
616 | |
740 | |
617 | =item $handle->rbuf_max ($max_octets) |
741 | =item $handle->rbuf_max ($max_octets) |
618 | |
742 | |
… | |
… | |
657 | $_[0]{$on_timeout} = $_[1]; |
781 | $_[0]{$on_timeout} = $_[1]; |
658 | }; |
782 | }; |
659 | |
783 | |
660 | *$timeout = sub { |
784 | *$timeout = sub { |
661 | my ($self, $new_value) = @_; |
785 | my ($self, $new_value) = @_; |
|
|
786 | |
|
|
787 | $new_value >= 0 |
|
|
788 | or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught"; |
662 | |
789 | |
663 | $self->{$timeout} = $new_value; |
790 | $self->{$timeout} = $new_value; |
664 | delete $self->{$tw}; &$cb; |
791 | delete $self->{$tw}; &$cb; |
665 | }; |
792 | }; |
666 | |
793 | |
… | |
… | |
730 | =item $handle->on_drain ($cb) |
857 | =item $handle->on_drain ($cb) |
731 | |
858 | |
732 | Sets the C<on_drain> callback or clears it (see the description of |
859 | Sets the C<on_drain> callback or clears it (see the description of |
733 | C<on_drain> in the constructor). |
860 | C<on_drain> in the constructor). |
734 | |
861 | |
|
|
862 | This method may invoke callbacks (and therefore the handle might be |
|
|
863 | destroyed after it returns). |
|
|
864 | |
735 | =cut |
865 | =cut |
736 | |
866 | |
737 | sub on_drain { |
867 | sub on_drain { |
738 | my ($self, $cb) = @_; |
868 | my ($self, $cb) = @_; |
739 | |
869 | |
… | |
… | |
746 | =item $handle->push_write ($data) |
876 | =item $handle->push_write ($data) |
747 | |
877 | |
748 | Queues the given scalar to be written. You can push as much data as you |
878 | Queues the given scalar to be written. You can push as much data as you |
749 | want (only limited by the available memory), as C<AnyEvent::Handle> |
879 | want (only limited by the available memory), as C<AnyEvent::Handle> |
750 | buffers it independently of the kernel. |
880 | buffers it independently of the kernel. |
|
|
881 | |
|
|
882 | This method may invoke callbacks (and therefore the handle might be |
|
|
883 | destroyed after it returns). |
751 | |
884 | |
752 | =cut |
885 | =cut |
753 | |
886 | |
754 | sub _drain_wbuf { |
887 | sub _drain_wbuf { |
755 | my ($self) = @_; |
888 | my ($self) = @_; |
… | |
… | |
785 | }; |
918 | }; |
786 | } |
919 | } |
787 | |
920 | |
788 | our %WH; |
921 | our %WH; |
789 | |
922 | |
|
|
923 | # deprecated |
790 | sub register_write_type($$) { |
924 | sub register_write_type($$) { |
791 | $WH{$_[0]} = $_[1]; |
925 | $WH{$_[0]} = $_[1]; |
792 | } |
926 | } |
793 | |
927 | |
794 | sub push_write { |
928 | sub push_write { |
795 | my $self = shift; |
929 | my $self = shift; |
796 | |
930 | |
797 | if (@_ > 1) { |
931 | if (@_ > 1) { |
798 | my $type = shift; |
932 | my $type = shift; |
799 | |
933 | |
|
|
934 | @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type" |
800 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
935 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write") |
801 | ->($self, @_); |
936 | ->($self, @_); |
802 | } |
937 | } |
803 | |
938 | |
|
|
939 | # we downgrade here to avoid hard-to-track-down bugs, |
|
|
940 | # and diagnose the problem earlier and better. |
|
|
941 | |
804 | if ($self->{tls}) { |
942 | if ($self->{tls}) { |
805 | $self->{_tls_wbuf} .= $_[0]; |
943 | utf8::downgrade $self->{_tls_wbuf} .= $_[0]; |
806 | &_dotls ($self) if $self->{fh}; |
944 | &_dotls ($self) if $self->{fh}; |
807 | } else { |
945 | } else { |
808 | $self->{wbuf} .= $_[0]; |
946 | utf8::downgrade $self->{wbuf} .= $_[0]; |
809 | $self->_drain_wbuf if $self->{fh}; |
947 | $self->_drain_wbuf if $self->{fh}; |
810 | } |
948 | } |
811 | } |
949 | } |
812 | |
950 | |
813 | =item $handle->push_write (type => @args) |
951 | =item $handle->push_write (type => @args) |
814 | |
952 | |
815 | Instead of formatting your data yourself, you can also let this module do |
953 | Instead of formatting your data yourself, you can also let this module |
816 | the job by specifying a type and type-specific arguments. |
954 | do the job by specifying a type and type-specific arguments. You |
|
|
955 | can also specify the (fully qualified) name of a package, in which |
|
|
956 | case AnyEvent tries to load the package and then expects to find the |
|
|
957 | C<anyevent_write_type> function inside (see "custom write types", below). |
817 | |
958 | |
818 | Predefined types are (if you have ideas for additional types, feel free to |
959 | Predefined types are (if you have ideas for additional types, feel free to |
819 | drop by and tell us): |
960 | drop by and tell us): |
820 | |
961 | |
821 | =over 4 |
962 | =over 4 |
… | |
… | |
924 | the peer. |
1065 | the peer. |
925 | |
1066 | |
926 | You can rely on the normal read queue and C<on_eof> handling |
1067 | You can rely on the normal read queue and C<on_eof> handling |
927 | afterwards. This is the cleanest way to close a connection. |
1068 | afterwards. This is the cleanest way to close a connection. |
928 | |
1069 | |
|
|
1070 | This method may invoke callbacks (and therefore the handle might be |
|
|
1071 | destroyed after it returns). |
|
|
1072 | |
929 | =cut |
1073 | =cut |
930 | |
1074 | |
931 | sub push_shutdown { |
1075 | sub push_shutdown { |
932 | my ($self) = @_; |
1076 | my ($self) = @_; |
933 | |
1077 | |
934 | delete $self->{low_water_mark}; |
1078 | delete $self->{low_water_mark}; |
935 | $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); |
1079 | $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); |
936 | } |
1080 | } |
937 | |
1081 | |
938 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
1082 | =item custom write types - Package::anyevent_write_type $handle, @args |
939 | |
1083 | |
940 | This function (not method) lets you add your own types to C<push_write>. |
1084 | Instead of one of the predefined types, you can also specify the name of |
|
|
1085 | a package. AnyEvent will try to load the package and then expects to find |
|
|
1086 | a function named C<anyevent_write_type> inside. If it isn't found, it |
|
|
1087 | progressively tries to load the parent package until it either finds the |
|
|
1088 | function (good) or runs out of packages (bad). |
|
|
1089 | |
941 | Whenever the given C<type> is used, C<push_write> will invoke the code |
1090 | Whenever the given C<type> is used, C<push_write> will the function with |
942 | reference with the handle object and the remaining arguments. |
1091 | the handle object and the remaining arguments. |
943 | |
1092 | |
944 | The code reference is supposed to return a single octet string that will |
1093 | The function is supposed to return a single octet string that will be |
945 | be appended to the write buffer. |
1094 | appended to the write buffer, so you cna mentally treat this function as a |
|
|
1095 | "arguments to on-the-wire-format" converter. |
946 | |
1096 | |
947 | Note that this is a function, and all types registered this way will be |
1097 | Example: implement a custom write type C<join> that joins the remaining |
948 | global, so try to use unique names. |
1098 | arguments using the first one. |
|
|
1099 | |
|
|
1100 | $handle->push_write (My::Type => " ", 1,2,3); |
|
|
1101 | |
|
|
1102 | # uses the following package, which can be defined in the "My::Type" or in |
|
|
1103 | # the "My" modules to be auto-loaded, or just about anywhere when the |
|
|
1104 | # My::Type::anyevent_write_type is defined before invoking it. |
|
|
1105 | |
|
|
1106 | package My::Type; |
|
|
1107 | |
|
|
1108 | sub anyevent_write_type { |
|
|
1109 | my ($handle, $delim, @args) = @_; |
|
|
1110 | |
|
|
1111 | join $delim, @args |
|
|
1112 | } |
949 | |
1113 | |
950 | =cut |
1114 | =cut |
951 | |
1115 | |
952 | ############################################################################# |
1116 | ############################################################################# |
953 | |
1117 | |
… | |
… | |
962 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
1126 | ways, the "simple" way, using only C<on_read> and the "complex" way, using |
963 | a queue. |
1127 | a queue. |
964 | |
1128 | |
965 | In the simple case, you just install an C<on_read> callback and whenever |
1129 | In the simple case, you just install an C<on_read> callback and whenever |
966 | new data arrives, it will be called. You can then remove some data (if |
1130 | new data arrives, it will be called. You can then remove some data (if |
967 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna |
1131 | enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can |
968 | leave the data there if you want to accumulate more (e.g. when only a |
1132 | leave the data there if you want to accumulate more (e.g. when only a |
969 | partial message has been received so far). |
1133 | partial message has been received so far), or change the read queue with |
|
|
1134 | e.g. C<push_read>. |
970 | |
1135 | |
971 | In the more complex case, you want to queue multiple callbacks. In this |
1136 | In the more complex case, you want to queue multiple callbacks. In this |
972 | case, AnyEvent::Handle will call the first queued callback each time new |
1137 | case, AnyEvent::Handle will call the first queued callback each time new |
973 | data arrives (also the first time it is queued) and removes it when it has |
1138 | data arrives (also the first time it is queued) and remove it when it has |
974 | done its job (see C<push_read>, below). |
1139 | done its job (see C<push_read>, below). |
975 | |
1140 | |
976 | This way you can, for example, push three line-reads, followed by reading |
1141 | This way you can, for example, push three line-reads, followed by reading |
977 | a chunk of data, and AnyEvent::Handle will execute them in order. |
1142 | a chunk of data, and AnyEvent::Handle will execute them in order. |
978 | |
1143 | |
… | |
… | |
1109 | |
1274 | |
1110 | This replaces the currently set C<on_read> callback, or clears it (when |
1275 | This replaces the currently set C<on_read> callback, or clears it (when |
1111 | the new callback is C<undef>). See the description of C<on_read> in the |
1276 | the new callback is C<undef>). See the description of C<on_read> in the |
1112 | constructor. |
1277 | constructor. |
1113 | |
1278 | |
|
|
1279 | This method may invoke callbacks (and therefore the handle might be |
|
|
1280 | destroyed after it returns). |
|
|
1281 | |
1114 | =cut |
1282 | =cut |
1115 | |
1283 | |
1116 | sub on_read { |
1284 | sub on_read { |
1117 | my ($self, $cb) = @_; |
1285 | my ($self, $cb) = @_; |
1118 | |
1286 | |
… | |
… | |
1120 | $self->_drain_rbuf if $cb; |
1288 | $self->_drain_rbuf if $cb; |
1121 | } |
1289 | } |
1122 | |
1290 | |
1123 | =item $handle->rbuf |
1291 | =item $handle->rbuf |
1124 | |
1292 | |
1125 | Returns the read buffer (as a modifiable lvalue). |
1293 | Returns the read buffer (as a modifiable lvalue). You can also access the |
|
|
1294 | read buffer directly as the C<< ->{rbuf} >> member, if you want (this is |
|
|
1295 | much faster, and no less clean). |
1126 | |
1296 | |
1127 | You can access the read buffer directly as the C<< ->{rbuf} >> |
1297 | The only operation allowed on the read buffer (apart from looking at it) |
1128 | member, if you want. However, the only operation allowed on the |
1298 | is removing data from its beginning. Otherwise modifying or appending to |
1129 | read buffer (apart from looking at it) is removing data from its |
1299 | it is not allowed and will lead to hard-to-track-down bugs. |
1130 | beginning. Otherwise modifying or appending to it is not allowed and will |
|
|
1131 | lead to hard-to-track-down bugs. |
|
|
1132 | |
1300 | |
1133 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
1301 | NOTE: The read buffer should only be used or modified in the C<on_read> |
1134 | C<push_read> or C<unshift_read> methods are used. The other read methods |
1302 | callback or when C<push_read> or C<unshift_read> are used with a single |
1135 | automatically manage the read buffer. |
1303 | callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods |
|
|
1304 | will manage the read buffer on their own. |
1136 | |
1305 | |
1137 | =cut |
1306 | =cut |
1138 | |
1307 | |
1139 | sub rbuf : lvalue { |
1308 | sub rbuf : lvalue { |
1140 | $_[0]{rbuf} |
1309 | $_[0]{rbuf} |
… | |
… | |
1157 | |
1326 | |
1158 | If enough data was available, then the callback must remove all data it is |
1327 | If enough data was available, then the callback must remove all data it is |
1159 | interested in (which can be none at all) and return a true value. After returning |
1328 | interested in (which can be none at all) and return a true value. After returning |
1160 | true, it will be removed from the queue. |
1329 | true, it will be removed from the queue. |
1161 | |
1330 | |
|
|
1331 | These methods may invoke callbacks (and therefore the handle might be |
|
|
1332 | destroyed after it returns). |
|
|
1333 | |
1162 | =cut |
1334 | =cut |
1163 | |
1335 | |
1164 | our %RH; |
1336 | our %RH; |
1165 | |
1337 | |
1166 | sub register_read_type($$) { |
1338 | sub register_read_type($$) { |
… | |
… | |
1172 | my $cb = pop; |
1344 | my $cb = pop; |
1173 | |
1345 | |
1174 | if (@_) { |
1346 | if (@_) { |
1175 | my $type = shift; |
1347 | my $type = shift; |
1176 | |
1348 | |
|
|
1349 | $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type" |
1177 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
1350 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read") |
1178 | ->($self, $cb, @_); |
1351 | ->($self, $cb, @_); |
1179 | } |
1352 | } |
1180 | |
1353 | |
1181 | push @{ $self->{_queue} }, $cb; |
1354 | push @{ $self->{_queue} }, $cb; |
1182 | $self->_drain_rbuf; |
1355 | $self->_drain_rbuf; |
… | |
… | |
1187 | my $cb = pop; |
1360 | my $cb = pop; |
1188 | |
1361 | |
1189 | if (@_) { |
1362 | if (@_) { |
1190 | my $type = shift; |
1363 | my $type = shift; |
1191 | |
1364 | |
|
|
1365 | $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type" |
1192 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") |
1366 | or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read") |
1193 | ->($self, $cb, @_); |
1367 | ->($self, $cb, @_); |
1194 | } |
1368 | } |
1195 | |
|
|
1196 | |
1369 | |
1197 | unshift @{ $self->{_queue} }, $cb; |
1370 | unshift @{ $self->{_queue} }, $cb; |
1198 | $self->_drain_rbuf; |
1371 | $self->_drain_rbuf; |
1199 | } |
1372 | } |
1200 | |
1373 | |
… | |
… | |
1202 | |
1375 | |
1203 | =item $handle->unshift_read (type => @args, $cb) |
1376 | =item $handle->unshift_read (type => @args, $cb) |
1204 | |
1377 | |
1205 | Instead of providing a callback that parses the data itself you can chose |
1378 | Instead of providing a callback that parses the data itself you can chose |
1206 | between a number of predefined parsing formats, for chunks of data, lines |
1379 | between a number of predefined parsing formats, for chunks of data, lines |
1207 | etc. |
1380 | etc. You can also specify the (fully qualified) name of a package, in |
|
|
1381 | which case AnyEvent tries to load the package and then expects to find the |
|
|
1382 | C<anyevent_read_type> function inside (see "custom read types", below). |
1208 | |
1383 | |
1209 | Predefined types are (if you have ideas for additional types, feel free to |
1384 | Predefined types are (if you have ideas for additional types, feel free to |
1210 | drop by and tell us): |
1385 | drop by and tell us): |
1211 | |
1386 | |
1212 | =over 4 |
1387 | =over 4 |
… | |
… | |
1304 | the receive buffer when neither C<$accept> nor C<$reject> match, |
1479 | the receive buffer when neither C<$accept> nor C<$reject> match, |
1305 | and everything preceding and including the match will be accepted |
1480 | and everything preceding and including the match will be accepted |
1306 | unconditionally. This is useful to skip large amounts of data that you |
1481 | unconditionally. This is useful to skip large amounts of data that you |
1307 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
1482 | know cannot be matched, so that the C<$accept> or C<$reject> regex do not |
1308 | have to start matching from the beginning. This is purely an optimisation |
1483 | have to start matching from the beginning. This is purely an optimisation |
1309 | and is usually worth only when you expect more than a few kilobytes. |
1484 | and is usually worth it only when you expect more than a few kilobytes. |
1310 | |
1485 | |
1311 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
1486 | Example: expect a http header, which ends at C<\015\012\015\012>. Since we |
1312 | expect the header to be very large (it isn't in practise, but...), we use |
1487 | expect the header to be very large (it isn't in practice, but...), we use |
1313 | a skip regex to skip initial portions. The skip regex is tricky in that |
1488 | a skip regex to skip initial portions. The skip regex is tricky in that |
1314 | it only accepts something not ending in either \015 or \012, as these are |
1489 | it only accepts something not ending in either \015 or \012, as these are |
1315 | required for the accept regex. |
1490 | required for the accept regex. |
1316 | |
1491 | |
1317 | $handle->push_read (regex => |
1492 | $handle->push_read (regex => |
… | |
… | |
1531 | } |
1706 | } |
1532 | }; |
1707 | }; |
1533 | |
1708 | |
1534 | =back |
1709 | =back |
1535 | |
1710 | |
1536 | =item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) |
1711 | =item custom read types - Package::anyevent_read_type $handle, $cb, @args |
1537 | |
1712 | |
1538 | This function (not method) lets you add your own types to C<push_read>. |
1713 | Instead of one of the predefined types, you can also specify the name |
|
|
1714 | of a package. AnyEvent will try to load the package and then expects to |
|
|
1715 | find a function named C<anyevent_read_type> inside. If it isn't found, it |
|
|
1716 | progressively tries to load the parent package until it either finds the |
|
|
1717 | function (good) or runs out of packages (bad). |
1539 | |
1718 | |
1540 | Whenever the given C<type> is used, C<push_read> will invoke the code |
1719 | Whenever this type is used, C<push_read> will invoke the function with the |
1541 | reference with the handle object, the callback and the remaining |
1720 | handle object, the original callback and the remaining arguments. |
1542 | arguments. |
|
|
1543 | |
1721 | |
1544 | The code reference is supposed to return a callback (usually a closure) |
1722 | The function is supposed to return a callback (usually a closure) that |
1545 | that works as a plain read callback (see C<< ->push_read ($cb) >>). |
1723 | works as a plain read callback (see C<< ->push_read ($cb) >>), so you can |
|
|
1724 | mentally treat the function as a "configurable read type to read callback" |
|
|
1725 | converter. |
1546 | |
1726 | |
1547 | It should invoke the passed callback when it is done reading (remember to |
1727 | It should invoke the original callback when it is done reading (remember |
1548 | pass C<$handle> as first argument as all other callbacks do that). |
1728 | to pass C<$handle> as first argument as all other callbacks do that, |
|
|
1729 | although there is no strict requirement on this). |
1549 | |
1730 | |
1550 | Note that this is a function, and all types registered this way will be |
|
|
1551 | global, so try to use unique names. |
|
|
1552 | |
|
|
1553 | For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, |
1731 | For examples, see the source of this module (F<perldoc -m |
1554 | search for C<register_read_type>)). |
1732 | AnyEvent::Handle>, search for C<register_read_type>)). |
1555 | |
1733 | |
1556 | =item $handle->stop_read |
1734 | =item $handle->stop_read |
1557 | |
1735 | |
1558 | =item $handle->start_read |
1736 | =item $handle->start_read |
1559 | |
1737 | |
… | |
… | |
1579 | } |
1757 | } |
1580 | |
1758 | |
1581 | sub start_read { |
1759 | sub start_read { |
1582 | my ($self) = @_; |
1760 | my ($self) = @_; |
1583 | |
1761 | |
1584 | unless ($self->{_rw} || $self->{_eof}) { |
1762 | unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) { |
1585 | Scalar::Util::weaken $self; |
1763 | Scalar::Util::weaken $self; |
1586 | |
1764 | |
1587 | $self->{_rw} = AE::io $self->{fh}, 0, sub { |
1765 | $self->{_rw} = AE::io $self->{fh}, 0, sub { |
1588 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1766 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1589 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1767 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf; |
1590 | |
1768 | |
1591 | if ($len > 0) { |
1769 | if ($len > 0) { |
1592 | $self->{_activity} = $self->{_ractivity} = AE::now; |
1770 | $self->{_activity} = $self->{_ractivity} = AE::now; |
1593 | |
1771 | |
1594 | if ($self->{tls}) { |
1772 | if ($self->{tls}) { |
1595 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1773 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1596 | |
1774 | |
1597 | &_dotls ($self); |
1775 | &_dotls ($self); |
1598 | } else { |
1776 | } else { |
1599 | $self->_drain_rbuf; |
1777 | $self->_drain_rbuf; |
|
|
1778 | } |
|
|
1779 | |
|
|
1780 | if ($len == $self->{read_size}) { |
|
|
1781 | $self->{read_size} *= 2; |
|
|
1782 | $self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE |
|
|
1783 | if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE); |
1600 | } |
1784 | } |
1601 | |
1785 | |
1602 | } elsif (defined $len) { |
1786 | } elsif (defined $len) { |
1603 | delete $self->{_rw}; |
1787 | delete $self->{_rw}; |
1604 | $self->{_eof} = 1; |
1788 | $self->{_eof} = 1; |
… | |
… | |
1682 | && ($tmp != $ERROR_SYSCALL || $!); |
1866 | && ($tmp != $ERROR_SYSCALL || $!); |
1683 | |
1867 | |
1684 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1868 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1685 | $self->{wbuf} .= $tmp; |
1869 | $self->{wbuf} .= $tmp; |
1686 | $self->_drain_wbuf; |
1870 | $self->_drain_wbuf; |
|
|
1871 | $self->{tls} or return; # tls session might have gone away in callback |
1687 | } |
1872 | } |
1688 | |
1873 | |
1689 | $self->{_on_starttls} |
1874 | $self->{_on_starttls} |
1690 | and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () |
1875 | and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () |
1691 | and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); |
1876 | and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); |
… | |
… | |
1713 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1898 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1714 | changed to your liking. Note that the handshake might have already started |
1899 | changed to your liking. Note that the handshake might have already started |
1715 | when this function returns. |
1900 | when this function returns. |
1716 | |
1901 | |
1717 | Due to bugs in OpenSSL, it might or might not be possible to do multiple |
1902 | Due to bugs in OpenSSL, it might or might not be possible to do multiple |
1718 | handshakes on the same stream. Best do not attempt to use the stream after |
1903 | handshakes on the same stream. It is best to not attempt to use the |
1719 | stopping TLS. |
1904 | stream after stopping TLS. |
|
|
1905 | |
|
|
1906 | This method may invoke callbacks (and therefore the handle might be |
|
|
1907 | destroyed after it returns). |
1720 | |
1908 | |
1721 | =cut |
1909 | =cut |
1722 | |
1910 | |
1723 | our %TLS_CACHE; #TODO not yet documented, should we? |
1911 | our %TLS_CACHE; #TODO not yet documented, should we? |
1724 | |
1912 | |
… | |
… | |
1736 | require Net::SSLeay; |
1924 | require Net::SSLeay; |
1737 | |
1925 | |
1738 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
1926 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
1739 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
1927 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
1740 | |
1928 | |
1741 | $tls = $self->{tls}; |
1929 | $tls = delete $self->{tls}; |
1742 | $ctx = $self->{tls_ctx}; |
1930 | $ctx = $self->{tls_ctx}; |
1743 | |
1931 | |
1744 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
1932 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
1745 | |
1933 | |
1746 | if ("HASH" eq ref $ctx) { |
1934 | if ("HASH" eq ref $ctx) { |
… | |
… | |
1790 | |
1978 | |
1791 | =item $handle->stoptls |
1979 | =item $handle->stoptls |
1792 | |
1980 | |
1793 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1981 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1794 | sending a close notify to the other side, but since OpenSSL doesn't |
1982 | sending a close notify to the other side, but since OpenSSL doesn't |
1795 | support non-blocking shut downs, it is not guarenteed that you can re-use |
1983 | support non-blocking shut downs, it is not guaranteed that you can re-use |
1796 | the stream afterwards. |
1984 | the stream afterwards. |
|
|
1985 | |
|
|
1986 | This method may invoke callbacks (and therefore the handle might be |
|
|
1987 | destroyed after it returns). |
1797 | |
1988 | |
1798 | =cut |
1989 | =cut |
1799 | |
1990 | |
1800 | sub stoptls { |
1991 | sub stoptls { |
1801 | my ($self) = @_; |
1992 | my ($self) = @_; |
1802 | |
1993 | |
1803 | if ($self->{tls}) { |
1994 | if ($self->{tls} && $self->{fh}) { |
1804 | Net::SSLeay::shutdown ($self->{tls}); |
1995 | Net::SSLeay::shutdown ($self->{tls}); |
1805 | |
1996 | |
1806 | &_dotls; |
1997 | &_dotls; |
1807 | |
1998 | |
1808 | # # we don't give a shit. no, we do, but we can't. no...#d# |
1999 | # # we don't give a shit. no, we do, but we can't. no...#d# |
… | |
… | |
1838 | push @linger, AE::io $fh, 1, sub { |
2029 | push @linger, AE::io $fh, 1, sub { |
1839 | my $len = syswrite $fh, $wbuf, length $wbuf; |
2030 | my $len = syswrite $fh, $wbuf, length $wbuf; |
1840 | |
2031 | |
1841 | if ($len > 0) { |
2032 | if ($len > 0) { |
1842 | substr $wbuf, 0, $len, ""; |
2033 | substr $wbuf, 0, $len, ""; |
1843 | } else { |
2034 | } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) { |
1844 | @linger = (); # end |
2035 | @linger = (); # end |
1845 | } |
2036 | } |
1846 | }; |
2037 | }; |
1847 | push @linger, AE::timer $linger, 0, sub { |
2038 | push @linger, AE::timer $linger, 0, sub { |
1848 | @linger = (); |
2039 | @linger = (); |
… | |
… | |
1885 | |
2076 | |
1886 | sub AnyEvent::Handle::destroyed::AUTOLOAD { |
2077 | sub AnyEvent::Handle::destroyed::AUTOLOAD { |
1887 | #nop |
2078 | #nop |
1888 | } |
2079 | } |
1889 | |
2080 | |
|
|
2081 | =item $handle->destroyed |
|
|
2082 | |
|
|
2083 | Returns false as long as the handle hasn't been destroyed by a call to C<< |
|
|
2084 | ->destroy >>, true otherwise. |
|
|
2085 | |
|
|
2086 | Can be useful to decide whether the handle is still valid after some |
|
|
2087 | callback possibly destroyed the handle. For example, C<< ->push_write >>, |
|
|
2088 | C<< ->starttls >> and other methods can call user callbacks, which in turn |
|
|
2089 | can destroy the handle, so work can be avoided by checking sometimes: |
|
|
2090 | |
|
|
2091 | $hdl->starttls ("accept"); |
|
|
2092 | return if $hdl->destroyed; |
|
|
2093 | $hdl->push_write (... |
|
|
2094 | |
|
|
2095 | Note that the call to C<push_write> will silently be ignored if the handle |
|
|
2096 | has been destroyed, so often you can just ignore the possibility of the |
|
|
2097 | handle being destroyed. |
|
|
2098 | |
|
|
2099 | =cut |
|
|
2100 | |
|
|
2101 | sub destroyed { 0 } |
|
|
2102 | sub AnyEvent::Handle::destroyed::destroyed { 1 } |
|
|
2103 | |
1890 | =item AnyEvent::Handle::TLS_CTX |
2104 | =item AnyEvent::Handle::TLS_CTX |
1891 | |
2105 | |
1892 | This function creates and returns the AnyEvent::TLS object used by default |
2106 | This function creates and returns the AnyEvent::TLS object used by default |
1893 | for TLS mode. |
2107 | for TLS mode. |
1894 | |
2108 | |
… | |
… | |
1925 | |
2139 | |
1926 | =item I get different callback invocations in TLS mode/Why can't I pause |
2140 | =item I get different callback invocations in TLS mode/Why can't I pause |
1927 | reading? |
2141 | reading? |
1928 | |
2142 | |
1929 | Unlike, say, TCP, TLS connections do not consist of two independent |
2143 | Unlike, say, TCP, TLS connections do not consist of two independent |
1930 | communication channels, one for each direction. Or put differently. The |
2144 | communication channels, one for each direction. Or put differently, the |
1931 | read and write directions are not independent of each other: you cannot |
2145 | read and write directions are not independent of each other: you cannot |
1932 | write data unless you are also prepared to read, and vice versa. |
2146 | write data unless you are also prepared to read, and vice versa. |
1933 | |
2147 | |
1934 | This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> |
2148 | This means that, in TLS mode, you might get C<on_error> or C<on_eof> |
1935 | callback invocations when you are not expecting any read data - the reason |
2149 | callback invocations when you are not expecting any read data - the reason |
1936 | is that AnyEvent::Handle always reads in TLS mode. |
2150 | is that AnyEvent::Handle always reads in TLS mode. |
1937 | |
2151 | |
1938 | During the connection, you have to make sure that you always have a |
2152 | During the connection, you have to make sure that you always have a |
1939 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
2153 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
… | |
… | |
1953 | my $data = delete $_[0]{rbuf}; |
2167 | my $data = delete $_[0]{rbuf}; |
1954 | }); |
2168 | }); |
1955 | |
2169 | |
1956 | The reason to use C<on_error> is that TCP connections, due to latencies |
2170 | The reason to use C<on_error> is that TCP connections, due to latencies |
1957 | and packets loss, might get closed quite violently with an error, when in |
2171 | and packets loss, might get closed quite violently with an error, when in |
1958 | fact, all data has been received. |
2172 | fact all data has been received. |
1959 | |
2173 | |
1960 | It is usually better to use acknowledgements when transferring data, |
2174 | It is usually better to use acknowledgements when transferring data, |
1961 | to make sure the other side hasn't just died and you got the data |
2175 | to make sure the other side hasn't just died and you got the data |
1962 | intact. This is also one reason why so many internet protocols have an |
2176 | intact. This is also one reason why so many internet protocols have an |
1963 | explicit QUIT command. |
2177 | explicit QUIT command. |
… | |
… | |
1980 | consider using C<< ->push_shutdown >> instead. |
2194 | consider using C<< ->push_shutdown >> instead. |
1981 | |
2195 | |
1982 | =item I want to contact a TLS/SSL server, I don't care about security. |
2196 | =item I want to contact a TLS/SSL server, I don't care about security. |
1983 | |
2197 | |
1984 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
2198 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
1985 | simply connect to it and then create the AnyEvent::Handle with the C<tls> |
2199 | connect to it and then create the AnyEvent::Handle with the C<tls> |
1986 | parameter: |
2200 | parameter: |
1987 | |
2201 | |
1988 | tcp_connect $host, $port, sub { |
2202 | tcp_connect $host, $port, sub { |
1989 | my ($fh) = @_; |
2203 | my ($fh) = @_; |
1990 | |
2204 | |
… | |
… | |
2090 | |
2304 | |
2091 | =item * all members not documented here and not prefixed with an underscore |
2305 | =item * all members not documented here and not prefixed with an underscore |
2092 | are free to use in subclasses. |
2306 | are free to use in subclasses. |
2093 | |
2307 | |
2094 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
2308 | Of course, new versions of AnyEvent::Handle may introduce more "public" |
2095 | member variables, but thats just life, at least it is documented. |
2309 | member variables, but that's just life. At least it is documented. |
2096 | |
2310 | |
2097 | =back |
2311 | =back |
2098 | |
2312 | |
2099 | =head1 AUTHOR |
2313 | =head1 AUTHOR |
2100 | |
2314 | |