diff options
| author | juhlig <[email protected]> | 2019-05-27 15:20:37 +0200 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2019-05-27 16:03:29 +0200 |
| commit | 30604262b5934b38e9f55f0d3ef44f8aed5310de (patch) | |
| tree | 5a88a20152197921b266769684c17651afc44882 /doc/src/manual/ranch_transport.asciidoc | |
| parent | ad82f58139ca88b7e82dcb6bd50063c899b685e9 (diff) | |
| download | ranch-30604262b5934b38e9f55f0d3ef44f8aed5310de.tar.gz ranch-30604262b5934b38e9f55f0d3ef44f8aed5310de.tar.bz2 ranch-30604262b5934b38e9f55f0d3ef44f8aed5310de.zip | |
Use transport options in ranch_transport:listen/1 callbacks
The callback `ranch_transport:listen/1` has changed to accept a map
of transport options instead of socket options.
Diffstat (limited to 'doc/src/manual/ranch_transport.asciidoc')
| -rw-r--r-- | doc/src/manual/ranch_transport.asciidoc | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/src/manual/ranch_transport.asciidoc b/doc/src/manual/ranch_transport.asciidoc index 2d59e82..78468b3 100644 --- a/doc/src/manual/ranch_transport.asciidoc +++ b/doc/src/manual/ranch_transport.asciidoc @@ -101,11 +101,12 @@ be upgraded to a `ranch_ssl` one using this function. [source,erlang] ---- -listen(SockOpts :: any()) +listen(TransportOpts :: ranch:transport_opts(any())) -> {ok, LSocket :: socket()} | {error, atom()} ---- -Create a socket that listens on the given port. +Create a socket that listens on the port given in the +socket options. The port may not be specified or may be set to 0, which means a random available port number will be chosen. @@ -292,6 +293,8 @@ The exact type will vary depending on the transport module. == Changelog +* *2.0*: The callback `listen/1` has changed to accept a map of + transport options instead of socket options. * *2.0*: The callback `messages/0` return value was updated to include the passive message for `{active, N}`. * *1.6*: The `socket()` type was added for documentation purposes. |