aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/guide/introduction.asciidoc
blob: 3199fb2f9cb838a3cd75e765bd31ebae8adddfd6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
== 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.

Ranch is developed for Erlang R15B01+.

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]