From 138b8d788ca056dcfed1f3092531020481ffa345 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Thu, 25 Apr 2013 23:58:28 +0200 Subject: Add default transport options section to listeners chapter --- guide/listeners.md | 11 +++++++++++ guide/toc.md | 1 + 2 files changed, 12 insertions(+) diff --git a/guide/listeners.md b/guide/listeners.md index a9ac4a0..3ddc0ae 100644 --- a/guide/listeners.md +++ b/guide/listeners.md @@ -81,6 +81,17 @@ telnet> quit Connection closed. ``` +Default transport options +------------------------- + +By default the socket will be set to return `binary` data, with the +options `{active, false}`, `{packet, raw}`, `{reuseaddr, true}` set. +These values can't be overriden when starting the listener, but +they can be overriden using `Transport:setopts/2` in the protocol. + +It will also set `{backlog, 1024}` and `{nodelay, true}`, which +can be overriden at listener startup. + Listening on a random port -------------------------- diff --git a/guide/toc.md b/guide/toc.md index 12ba6c1..eac5338 100644 --- a/guide/toc.md +++ b/guide/toc.md @@ -7,6 +7,7 @@ Ranch User Guide * [Listeners](listeners.md) * Purpose * Starting and stopping + * Default transport options * Listening on a random port * Listening on privileged ports * Accepting connections on an existing socket -- cgit v1.2.3