aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/ranch.get_transport_options.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/manual/ranch.get_transport_options.asciidoc')
-rw-r--r--doc/src/manual/ranch.get_transport_options.asciidoc7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/src/manual/ranch.get_transport_options.asciidoc b/doc/src/manual/ranch.get_transport_options.asciidoc
index 438df90..0214e0f 100644
--- a/doc/src/manual/ranch.get_transport_options.asciidoc
+++ b/doc/src/manual/ranch.get_transport_options.asciidoc
@@ -9,7 +9,7 @@ ranch:get_transport_options - Get the current transport options
[source,erlang]
----
get_transport_options(Ref :: ranch:ref())
- -> TransOpts :: any()
+ -> TransOpts :: ranch:transport_opts(any())
----
Get the current transport options.
@@ -24,6 +24,11 @@ The listener name.
The current transport options are returned.
+If the transport options were specified as only socket options (not a map) using
+link:man:ranch:start_listener(3)[ranch:start_listener(3)] or
+link:man:ranch:set_transport_options(3)[ranch:set_transport_options(3)], they
+are returned as `#{socket_opts => SocketOpts}`.
+
== Examples
.Get the current transport options