2004 2010 Ericsson AB. All Rights Reserved.
The contents of this file are subject to the Erlang Public License, Version 1.1, (the "License"); you may not use this file except in compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License.

HTTP Client

Ingela Anderton Andin
http_client.xml

## Introduction

The HTTP client default profile will be started when the inets application is started and is then available to all processes on that erlang node. Other profiles may also be started at application startup, or profiles can be started and stopped dynamically in runtime. Each client profile will spawn a new process to handle each request unless there is a possibility to use a persistent connection with or without pipelining. The client will add a host header and an empty te header if there are no such headers present in the request.

The client supports ipv6 as long as the underlying mechanisms also do so.

## Configuration

What to put in the erlang node application configuration file in order to start a profile at application startup.

          [{inets, [{services, [{httpc, PropertyList}]}]}]

For valid properties see httpc(3).

## Using the HTTP Client API

`1 > inets:start(). ok`

The following calls uses the default client profile. Use the proxy "www-proxy.mycompany.com:8000", but not for requests to localhost. This will apply to all subsequent requests

`2 > httpc:set_options([{proxy, {{"www-proxy.mycompany.com", 8000}, ["localhost"]}}]). ok`

An ordinary synchronous request.

`3 > {ok, {{Version, 200, ReasonPhrase}, Headers, Body}} = httpc:request(get, {"http://www.erlang.org", []}, [], []).`

With all default values, as above, a get request can also be written like this.

`4 > {ok, {{Version, 200, ReasonPhrase}, Headers, Body}} = httpc:request("http://www.erlang.org").`

An ordinary asynchronous request. The result will be sent to the calling process in the form {http, {ReqestId, Result}}

`5 > {ok, RequestId} = httpc:request(get, {"http://www.erlang.org", []}, [], [{sync, false}]).`

In this case the calling process is the shell, so we receive the result.

`6 > receive {http, {RequestId, Result}} -> ok after 500 -> error end. ok`

Send a request with a specified connection header.

`7 > {ok, {{NewVersion, 200, NewReasonPhrase}, NewHeaders, NewBody}} = httpc:request(get, {"http://www.erlang.org", [{"connection", "close"}]}, [], []).`

Start a HTTP client profile.

`8 > {ok, Pid} = inets:start(httpc, [{profile, foo}]). {ok, <0.45.0>}`

The new profile has no proxy settings so the connection will be refused

`9 > httpc:request("http://www.erlang.org", foo). {error, econnrefused}`

Stop a HTTP client profile.

`10 > inets:stop(httpc, foo). ok`

Alternatively:

`10 > inets:stop(httpc, Pid). ok`