… | |
… | |
49 | "http_request" returns a "cancellation guard" - you have to keep the |
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 |
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 |
51 | gets destroyed before the callbakc is called, the request will be |
52 | cancelled. |
52 | cancelled. |
53 | |
53 | |
54 | 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 |
55 | (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 |
56 | with response headers as second argument. |
56 | response headers 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" "HTTPVersion", "Status" and |
59 | response headers, the "pseudo-headers" "HTTPVersion", "Status" and |
60 | "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 |
61 | name. The pseudo-header "URL" contains the original URL (which can |
61 | name. The pseudo-header "URL" contains the original URL (which can |
… | |
… | |
64 | If the server sends a header multiple times, then their contents |
64 | If the server sends a header multiple times, then their contents |
65 | will be joined together with a comma (","), as per the HTTP spec. |
65 | will be joined together with a comma (","), as per the HTTP spec. |
66 | |
66 | |
67 | 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 |
68 | hostname, then $data will be "undef", "$headers->{Status}" will be |
68 | hostname, then $data will be "undef", "$headers->{Status}" will be |
69 | 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. |
70 | |
71 | |
71 | A typical callback might look like this: |
72 | A typical callback might look like this: |
72 | |
73 | |
73 | sub { |
74 | sub { |
74 | my ($body, $hdr) = @_; |
75 | my ($body, $hdr) = @_; |
… | |
… | |
89 | |
90 | |
90 | headers => hashref |
91 | headers => hashref |
91 | The request headers to use. Currently, "http_request" may |
92 | The request headers to use. Currently, "http_request" may |
92 | provide its own "Host:", "Content-Length:", "Connection:" and |
93 | provide its own "Host:", "Content-Length:", "Connection:" and |
93 | "Cookie:" headers and will provide defaults for "User-Agent:" |
94 | "Cookie:" headers and will provide defaults for "User-Agent:" |
94 | 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). |
95 | |
97 | |
96 | timeout => $seconds |
98 | timeout => $seconds |
97 | The time-out to use for various stages - each connect attempt |
99 | The time-out to use for various stages - each connect attempt |
98 | 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 | |
99 | timeout is 5 minutes. |
103 | Default timeout is 5 minutes. |
100 | |
104 | |
101 | proxy => [$host, $port[, $scheme]] or undef |
105 | proxy => [$host, $port[, $scheme]] or undef |
102 | Use the given http proxy for all requests. If not specified, |
106 | Use the given http proxy for all requests. If not specified, |
103 | then the default proxy (as specified by $ENV{http_proxy}) is |
107 | then the default proxy (as specified by $ENV{http_proxy}) is |
104 | used. |
108 | used. |
105 | |
109 | |
106 | $scheme must be either missing or "http" for HTTP, or "https" |
110 | $scheme must be either missing, "http" for HTTP or "https" for |
107 | for HTTPS. |
111 | HTTPS. |
108 | |
112 | |
109 | body => $string |
113 | body => $string |
110 | The request body, usually empty. Will be-sent as-is (future |
114 | The request body, usually empty. Will be-sent as-is (future |
111 | versions of this module might offer more options). |
115 | versions of this module might offer more options). |
112 | |
116 | |
… | |
… | |
115 | loosely based on the original netscape specification. |
119 | loosely based on the original netscape specification. |
116 | |
120 | |
117 | The $hash_ref must be an (initially empty) hash reference which |
121 | The $hash_ref must be an (initially empty) hash reference which |
118 | will get updated automatically. It is possible to save the |
122 | will get updated automatically. It is possible to save the |
119 | cookie_jar to persistent storage with something like JSON or |
123 | cookie_jar to persistent storage with something like JSON or |
120 | Storable, but this is not recommended, as expire times are |
124 | Storable, but this is not recommended, as expiry times are |
121 | currently being ignored. |
125 | currently being ignored. |
122 | |
126 | |
123 | Note that this cookie implementation is not of very high |
127 | Note that this cookie implementation is not of very high |
124 | quality, nor meant to be complete. If you want complete cookie |
128 | quality, nor meant to be complete. If you want complete cookie |
125 | 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 |
126 | 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. |
127 | Cookies are a privacy disaster, do not use them unless required |
131 | Cookies are a privacy disaster, do not use them unless required |
128 | 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. |
129 | |
218 | |
130 | 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/ |
131 | |
220 | |
132 | http_request GET => "http://www.nethype.de/", sub { |
221 | http_request GET => "http://www.nethype.de/", sub { |
133 | my ($body, $hdr) = @_; |
222 | my ($body, $hdr) = @_; |
… | |
… | |
165 | $AnyEvent::HTTP::MAX_RECURSE |
254 | $AnyEvent::HTTP::MAX_RECURSE |
166 | The default value for the "recurse" request parameter (default: 10). |
255 | The default value for the "recurse" request parameter (default: 10). |
167 | |
256 | |
168 | $AnyEvent::HTTP::USERAGENT |
257 | $AnyEvent::HTTP::USERAGENT |
169 | The default value for the "User-Agent" header (the default is |
258 | The default value for the "User-Agent" header (the default is |
170 | "Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; |
259 | "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; |
171 | +http://software.schmorp.de/pkg/AnyEvent)"). |
260 | +http://software.schmorp.de/pkg/AnyEvent)"). |
172 | |
261 | |
173 | $AnyEvent::HTTP::MAX_PERSISTENT |
262 | $AnyEvent::HTTP::MAX_PER_HOST |
174 | The maximum number of persistent connections to keep open (default: |
263 | The maximum number of concurrent connections to the same host |
175 | 8). |
264 | (identified by the hostname). If the limit is exceeded, then the |
|
|
265 | additional requests are queued until previous connections are |
|
|
266 | closed. |
176 | |
267 | |
177 | Not implemented currently. |
268 | The default value for this is 4, and it is highly advisable to not |
178 | |
269 | increase it. |
179 | $AnyEvent::HTTP::PERSISTENT_TIMEOUT |
|
|
180 | The maximum time to cache a persistent connection, in seconds |
|
|
181 | (default: 2). |
|
|
182 | |
|
|
183 | Not implemented currently. |
|
|
184 | |
270 | |
185 | $AnyEvent::HTTP::ACTIVE |
271 | $AnyEvent::HTTP::ACTIVE |
186 | The number of active connections. This is not the number of |
272 | The number of active connections. This is not the number of |
187 | currently running requests, but the number of currently open and |
273 | currently running requests, but the number of currently open and |
188 | non-idle TCP connections. This number of can be useful for |
274 | non-idle TCP connections. This number of can be useful for |
… | |
… | |
193 | |
279 | |
194 | AUTHOR |
280 | AUTHOR |
195 | Marc Lehmann <schmorp@schmorp.de> |
281 | Marc Lehmann <schmorp@schmorp.de> |
196 | http://home.schmorp.de/ |
282 | http://home.schmorp.de/ |
197 | |
283 | |
|
|
284 | With many thanks to Дмитрий Шалашов, who provided |
|
|
285 | countless testcases and bugreports. |
|
|
286 | |