cancel_request(RequestId) ->
cancel_request(RequestId, Profile) -> ok
Types
When started
stand_alone
only the pid can be used.
Cancels an asynchronous HTTP request. Notice that this does not guarantee that the request response is not delivered. Because it is asynchronous, the request can already have been completed when the cancellation arrives.
Types
When started
stand_alone
.
Returns the cookie header that would have been sent when making a request to Url
using profile Profile
. If no profile is specified, the default profile is used.
Option ipv6_host_with_bracket
deals with how to parse IPv6 addresses. For details, see argument Options
of request/[4,5]
.
get_options(OptionItems) -> {ok, Values} | {error, Reason}
get_options(OptionItems, Profile) -> {ok, Values} | {error, Reason}
Types
When started
stand_alone
only the pid can used.
Retrieves the options currently used by the client.
info() -> list()
info(Profile) -> list()
Types
When started
stand_alone
only the pid can be used.
Produces a list of miscellaneous information. Intended for debugging. If no profile is specified, the default profile is used.
reset_cookies() -> void()
reset_cookies(Profile) -> void()
Types
When started
stand_alone
only the pid can be used.
Resets (clears) the cookie database for the specified Profile
. If no profile is specified the default profile is used.
request(Url) ->
request(Url, Profile) -> {ok, Result} | {error, Reason}
Types
When started
stand_alone
only the pid can be used.
Equivalent to httpc:request(get, {Url, []}, [], [])
.
request(Method, Request, HTTPOptions, Options) ->
request(Method, Request, HTTPOptions, Options, Profile) -> {ok, Result} | {ok, saved_to_file} | {error, Reason}
Types
When started
stand_alone
only the pid can be used.
Sends an HTTP request. The function can be both synchronous and asynchronous. In the latter case, the function returns {ok, RequestId}
and then the information is delivered to the receiver
depending on that value.
HTTP option (http_option()
) details:
timeout
-
Time-out time for the request.
The clock starts ticking when the request is sent.
Time is in milliseconds.
Default is infinity
.
connect_timeout
-
Connection time-out time, used during the initial request, when the client is connecting to the server.
Time is in milliseconds.
Default is the value of option timeout
.
ssl
-
This is the SSL/TLS
connectin configuration option.
Defaults to []
. See ssl:connect/[2,3,4]
for available options.
autoredirect
-
The client automatically retrieves the information from the new URI and returns that as the result, instead of a 30X-result code.
For some 30X-result codes, automatic redirect is not allowed. In these cases the 30X-result is always returned.
Default is true
.
proxy_auth
-
A proxy-authorization header using the provided username and password is added to the request.
version
-
Can be used to make the client act as an HTTP/1.0
or HTTP/0.9
client. By default this is an HTTP/1.1
client. When using HTTP/1.0
persistent connections are not used.
Default is the string "HTTP/1.1"
.
relaxed
-
If set to true
, workarounds for known server deviations from the HTTP-standard are enabled.
Default is false
.
Option (option()
) details:
sync
-
Option for the request to be synchronous or asynchronous.
Default is true
.
stream
-
Streams the body of a 200 or 206 response to the calling process or to a file. When streaming to the calling process using option self
, the following stream messages are sent to that process: {http, {RequestId, stream_start, Headers}}, {http, {RequestId, stream, BinBodyPart}}, and {http, {RequestId, stream_end, Headers}}
.
When streaming to the calling processes using option {self, once}
, the first message has an extra element, that is, {http, {RequestId, stream_start, Headers, Pid}}
. This is the process id to be used as an argument to httpc:stream_next/1
to trigger the next message to be sent to the calling process.
Notice that chunked encoding can add headers so that there are more headers in the stream_end
message than in stream_start
. When streaming to a file and the request is asynchronous, the message {http, {RequestId, saved_to_file}}
is sent.
Default is none
.
body_format
-
Defines if the body is to be delivered as a string or binary. This option is only valid for the synchronous request.
Default is string
.
full_result
-
Defines if a "full result" is to be returned to the caller (that is, the body, the headers, and the entire status line) or not (the body and the status code).
Default is true
.
headers_as_is
-
Defines if the headers provided by the user are to be made lower case or to be regarded as case sensitive.
The HTTP standard requires them to be case insensitive. Use this feature only if there is no other way to communicate with the server or for testing purpose. When this option is used, no headers are automatically added. All necessary headers must be provided by the user.
Default is false
.
socket_opts
-
Socket options to be used for this request.
Overrides any value set by function set_options
.
The validity of the options is not checked by the HTTP client they are assumed to be correct and passed on to ssl application and inet driver, which may reject them if they are not correct.
Note
Persistent connections are not supported when setting the socket_opts
option. When socket_opts
is not set the current implementation assumes the requests to the same host, port combination will use the same socket options.
By default the socket options set by function set_options/[1,2]
are used when establishing a connection.
receiver
-
Defines how the client delivers the result of an asynchronous request (sync
has the value false
).
pid()
-
Messages are sent to this process in the format {http, ReplyInfo}
.
function/1
-
Information is delivered to the receiver through calls to the provided fun Receiver(ReplyInfo)
.
{Module, Function, Args}
-
Information is delivered to the receiver through calls to the callback function apply(Module, Function, [ReplyInfo | Args])
.
In all of these cases, ReplyInfo
has the following structure:
{RequestId, saved_to_file}
{RequestId, {error, Reason}}
{RequestId, Result}
{RequestId, stream_start, Headers}
{RequestId, stream_start, Headers, HandlerPid}
{RequestId, stream, BinBodyPart}
{RequestId, stream_end, Headers}
Default is the pid
of the process calling the request function (self()
).
ipv6_host_with_brackets
-
Defines when parsing the Host-Port part of an URI with an IPv6 address with brackets, if those brackets are to be retained (true
) or stripped (false
).
Default is false
.
set_options(Options) ->
set_options(Options, Profile) -> ok | {error, Reason}
Types
Example: "localhost" or "foo.bar.se"
Example: 8080
Example: "*.ericsson.se"
Example: "134.138" or "[FEDC:BA98" (all IP addresses starting with 134.138 or FEDC:BA98), "66.35.250.150" or "[2010:836B:4179::836B:4179]" (a complete IP address).
proxy
defaults to
{undefined, []}
, that is, no proxy is configured and
https_proxy
defaults to the value of
proxy
. Maximum number of persistent connections to a host. Default is
2
. Maximum number of outstanding requests on the same connection to a host. Default is
5
. If a persistent connection is idle longer than the
keep_alive_timeout
in milliseconds, the client closes the connection. The server can also have such a time-out but do not take that for granted. Default is
120000
(= 2 min). Maximum number of outstanding requests on a pipelined connection to a host. Default is
2
. If a persistent connection is idle longer than the
pipeline_timeout
in milliseconds, the client closes the connection. Default is
0
, which results in pipelining not being used. If cookies are enabled, all valid cookies are automatically saved in the cookie database of the client manager. If option
verify
is used, function
store_cookies/2
has to be called for the cookies to be saved. Default is
disabled
. Default is
inet
. If the host has several network interfaces, this option specifies which one to use. See
gen_tcp:connect/3,4
for details. Local port number to use. See
gen_tcp:connect/3,4
for details. The options are appended to the socket options used by the client. These are the default values when a new request handler is started (for the initial connect). They are passed directly to the underlying transport (
gen_tcp
or
SSL
)
without verification. Default is
false
. This option is used to switch on (or off) different levels of Erlang trace on the client. It is a debug feature. When started
stand_alone
only the pid can be used. Experimental option for sending HTTP requests over a unix domain socket. The value of
unix_socket
shall be the full path to a unix domain socket file with read/write permissions for the erlang process. Default is
undefined
.
Sets options to be used for subsequent requests.
Note
If possible, the client keeps its connections alive and uses persistent connections with or without pipeline depending on configuration and current circumstances. The HTTP/1.1 specification does not provide a guideline for how many requests that are ideal to be sent on a persistent connection. This depends much on the application.
A long queue of requests can cause a user-perceived delay, as earlier requests can take a long time to complete. The HTTP/1.1 specification suggests a limit of two persistent connections per server, which is the default value of option max_sessions
.
The current implementation assumes the requests to the same host, port combination will use the same socket options.
store_cookies(SetCookieHeaders, Url) ->
store_cookies(SetCookieHeaders, Url, Profile) -> ok | {error, Reason}
Types
When started
stand_alone
only the pid can be used.
Saves the cookies defined in SetCookieHeaders
in the client profile cookie database. Call this function if option cookies
is set to verify
. If no profile is specified, the default profile is used.
stream_next(Pid) -> ok
Types
As received in the
stream_start message
Triggers the next message to be streamed, that is, the same behavior as active ones for sockets.
which_cookies() -> cookies()
which_cookies(Profile) -> cookies()
Types
When started
stand_alone
only the pid can be used.
Produces a list of the entire cookie database. Intended for debugging/testing purposes. If no profile is specified, the default profile is used.
which_sessions() -> session_info()
which_sessions(Profile) -> session_info()
Types
When started
stand_alone
only the pid can be used.
Produces a slightly processed dump of the session database. It is intended for debugging. If no profile is specified, the default profile is used.