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.asciidoc40
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/src/manual/ranch.get_transport_options.asciidoc b/doc/src/manual/ranch.get_transport_options.asciidoc
new file mode 100644
index 0000000..438df90
--- /dev/null
+++ b/doc/src/manual/ranch.get_transport_options.asciidoc
@@ -0,0 +1,40 @@
+= ranch:get_transport_options(3)
+
+== Name
+
+ranch:get_transport_options - Get the current transport options
+
+== Description
+
+[source,erlang]
+----
+get_transport_options(Ref :: ranch:ref())
+ -> TransOpts :: any()
+----
+
+Get the current transport options.
+
+== Arguments
+
+Ref::
+
+The listener name.
+
+== Return value
+
+The current transport options are returned.
+
+== Examples
+
+.Get the current transport options
+[source,erlang]
+----
+TransOpts = ranch:get_transport_options(example).
+----
+
+== See also
+
+link:man:ranch:get_max_connections(3)[ranch:get_max_connections(3)],
+link:man:ranch:get_protocol_options(3)[ranch:get_protocol_options(3)],
+link:man:ranch:set_transport_options(3)[ranch:set_transport_options(3)],
+link:man:ranch(3)[ranch(3)]