aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/ranch.set_protocol_options.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2018-07-18 17:24:41 +0200
committerLoïc Hoguin <[email protected]>2018-07-18 17:24:41 +0200
commit8b4c6f4bf9880d59bbc012b6ba9d5e60c4f62b3a (patch)
tree8cfcf87f69be525252addd32d880abb8ad02a1ad /doc/src/manual/ranch.set_protocol_options.asciidoc
parenta230411488fe2d8ae1e8bf414a4fe4ecf3662a83 (diff)
downloadranch-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.set_protocol_options.asciidoc')
-rw-r--r--doc/src/manual/ranch.set_protocol_options.asciidoc48
1 files changed, 48 insertions, 0 deletions
diff --git a/doc/src/manual/ranch.set_protocol_options.asciidoc b/doc/src/manual/ranch.set_protocol_options.asciidoc
new file mode 100644
index 0000000..1851fab
--- /dev/null
+++ b/doc/src/manual/ranch.set_protocol_options.asciidoc
@@ -0,0 +1,48 @@
+= ranch:set_protocol_options(3)
+
+== Name
+
+ranch:set_protocol_options - Set the protocol options
+
+== Description
+
+[source,erlang]
+----
+set_protocol_options(Ref :: ranch:ref(),
+ ProtoOpts :: any())
+ -> ok
+----
+
+Set the protocol options.
+
+The change will be applied immediately for all new connections.
+Old connections will not receive the new options.
+
+== Arguments
+
+Ref::
+
+The listener name.
+
+ProtoOpts::
+
+The new protocol options.
+
+== Return value
+
+The atom `ok` is always returned. It can be safely ignored.
+
+== Examples
+
+.Set the protocol options
+[source,erlang]
+----
+ranch:set_protocol_options(example, ProtoOpts).
+----
+
+== See also
+
+link:man:ranch:get_protocol_options(3)[ranch:get_protocol_options(3)],
+link:man:ranch:set_max_connections(3)[ranch:set_max_connections(3)],
+link:man:ranch:set_transport_options(3)[ranch:set_transport_options(3)],
+link:man:ranch(3)[ranch(3)]