From 474dfaf674ac8746367ff856534ef0b63afc6307 Mon Sep 17 00:00:00 2001 From: Ingela Anderton Andin Date: Tue, 1 Sep 2015 17:32:34 +0200 Subject: inets: Align with alphabetical order and clean local anchor handling Functions in the same module can be referenced as #Function-Arity, no need to make special markers for them. --- lib/inets/doc/src/httpc.xml | 255 +++++++++++++++++++++----------------------- 1 file changed, 119 insertions(+), 136 deletions(-) (limited to 'lib/inets/doc/src/httpc.xml') diff --git a/lib/inets/doc/src/httpc.xml b/lib/inets/doc/src/httpc.xml index 70400d1ca7..9a24226e78 100644 --- a/lib/inets/doc/src/httpc.xml +++ b/lib/inets/doc/src/httpc.xml @@ -146,11 +146,112 @@

The client can be stopped using inets:stop(httpc, Pid) or inets:stop(httpc, Profile).

- - + + + cancel_request(RequestId) -> + cancel_request(RequestId, Profile) -> ok + Cancels an asynchronous HTTP request. + + RequestId = request_id() - A unique identifier as returned + by request/4 + Profile = profile() | pid() + When started stand_alone. + + +

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. +

+ + + + + cookie_header(Url) -> + cookie_header(Url, Profile | Opts) -> header() | {error, Reason} + cookie_header(Url, Opts, Profile) -> header() | {error, Reason} + Returns the cookie header that would have been sent when + making a request to URL using the profile Profile. + + Url = url() + Opts = [cookie_header_opt()] + Profile = profile() | pid() + When started stand_alone. + cookie_header_opt() = {ipv6_host_with_brackets, boolean()} + + +

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} + Gets the currently used options. + + OptionItems = all | [option_item()] + option_item() = proxy | + https_proxy + max_sessions | + keep_alive_timeout | + max_keep_alive_length | + pipeline_timeout | + max_pipeline_length | + cookies | + ipfamily | + ip | + port | + socket_opts | + verbose + Profile = profile() | pid( + When started stand_alone. + Values = [{option_item(), term()}] + Reason = term() + + +

Retrieves the options currently used by the client.

+ + + + + info() -> list() + info(Profile) -> list() + Produces a list of miscellaneous information. + + Profile = profile() | pid() + When started stand_alone. + + +

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() + Resets the cookie database. + + Profile = profile() | pid() + When started stand_alone. + + +

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} @@ -166,8 +267,6 @@

Equivalent to httpc:request(get, {Url, []}, [], []).

- - @@ -353,7 +452,7 @@

Socket options to be used for this and subsequent requests.

Overrides any value set by function - set_options.

+ set_options.

The validity of the options is not checked in any way.

Notice that this can change the socket behavior @@ -361,7 +460,7 @@ for an already existing one, and therefore an already connected request handler.

By default the socket options set by function - set_options/1,2 + set_options/[1,2] are used when establishing a connection.

@@ -418,31 +517,10 @@ - - - - - - - cancel_request(RequestId) -> - cancel_request(RequestId, Profile) -> ok - Cancels an asynchronous HTTP request. - - RequestId = request_id() - A unique identifier as returned - by request/4 - Profile = profile() | pid() - When started stand_alone. - - -

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. -

- - + set_options(Options) -> set_options(Options, Profile) -> ok | {error, Reason} @@ -554,56 +632,7 @@ - - - get_options(OptionItems) -> {ok, Values} | {error, Reason} - get_options(OptionItems, Profile) -> {ok, Values} | {error, Reason} - Gets the currently used options. - - OptionItems = all | [option_item()] - option_item() = proxy | - https_proxy - max_sessions | - keep_alive_timeout | - max_keep_alive_length | - pipeline_timeout | - max_pipeline_length | - cookies | - ipfamily | - ip | - port | - socket_opts | - verbose - Profile = profile() | pid( - When started stand_alone. - Values = [{option_item(), term()}] - Reason = term() - - -

Retrieves the options currently used by the client.

- - - - - - - stream_next(Pid) -> ok - Triggers the next message to be streamed, that is, - the same behavior as active ones for sockets. - - - Pid = pid() - As received in the stream_start message - - -

Triggers the next message to be streamed, that is, - the same behavior as active ones for sockets.

- - - - - - + store_cookies(SetCookieHeaders, Url) -> store_cookies(SetCookieHeaders, Url, Profile) -> ok | {error, Reason} @@ -620,56 +649,27 @@ 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.

- - - - - - - cookie_header(Url) -> - cookie_header(Url, Profile | Opts) -> header() | {error, Reason} - cookie_header(Url, Opts, Profile) -> header() | {error, Reason} - Returns the cookie header that would have been sent when - making a request to URL using the profile Profile. - - Url = url() - Opts = [cookie_header_opt()] - Profile = profile() | pid() - When started stand_alone. - cookie_header_opt() = {ipv6_host_with_brackets, boolean()} - - -

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.

- - - - reset_cookies() -> void() - reset_cookies(Profile) -> void() - Resets the cookie database. + stream_next(Pid) -> ok + Triggers the next message to be streamed, that is, + the same behavior as active ones for sockets. + - Profile = profile() | pid() - When started stand_alone. + Pid = pid() + As received in the stream_start message -

Resets (clears) the cookie database for the specified - Profile. If no profile is specified the default profile - is used.

+

Triggers the next message to be streamed, that is, + the same behavior as active ones for sockets.

- + + - - + which_cookies() -> cookies() which_cookies(Profile) -> cookies() @@ -686,8 +686,6 @@

Produces a list of the entire cookie database. Intended for debugging/testing purposes. If no profile is specified, the default profile is used.

- - @@ -707,25 +705,10 @@

Produces a slightly processed dump of the session database. It is intended for debugging. If no profile is specified, the default profile is used.

- - - - info() -> list() - info(Profile) -> list() - Produces a list of miscellaneous information. - - Profile = profile() | pid() - When started stand_alone. - - -

Produces a list of miscellaneous information. - Intended for debugging. - If no profile is specified, the default profile is used.

- - +
-- cgit v1.2.3