From 5cefb654a99eae754badd417de493acc59f8efb3 Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Tue, 13 Mar 2012 14:26:07 +0100
Subject: [inets/httpc] Add function to retreive current options

Add function to retreive current options, httpc:get_options/1,2.

OTP-9979
---
 lib/inets/doc/src/httpc.xml | 31 ++++++++++++++++++++++++++++++-
 lib/inets/doc/src/notes.xml |  6 ++++++
 2 files changed, 36 insertions(+), 1 deletion(-)

(limited to 'lib/inets/doc')

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>
diff --git a/lib/inets/doc/src/notes.xml b/lib/inets/doc/src/notes.xml
index a14eb15de3..f2cd03b6a8 100644
--- a/lib/inets/doc/src/notes.xml
+++ b/lib/inets/doc/src/notes.xml
@@ -64,6 +64,12 @@
 	  <p>Own Id: OTP-9960</p>
         </item>
 
+        <item>
+          <p>[httpc] Add function for retrieving current options, 
+	  <seealso marker="httpc#get_options">get_options/1,2</seealso>. </p>
+	  <p>Own Id: OTP-9979</p>
+        </item>
+
       </list>
 
     </section>
-- 
cgit v1.2.3