aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/ranch.set_transport_options.asciidoc
blob: 51bc3f75c9748e6c1ea7fff335128360e07bfabf (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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
= ranch:set_transport_options(3)

== Name

ranch:set_transport_options - Set the transport options

== Description

[source,erlang]
----
set_transport_options(Ref       :: ranch:ref(),
                      TransOpts :: any())
    -> ok | {error, running}
----

Set the transport options.

The listener must be suspended for this call to succeed.
If the listener is running, `{error, running}` will be returned.

The change will take effect when the listener resumes.

== Arguments

Ref::

The listener name.

TransOpts::

The new transport options.

== Return value

The atom `ok` is always returned. It can be safely ignored.

== Examples

.Set the transport options
[source,erlang]
----
Ref = example,

ok = ranch:suspend_listener(Ref),
ok = ranch:set_transport_options(Ref, TransOpts),
ok = ranch:resume_listener(Ref).
----

== See also

link:man:ranch:suspend_listener(3)[ranch:suspend_listener(3)],
link:man:ranch:resume_listener(3)[ranch:resume_listener(3)],
link:man:ranch:get_transport_options(3)[ranch:get_transport_options(3)],
link:man:ranch:set_max_connections(3)[ranch:set_max_connections(3)],
link:man:ranch:set_protocol_options(3)[ranch:set_protocol_options(3)],
link:man:ranch(3)[ranch(3)]