From 76ffc030fc320d436b0a540a20783d5d317ae761 Mon Sep 17 00:00:00 2001 From: Micael Karlberg Date: Tue, 22 May 2012 18:05:07 +0200 Subject: [inets/httpc] Updated docs, release notes and appup Added documentation for new (httpc:which_sessions/0,1) and updated (httpc:info/0,1) functions. Also updated appup. OTP-10093 --- lib/inets/doc/src/httpc.xml | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) (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 70c845bade..0e6abf3c65 100644 --- a/lib/inets/doc/src/httpc.xml +++ b/lib/inets/doc/src/httpc.xml @@ -648,6 +648,8 @@ apply(Module, Function, [ReplyInfo | Args])

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

+ + @@ -667,6 +669,42 @@ apply(Module, Function, [ReplyInfo | Args])

This function produces a list of the entire cookie database. It is intended for debugging/testing purposes. If no profile is specified the default profile will be used.

+ + + + + + + which_sessions() -> session_info() + which_sessions(Profile) -> session_info() + Produces a slightly processed dump of the sessions database. + + Profile = profile() | pid() (when started stand_alone) + session_info() = {GoodSessions, BadSessions, NonSessions} + GoodSessions = session() + BadSessions = tuple() + NonSessions = term() + + +

This function produces a slightly processed dump of the session + database. It is intended for debugging. + If no profile is specified the default profile will be used.

+ + + + + + + info() -> list() + info(Profile) -> list() + Produces a list of miscelleneous info + + Profile = profile() | pid() (when started stand_alone) + + +

This function produces a list of miscelleneous info. + It is intended for debugging. + If no profile is specified the default profile will be used.

-- cgit v1.2.3 From 1bc041bd68040220081e8af275701f92f4a07aae Mon Sep 17 00:00:00 2001 From: Jesper Louis Andersen Date: Fri, 8 Jun 2012 19:18:06 +0200 Subject: Elaborate on timeouts in the httpc documentation All timeouts are in milliseconds. Reflect this in the documentation so it is explicit that it is so. --- lib/inets/doc/src/httpc.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 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 70c845bade..f032ac96e1 100644 --- a/lib/inets/doc/src/httpc.xml +++ b/lib/inets/doc/src/httpc.xml @@ -488,7 +488,7 @@ apply(Module, Function, [ReplyInfo | Args]) KeepAliveTimeout = integer() Default is 120000 (= 2 min). If a persistent connection is idle longer than the - keep_alive_timeout the client will close the connection. + keep_alive_timeout in milliseconds, the client will close the connection. The server may also have such a time out but you should not count on it! MaxPipeline = integer() @@ -498,7 +498,7 @@ apply(Module, Function, [ReplyInfo | Args]) Default is 0, which will result in pipelining not being used. If a persistent connection is idle longer than the - pipeline_timeout the client will close the connection. + pipeline_timeout in milliseconds the client will close the connection. CookieMode = enabled | disabled | verify Default is disabled. If Cookies are enabled all valid cookies will automatically be -- cgit v1.2.3 From 134eb88158b5ccb49afc054091deea38580e9f86 Mon Sep 17 00:00:00 2001 From: Micael Karlberg Date: Thu, 14 Jun 2012 12:56:25 +0200 Subject: Added missing comma and set proper version --- lib/inets/doc/src/httpc.xml | 105 +++++++++++++++++++++++--------------------- 1 file changed, 54 insertions(+), 51 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 f032ac96e1..f4d3b97122 100644 --- a/lib/inets/doc/src/httpc.xml +++ b/lib/inets/doc/src/httpc.xml @@ -480,66 +480,69 @@ apply(Module, Function, [ReplyInfo | Args]) ex: "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). MaxSessions = integer() Default is 2. - Maximum number of persistent connections to a host. + Maximum number of persistent connections to a host. MaxKeepAlive = integer() - Default is 5. - Maximum number of outstanding requests on the same connection to - a host. - KeepAliveTimeout = integer() - Default is 120000 (= 2 min). - If a persistent connection is idle longer than the - keep_alive_timeout in milliseconds, the client will close the connection. - The server may also have such a time out but you should - not count on it! + Default is 5. + Maximum number of outstanding requests on the same connection to + a host. + KeepAliveTimeout = integer() + Default is 120000 (= 2 min). + If a persistent connection is idle longer than the + keep_alive_timeout in milliseconds, + the client will close the connection. + The server may also have such a time out but you should + not count on it! MaxPipeline = integer() - Default is 2. - Maximum number of outstanding requests on a pipelined connection to a host. - PipelineTimeout = integer() - Default is 0, - which will result in pipelining not being used. - If a persistent connection is idle longer than the - pipeline_timeout in milliseconds the client will close the connection. + Default is 2. + Maximum number of outstanding requests on a pipelined connection + to a host. + PipelineTimeout = integer() + Default is 0, + which will result in pipelining not being used. + If a persistent connection is idle longer than the + pipeline_timeout in milliseconds, + the client will close the connection. CookieMode = enabled | disabled | verify Default is disabled. - If Cookies are enabled all valid cookies will automatically be - saved in the client manager's cookie database. - If the option verify is used the function store_cookies/2 - has to be called for the cookies to be saved. - IpFamily = inet | inet6 | inet6fb4 - By default inet. - When it is set to inet6fb4 you can use both ipv4 and ipv6. - It first tries inet6 and if that does not works falls back to inet. - The option is here to provide a workaround for buggy ipv6 stacks to ensure that - ipv4 will always work. + If Cookies are enabled all valid cookies will automatically be + saved in the client manager's cookie database. + If the option verify is used the function store_cookies/2 + has to be called for the cookies to be saved. + IpFamily = inet | inet6 | inet6fb4 + By default inet. + When it is set to inet6fb4 you can use both ipv4 and ipv6. + It first tries inet6 and if that does not works falls back to inet. + The option is here to provide a workaround for buggy ipv6 stacks to ensure that + ipv4 will always work. IpAddress = ip_address() - If the host has several network interfaces, this option specifies which one to use. - See gen_tcp:connect/3,4 for more info. + If the host has several network interfaces, this option specifies which one to use. + See gen_tcp:connect/3,4 for more info. Port = integer() - Specify which local port number to use. - See gen_tcp:connect/3,4 for more info. - VerboseMode = false | verbose | debug | trace - 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. + Specify which local port number to use. + See gen_tcp:connect/3,4 for more info. + VerboseMode = false | verbose | debug | trace + 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. Profile = profile() | pid() (when started stand_alone) -

Sets options to be used for subsequent requests.

- -

If possible the client will keep its connections - alive and use 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 would be - ideal to be sent on a persistent connection, - this very much depends on the - application. Note that a very long queue of requests may cause a - user perceived delay as earlier requests may take a long time - to complete. The HTTP/1.1 specification does suggest a - limit of 2 persistent connections per server, which is the - default value of the max_sessions option.

- +

Sets options to be used for subsequent requests.

+ +

If possible the client will keep its connections + alive and use 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 would be + ideal to be sent on a persistent connection, + this very much depends on the + application. Note that a very long queue of requests may cause a + user perceived delay as earlier requests may take a long time + to complete. The HTTP/1.1 specification does suggest a + limit of 2 persistent connections per server, which is the + default value of the max_sessions option.

+ -- cgit v1.2.3