diff options
author | Loïc Hoguin <[email protected]> | 2018-07-18 17:24:41 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2018-07-18 17:24:41 +0200 |
commit | 8b4c6f4bf9880d59bbc012b6ba9d5e60c4f62b3a (patch) | |
tree | 8cfcf87f69be525252addd32d880abb8ad02a1ad /doc/src/manual/ranch.get_protocol_options.asciidoc | |
parent | a230411488fe2d8ae1e8bf414a4fe4ecf3662a83 (diff) | |
download | ranch-8b4c6f4bf9880d59bbc012b6ba9d5e60c4f62b3a.tar.gz ranch-8b4c6f4bf9880d59bbc012b6ba9d5e60c4f62b3a.tar.bz2 ranch-8b4c6f4bf9880d59bbc012b6ba9d5e60c4f62b3a.zip |
Add one manual per function for the ranch module
Also review and update the ranch(7) manual and fix a few specs.
Diffstat (limited to 'doc/src/manual/ranch.get_protocol_options.asciidoc')
-rw-r--r-- | doc/src/manual/ranch.get_protocol_options.asciidoc | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/src/manual/ranch.get_protocol_options.asciidoc b/doc/src/manual/ranch.get_protocol_options.asciidoc new file mode 100644 index 0000000..b5b2a9e --- /dev/null +++ b/doc/src/manual/ranch.get_protocol_options.asciidoc @@ -0,0 +1,40 @@ += ranch:get_protocol_options(3) + +== Name + +ranch:get_protocol_options - Get the current protocol options + +== Description + +[source,erlang] +---- +get_protocol_options(Ref :: ranch:ref()) + -> ProtoOpts :: any() +---- + +Get the current protocol options. + +== Arguments + +Ref:: + +The listener name. + +== Return value + +The current protocol options are returned. + +== Examples + +.Get the current protocol options +[source,erlang] +---- +ProtoOpts = ranch:get_protocol_options(example). +---- + +== See also + +link:man:ranch:get_max_connections(3)[ranch:get_max_connections(3)], +link:man:ranch:get_transport_options(3)[ranch:get_transport_options(3)], +link:man:ranch:set_protocol_options(3)[ranch:set_protocol_options(3)], +link:man:ranch(3)[ranch(3)] |