Tecipe (pronounce it like recipe) is a lightweight and flexible TCP socket acceptor pool for Erlang. Its features are as follows:
- Accepting connections in two dynamic and static methods based on config for different purposes
- Parsing Proxy Protocol (v1 and v2) for transporting connection information across NAT or TCP proxies
- Monitoring connections and reporting their statistics based on configuration
- Providing both TCP and SSL transport and being pluggable for adding new transports
Include tecipe in the rebar.conf file of your project.
{deps, [
%% ...
{tecipe, ".*", {git, "git://github.com/bisphone/tecipe.git", {branch, "master"}}}
]}.Then start its application.
ok = application:start(tecipe).Now you can start a TCP listener with a named-fun as follows:
Ref = foo, Port = 8080,
Handler = fun Loop(Transport, Sock) ->
receive
{tcp, _, Data} ->
Transport:send(Sock, Data),
Loop(Transport, Sock);
_ ->
Transport:close(Sock)
end
end,
Acceptor = {acceptor, static},
Pool = {pool, 50},
Transport = {transport, tecipe_tcp},
Monitor = {monitor, true},
Proxy = {proxy, v2},
ListenerOpts = [Acceptor, Pool, Transport, Monitor, Proxy],
{ok, ListenerPID} = tecipe:start_listener(Ref, Port, Handler, ListenerOpts),This way a static pool with 50 acceptors is started and echoes back every data it receives.
- Listener: An actor which is listening on a port and waits for new connections by its acceptors.
- Acceptor: An actor which accepts new connections and spawns workers to handler the connection.
- Worker: An actor which owns an accepted socket and do the logic.
- Monitor: An actor which is attached to a listener and monitors the workers and collects their stats.
- Pool: The number of acceptors which a listeners created.
- Transport: An interface which must implement some required API to work with sockets.
- Handler: A function or MFA which is responsible to implement the logic of workers.
- Static:
A listener with static acceptor pool accepts incoming connections inside the acceptors and then passes the socket to a newly spawned actor which is called a worker. This way the acceptors remain intact and do not do anything except accepting new connections.
+--------------+ +--------------+
+--+ Monitor | +--+ Monitor +--+
| +--------------+ | +--------------+ |
1) A listener with | 2) After coming | |
no connections | +--------------+ new connections | +--------------+ | +--------------+
+--+ Acceptor # 1 | +--+ Acceptor # 1 | +--+ Worker # 1 |
+----------------+ | +--------------+ +----------------+ | +--------------+ | +--------------+
| Listener +--+ | Listener +--+ |
+----------------+ | +--------------+ +----------------+ | +--------------+ | +--------------+
+--+ Acceptor # 2 | +--+ Acceptor # 2 | +--+ Worker # 2 |
| +--------------+ | +--------------+ | +--------------+
| | |
| +--------------+ | +--------------+ | +--------------+
+--+ Acceptor # 3 | +--+ Acceptor # 3 | +--+ Worker # 3 |
+--------------+ +--------------+ +--------------+
- Dynamic:
A listener with dynamic acceptor pool accepts incoming connections inside the acceptors and make it a worker, and then a new acceptor is spawned. This way the acceptors are changed to workers and new acceptors are replaced with.
+--------------+ +--------------+
+--+ Monitor | +--+ Monitor +--+
| +--------------+ | +--------------+ |
1) A listener with | 2) After coming | |
no connections | +--------------+ new connections | +--------------+ | +--------------+
+--+ Acceptor # 1 | +--+ Acceptor # 4 | +--+ Worker # 1 |
+----------------+ | +--------------+ +----------------+ | +--------------+ | +--------------+
| Listener +--+ | Listener +--+ |
+----------------+ | +--------------+ +----------------+ | +--------------+ | +--------------+
+--+ Acceptor # 2 | +--+ Acceptor # 5 | +--+ Worker # 2 |
| +--------------+ | +--------------+ | +--------------+
| | |
| +--------------+ | +--------------+ | +--------------+
+--+ Acceptor # 3 | +--+ Acceptor # 6 | +--+ Worker # 3 |
+--------------+ +--------------+ +--------------+
Note: Both approaches could have good results in different scenarios. I have plan to write some benchmarks to show the differences.
When the monitor option of a listener is set to true, a monitor actor becomes responsible for collecting the statistics and giving the report.
Using get_stats/1 you can get the statistics as return value and format it as you want. However there is a print_stats/1 function which prints
all the available statistics as follows.
worker-pid socket-port monitor-ref local-address remote-address proxy recv-cnt recv-max recv-avg recv-oct recv-dvi send-cnt send-max send-avg send-oct send-pend
--------------- ------------------- ------------------- ------------------- ------------------- ----- -------- -------- -------- -------- -------- -------- -------- -------- -------- ---------
<0.227.0> #Port<0.40397> #Ref<0.0.1.1156> 192.168.100.2:9999 192.168.103.1:52876 v2 1631 42 20 23112 0 1112 40 20 23112 0
<0.219.0> #Port<0.40389> #Ref<0.0.1.1140> 192.168.100.2:9999 192.168.201.5:52868 v2 6341 60 20 23311 0 1621 40 20 23311 0
<0.211.0> #Port<0.40381> #Ref<0.0.1.1124> 192.168.100.2:9999 192.168.42.63:52860 v2 6112 31 21 23641 0 6322 39 21 23641 0
<0.224.0> #Port<0.40394> #Ref<0.0.1.1150> 192.168.100.2:9999 192.168.12.64:52873 v2 1624 60 21 23732 0 6412 40 21 23732 0
<0.216.0> #Port<0.40386> #Ref<0.0.1.1134> 192.168.100.2:9999 192.168.115.9:52865 v2 5123 10 21 23373 0 1523 40 21 23373 0
For more information about the fields please refer to inet documentation page of Erlang/OTP.
start_listener/3,4,5starts a new listener.stop_listener/1stops a previously started listener.get_listener/1gets information about a running listener.get_workers/1gets a list of a listener's workers.get_stats/1gets a detailed statistics about listener's workers.print_stats/1print the statistics of listener's workers.
Also there is a complete list of type specifications in Tecipe main header file.
acceptordefines the type of acceptor which could bedynamicorstatic. Default isstatic.pooldefines the number of acceptor actors of a listener acceptor pool. Default is5.monitordefines whether the listener monitors their workers or not. Default isfalse.transportdefines the using interface of tecipe which could betecipe_tcportecipe_ssl. Default istecipe_tcp.
Comments, contributions and patches are greatly appreciated.
The MIT License (MIT).