… | |
… | |
89 | C<http_request> returns a "cancellation guard" - you have to keep the |
89 | C<http_request> returns a "cancellation guard" - you have to keep the |
90 | object at least alive until the callback get called. If the object gets |
90 | object at least alive until the callback get called. If the object gets |
91 | destroyed before the callback is called, the request will be cancelled. |
91 | destroyed before the callback is called, the request will be cancelled. |
92 | |
92 | |
93 | The callback will be called with the response body data as first argument |
93 | The callback will be called with the response body data as first argument |
94 | (or C<undef> if an error occured), and a hash-ref with response headers |
94 | (or C<undef> if an error occurred), and a hash-ref with response headers |
95 | (and trailers) as second argument. |
95 | (and trailers) as second argument. |
96 | |
96 | |
97 | All the headers in that hash are lowercased. In addition to the response |
97 | All the headers in that hash are lowercased. In addition to the response |
98 | headers, the "pseudo-headers" (uppercase to avoid clashing with possible |
98 | headers, the "pseudo-headers" (uppercase to avoid clashing with possible |
99 | response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the |
99 | response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the |
… | |
… | |
242 | context) - only connections using the same unique ID will be reused. |
242 | context) - only connections using the same unique ID will be reused. |
243 | |
243 | |
244 | =item on_prepare => $callback->($fh) |
244 | =item on_prepare => $callback->($fh) |
245 | |
245 | |
246 | In rare cases you need to "tune" the socket before it is used to |
246 | In rare cases you need to "tune" the socket before it is used to |
247 | connect (for exmaple, to bind it on a given IP address). This parameter |
247 | connect (for example, to bind it on a given IP address). This parameter |
248 | overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect> |
248 | overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect> |
249 | and behaves exactly the same way (e.g. it has to provide a |
249 | and behaves exactly the same way (e.g. it has to provide a |
250 | timeout). See the description for the C<$prepare_cb> argument of |
250 | timeout). See the description for the C<$prepare_cb> argument of |
251 | C<AnyEvent::Socket::tcp_connect> for details. |
251 | C<AnyEvent::Socket::tcp_connect> for details. |
252 | |
252 | |
… | |
… | |
844 | . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) |
844 | . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) |
845 | . "\015\012" |
845 | . "\015\012" |
846 | . (delete $arg{body}) |
846 | . (delete $arg{body}) |
847 | ); |
847 | ); |
848 | |
848 | |
849 | # return if error occured during push_write() |
849 | # return if error occurred during push_write() |
850 | return unless %state; |
850 | return unless %state; |
851 | |
851 | |
852 | # reduce memory usage, save a kitten, also re-use it for the response headers. |
852 | # reduce memory usage, save a kitten, also re-use it for the response headers. |
853 | %hdr = (); |
853 | %hdr = (); |
854 | |
854 | |
… | |
… | |
1244 | C<$session_end> is given and true, then additionally remove all session |
1244 | C<$session_end> is given and true, then additionally remove all session |
1245 | cookies. |
1245 | cookies. |
1246 | |
1246 | |
1247 | You should call this function (with a true C<$session_end>) before you |
1247 | You should call this function (with a true C<$session_end>) before you |
1248 | save cookies to disk, and you should call this function after loading them |
1248 | save cookies to disk, and you should call this function after loading them |
1249 | again. If you have a long-running program you can additonally call this |
1249 | again. If you have a long-running program you can additionally call this |
1250 | function from time to time. |
1250 | function from time to time. |
1251 | |
1251 | |
1252 | A cookie jar is initially an empty hash-reference that is managed by this |
1252 | A cookie jar is initially an empty hash-reference that is managed by this |
1253 | module. It's format is subject to change, but currently it is like this: |
1253 | module. It's format is subject to change, but currently it is like this: |
1254 | |
1254 | |
… | |
… | |
1311 | |
1311 | |
1312 | The default value for this is C<4>, and it is highly advisable to not |
1312 | The default value for this is C<4>, and it is highly advisable to not |
1313 | increase it much. |
1313 | increase it much. |
1314 | |
1314 | |
1315 | For comparison: the RFC's recommend 4 non-persistent or 2 persistent |
1315 | For comparison: the RFC's recommend 4 non-persistent or 2 persistent |
1316 | connections, older browsers used 2, newers (such as firefox 3) typically |
1316 | connections, older browsers used 2, newer ones (such as firefox 3) |
1317 | use 6, and Opera uses 8 because like, they have the fastest browser and |
1317 | typically use 6, and Opera uses 8 because like, they have the fastest |
1318 | give a shit for everybody else on the planet. |
1318 | browser and give a shit for everybody else on the planet. |
1319 | |
1319 | |
1320 | =item $AnyEvent::HTTP::PERSISTENT_TIMEOUT |
1320 | =item $AnyEvent::HTTP::PERSISTENT_TIMEOUT |
1321 | |
1321 | |
1322 | The time after which idle persistent connections get closed by |
1322 | The time after which idle persistent connections get closed by |
1323 | AnyEvent::HTTP (default: C<3>). |
1323 | AnyEvent::HTTP (default: C<3>). |
… | |
… | |
1392 | set_proxy $ENV{http_proxy}; |
1392 | set_proxy $ENV{http_proxy}; |
1393 | }; |
1393 | }; |
1394 | |
1394 | |
1395 | =head2 SHOWCASE |
1395 | =head2 SHOWCASE |
1396 | |
1396 | |
1397 | This section contaisn some more elaborate "real-world" examples or code |
1397 | This section contains some more elaborate "real-world" examples or code |
1398 | snippets. |
1398 | snippets. |
1399 | |
1399 | |
1400 | =head2 HTTP/1.1 FILE DOWNLOAD |
1400 | =head2 HTTP/1.1 FILE DOWNLOAD |
1401 | |
1401 | |
1402 | Downloading files with HTTP can be quite tricky, especially when something |
1402 | Downloading files with HTTP can be quite tricky, especially when something |
… | |
… | |
1406 | last modified time to check for file content changes, and works with many |
1406 | last modified time to check for file content changes, and works with many |
1407 | HTTP/1.0 servers as well, and usually falls back to a complete re-download |
1407 | HTTP/1.0 servers as well, and usually falls back to a complete re-download |
1408 | on older servers. |
1408 | on older servers. |
1409 | |
1409 | |
1410 | It calls the completion callback with either C<undef>, which means a |
1410 | It calls the completion callback with either C<undef>, which means a |
1411 | nonretryable error occured, C<0> when the download was partial and should |
1411 | nonretryable error occurred, C<0> when the download was partial and should |
1412 | be retried, and C<1> if it was successful. |
1412 | be retried, and C<1> if it was successful. |
1413 | |
1413 | |
1414 | use AnyEvent::HTTP; |
1414 | use AnyEvent::HTTP; |
1415 | |
1415 | |
1416 | sub download($$$) { |
1416 | sub download($$$) { |