| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475 |
- = ranch:set_transport_options(3)
- == Name
- ranch:set_transport_options - Set the transport options
- == Description
- [source,erlang]
- ----
- set_transport_options(Ref :: ranch:ref(),
- TransOpts :: ranch:opts())
- -> ok | {error, Reason :: term()}
- ----
- Set the transport options.
- Changes to the following options will take effect...
- * immediately:
- ** `max_connections`
- ** `handshake_timeout`
- ** `shutdown`
- * only after the listener has been suspended and resumed:
- ** `num_acceptors`
- ** `num_listen_sockets`
- ** `socket_opts`
- * only when the entire listener is restarted:
- ** `num_conns_sups`
- ** `logger`
- == Arguments
- Ref::
- The listener name.
- TransOpts::
- The new transport options.
- == Return value
- The atom `ok` is returned on success.
- An error tuple is returned on failure, for example if the given
- transport options contain invalid values.
- == Changelog
- * *2.0*: The restriction that the listener must be suspended
- has been removed.
- * *2.0*: The `TransOpts` argument must no longer contain
- Ranch-specific options if given as a list. Use a map.
- == 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)]
|
