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.1 by root, Tue Jun 3 16:37:13 2008 UTC vs.
Revision 1.30 by root, Thu Oct 23 02:46:20 2008 UTC

… …
3AnyEvent::HTTP - simple but non-blocking HTTP/HTTPS client 3AnyEvent::HTTP - simple but non-blocking HTTP/HTTPS client
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use AnyEvent::HTTP; 7 use AnyEvent::HTTP;
8
9 http_get "http://www.nethype.de/", sub { print $_[1] };
10
11 # ... do something else here
8 12
9=head1 DESCRIPTION 13=head1 DESCRIPTION
10 14
11This module is an L<AnyEvent> user, you need to make sure that you use and 15This module is an L<AnyEvent> user, you need to make sure that you use and
12run a supported event loop. 16run a supported event loop.
17
18This module implements a simple, stateless and non-blocking HTTP
19client. It supports GET, POST and other request methods, cookies and more,
20all on a very low level. It can follow redirects supports proxies and
21automatically limits the number of connections to the values specified in
22the RFC.
23
24It should generally be a "good client" that is enough for most HTTP
25tasks. Simple tasks should be simple, but complex tasks should still be
26possible as the user retains control over request and response headers.
27
28The caller is responsible for authentication management, cookies (if
29the simplistic implementation in this module doesn't suffice), referer
30and other high-level protocol details for which this module offers only
31limited support.
13 32
14=head2 METHODS 33=head2 METHODS
15 34
16=over 4 35=over 4
17 36
… …
29use AnyEvent::Socket (); 48use AnyEvent::Socket ();
30use AnyEvent::Handle (); 49use AnyEvent::Handle ();
31 50
32use base Exporter::; 51use base Exporter::;
33 52
34our $VERSION = '1.0'; 53our $VERSION = '1.05';
35 54
36our @EXPORT = qw(http_get http_request); 55our @EXPORT = qw(http_get http_post http_head http_request);
37 56
38our $MAX_REDIRECTS = 10;
39our $USERAGENT = "Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)"; 57our $USERAGENT = "Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";
58our $MAX_RECURSE = 10;
40our $MAX_PERSISTENT = 8; 59our $MAX_PERSISTENT = 8;
41our $PERSISTENT_TIMEOUT = 15; 60our $PERSISTENT_TIMEOUT = 2;
42our $TIMEOUT = 60; 61our $TIMEOUT = 300;
43 62
44# changing these is evil 63# changing these is evil
45our $MAX_PERSISTENT_PER_HOST = 2; 64our $MAX_PERSISTENT_PER_HOST = 2;
46our $MAX_PER_HOST = 4; # not respected yet :( 65our $MAX_PER_HOST = 4;
66
67our $PROXY;
68our $ACTIVE = 0;
47 69
48my %KA_COUNT; # number of open keep-alive connections per host 70my %KA_COUNT; # number of open keep-alive connections per host
71my %CO_SLOT; # number of open connections, and wait queue, per host
49 72
50=item http_get $url, key => value..., $cb->($data, $headers) 73=item http_get $url, key => value..., $cb->($data, $headers)
51 74
52Executes an HTTP-GET request. See the http_request function for details on 75Executes an HTTP-GET request. See the http_request function for details on
53additional parameters. 76additional parameters and the return value.
77
78=item http_head $url, key => value..., $cb->($data, $headers)
79
80Executes an HTTP-HEAD request. See the http_request function for details
81on additional parameters and the return value.
82
83=item http_post $url, $body, key => value..., $cb->($data, $headers)
84
85Executes an HTTP-POST request with a request body of C<$body>. See the
86http_request function for details on additional parameters and the return
87value.
54 88
55=item http_request $method => $url, key => value..., $cb->($data, $headers) 89=item http_request $method => $url, key => value..., $cb->($data, $headers)
56 90
57Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL 91Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL
58must be an absolute http or https URL. 92must be an absolute http or https URL.
59 93
94When called in void context, nothing is returned. In other contexts,
95C<http_request> returns a "cancellation guard" - you have to keep the
96object at least alive until the callback get called. If the object gets
97destroyed before the callbakc is called, the request will be cancelled.
98
99The callback will be called with the response data as first argument
100(or C<undef> if it wasn't available due to errors), and a hash-ref with
101response headers as second argument.
102
103All the headers in that hash are lowercased. In addition to the response
104headers, the "pseudo-headers" C<HTTPVersion>, C<Status> and C<Reason>
105contain the three parts of the HTTP Status-Line of the same name. The
106pseudo-header C<URL> contains the original URL (which can differ from the
107requested URL when following redirects).
108
109If the server sends a header multiple lines, then their contents will be
110joined together with C<\x00>.
111
112If an internal error occurs, such as not being able to resolve a hostname,
113then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<599>
114and the C<Reason> pseudo-header will contain an error message.
115
116A typical callback might look like this:
117
118 sub {
119 my ($body, $hdr) = @_;
120
121 if ($hdr->{Status} =~ /^2/) {
122 ... everything should be ok
123 } else {
124 print "error, $hdr->{Status} $hdr->{Reason}\n";
125 }
126 }
127
60Additional parameters are key-value pairs, and are fully optional. They 128Additional parameters are key-value pairs, and are fully optional. They
61include: 129include:
62 130
63=over 4 131=over 4
64 132
65=item recurse => $boolean (default: true) 133=item recurse => $count (default: $MAX_RECURSE)
66 134
67Whether to recurse requests or not, e.g. on redirects, authentication 135Whether to recurse requests or not, e.g. on redirects, authentication
68retries and so on. 136retries and so on, and how often to do so.
69 137
70=item headers => hashref 138=item headers => hashref
71 139
72The request headers to use. 140The request headers to use. Currently, C<http_request> may provide its
141own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers
142and will provide defaults for C<User-Agent:> and C<Referer:>.
73 143
74=item timeout => $seconds 144=item timeout => $seconds
75 145
76The time-out to use for various stages - each connect attempt will reset 146The time-out to use for various stages - each connect attempt will reset
77the timeout, as will read or write activity. 147the timeout, as will read or write activity. Default timeout is 5 minutes.
148
149=item proxy => [$host, $port[, $scheme]] or undef
150
151Use the given http proxy for all requests. If not specified, then the
152default proxy (as specified by C<$ENV{http_proxy}>) is used.
153
154C<$scheme> must be either missing or C<http> for HTTP, or C<https> for
155HTTPS.
156
157=item body => $string
158
159The request body, usually empty. Will be-sent as-is (future versions of
160this module might offer more options).
161
162=item cookie_jar => $hash_ref
163
164Passing this parameter enables (simplified) cookie-processing, loosely
165based on the original netscape specification.
166
167The C<$hash_ref> must be an (initially empty) hash reference which will
168get updated automatically. It is possible to save the cookie_jar to
169persistent storage with something like JSON or Storable, but this is not
170recommended, as expire times are currently being ignored.
171
172Note that this cookie implementation is not of very high quality, nor
173meant to be complete. If you want complete cookie management you have to
174do that on your own. C<cookie_jar> is meant as a quick fix to get some
175cookie-using sites working. Cookies are a privacy disaster, do not use
176them unless required to.
78 177
79=back 178=back
80 179
81=back 180Example: make a simple HTTP GET request for http://www.nethype.de/
181
182 http_request GET => "http://www.nethype.de/", sub {
183 my ($body, $hdr) = @_;
184 print "$body\n";
185 };
186
187Example: make a HTTP HEAD request on https://www.google.com/, use a
188timeout of 30 seconds.
189
190 http_request
191 GET => "https://www.google.com",
192 timeout => 30,
193 sub {
194 my ($body, $hdr) = @_;
195 use Data::Dumper;
196 print Dumper $hdr;
197 }
198 ;
199
200Example: make another simple HTTP GET request, but immediately try to
201cancel it.
202
203 my $request = http_request GET => "http://www.nethype.de/", sub {
204 my ($body, $hdr) = @_;
205 print "$body\n";
206 };
207
208 undef $request;
82 209
83=cut 210=cut
84 211
212sub _slot_schedule;
213sub _slot_schedule($) {
214 my $host = shift;
215
216 while ($CO_SLOT{$host}[0] < $MAX_PER_HOST) {
217 if (my $cb = shift @{ $CO_SLOT{$host}[1] }) {
218 # somebody wants that slot
219 ++$CO_SLOT{$host}[0];
220 ++$ACTIVE;
221
222 $cb->(AnyEvent::Util::guard {
223 --$ACTIVE;
224 --$CO_SLOT{$host}[0];
225 _slot_schedule $host;
226 });
227 } else {
228 # nobody wants the slot, maybe we can forget about it
229 delete $CO_SLOT{$host} unless $CO_SLOT{$host}[0];
230 last;
231 }
232 }
233}
234
235# wait for a free slot on host, call callback
236sub _get_slot($$) {
237 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
238
239 _slot_schedule $_[0];
240}
241
85sub http_request($$$;@) { 242sub http_request($$@) {
86 my $cb = pop; 243 my $cb = pop;
87 my ($method, $url, %arg) = @_; 244 my ($method, $url, %arg) = @_;
88 245
89 my %hdr; 246 my %hdr;
90 247
248 $method = uc $method;
249
91 if (my $hdr = delete $arg{headers}) { 250 if (my $hdr = $arg{headers}) {
92 while (my ($k, $v) = each %$hdr) { 251 while (my ($k, $v) = each %$hdr) {
93 $hdr{lc $k} = $v; 252 $hdr{lc $k} = $v;
94 } 253 }
95 } 254 }
96 255
256 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
257
258 return $cb->(undef, { Status => 599, Reason => "recursion limit reached", URL => $url })
259 if $recurse < 0;
260
261 my $proxy = $arg{proxy} || $PROXY;
97 my $timeout = $arg{timeout} || $TIMEOUT; 262 my $timeout = $arg{timeout} || $TIMEOUT;
98 263
99 $hdr{"user-agent"} ||= $USERAGENT; 264 $hdr{"user-agent"} ||= $USERAGENT;
100 265
101 my ($scheme, $authority, $path, $query, $fragment) = 266 my ($scheme, $authority, $upath, $query, $fragment) =
102 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|; 267 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|;
103 268
104 $scheme = lc $scheme; 269 $scheme = lc $scheme;
270
105 my $port = $scheme eq "http" ? 80 271 my $uport = $scheme eq "http" ? 80
106 : $scheme eq "https" ? 443 272 : $scheme eq "https" ? 443
107 : croak "$url: only http and https URLs supported"; 273 : return $cb->(undef, { Status => 599, Reason => "only http and https URL schemes supported", URL => $url });
274
275 $hdr{referer} ||= "$scheme://$authority$upath"; # leave out fragment and query string, just a heuristic
108 276
109 $authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 277 $authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
110 or croak "$authority: unparsable URL"; 278 or return $cb->(undef, { Status => 599, Reason => "unparsable URL", URL => $url });
111 279
112 my $host = $1; 280 my $uhost = $1;
113 $port = $2 if defined $2; 281 $uport = $2 if defined $2;
114 282
115 $host =~ s/^\[(.*)\]$/$1/; 283 $uhost =~ s/^\[(.*)\]$/$1/;
116 $path .= "?$query" if length $query; 284 $upath .= "?$query" if length $query;
117 285
118 $hdr{host} = $host = lc $host; 286 $upath =~ s%^/?%/%;
119 287
120 my %state; 288 # cookie processing
121 289 if (my $jar = $arg{cookie_jar}) {
122 my $body = ""; 290 %$jar = () if $jar->{version} < 1;
123 $state{body} = $body; 291
124 292 my @cookie;
125 $hdr{"content-length"} = length $body; 293
126 294 while (my ($chost, $v) = each %$jar) {
127 $state{connect_guard} = AnyEvent::Socket::tcp_connect $host, $port, sub { 295 if ($chost =~ /^\./) {
128 $state{fh} = shift 296 next unless $chost eq substr $uhost, -length $chost;
129 or return $cb->(undef, { Status => 599, Reason => "$!" }); 297 } elsif ($chost =~ /\./) {
130 298 next unless $chost eq $uhost;
131 delete $state{connect_guard}; # reduce memory usage, save a tree
132
133 # get handle
134 $state{handle} = new AnyEvent::Handle
135 fh => $state{fh},
136 ($scheme eq "https" ? (tls => "connect") : ());
137
138 # limit the number of persistent connections
139 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
140 ++$KA_COUNT{$_[1]};
141 $state{handle}{ka_count_guard} = AnyEvent::Util::guard { --$KA_COUNT{$_[1]} };
142 $hdr{connection} = "keep-alive";
143 } else { 299 } else {
144 delete $hdr{connection}; 300 next;
301 }
302
303 while (my ($cpath, $v) = each %$v) {
304 next unless $cpath eq substr $upath, 0, length $cpath;
305
306 while (my ($k, $v) = each %$v) {
307 next if $scheme ne "https" && exists $v->{secure};
308 push @cookie, "$k=$v->{value}";
309 }
310 }
145 } 311 }
312
313 $hdr{cookie} = join "; ", @cookie
314 if @cookie;
315 }
146 316
317 my ($rhost, $rport, $rpath); # request host, port, path
318
319 if ($proxy) {
320 ($rhost, $rport, $scheme) = @$proxy;
321 $rpath = $url;
322 } else {
323 ($rhost, $rport, $rpath) = ($uhost, $uport, $upath);
324 $hdr{host} = $uhost;
325 }
326
327 $hdr{"content-length"} = length $arg{body};
328
329 my %state = (connect_guard => 1);
330
331 _get_slot $uhost, sub {
332 $state{slot_guard} = shift;
333
334 return unless $state{connect_guard};
335
336 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub {
337 $state{fh} = shift
338 or return $cb->(undef, { Status => 599, Reason => "$!", URL => $url });
339
340 delete $state{connect_guard}; # reduce memory usage, save a tree
341
342 # get handle
343 $state{handle} = new AnyEvent::Handle
344 fh => $state{fh},
345 ($scheme eq "https" ? (tls => "connect") : ());
346
347 # limit the number of persistent connections
348 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
349 ++$KA_COUNT{$_[1]};
350 $state{handle}{ka_count_guard} = AnyEvent::Util::guard { --$KA_COUNT{$_[1]} };
351 $hdr{connection} = "keep-alive";
352 delete $hdr{connection}; # keep-alive not yet supported
353 } else {
354 delete $hdr{connection};
355 }
356
147 # (re-)configure handle 357 # (re-)configure handle
148 $state{handle}->timeout ($timeout); 358 $state{handle}->timeout ($timeout);
149 $state{handle}->on_error (sub { 359 $state{handle}->on_error (sub {
360 my $errno = "$!";
150 %state = (); 361 %state = ();
151 $cb->(undef, { Status => 599, Reason => "$!" }); 362 $cb->(undef, { Status => 599, Reason => $errno, URL => $url });
152 }); 363 });
153 $state{handle}->on_eof (sub { 364 $state{handle}->on_eof (sub {
154 %state = (); 365 %state = ();
155 $cb->(undef, { Status => 599, Reason => "unexpected end-of-file" }); 366 $cb->(undef, { Status => 599, Reason => "unexpected end-of-file", URL => $url });
156 }); 367 });
157 368
158 # send request 369 # send request
159 $state{handle}->push_write ( 370 $state{handle}->push_write (
160 "\U$method\E $path HTTP/1.0\015\012" 371 "$method $rpath HTTP/1.0\015\012"
161 . (join "", map "$_: $hdr{$_}\015\012", keys %hdr) 372 . (join "", map "$_: $hdr{$_}\015\012", keys %hdr)
162 . "\015\012" 373 . "\015\012"
163 . (delete $state{body}) 374 . (delete $arg{body})
164 );
165
166 %hdr = (); # reduce memory usage, save a kitten
167
168 # status line
169 $state{handle}->push_read (line => qr/\015?\012/, sub {
170 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) \s+ ([^\015\012]+)/ix
171 or return (%state = (), $cb->(undef, { Status => 599, Reason => "invalid server response ($_[1])" }));
172
173 my %hdr = ( # response headers
174 HTTPVersion => ",$1",
175 Status => ",$2",
176 Reason => ",$3",
177 ); 375 );
178 376
377 %hdr = (); # reduce memory usage, save a kitten
378
379 # status line
380 $state{handle}->push_read (line => qr/\015?\012/, sub {
381 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
382 or return (%state = (), $cb->(undef, { Status => 599, Reason => "invalid server response ($_[1])", URL => $url }));
383
384 my %hdr = ( # response headers
385 HTTPVersion => "\x00$1",
386 Status => "\x00$2",
387 Reason => "\x00$3",
388 URL => "\x00$url"
389 );
390
179 # headers, could be optimized a bit 391 # headers, could be optimized a bit
180 $state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub { 392 $state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub {
181 for ("$_[1]\012") { 393 for ("$_[1]\012") {
394 # we support spaces in field names, as lotus domino
395 # creates them (actually spaces around seperators
396 # are strictly allowed in http, they are a security issue).
182 $hdr{lc $1} .= ",$2" 397 $hdr{lc $1} .= "\x00$2"
183 while /\G 398 while /\G
184 ([^:\000-\040]+): 399 ([^:\000-\037]+):
185 [\011\040]* 400 [\011\040]*
186 ((?: [^\015\012]+ | \015?\012[\011\040] )*) 401 ((?: [^\015\012]+ | \015?\012[\011\040] )*)
187 \015?\012 402 \015?\012
188 /gxc; 403 /gxc;
189 404
190 /\G$/ 405 /\G$/
191 or return $cb->(undef, { Status => 599, Reason => "garbled response headers" }); 406 or return (%state = (), $cb->(undef, { Status => 599, Reason => "garbled response headers", URL => $url }));
192 } 407 }
193 408
194 substr $_, 0, 1, "" 409 substr $_, 0, 1, ""
195 for values %hdr; 410 for values %hdr;
196 411
197 if (exists $hdr{"content-length"}) { 412 my $finish = sub {
198 $_[0]->unshift_read (chunk => $hdr{"content-length"}, sub { 413 # TODO: use destroy method, when/if available
199 # could cache persistent connection now 414 #$state{handle}->destroy;
200 if ($hdr{connection} =~ /\bkeep-alive\b/i) { 415 $state{handle}->on_eof (undef);
201 }; 416 $state{handle}->on_error (undef);
202
203 %state = (); 417 %state = ();
418
419 # set-cookie processing
420 if ($arg{cookie_jar} && exists $hdr{"set-cookie"}) {
421 for (split /\x00/, $hdr{"set-cookie"}) {
422 my ($cookie, @arg) = split /;\s*/;
423 my ($name, $value) = split /=/, $cookie, 2;
424 my %kv = (value => $value, map { split /=/, $_, 2 } @arg);
425
426 my $cdom;
427 my $cpath = (delete $kv{path}) || "/";
428
429 if (exists $kv{domain}) {
430 $cdom = delete $kv{domain};
431
432 $cdom =~ s/^\.?/./; # make sure it starts with a "."
433
434 next if $cdom =~ /\.$/;
435
436 # this is not rfc-like and not netscape-like. go figure.
437 my $ndots = $cdom =~ y/.//;
438 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
439 } else {
440 $cdom = $uhost;
441 }
442
443 # store it
444 $arg{cookie_jar}{version} = 1;
445 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
446 }
447 }
448
449 # microsoft and other shitheads don't give a shit for following standards,
450 # try to support some common forms of broken Location headers.
451 if ($_[1]{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
452 $_[1]{location} =~ s/^\.\/+//;
453
454 my $url = "$scheme://$uhost:$uport";
455
456 unless ($_[1]{location} =~ s/^\///) {
457 $url .= $upath;
458 $url =~ s/\/[^\/]*$//;
459 }
460
461 $_[1]{location} = "$url/$_[1]{location}";
462 }
463
464 if ($_[1]{Status} =~ /^30[12]$/ && $recurse && $method ne "POST") {
465 # apparently, mozilla et al. just change POST to GET here
466 # more research is needed before we do the same
467 http_request ($method, $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
468 } elsif ($_[1]{Status} == 303 && $recurse) {
469 # even http/1.1 is unclear on how to mutate the method
470 $method = "GET" unless $method eq "HEAD";
471 http_request ($method => $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
472 } elsif ($_[1]{Status} == 307 && $recurse && $method =~ /^(?:GET|HEAD)$/) {
473 http_request ($method => $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
474 } else {
204 $cb->($_[1], \%hdr); 475 $cb->($_[0], $_[1]);
476 }
205 }); 477 };
478
479 if ($hdr{Status} =~ /^(?:1..|204|304)$/ or $method eq "HEAD") {
480 $finish->(undef, \%hdr);
206 } else { 481 } else {
482 if (exists $hdr{"content-length"}) {
483 $_[0]->unshift_read (chunk => $hdr{"content-length"}, sub {
484 # could cache persistent connection now
485 if ($hdr{connection} =~ /\bkeep-alive\b/i) {
486 # but we don't, due to misdesigns, this is annoyingly complex
487 };
488
489 $finish->($_[1], \%hdr);
490 });
491 } else {
207 # too bad, need to read until we get an error or EOF, 492 # too bad, need to read until we get an error or EOF,
208 # no way to detect winged data. 493 # no way to detect winged data.
209 $_[0]->on_error (sub { 494 $_[0]->on_error (sub {
210 %state = ();
211 $cb->($_[0]{rbuf}, \%hdr); 495 $finish->($_[0]{rbuf}, \%hdr);
496 });
497 $_[0]->on_eof (undef);
498 $_[0]->on_read (sub { });
499 }
212 }); 500 }
213 $_[0]->on_eof (undef);
214 $_[0]->on_read (sub { });
215 } 501 });
216 }); 502 });
503 }, sub {
504 $timeout
217 }); 505 };
218 }, sub {
219 $timeout
220 }; 506 };
221 507
222 defined wantarray && AnyEvent::Util::guard { %state = () } 508 defined wantarray && AnyEvent::Util::guard { %state = () }
223} 509}
224 510
225sub http_get($$;@) { 511sub http_get($@) {
226 unshift @_, "GET"; 512 unshift @_, "GET";
227 &http_request 513 &http_request
228} 514}
229 515
516sub http_head($@) {
517 unshift @_, "HEAD";
518 &http_request
519}
520
521sub http_post($$@) {
522 my $url = shift;
523 unshift @_, "POST", $url, "body";
524 &http_request
525}
526
527=back
528
230=head2 GLOBAL VARIABLES 529=head2 GLOBAL FUNCTIONS AND VARIABLES
231 530
232=over 4 531=over 4
233 532
533=item AnyEvent::HTTP::set_proxy "proxy-url"
534
535Sets the default proxy server to use. The proxy-url must begin with a
536string of the form C<http://host:port> (optionally C<https:...>).
537
234=item $AnyEvent::HTTP::MAX_REDIRECTS 538=item $AnyEvent::HTTP::MAX_RECURSE
235 539
236The default value for the C<max_redirects> request parameter 540The default value for the C<recurse> request parameter (default: C<10>).
237(default: C<10>).
238 541
239=item $AnyEvent::HTTP::USERAGENT 542=item $AnyEvent::HTTP::USERAGENT
240 543
241The default value for the C<User-Agent> header (the default is 544The default value for the C<User-Agent> header (the default is
242C<Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 545C<Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
243 546
244=item $AnyEvent::HTTP::MAX_PERSISTENT 547=item $AnyEvent::HTTP::MAX_PERSISTENT
245 548
246The maximum number of persistent connections to keep open (default: 8). 549The maximum number of persistent connections to keep open (default: 8).
247 550
551Not implemented currently.
552
248=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT 553=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
249 554
250The maximum time to cache a persistent connection, in seconds (default: 15). 555The maximum time to cache a persistent connection, in seconds (default: 2).
556
557Not implemented currently.
558
559=item $AnyEvent::HTTP::ACTIVE
560
561The number of active connections. This is not the number of currently
562running requests, but the number of currently open and non-idle TCP
563connections. This number of can be useful for load-leveling.
251 564
252=back 565=back
253 566
254=cut 567=cut
255 568
569sub set_proxy($) {
570 $PROXY = [$2, $3 || 3128, $1] if $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix;
571}
572
573# initialise proxy from environment
574set_proxy $ENV{http_proxy};
575
256=head1 SEE ALSO 576=head1 SEE ALSO
257 577
258L<AnyEvent>. 578L<AnyEvent>.
259 579
260=head1 AUTHOR 580=head1 AUTHOR
261 581
262 Marc Lehmann <schmorp@schmorp.de> 582 Marc Lehmann <schmorp@schmorp.de>
263 http://home.schmorp.de/ 583 http://home.schmorp.de/
264 584
265=cut 585=cut
266 586
2671 5871
268 588

Diff Legend

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