aboutsummaryrefslogtreecommitdiffstats
path: root/lib/inets/doc/src/httpc.xml
diff options
context:
space:
mode:
authorMicael Karlberg <[email protected]>2012-03-13 14:26:07 +0100
committerMicael Karlberg <[email protected]>2012-03-13 14:26:07 +0100
commit5cefb654a99eae754badd417de493acc59f8efb3 (patch)
treef4fe18d5c00a6eb4b17abfee47f4d8ab61ff055d /lib/inets/doc/src/httpc.xml
parent8f83fe72fe713a64e67490020e8d375b620f4abe (diff)
downloadotp-5cefb654a99eae754badd417de493acc59f8efb3.tar.gz
otp-5cefb654a99eae754badd417de493acc59f8efb3.tar.bz2
otp-5cefb654a99eae754badd417de493acc59f8efb3.zip
[inets/httpc] Add function to retreive current options
Add function to retreive current options, httpc:get_options/1,2. OTP-9979
Diffstat (limited to 'lib/inets/doc/src/httpc.xml')
-rw-r--r--lib/inets/doc/src/httpc.xml31
1 files changed, 30 insertions, 1 deletions
diff --git a/lib/inets/doc/src/httpc.xml b/lib/inets/doc/src/httpc.xml
index 48a2089605..70c845bade 100644
--- a/lib/inets/doc/src/httpc.xml
+++ b/lib/inets/doc/src/httpc.xml
@@ -4,7 +4,7 @@
<erlref>
<header>
<copyright>
- <year>2004</year><year>2011</year>
+ <year>2004</year><year>2012</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -541,6 +541,35 @@ apply(Module, Function, [ReplyInfo | Args])
default value of the <c>max_sessions</c> option. </p>
</note>
+ <marker id="get_options"></marker>
+ </desc>
+ </func>
+
+ <func>
+ <name>get_options(OptionItems) -> {ok, Values} | {error, Reason}</name>
+ <name>get_options(OptionItems, Profile) -> {ok, Values} | {error, Reason}</name>
+ <fsummary>Gets the currently used options.</fsummary>
+ <type>
+ <v>OptionItems = all | [option_item()]</v>
+ <v>option_item() = proxy |
+ max_sessions |
+ keep_alive_timeout |
+ max_keep_alive_length |
+ pipeline_timeout |
+ max_pipeline_length |
+ cookies |
+ ipfamily |
+ ip |
+ port |
+ socket_opts |
+ verbose</v>
+ <v>Profile = profile() | pid() (when started <c>stand_alone</c>)</v>
+ <v>Values = [{option_item(), term()}]</v>
+ <v>Reason = term() </v>
+ </type>
+ <desc>
+ <p>Retrieves the options currently used by the client.</p>
+
<marker id="stream_next"></marker>
</desc>
</func>