aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2013-04-25 23:58:28 +0200
committerLoïc Hoguin <[email protected]>2013-04-25 23:58:28 +0200
commit138b8d788ca056dcfed1f3092531020481ffa345 (patch)
tree3d7768c7bf198e68b1ff07750fc4fa9bfe6cb1f2
parentaeceeae9b2df201a20d201cc7c23341ffdc170f3 (diff)
downloadranch-138b8d788ca056dcfed1f3092531020481ffa345.tar.gz
ranch-138b8d788ca056dcfed1f3092531020481ffa345.tar.bz2
ranch-138b8d788ca056dcfed1f3092531020481ffa345.zip
Add default transport options section to listeners chapter
-rw-r--r--guide/listeners.md11
-rw-r--r--guide/toc.md1
2 files changed, 12 insertions, 0 deletions
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