From e96a373c9699296ade966c601bb0e7185f4a163d Mon Sep 17 00:00:00 2001
From: Sverker Eriksson <sverker@erlang.org>
Date: Tue, 9 Aug 2016 20:07:47 +0200
Subject: kernel: Document net_kernel:getopts and setopts

---
 lib/kernel/doc/src/kernel_app.xml |  2 ++
 lib/kernel/doc/src/net_kernel.xml | 36 ++++++++++++++++++++++++++++++++++++
 2 files changed, 38 insertions(+)

(limited to 'lib/kernel/doc')

diff --git a/lib/kernel/doc/src/kernel_app.xml b/lib/kernel/doc/src/kernel_app.xml
index 9e6fb60bb7..dc0291babe 100644
--- a/lib/kernel/doc/src/kernel_app.xml
+++ b/lib/kernel/doc/src/kernel_app.xml
@@ -215,12 +215,14 @@
         <p>Defines the <c>First..Last</c> port range for the listener
           socket of a distributed Erlang node.</p>
       </item>
+      <marker id="inet_dist_listen_options"></marker>
       <tag><c>{inet_dist_listen_options, Opts}</c></tag>
       <item>
         <p>Defines a list of extra socket options to be used when opening the
 	  listening socket for a distributed Erlang node.
 	  See <seealso marker="gen_tcp#listen/2"><c>gen_tcp:listen/2</c></seealso>.</p>
       </item>
+      <marker id="inet_dist_connect_options"></marker>
       <tag><c>{inet_dist_connect_options, Opts}</c></tag>
       <item>
         <p>Defines a list of extra socket options to be used when connecting to
diff --git a/lib/kernel/doc/src/net_kernel.xml b/lib/kernel/doc/src/net_kernel.xml
index f48a534d4f..3c1b3d5190 100644
--- a/lib/kernel/doc/src/net_kernel.xml
+++ b/lib/kernel/doc/src/net_kernel.xml
@@ -115,6 +115,21 @@ $ <input>erl -sname foobar</input></pre>
       </desc>
     </func>
 
+    <func>
+      <name name="getopts" arity="2"/>
+      <fsummary>Get distribution socket options.</fsummary>
+      <desc>
+        <p>Get one or more options for the distribution socket
+	connected to <c><anno>Node</anno></c>.</p>
+        <p>If <c><anno>Node</anno></c> is a connected node
+	the return value is the same as from
+	<seealso marker="inet#getopts/2"><c>inet:getopts(Sock, Options)</c></seealso>
+	where <c>Sock</c> is the distribution socket for <c><anno>Node</anno></c>.</p>
+	<p>Returns <c>ignored</c> if the local node is not alive or
+	<c>{error, noconnection}</c> if <c><anno>Node</anno></c> is not connected.</p>
+      </desc>
+    </func>
+
     <func>
       <name name="monitor_nodes" arity="1"/>
       <name name="monitor_nodes" arity="2"/>
@@ -288,6 +303,27 @@ $ <input>erl -sname foobar</input></pre>
       </desc>
     </func>
 
+    <func>
+      <name name="setopts" arity="2"/>
+      <fsummary>Set distribution socket options.</fsummary>
+      <desc>
+        <p>Set one or more options for distribution sockets.
+	Argument <c><anno>Node</anno></c> can be either one node name
+	or the atom <c>new</c> to affect the distribution sockets of all
+	future connected nodes.</p>
+        <p>The return value is the same as from
+	<seealso marker="inet#setopts/2"><c>inet:setopts/2</c></seealso>
+	or <c>{error, noconnection}</c> if <c><anno>Node</anno></c> is not
+	a connected node or <c>new</c>.</p>
+	<p>If <c><anno>Node</anno></c> is <c>new</c> the <c><anno>Options</anno></c>
+	will then also be added to kernel configration parameters
+	<seealso marker="kernel:kernel_app#inet_dist_listen_options">inet_dist_listen_options</seealso>
+	and
+	<seealso marker="kernel:kernel_app#inet_dist_connect_options">inet_dist_connect_options</seealso>.</p>
+	<p>Returns <c>ignored</c> if the local node is not alive.</p>
+      </desc>
+    </func>
+
     <func>
       <name>start([Name]) -> {ok, pid()} | {error, Reason}</name>
       <name>start([Name, NameType]) -> {ok, pid()} | {error, Reason}</name>
-- 
cgit v1.2.3