aboutsummaryrefslogtreecommitdiffstats
path: root/lib/kernel/doc/src/net_kernel.xml
diff options
context:
space:
mode:
authorSverker Eriksson <[email protected]>2016-08-19 14:30:52 +0200
committerSverker Eriksson <[email protected]>2016-08-19 14:30:52 +0200
commit74eea0fbb2cb5d0bb211dad19891d2aae31e170d (patch)
treecf599434e94471c94b49196758fff1462e542996 /lib/kernel/doc/src/net_kernel.xml
parent2757590a9d7e092dcbaf15c15354f7ccd0154219 (diff)
parentaa12cfd7a35434f6da89b5c3aaafdc99189f5a98 (diff)
downloadotp-74eea0fbb2cb5d0bb211dad19891d2aae31e170d.tar.gz
otp-74eea0fbb2cb5d0bb211dad19891d2aae31e170d.tar.bz2
otp-74eea0fbb2cb5d0bb211dad19891d2aae31e170d.zip
Merge branch 'sverker/net_kernel-setopts/OTP-13564' into maint
Diffstat (limited to 'lib/kernel/doc/src/net_kernel.xml')
-rw-r--r--lib/kernel/doc/src/net_kernel.xml36
1 files changed, 36 insertions, 0 deletions
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
@@ -116,6 +116,21 @@ $ <input>erl -sname foobar</input></pre>
</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"/>
<fsummary>Subscribe to node status change messages.</fsummary>
@@ -289,6 +304,27 @@ $ <input>erl -sname foobar</input></pre>
</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>
<name>start([Name, NameType, Ticktime]) -> {ok, pid()} | {error, Reason}</name>