https://github.com/ninenines/ranch

Socket acceptor pool for TCP protocols.
https://github.com/ninenines/ranch

Last synced: 10 days ago
JSON representation

Socket acceptor pool for TCP protocols.

• Host: GitHub
• URL: https://github.com/ninenines/ranch
• Owner: ninenines
• License: isc
• Created: 2012-04-05T23:06:16.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2024-05-17T11:19:34.000Z (6 months ago)
• Last Synced: 2024-05-18T12:04:11.276Z (6 months ago)
• Language: Erlang
• Homepage:
• Size: 1.2 MB
• Stars: 1,176
• Watchers: 95
• Forks: 333
• Open Issues: 7
• Metadata Files:
  • Readme: README.asciidoc
  • License: LICENSE

Awesome Lists containing this project

• awesome-erlang-cn - ranch - cowboy用到的TCP网络库. (网络)
• awesome-erlang - ranch - Socket acceptor pool for TCP protocols. (Networking)

README

        
= 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.

== Online documentation

* https://ninenines.eu/docs/en/ranch/2.1/guide[User guide]

* https://ninenines.eu/docs/en/ranch/2.1/manual[Function reference]

== Offline documentation

* While still online, run `make docs`

* User guide available in `doc/` in PDF and HTML formats

* Function reference man pages available in `doc/man3/` and `doc/man7/`

* Run `make install-docs` to install man pages on your system

* Full documentation in Asciidoc available in `doc/src/`

* Examples available in `examples/`

== Getting help

* https://github.com/ninenines/ranch/issues[Issues tracker]

* https://ninenines.eu/services[Commercial Support]