aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/ranch.get_protocol_options.asciidoc
blob: b5b2a9e272b923ee73c19fa8e830d1ba9a3fbbf9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
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)]