… | |
… | |
50 | object at least alive until the callback get called. If the object |
50 | object at least alive until the callback get called. If the object |
51 | gets destroyed before the callback is called, the request will be |
51 | gets destroyed before the callback is called, the request will be |
52 | cancelled. |
52 | cancelled. |
53 | |
53 | |
54 | The callback will be called with the response body data as first |
54 | The callback will be called with the response body data as first |
55 | argument (or "undef" if an error occured), and a hash-ref with |
55 | argument (or "undef" if an error occurred), and a hash-ref with |
56 | response headers (and trailers) as second argument. |
56 | response headers (and trailers) as second argument. |
57 | |
57 | |
58 | All the headers in that hash are lowercased. In addition to the |
58 | All the headers in that hash are lowercased. In addition to the |
59 | response headers, the "pseudo-headers" (uppercase to avoid clashing |
59 | response headers, the "pseudo-headers" (uppercase to avoid clashing |
60 | with possible response headers) "HTTPVersion", "Status" and "Reason" |
60 | with possible response headers) "HTTPVersion", "Status" and "Reason" |
… | |
… | |
82 | If an internal error occurs, such as not being able to resolve a |
82 | If an internal error occurs, such as not being able to resolve a |
83 | hostname, then $data will be "undef", "$headers->{Status}" will be |
83 | hostname, then $data will be "undef", "$headers->{Status}" will be |
84 | 590-599 and the "Reason" pseudo-header will contain an error |
84 | 590-599 and the "Reason" pseudo-header will contain an error |
85 | message. Currently the following status codes are used: |
85 | message. Currently the following status codes are used: |
86 | |
86 | |
87 | 595 - errors during connection etsbalishment, proxy handshake. |
87 | 595 - errors during connection establishment, proxy handshake. |
88 | 596 - errors during TLS negotiation, request sending and header |
88 | 596 - errors during TLS negotiation, request sending and header |
89 | processing. |
89 | processing. |
90 | 597 - errors during body receiving or processing. |
90 | 597 - errors during body receiving or processing. |
91 | 598 - user aborted request via "on_header" or "on_body". |
91 | 598 - user aborted request via "on_header" or "on_body". |
92 | 599 - other, usually nonretryable, errors (garbled URL etc.). |
92 | 599 - other, usually nonretryable, errors (garbled URL etc.). |
… | |
… | |
106 | Additional parameters are key-value pairs, and are fully optional. |
106 | Additional parameters are key-value pairs, and are fully optional. |
107 | They include: |
107 | They include: |
108 | |
108 | |
109 | recurse => $count (default: $MAX_RECURSE) |
109 | recurse => $count (default: $MAX_RECURSE) |
110 | Whether to recurse requests or not, e.g. on redirects, |
110 | Whether to recurse requests or not, e.g. on redirects, |
111 | authentication retries and so on, and how often to do so. |
111 | authentication and other retries and so on, and how often to do |
|
|
112 | so. |
|
|
113 | |
|
|
114 | Only redirects to http and https URLs are supported. While most |
|
|
115 | common redirection forms are handled entirely within this |
|
|
116 | module, some require the use of the optional URI module. If it |
|
|
117 | is required but missing, then the request will fail with an |
|
|
118 | error. |
112 | |
119 | |
113 | headers => hashref |
120 | headers => hashref |
114 | The request headers to use. Currently, "http_request" may |
121 | The request headers to use. Currently, "http_request" may |
115 | provide its own "Host:", "Content-Length:", "Connection:" and |
122 | provide its own "Host:", "Content-Length:", "Connection:" and |
116 | "Cookie:" headers and will provide defaults at least for "TE:", |
123 | "Cookie:" headers and will provide defaults at least for "TE:", |
… | |
… | |
121 | You really should provide your own "User-Agent:" header value |
128 | You really should provide your own "User-Agent:" header value |
122 | that is appropriate for your program - I wouldn't be surprised |
129 | that is appropriate for your program - I wouldn't be surprised |
123 | if the default AnyEvent string gets blocked by webservers sooner |
130 | if the default AnyEvent string gets blocked by webservers sooner |
124 | or later. |
131 | or later. |
125 | |
132 | |
|
|
133 | Also, make sure that your headers names and values do not |
|
|
134 | contain any embedded newlines. |
|
|
135 | |
126 | timeout => $seconds |
136 | timeout => $seconds |
127 | The time-out to use for various stages - each connect attempt |
137 | The time-out to use for various stages - each connect attempt |
128 | will reset the timeout, as will read or write activity, i.e. |
138 | will reset the timeout, as will read or write activity, i.e. |
129 | this is not an overall timeout. |
139 | this is not an overall timeout. |
130 | |
140 | |
… | |
… | |
136 | |
146 | |
137 | $scheme must be either missing or must be "http" for HTTP. |
147 | $scheme must be either missing or must be "http" for HTTP. |
138 | |
148 | |
139 | If not specified, then the default proxy is used (see |
149 | If not specified, then the default proxy is used (see |
140 | "AnyEvent::HTTP::set_proxy"). |
150 | "AnyEvent::HTTP::set_proxy"). |
|
|
151 | |
|
|
152 | Currently, if your proxy requires authorization, you have to |
|
|
153 | specify an appropriate "Proxy-Authorization" header in every |
|
|
154 | request. |
141 | |
155 | |
142 | body => $string |
156 | body => $string |
143 | The request body, usually empty. Will be sent as-is (future |
157 | The request body, usually empty. Will be sent as-is (future |
144 | versions of this module might offer more options). |
158 | versions of this module might offer more options). |
145 | |
159 | |
… | |
… | |
185 | object storing your state data, or the TLS context) - only |
199 | object storing your state data, or the TLS context) - only |
186 | connections using the same unique ID will be reused. |
200 | connections using the same unique ID will be reused. |
187 | |
201 | |
188 | on_prepare => $callback->($fh) |
202 | on_prepare => $callback->($fh) |
189 | In rare cases you need to "tune" the socket before it is used to |
203 | In rare cases you need to "tune" the socket before it is used to |
190 | connect (for exmaple, to bind it on a given IP address). This |
204 | connect (for example, to bind it on a given IP address). This |
191 | parameter overrides the prepare callback passed to |
205 | parameter overrides the prepare callback passed to |
192 | "AnyEvent::Socket::tcp_connect" and behaves exactly the same way |
206 | "AnyEvent::Socket::tcp_connect" and behaves exactly the same way |
193 | (e.g. it has to provide a timeout). See the description for the |
207 | (e.g. it has to provide a timeout). See the description for the |
194 | $prepare_cb argument of "AnyEvent::Socket::tcp_connect" for |
208 | $prepare_cb argument of "AnyEvent::Socket::tcp_connect" for |
195 | details. |
209 | details. |
… | |
… | |
333 | |
347 | |
334 | Example: do a HTTP HEAD request on https://www.google.com/, use a |
348 | Example: do a HTTP HEAD request on https://www.google.com/, use a |
335 | timeout of 30 seconds. |
349 | timeout of 30 seconds. |
336 | |
350 | |
337 | http_request |
351 | http_request |
338 | GET => "https://www.google.com", |
352 | HEAD => "https://www.google.com", |
339 | headers => { "user-agent" => "MySearchClient 1.0" }, |
353 | headers => { "user-agent" => "MySearchClient 1.0" }, |
340 | timeout => 30, |
354 | timeout => 30, |
341 | sub { |
355 | sub { |
342 | my ($body, $hdr) = @_; |
356 | my ($body, $hdr) = @_; |
343 | use Data::Dumper; |
357 | use Data::Dumper; |
… | |
… | |
368 | Sets the default proxy server to use. The proxy-url must begin with |
382 | Sets the default proxy server to use. The proxy-url must begin with |
369 | a string of the form "http://host:port", croaks otherwise. |
383 | a string of the form "http://host:port", croaks otherwise. |
370 | |
384 | |
371 | To clear an already-set proxy, use "undef". |
385 | To clear an already-set proxy, use "undef". |
372 | |
386 | |
373 | When AnyEvent::HTTP is laoded for the first time it will query the |
387 | When AnyEvent::HTTP is loaded for the first time it will query the |
374 | default proxy from the operating system, currently by looking at |
388 | default proxy from the operating system, currently by looking at |
375 | "$ENV{http_proxy"}. |
389 | "$ENV{http_proxy"}. |
376 | |
390 | |
377 | AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end] |
391 | AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end] |
378 | Remove all cookies from the cookie jar that have been expired. If |
392 | Remove all cookies from the cookie jar that have been expired. If |
… | |
… | |
380 | cookies. |
394 | cookies. |
381 | |
395 | |
382 | You should call this function (with a true $session_end) before you |
396 | You should call this function (with a true $session_end) before you |
383 | save cookies to disk, and you should call this function after |
397 | save cookies to disk, and you should call this function after |
384 | loading them again. If you have a long-running program you can |
398 | loading them again. If you have a long-running program you can |
385 | additonally call this function from time to time. |
399 | additionally call this function from time to time. |
386 | |
400 | |
387 | A cookie jar is initially an empty hash-reference that is managed by |
401 | A cookie jar is initially an empty hash-reference that is managed by |
388 | this module. It's format is subject to change, but currently it is |
402 | this module. Its format is subject to change, but currently it is as |
389 | like this: |
403 | follows: |
390 | |
404 | |
391 | The key "version" has to contain 1, otherwise the hash gets emptied. |
405 | The key "version" has to contain 1, otherwise the hash gets emptied. |
392 | All other keys are hostnames or IP addresses pointing to |
406 | All other keys are hostnames or IP addresses pointing to |
393 | hash-references. The key for these inner hash references is the |
407 | hash-references. The key for these inner hash references is the |
394 | server path for which this cookie is meant, and the values are again |
408 | server path for which this cookie is meant, and the values are again |
395 | hash-references. The keys of those hash-references is the cookie |
409 | hash-references. Each key of those hash-references is a cookie name, |
396 | name, and the value, you guessed it, is another hash-reference, this |
410 | and the value, you guessed it, is another hash-reference, this time |
397 | time with the key-value pairs from the cookie, except for "expires" |
411 | with the key-value pairs from the cookie, except for "expires" and |
398 | and "max-age", which have been replaced by a "_expires" key that |
412 | "max-age", which have been replaced by a "_expires" key that |
399 | contains the cookie expiry timestamp. |
413 | contains the cookie expiry timestamp. Session cookies are indicated |
|
|
414 | by not having an "_expires" key. |
400 | |
415 | |
401 | Here is an example of a cookie jar with a single cookie, so you have |
416 | Here is an example of a cookie jar with a single cookie, so you have |
402 | a chance of understanding the above paragraph: |
417 | a chance of understanding the above paragraph: |
403 | |
418 | |
404 | { |
419 | { |
… | |
… | |
425 | |
440 | |
426 | $AnyEvent::HTTP::MAX_RECURSE |
441 | $AnyEvent::HTTP::MAX_RECURSE |
427 | The default value for the "recurse" request parameter (default: 10). |
442 | The default value for the "recurse" request parameter (default: 10). |
428 | |
443 | |
429 | $AnyEvent::HTTP::TIMEOUT |
444 | $AnyEvent::HTTP::TIMEOUT |
430 | The default timeout for conenction operations (default: 300). |
445 | The default timeout for connection operations (default: 300). |
431 | |
446 | |
432 | $AnyEvent::HTTP::USERAGENT |
447 | $AnyEvent::HTTP::USERAGENT |
433 | The default value for the "User-Agent" header (the default is |
448 | The default value for the "User-Agent" header (the default is |
434 | "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; |
449 | "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; |
435 | +http://software.schmorp.de/pkg/AnyEvent)"). |
450 | +http://software.schmorp.de/pkg/AnyEvent)"). |
436 | |
451 | |
437 | $AnyEvent::HTTP::MAX_PER_HOST |
452 | $AnyEvent::HTTP::MAX_PER_HOST |
438 | The maximum number of concurrent connections to the same host |
453 | The maximum number of concurrent connections to the same host |
439 | (identified by the hostname). If the limit is exceeded, then the |
454 | (identified by the hostname). If the limit is exceeded, then |
440 | additional requests are queued until previous connections are |
455 | additional requests are queued until previous connections are |
441 | closed. Both persistent and non-persistent connections are counted |
456 | closed. Both persistent and non-persistent connections are counted |
442 | in this limit. |
457 | in this limit. |
443 | |
458 | |
444 | The default value for this is 4, and it is highly advisable to not |
459 | The default value for this is 4, and it is highly advisable to not |
445 | increase it much. |
460 | increase it much. |
446 | |
461 | |
447 | For comparison: the RFC's recommend 4 non-persistent or 2 persistent |
462 | For comparison: the RFC's recommend 4 non-persistent or 2 persistent |
448 | connections, older browsers used 2, newers (such as firefox 3) |
463 | connections, older browsers used 2, newer ones (such as firefox 3) |
449 | typically use 6, and Opera uses 8 because like, they have the |
464 | typically use 6, and Opera uses 8 because like, they have the |
450 | fastest browser and give a shit for everybody else on the planet. |
465 | fastest browser and give a shit for everybody else on the planet. |
451 | |
466 | |
452 | $AnyEvent::HTTP::PERSISTENT_TIMEOUT |
467 | $AnyEvent::HTTP::PERSISTENT_TIMEOUT |
453 | The time after which idle persistent conenctions get closed by |
468 | The time after which idle persistent connections get closed by |
454 | AnyEvent::HTTP (default: 3). |
469 | AnyEvent::HTTP (default: 3). |
455 | |
470 | |
456 | $AnyEvent::HTTP::ACTIVE |
471 | $AnyEvent::HTTP::ACTIVE |
457 | The number of active connections. This is not the number of |
472 | The number of active connections. This is not the number of |
458 | currently running requests, but the number of currently open and |
473 | currently running requests, but the number of currently open and |
459 | non-idle TCP connections. This number can be useful for |
474 | non-idle TCP connections. This number can be useful for |
460 | load-leveling. |
475 | load-leveling. |
461 | |
476 | |
462 | SHOWCASE |
477 | SHOWCASE |
463 | This section contaisn some more elaborate "real-world" examples or code |
478 | This section contains some more elaborate "real-world" examples or code |
464 | snippets. |
479 | snippets. |
465 | |
480 | |
466 | HTTP/1.1 FILE DOWNLOAD |
481 | HTTP/1.1 FILE DOWNLOAD |
467 | Downloading files with HTTP can be quite tricky, especially when |
482 | Downloading files with HTTP can be quite tricky, especially when |
468 | something goes wrong and you want to resume. |
483 | something goes wrong and you want to resume. |
… | |
… | |
471 | last modified time to check for file content changes, and works with |
486 | last modified time to check for file content changes, and works with |
472 | many HTTP/1.0 servers as well, and usually falls back to a complete |
487 | many HTTP/1.0 servers as well, and usually falls back to a complete |
473 | re-download on older servers. |
488 | re-download on older servers. |
474 | |
489 | |
475 | It calls the completion callback with either "undef", which means a |
490 | It calls the completion callback with either "undef", which means a |
476 | nonretryable error occured, 0 when the download was partial and should |
491 | nonretryable error occurred, 0 when the download was partial and should |
477 | be retried, and 1 if it was successful. |
492 | be retried, and 1 if it was successful. |
478 | |
493 | |
479 | use AnyEvent::HTTP; |
494 | use AnyEvent::HTTP; |
480 | |
495 | |
481 | sub download($$$) { |
496 | sub download($$$) { |
… | |
… | |
485 | or die "$file: $!"; |
500 | or die "$file: $!"; |
486 | |
501 | |
487 | my %hdr; |
502 | my %hdr; |
488 | my $ofs = 0; |
503 | my $ofs = 0; |
489 | |
504 | |
490 | warn stat $fh; |
|
|
491 | warn -s _; |
|
|
492 | if (stat $fh and -s _) { |
505 | if (stat $fh and -s _) { |
493 | $ofs = -s _; |
506 | $ofs = -s _; |
494 | warn "-s is ", $ofs;#d# |
507 | warn "-s is ", $ofs; |
495 | $hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9]; |
508 | $hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9]; |
496 | $hdr{"range"} = "bytes=$ofs-"; |
509 | $hdr{"range"} = "bytes=$ofs-"; |
497 | } |
510 | } |
498 | |
511 | |
499 | http_get $url, |
512 | http_get $url, |
… | |
… | |
524 | my (undef, $hdr) = @_; |
537 | my (undef, $hdr) = @_; |
525 | |
538 | |
526 | my $status = $hdr->{Status}; |
539 | my $status = $hdr->{Status}; |
527 | |
540 | |
528 | if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) { |
541 | if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) { |
529 | utime $fh, $time, $time; |
542 | utime $time, $time, $fh; |
530 | } |
543 | } |
531 | |
544 | |
532 | if ($status == 200 || $status == 206 || $status == 416) { |
545 | if ($status == 200 || $status == 206 || $status == 416) { |
533 | # download ok || resume ok || file already fully downloaded |
546 | # download ok || resume ok || file already fully downloaded |
534 | $cb->(1, $hdr); |
547 | $cb->(1, $hdr); |
… | |
… | |
619 | |
632 | |
620 | AUTHOR |
633 | AUTHOR |
621 | Marc Lehmann <schmorp@schmorp.de> |
634 | Marc Lehmann <schmorp@schmorp.de> |
622 | http://home.schmorp.de/ |
635 | http://home.schmorp.de/ |
623 | |
636 | |
624 | With many thanks to Дмитрий Шалашов, who provided |
637 | With many thanks to Дмитрий Шалашов, who provided countless testcases |
625 | countless testcases and bugreports. |
638 | and bugreports. |
626 | |
639 | |