ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent-HTTP/HTTP.pm
(Generate patch)

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.115 by root, Fri Jan 18 22:55:39 2013 UTC vs.
Revision 1.118 by root, Mon Nov 18 01:01:02 2013 UTC

… …
89C<http_request> returns a "cancellation guard" - you have to keep the 89C<http_request> returns a "cancellation guard" - you have to keep the
90object at least alive until the callback get called. If the object gets 90object at least alive until the callback get called. If the object gets
91destroyed before the callback is called, the request will be cancelled. 91destroyed before the callback is called, the request will be cancelled.
92 92
93The callback will be called with the response body data as first argument 93The 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
97All the headers in that hash are lowercased. In addition to the response 97All the headers in that hash are lowercased. In addition to the response
98headers, the "pseudo-headers" (uppercase to avoid clashing with possible 98headers, the "pseudo-headers" (uppercase to avoid clashing with possible
99response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the 99response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
… …
242context) - only connections using the same unique ID will be reused. 242context) - 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
246In rare cases you need to "tune" the socket before it is used to 246In rare cases you need to "tune" the socket before it is used to
247connect (for exmaple, to bind it on a given IP address). This parameter 247connect (for example, to bind it on a given IP address). This parameter
248overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect> 248overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
249and behaves exactly the same way (e.g. it has to provide a 249and behaves exactly the same way (e.g. it has to provide a
250timeout). See the description for the C<$prepare_cb> argument of 250timeout). See the description for the C<$prepare_cb> argument of
251C<AnyEvent::Socket::tcp_connect> for details. 251C<AnyEvent::Socket::tcp_connect> for details.
252 252
… …
689 689
690 $cb->(undef, $hdr); 690 $cb->(undef, $hdr);
691 () 691 ()
692} 692}
693 693
694our %IDEMPOTENT = (
695 DELETE => 1,
696 GET => 1,
697 HEAD => 1,
698 OPTIONS => 1,
699 PUT => 1,
700 TRACE => 1,
701
702 ACL => 1,
703 "BASELINE-CONTROL" => 1,
704 BIND => 1,
705 CHECKIN => 1,
706 CHECKOUT => 1,
707 COPY => 1,
708 LABEL => 1,
709 LINK => 1,
710 MERGE => 1,
711 MKACTIVITY => 1,
712 MKCALENDAR => 1,
713 MKCOL => 1,
714 MKREDIRECTREF => 1,
715 MKWORKSPACE => 1,
716 MOVE => 1,
717 ORDERPATCH => 1,
718 PROPFIND => 1,
719 PROPPATCH => 1,
720 REBIND => 1,
721 REPORT => 1,
722 SEARCH => 1,
723 UNBIND => 1,
724 UNCHECKOUT => 1,
725 UNLINK => 1,
726 UNLOCK => 1,
727 UPDATE => 1,
728 UPDATEREDIRECTREF => 1,
729 "VERSION-CONTROL" => 1,
730);
731
694sub http_request($$@) { 732sub http_request($$@) {
695 my $cb = pop; 733 my $cb = pop;
696 my ($method, $url, %arg) = @_; 734 my ($method, $url, %arg) = @_;
697 735
698 my %hdr; 736 my %hdr;
… …
773 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"}; 811 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
774 812
775 $hdr{"content-length"} = length $arg{body} 813 $hdr{"content-length"} = length $arg{body}
776 if length $arg{body} || $method ne "GET"; 814 if length $arg{body} || $method ne "GET";
777 815
778 my $idempotent = $method =~ /^(?:GET|HEAD|PUT|DELETE|OPTIONS|TRACE)$/; 816 my $idempotent = $IDEMPOTENT{$method};
779 817
780 # default value for keepalive is true iff the request is for an idempotent method 818 # default value for keepalive is true iff the request is for an idempotent method
781 my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent; 819 my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent;
782 my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy; 820 my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy;
783 my $was_persistent; # true if this is actually a recycled connection 821 my $was_persistent; # true if this is actually a recycled connection
784 822
785 # the key to use in the keepalive cache 823 # the key to use in the keepalive cache
786 my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}"; 824 my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}";
787 825
788 $hdr{connection} = ($persistent ? $keepalive ? "keep-alive " : "" : "close ") . "Te"; #1.1 826 $hdr{connection} = ($persistent ? $keepalive ? "keep-alive, " : "" : "close, ") . "Te"; #1.1
789 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1 827 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
790 828
791 my %state = (connect_guard => 1); 829 my %state = (connect_guard => 1);
792 830
793 my $ae_error = 595; # connecting 831 my $ae_error = 595; # connecting
… …
806 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) 844 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
807 . "\015\012" 845 . "\015\012"
808 . (delete $arg{body}) 846 . (delete $arg{body})
809 ); 847 );
810 848
811 # return if error occured during push_write() 849 # return if error occurred during push_write()
812 return unless %state; 850 return unless %state;
813 851
814 # 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.
815 %hdr = (); 853 %hdr = ();
816 854
… …
1206C<$session_end> is given and true, then additionally remove all session 1244C<$session_end> is given and true, then additionally remove all session
1207cookies. 1245cookies.
1208 1246
1209You should call this function (with a true C<$session_end>) before you 1247You should call this function (with a true C<$session_end>) before you
1210save cookies to disk, and you should call this function after loading them 1248save cookies to disk, and you should call this function after loading them
1211again. If you have a long-running program you can additonally call this 1249again. If you have a long-running program you can additionally call this
1212function from time to time. 1250function from time to time.
1213 1251
1214A cookie jar is initially an empty hash-reference that is managed by this 1252A cookie jar is initially an empty hash-reference that is managed by this
1215module. It's format is subject to change, but currently it is like this: 1253module. It's format is subject to change, but currently it is like this:
1216 1254
… …
1273 1311
1274The default value for this is C<4>, and it is highly advisable to not 1312The default value for this is C<4>, and it is highly advisable to not
1275increase it much. 1313increase it much.
1276 1314
1277For comparison: the RFC's recommend 4 non-persistent or 2 persistent 1315For comparison: the RFC's recommend 4 non-persistent or 2 persistent
1278connections, older browsers used 2, newers (such as firefox 3) typically 1316connections, older browsers used 2, newer ones (such as firefox 3)
1279use 6, and Opera uses 8 because like, they have the fastest browser and 1317typically use 6, and Opera uses 8 because like, they have the fastest
1280give a shit for everybody else on the planet. 1318browser and give a shit for everybody else on the planet.
1281 1319
1282=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT 1320=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
1283 1321
1284The time after which idle persistent conenctions get closed by 1322The time after which idle persistent connections get closed by
1285AnyEvent::HTTP (default: C<3>). 1323AnyEvent::HTTP (default: C<3>).
1286 1324
1287=item $AnyEvent::HTTP::ACTIVE 1325=item $AnyEvent::HTTP::ACTIVE
1288 1326
1289The number of active connections. This is not the number of currently 1327The number of active connections. This is not the number of currently
… …
1354 set_proxy $ENV{http_proxy}; 1392 set_proxy $ENV{http_proxy};
1355}; 1393};
1356 1394
1357=head2 SHOWCASE 1395=head2 SHOWCASE
1358 1396
1359This section contaisn some more elaborate "real-world" examples or code 1397This section contains some more elaborate "real-world" examples or code
1360snippets. 1398snippets.
1361 1399
1362=head2 HTTP/1.1 FILE DOWNLOAD 1400=head2 HTTP/1.1 FILE DOWNLOAD
1363 1401
1364Downloading files with HTTP can be quite tricky, especially when something 1402Downloading files with HTTP can be quite tricky, especially when something
… …
1368last modified time to check for file content changes, and works with many 1406last modified time to check for file content changes, and works with many
1369HTTP/1.0 servers as well, and usually falls back to a complete re-download 1407HTTP/1.0 servers as well, and usually falls back to a complete re-download
1370on older servers. 1408on older servers.
1371 1409
1372It calls the completion callback with either C<undef>, which means a 1410It calls the completion callback with either C<undef>, which means a
1373nonretryable error occured, C<0> when the download was partial and should 1411nonretryable error occurred, C<0> when the download was partial and should
1374be retried, and C<1> if it was successful. 1412be retried, and C<1> if it was successful.
1375 1413
1376 use AnyEvent::HTTP; 1414 use AnyEvent::HTTP;
1377 1415
1378 sub download($$$) { 1416 sub download($$$) {

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines