mirror https://github.com/ninenines/ranch

Loïc Hoguin c5b324a138 Update .gitignore 9 years ago
doc f4c6da56d4 Convert the documentation to Asciidoc 9 years ago
examples e31109dd3c Fix examples README 10 years ago
src 309f8bacf6 Print a warning when discarding an option on listener startup 9 years ago
test 309f8bacf6 Print a warning when discarding an option on listener startup 9 years ago
.gitignore c5b324a138 Update .gitignore 9 years ago
AUTHORS f3ae53708c Update AUTHORS 10 years ago
CHANGELOG.asciidoc 6745cad376 Convert CHANGELOG and README to Asciidoc 9 years ago
LICENSE c9da21c7aa Update LICENSE file copyright years 9 years ago
Makefile 300e5f3922 Update ct_helper 9 years ago
README.asciidoc 6745cad376 Convert CHANGELOG and README to Asciidoc 9 years ago
circle.yml 5ea28fb446 Update apt-get before installing things on CI 9 years ago
erlang.mk 9508d521c4 Update erlang.mk 10 years ago

README.asciidoc

= Ranch

Ranch is a socket acceptor pool for TCP protocols.

== Goals

Ranch aims to provide everything you need to accept TCP connections with
a **small** code base and **low latency** while being easy to use directly
as an application or to **embed** into your own.

Ranch provides a **modular** design, letting you choose which transport
and protocol are going to be used for a particular listener. Listeners
accept and manage connections on one port, and include facilities to
limit the number of **concurrent** connections. Connections are sorted
into **pools**, each pool having a different configurable limit.

Ranch also allows you to **upgrade** the acceptor pool without having
to close any of the currently opened sockets.

== Getting started

* [Read the guide](doc/src/guide/book.asciidoc)
* [Check the manual](doc/src/manual/)
* Look at the examples in the `examples/` directory

== Support

* Official IRC Channel: #ninenines on irc.freenode.net
* [Mailing Lists](http://lists.ninenines.eu)
* [Commercial Support](http://ninenines.eu/support)