aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/ranch.set_transport_options.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/manual/ranch.set_transport_options.asciidoc')
-rw-r--r--doc/src/manual/ranch.set_transport_options.asciidoc20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/src/manual/ranch.set_transport_options.asciidoc b/doc/src/manual/ranch.set_transport_options.asciidoc
index 146f21e..8c2eacb 100644
--- a/doc/src/manual/ranch.set_transport_options.asciidoc
+++ b/doc/src/manual/ranch.set_transport_options.asciidoc
@@ -15,6 +15,11 @@ set_transport_options(Ref :: ranch:ref(),
Set the transport options.
+The complete set of transport options is replaced. To update a subset of the
+transport options, it is recommended to get the current transport options using
+link:man:ranch:get_transport_options(3)[ranch:get_transport_options(3)], update
+them and then set them back using this function.
+
Changes to the following options will take effect...
* immediately:
@@ -66,6 +71,21 @@ ok = ranch:set_transport_options(Ref, TransOpts),
ok = ranch:resume_listener(Ref).
----
+.Update the listener TCP port within the `socket_opts` transport option
+[source,erlang]
+----
+Ref = example,
+
+TransOpts0 = ranch:get_transport_options(Ref),
+#{socket_opts = SocketOpts0} = TransOpts0,
+SocketOpts = [{port, 12345}|proplists:delete(port, SocketOpts0)],
+TransOpts = TransOpts0#{socket_opts = SocketOpts},
+
+ok = ranch:suspend_listener(Ref),
+ok = ranch:set_transport_options(Ref, TransOpts),
+ok = ranch:resume_listener(Ref).
+----
+
== See also
link:man:ranch:suspend_listener(3)[ranch:suspend_listener(3)],