aboutsummaryrefslogblamecommitdiffstats
path: root/doc/src/guide/introduction.asciidoc
blob: 16449217b26e596d6dffcbf23c80f1893f55916a (plain) (tree)
1
2
3
4
5
6
7
8
9
               






                                                                       
                 


                                                                        
 
                       
 
                                                                 
 
                                      


                                                                       
 
              
 
                                                        
== Introduction

Ranch is a socket acceptor pool for TCP protocols.

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.

=== Prerequisites

It is assumed the developer already knows Erlang and has some experience
with socket programming and TCP protocols.

=== Supported platforms

Ranch is tested and supported on Linux, FreeBSD, OSX and Windows.

Ranch is developed for Erlang/OTP 19+.

Ranch may be compiled on earlier Erlang versions with small source code
modifications but there is no guarantee that it will work as expected.

=== Versioning

Ranch uses http://semver.org/[Semantic Versioning 2.0.0]