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

Loïc Hoguin cf85152fff Properly handle Ctrl+D in examples 8 years ago
doc 2c93d8ef43 Remove bad advice for gen_server protocols 8 years ago
ebin 5c6cedf992 Add ssl to the list of dependencies 8 years ago
examples cf85152fff Properly handle Ctrl+D in examples 8 years ago
src 5c6cedf992 Add ssl to the list of dependencies 8 years ago
test 5c6cedf992 Add ssl to the list of dependencies 8 years ago
.gitignore c5b324a138 Update .gitignore 9 years ago
AUTHORS f3ae53708c Update AUTHORS 10 years ago
CHANGELOG.asciidoc 4eca99ec83 Update changelog 9 years ago
LICENSE c9da21c7aa Update LICENSE file copyright years 9 years ago
Makefile 5c6cedf992 Add ssl to the list of dependencies 8 years ago
README.asciidoc 0b5f146d9a Update links in README 8 years ago
erlang.mk 905642f6fc Update Erlang.mk and CI OTP versions for 19.1.6 8 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

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

== Support

* Official IRC Channel: #ninenines on irc.freenode.net
* http://ninenines.eu/services[Commercial Support]