README.asciidoc (1407B)
1 = Ranch 2 3 Ranch is a socket acceptor pool for TCP protocols. 4 5 == Goals 6 7 Ranch aims to provide everything you need to accept TCP connections with 8 a *small* code base and *low latency* while being easy to use directly 9 as an application or to *embed* into your own. 10 11 Ranch provides a *modular* design, letting you choose which transport 12 and protocol are going to be used for a particular listener. Listeners 13 accept and manage connections on one port, and include facilities to 14 limit the number of *concurrent* connections. Connections are sorted 15 into *pools*, each pool having a different configurable limit. 16 17 Ranch also allows you to *upgrade* the acceptor pool without having 18 to close any of the currently opened sockets. 19 20 == Online documentation 21 22 * https://ninenines.eu/docs/en/ranch/1.7/guide[User guide] 23 * https://ninenines.eu/docs/en/ranch/1.7/manual[Function reference] 24 25 == Offline documentation 26 27 * While still online, run `make docs` 28 * User guide available in `doc/` in PDF and HTML formats 29 * Function reference man pages available in `doc/man3/` and `doc/man7/` 30 * Run `make install-docs` to install man pages on your system 31 * Full documentation in Asciidoc available in `doc/src/` 32 * Examples available in `examples/` 33 34 == Getting help 35 36 * Official IRC Channel: #ninenines on irc.freenode.net 37 * https://github.com/ninenines/ranch/issues[Issues tracker] 38 * https://ninenines.eu/services[Commercial Support]