ranch:set_transport_options(3)

Name

ranch:set_transport_options - Set the transport options

Description

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

Ref = example,

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

See also

ranch:suspend_listener(3), ranch:resume_listener(3), ranch:get_transport_options(3), ranch:set_max_connections(3), ranch:set_protocol_options(3), ranch(3)