diff options
Diffstat (limited to 'doc/src/guide/upcoming_2.0_changes.asciidoc')
| -rw-r--r-- | doc/src/guide/upcoming_2.0_changes.asciidoc | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/src/guide/upcoming_2.0_changes.asciidoc b/doc/src/guide/upcoming_2.0_changes.asciidoc new file mode 100644 index 0000000..40fc4e9 --- /dev/null +++ b/doc/src/guide/upcoming_2.0_changes.asciidoc @@ -0,0 +1,29 @@ +== Upcoming changes in Ranch 2.0 + +The following changes will be done in Ranch 2.0. In most +cases an alternative is already available in the most +recent Ranch version. + +* The function `ranch:start_listener/6` has been deprecated + in favor of `ranch:start_listener/5`. The number of acceptors + was removed and will be taken from the transport options. + +* The function `ranch:child_spec/6` has also been deprecated, + in favor of `ranch:child_spec/5`. + +* The function `ranch:accept_ack/1` has been deprecated in + favor of `ranch:handshake/1,2`. + +* The socket will no longer be passed to the protocol when + starting it. It will be available as a return value from + `ranch:handshake/1,2` only. + +* Starting from Ranch 2.0 it will no longer be allowed to + pass Ranch options along with socket options as a proplist. + The only forms allowed will be the `ranch:opts()` map or socket + options as-is. The `ranch:opts()` map must be used in case socket + options also use a map. + +* The `socket` option will be removed. A more viable solution + is to define a custom transport module that returns a fresh + socket when `Transport:listen/1` is called. |