… | |
… | |
28 | limited support. |
28 | limited support. |
29 | |
29 | |
30 | METHODS |
30 | METHODS |
31 | http_get $url, key => value..., $cb->($data, $headers) |
31 | http_get $url, key => value..., $cb->($data, $headers) |
32 | Executes an HTTP-GET request. See the http_request function for |
32 | Executes an HTTP-GET request. See the http_request function for |
33 | details on additional parameters. |
33 | details on additional parameters and the return value. |
34 | |
34 | |
35 | http_head $url, key => value..., $cb->($data, $headers) |
35 | http_head $url, key => value..., $cb->($data, $headers) |
36 | Executes an HTTP-HEAD request. See the http_request function for |
36 | Executes an HTTP-HEAD request. See the http_request function for |
37 | details on additional parameters. |
37 | details on additional parameters and the return value. |
38 | |
38 | |
39 | http_post $url, $body, key => value..., $cb->($data, $headers) |
39 | http_post $url, $body, key => value..., $cb->($data, $headers) |
40 | Executes an HTTP-POST request with a request body of $bod. See the |
40 | Executes an HTTP-POST request with a request body of $body. See the |
41 | http_request function for details on additional parameters. |
41 | http_request function for details on additional parameters and the |
|
|
42 | return value. |
42 | |
43 | |
43 | http_request $method => $url, key => value..., $cb->($data, $headers) |
44 | http_request $method => $url, key => value..., $cb->($data, $headers) |
44 | Executes a HTTP request of type $method (e.g. "GET", "POST"). The |
45 | Executes a HTTP request of type $method (e.g. "GET", "POST"). The |
45 | URL must be an absolute http or https URL. |
46 | URL must be an absolute http or https URL. |
46 | |
47 | |
|
|
48 | When called in void context, nothing is returned. In other contexts, |
|
|
49 | "http_request" returns a "cancellation guard" - you have to keep the |
|
|
50 | object at least alive until the callback get called. If the object |
|
|
51 | gets destroyed before the callbakc is called, the request will be |
|
|
52 | cancelled. |
|
|
53 | |
47 | The callback will be called with the response data as first argument |
54 | The callback will be called with the response body data as first |
48 | (or "undef" if it wasn't available due to errors), and a hash-ref |
55 | argument (or "undef" if an error occured), and a hash-ref with |
49 | with response headers as second argument. |
56 | response headers as second argument. |
50 | |
57 | |
51 | 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 |
52 | response headers, the "pseudo-headers" "HTTPVersion", "Status" and |
59 | response headers, the "pseudo-headers" "HTTPVersion", "Status" and |
53 | "Reason" contain the three parts of the HTTP Status-Line of the same |
60 | "Reason" contain the three parts of the HTTP Status-Line of the same |
54 | name. The pseudo-header "URL" contains the original URL (which can |
61 | name. The pseudo-header "URL" contains the original URL (which can |
55 | differ from the requested URL when following redirects). |
62 | differ from the requested URL when following redirects). |
56 | |
63 | |
57 | If the server sends a header multiple lines, then their contents |
64 | If the server sends a header multiple times, then their contents |
58 | will be joined together with "\x00". |
65 | will be joined together with a comma (","), as per the HTTP spec. |
59 | |
66 | |
60 | If an internal error occurs, such as not being able to resolve a |
67 | If an internal error occurs, such as not being able to resolve a |
61 | hostname, then $data will be "undef", "$headers->{Status}" will be |
68 | hostname, then $data will be "undef", "$headers->{Status}" will be |
62 | 599 and the "Reason" pseudo-header will contain an error message. |
69 | "59x" (usually 599) and the "Reason" pseudo-header will contain an |
|
|
70 | error message. |
63 | |
71 | |
64 | A typical callback might look like this: |
72 | A typical callback might look like this: |
65 | |
73 | |
66 | sub { |
74 | sub { |
67 | my ($body, $hdr) = @_; |
75 | my ($body, $hdr) = @_; |
… | |
… | |
82 | |
90 | |
83 | headers => hashref |
91 | headers => hashref |
84 | The request headers to use. Currently, "http_request" may |
92 | The request headers to use. Currently, "http_request" may |
85 | provide its own "Host:", "Content-Length:", "Connection:" and |
93 | provide its own "Host:", "Content-Length:", "Connection:" and |
86 | "Cookie:" headers and will provide defaults for "User-Agent:" |
94 | "Cookie:" headers and will provide defaults for "User-Agent:" |
87 | and "Referer:". |
95 | and "Referer:" (this can be suppressed by using "undef" for |
|
|
96 | these headers in which case they won't be sent at all). |
88 | |
97 | |
89 | timeout => $seconds |
98 | timeout => $seconds |
90 | The time-out to use for various stages - each connect attempt |
99 | The time-out to use for various stages - each connect attempt |
91 | will reset the timeout, as will read or write activity. Default |
100 | will reset the timeout, as will read or write activity, i.e. |
|
|
101 | this is not an overall timeout. |
|
|
102 | |
92 | timeout is 5 minutes. |
103 | Default timeout is 5 minutes. |
93 | |
104 | |
94 | proxy => [$host, $port[, $scheme]] or undef |
105 | proxy => [$host, $port[, $scheme]] or undef |
95 | Use the given http proxy for all requests. If not specified, |
106 | Use the given http proxy for all requests. If not specified, |
96 | then the default proxy (as specified by $ENV{http_proxy}) is |
107 | then the default proxy (as specified by $ENV{http_proxy}) is |
97 | used. |
108 | used. |
98 | |
109 | |
99 | $scheme must be either missing or "http" for HTTP, or "https" |
110 | $scheme must be either missing, "http" for HTTP or "https" for |
100 | for HTTPS. |
111 | HTTPS. |
101 | |
112 | |
102 | body => $string |
113 | body => $string |
103 | The request body, usually empty. Will be-sent as-is (future |
114 | The request body, usually empty. Will be-sent as-is (future |
104 | versions of this module might offer more options). |
115 | versions of this module might offer more options). |
105 | |
116 | |
… | |
… | |
108 | loosely based on the original netscape specification. |
119 | loosely based on the original netscape specification. |
109 | |
120 | |
110 | The $hash_ref must be an (initially empty) hash reference which |
121 | The $hash_ref must be an (initially empty) hash reference which |
111 | will get updated automatically. It is possible to save the |
122 | will get updated automatically. It is possible to save the |
112 | cookie_jar to persistent storage with something like JSON or |
123 | cookie_jar to persistent storage with something like JSON or |
113 | Storable, but this is not recommended, as expire times are |
124 | Storable, but this is not recommended, as expiry times are |
114 | currently being ignored. |
125 | currently being ignored. |
115 | |
126 | |
116 | Note that this cookie implementation is not of very high |
127 | Note that this cookie implementation is not of very high |
117 | quality, nor meant to be complete. If you want complete cookie |
128 | quality, nor meant to be complete. If you want complete cookie |
118 | management you have to do that on your own. "cookie_jar" is |
129 | management you have to do that on your own. "cookie_jar" is |
119 | meant as a quick fix to get some cookie-using sites working. |
130 | meant as a quick fix to get some cookie-using sites working. |
120 | Cookies are a privacy disaster, do not use them unless required |
131 | Cookies are a privacy disaster, do not use them unless required |
121 | to. |
132 | to. |
|
|
133 | |
|
|
134 | tls_ctx => $scheme | $tls_ctx |
|
|
135 | Specifies the AnyEvent::TLS context to be used for https |
|
|
136 | connections. This parameter follows the same rules as the |
|
|
137 | "tls_ctx" parameter to AnyEvent::Handle, but additionally, the |
|
|
138 | two strings "low" or "high" can be specified, which give you a |
|
|
139 | predefined low-security (no verification, highest compatibility) |
|
|
140 | and high-security (CA and common-name verification) TLS context. |
|
|
141 | |
|
|
142 | The default for this option is "low", which could be interpreted |
|
|
143 | as "give me the page, no matter what". |
|
|
144 | |
|
|
145 | on_prepare => $callback->($fh) |
|
|
146 | In rare cases you need to "tune" the socket before it is used to |
|
|
147 | connect (for exmaple, to bind it on a given IP address). This |
|
|
148 | parameter overrides the prepare callback passed to |
|
|
149 | "AnyEvent::Socket::tcp_connect" and behaves exactly the same way |
|
|
150 | (e.g. it has to provide a timeout). See the description for the |
|
|
151 | $prepare_cb argument of "AnyEvent::Socket::tcp_connect" for |
|
|
152 | details. |
|
|
153 | |
|
|
154 | on_header => $callback->($headers) |
|
|
155 | When specified, this callback will be called with the header |
|
|
156 | hash as soon as headers have been successfully received from the |
|
|
157 | remote server (not on locally-generated errors). |
|
|
158 | |
|
|
159 | It has to return either true (in which case AnyEvent::HTTP will |
|
|
160 | continue), or false, in which case AnyEvent::HTTP will cancel |
|
|
161 | the download (and call the finish callback with an error code of |
|
|
162 | 598). |
|
|
163 | |
|
|
164 | This callback is useful, among other things, to quickly reject |
|
|
165 | unwanted content, which, if it is supposed to be rare, can be |
|
|
166 | faster than first doing a "HEAD" request. |
|
|
167 | |
|
|
168 | Example: cancel the request unless the content-type is |
|
|
169 | "text/html". |
|
|
170 | |
|
|
171 | on_header => sub { |
|
|
172 | $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/ |
|
|
173 | }, |
|
|
174 | |
|
|
175 | on_body => $callback->($partial_body, $headers) |
|
|
176 | When specified, all body data will be passed to this callback |
|
|
177 | instead of to the completion callback. The completion callback |
|
|
178 | will get the empty string instead of the body data. |
|
|
179 | |
|
|
180 | It has to return either true (in which case AnyEvent::HTTP will |
|
|
181 | continue), or false, in which case AnyEvent::HTTP will cancel |
|
|
182 | the download (and call the completion callback with an error |
|
|
183 | code of 598). |
|
|
184 | |
|
|
185 | This callback is useful when the data is too large to be held in |
|
|
186 | memory (so the callback writes it to a file) or when only some |
|
|
187 | information should be extracted, or when the body should be |
|
|
188 | processed incrementally. |
|
|
189 | |
|
|
190 | It is usually preferred over doing your own body handling via |
|
|
191 | "want_body_handle", but in case of streaming APIs, where HTTP is |
|
|
192 | only used to create a connection, "want_body_handle" is the |
|
|
193 | better alternative, as it allows you to install your own event |
|
|
194 | handler, reducing resource usage. |
|
|
195 | |
|
|
196 | want_body_handle => $enable |
|
|
197 | When enabled (default is disabled), the behaviour of |
|
|
198 | AnyEvent::HTTP changes considerably: after parsing the headers, |
|
|
199 | and instead of downloading the body (if any), the completion |
|
|
200 | callback will be called. Instead of the $body argument |
|
|
201 | containing the body data, the callback will receive the |
|
|
202 | AnyEvent::Handle object associated with the connection. In error |
|
|
203 | cases, "undef" will be passed. When there is no body (e.g. |
|
|
204 | status 304), the empty string will be passed. |
|
|
205 | |
|
|
206 | The handle object might or might not be in TLS mode, might be |
|
|
207 | connected to a proxy, be a persistent connection etc., and |
|
|
208 | configured in unspecified ways. The user is responsible for this |
|
|
209 | handle (it will not be used by this module anymore). |
|
|
210 | |
|
|
211 | This is useful with some push-type services, where, after the |
|
|
212 | initial headers, an interactive protocol is used (typical |
|
|
213 | example would be the push-style twitter API which starts a |
|
|
214 | JSON/XML stream). |
|
|
215 | |
|
|
216 | If you think you need this, first have a look at "on_body", to |
|
|
217 | see if that doesn't solve your problem in a better way. |
122 | |
218 | |
123 | Example: make a simple HTTP GET request for http://www.nethype.de/ |
219 | Example: make a simple HTTP GET request for http://www.nethype.de/ |
124 | |
220 | |
125 | http_request GET => "http://www.nethype.de/", sub { |
221 | http_request GET => "http://www.nethype.de/", sub { |
126 | my ($body, $hdr) = @_; |
222 | my ($body, $hdr) = @_; |
… | |
… | |
138 | use Data::Dumper; |
234 | use Data::Dumper; |
139 | print Dumper $hdr; |
235 | print Dumper $hdr; |
140 | } |
236 | } |
141 | ; |
237 | ; |
142 | |
238 | |
|
|
239 | Example: make another simple HTTP GET request, but immediately try |
|
|
240 | to cancel it. |
|
|
241 | |
|
|
242 | my $request = http_request GET => "http://www.nethype.de/", sub { |
|
|
243 | my ($body, $hdr) = @_; |
|
|
244 | print "$body\n"; |
|
|
245 | }; |
|
|
246 | |
|
|
247 | undef $request; |
|
|
248 | |
143 | GLOBAL FUNCTIONS AND VARIABLES |
249 | GLOBAL FUNCTIONS AND VARIABLES |
144 | AnyEvent::HTTP::set_proxy "proxy-url" |
250 | AnyEvent::HTTP::set_proxy "proxy-url" |
145 | Sets the default proxy server to use. The proxy-url must begin with |
251 | Sets the default proxy server to use. The proxy-url must begin with |
146 | a string of the form "http://host:port" (optionally "https:..."). |
252 | a string of the form "http://host:port" (optionally "https:..."), |
|
|
253 | croaks otherwise. |
|
|
254 | |
|
|
255 | To clear an already-set proxy, use "undef". |
147 | |
256 | |
148 | $AnyEvent::HTTP::MAX_RECURSE |
257 | $AnyEvent::HTTP::MAX_RECURSE |
149 | The default value for the "recurse" request parameter (default: 10). |
258 | The default value for the "recurse" request parameter (default: 10). |
150 | |
259 | |
151 | $AnyEvent::HTTP::USERAGENT |
260 | $AnyEvent::HTTP::USERAGENT |
152 | The default value for the "User-Agent" header (the default is |
261 | The default value for the "User-Agent" header (the default is |
153 | "Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; |
262 | "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; |
154 | +http://software.schmorp.de/pkg/AnyEvent)"). |
263 | +http://software.schmorp.de/pkg/AnyEvent)"). |
155 | |
264 | |
156 | $AnyEvent::HTTP::MAX_PERSISTENT |
265 | $AnyEvent::HTTP::MAX_PER_HOST |
157 | The maximum number of persistent connections to keep open (default: |
266 | The maximum number of concurrent connections to the same host |
158 | 8). |
267 | (identified by the hostname). If the limit is exceeded, then the |
|
|
268 | additional requests are queued until previous connections are |
|
|
269 | closed. |
159 | |
270 | |
160 | Not implemented currently. |
271 | The default value for this is 4, and it is highly advisable to not |
161 | |
272 | increase it. |
162 | $AnyEvent::HTTP::PERSISTENT_TIMEOUT |
|
|
163 | The maximum time to cache a persistent connection, in seconds |
|
|
164 | (default: 2). |
|
|
165 | |
|
|
166 | Not implemented currently. |
|
|
167 | |
273 | |
168 | $AnyEvent::HTTP::ACTIVE |
274 | $AnyEvent::HTTP::ACTIVE |
169 | The number of active connections. This is not the number of |
275 | The number of active connections. This is not the number of |
170 | currently running requests, but the number of currently open and |
276 | currently running requests, but the number of currently open and |
171 | non-idle TCP connections. This number of can be useful for |
277 | non-idle TCP connections. This number of can be useful for |
… | |
… | |
176 | |
282 | |
177 | AUTHOR |
283 | AUTHOR |
178 | Marc Lehmann <schmorp@schmorp.de> |
284 | Marc Lehmann <schmorp@schmorp.de> |
179 | http://home.schmorp.de/ |
285 | http://home.schmorp.de/ |
180 | |
286 | |
|
|
287 | With many thanks to Дмитрий Шалашов, who provided |
|
|
288 | countless testcases and bugreports. |
|
|
289 | |