diff options
| author | Viktor Söderqvist <[email protected]> | 2020-12-03 09:34:57 +0100 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2020-12-04 11:49:19 +0100 |
| commit | 4a1d16242c6fa9865fd7499d301d90b9ca65d6b1 (patch) | |
| tree | 5f5547749f3a79763313470fe582996c0216264b /doc/src/manual/ranch.get_transport_options.asciidoc | |
| parent | 3e914c44a4e956c3b6ef3c1ffc64aac1fca46be9 (diff) | |
| download | ranch-4a1d16242c6fa9865fd7499d301d90b9ca65d6b1.tar.gz ranch-4a1d16242c6fa9865fd7499d301d90b9ca65d6b1.tar.bz2 ranch-4a1d16242c6fa9865fd7499d301d90b9ca65d6b1.zip | |
Clarify {get,set}_{protocol,transport}_options docs
Clarifications and examples.
Diffstat (limited to 'doc/src/manual/ranch.get_transport_options.asciidoc')
| -rw-r--r-- | doc/src/manual/ranch.get_transport_options.asciidoc | 7 |
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 |