|
|
@@ -1,37 +1,24 @@
|
|
|
Ranch User Guide
|
|
|
================
|
|
|
|
|
|
+The Ranch User Guide explores how to make best use of Ranch
|
|
|
+for writing powerful TCP applications.
|
|
|
+
|
|
|
+Introducing Ranch
|
|
|
+-----------------
|
|
|
+
|
|
|
* [Introduction](introduction.md)
|
|
|
- * Purpose
|
|
|
- * Prerequisites
|
|
|
+
|
|
|
+Using Ranch
|
|
|
+-----------
|
|
|
+
|
|
|
* [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
|
|
|
- * Limiting the number of concurrent connections
|
|
|
- * Upgrading
|
|
|
* [Transports](transports.md)
|
|
|
- * Purpose
|
|
|
- * TCP transport
|
|
|
- * SSL transport
|
|
|
- * Sending and receiving data
|
|
|
- * Writing a transport handler
|
|
|
* [Protocols](protocols.md)
|
|
|
- * Purpose
|
|
|
- * Writing a protocol handler
|
|
|
- * Using gen_server
|
|
|
+
|
|
|
+Advanced topics
|
|
|
+---------------
|
|
|
+
|
|
|
* [SSL client authentication](ssl_auth.md)
|
|
|
- * Purpose
|
|
|
- * Obtaining client certificates
|
|
|
- * Transport configuration
|
|
|
- * Authentication
|
|
|
* [Embedded mode](embedded.md)
|
|
|
- * Purpose
|
|
|
- * Embedding
|
|
|
* [Internals](internals.md)
|
|
|
- * Architecture
|
|
|
- * Number of acceptors
|
|
|
- * Platform-specific TCP features
|
Loïc Hoguin