{"id":15656882,"url":"https://github.com/emqx/esockd","last_synced_at":"2025-12-11T23:44:03.900Z","repository":{"id":23663813,"uuid":"27034717","full_name":"emqx/esockd","owner":"emqx","description":"Erlang general non-blocking TCP/SSL socket server","archived":false,"fork":false,"pushed_at":"2025-04-02T13:12:43.000Z","size":3872,"stargazers_count":212,"open_issues_count":9,"forks_count":86,"subscribers_count":33,"default_branch":"master","last_synced_at":"2025-05-08T02:54:05.347Z","etag":null,"topics":["erlang-library","mqtt","tcp-server","udp-server"],"latest_commit_sha":null,"homepage":"https://www.emqx.com","language":"Erlang","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/emqx.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2014-11-23T14:18:01.000Z","updated_at":"2025-03-28T08:41:11.000Z","dependencies_parsed_at":"2023-12-18T12:23:54.631Z","dependency_job_id":"e6c20335-8acd-4ecb-8223-dbeb7e3dd48e","html_url":"https://github.com/emqx/esockd","commit_stats":{"total_commits":559,"total_committers":22,"mean_commits":25.40909090909091,"dds":0.5348837209302326,"last_synced_commit":"728769bfb7e653455ec86ecf1134b77b9a2f95f4"},"previous_names":[],"tags_count":96,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emqx%2Fesockd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emqx%2Fesockd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emqx%2Fesockd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emqx%2Fesockd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/emqx","download_url":"https://codeload.github.com/emqx/esockd/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254135445,"owners_count":22020546,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["erlang-library","mqtt","tcp-server","udp-server"],"created_at":"2024-10-03T13:04:40.322Z","updated_at":"2025-12-11T23:44:03.888Z","avatar_url":"https://github.com/emqx.png","language":"Erlang","funding_links":[],"categories":[],"sub_categories":[],"readme":"# esockd [![Build status](https://github.com/emqx/esockd/actions/workflows/run_test_case.yaml/badge.svg)](https://github.com/emqx/esockd/actions/workflows/run_test_case.yaml)\n\nErlang General Non-blocking TCP/SSL Socket Server.\n\n## Features\n\n* General Non-blocking TCP/SSL Socket Server\n* Acceptor Pool and Asynchronous TCP Accept\n* UDP/DTLS Server\n* Max connections management\n* Allow/Deny by peer address\n* Proxy Protocol V1/V2\n* Keepalive Support\n* Rate Limit\n* IPv6 Support\n\n## Usage\n\nA Simple TCP Echo Server:\n\n    -module(echo_server).\n\n    -export([start_link/2, init/2]).\n\n    start_link(Transport, Sock) -\u003e\n        {ok, spawn_link(?MODULE, init, [Transport, Sock])}.\n\n    init(Transport, Sock) -\u003e\n        case Transport:wait(Sock) of\n            {ok, NewSock} -\u003e\n                loop(Transport, NewSock);\n            Error -\u003e Error\n        end.\n\n    loop(Transport, Sock) -\u003e\n        case Transport:recv(Sock, 0) of\n            {ok, Data} -\u003e\n                {ok, Peername} = Transport:peername(Sock),\n                Transport:send(Sock, Data),\n                loop(Transport, Sock);\n            {error, Reason} -\u003e\n                io:format(\"TCP Error: ~s~n\", [Reason]),\n                {stop, Reason}\n        end.\n\nSetup Echo Server:\n\n    %% Start esockd application\n    ok = esockd:start().\n    Options = [{acceptors, 10}, {max_connections, 1024}, {tcp_options, [binary, {reuseaddr, true}]}].\n    MFArgs = {echo_server, start_link, []},\n    esockd:open(echo, 5000, Options, MFArgs).\n\n## Examples\n\nExample                 | Description\n------------------------|---------------------------\nexamples/async_recv     | prim_net async recv/send\nexamples/gen_server     | gen_server behaviour\nexamples/simple         | simple echo server\nexamples/ssl            | ssl echo server\nexamples/proxy_protocol | proxy protocol v1/2\nexamples/udp            | udp echo server\nexamples/dtls           | dtls echo server\n\n## API\n\n### Open a listener\n\n    esockd:open(echo, 5000, [{tcp_options, [binary, {reuseaddr, true}]}],\n                {echo_server, start_link, []}).\n\n    esockd:open(echo, {\"127.0.0.1\", 6000}, [{tcp_options, [binary, {reuseaddr, true}]}],\n                {echo_server, start_link, []}).\n\nSpec:\n\n    -spec(open(Protocol, ListenOn, Options, MFArgs) -\u003e {ok, pid()} | {error, term()} when\n               Protocol :: atom(),\n               ListenOn :: inet:port_number() | {host(), inet:port_number()}),\n               Options  :: [option()],\n               MFArgs   :: esockd:mfargs()).\n\nOption:\n\n    -type(option() :: {acceptors, pos_integer()}\n                    | {max_connections, pos_integer()}\n                    | {max_conn_rate, pos_integer()}\n                    | {access_rules, [esockd_access:rule()]}\n                    | {shutdown, brutal_kill | infinity | pos_integer()}\n                    | tune_buffer | {tune_buffer, boolean()}\n                    | proxy_protocol | {proxy_protocol, boolean()}\n                    | {proxy_protocol_timeout, timeout()}\n                    | {ssl_options, [ssl:ssl_option()]}\n                    | {udp_options, [gen_udp:option()]}\n                    | {dtls_options, [gen_udp:option() | ssl:ssl_option()]}).\n\nMFArgs:\n\n    -type(mfargs() :: atom() | {atom(), atom()} | {module(), atom(), [term()]}).\n\n### Get Setting and Stats\n\nGet stats:\n\n    esockd:get_stats({echo, 5000}).\n\nGet acceptors:\n\n    esockd:get_acceptors({echo, {\"127.0.0.1\", 6000}}).\n\nGet/Set max connections:\n\n    esockd:get_max_connections({echo, 5000}).\n    esockd:set_max_connections({echo, 5000}, 100000).\n\n### Allow/Deny\n\nSame to Allow/Deny Syntax of nginx:\n\n    allow address | CIDR | all;\n\n    deny address | CIDR | all;\n\nallow/deny by options:\n\n    esockd:open(echo, 5000, [{access, [{deny, \"192.168.1.1\"}, {allow, \"192.168.1.0/24\"}, {deny, all}]}], MFArgs).\n\nallow/deny by API:\n\n    esockd:allow({echo, 5000}, all).\n    esockd:allow({echo, 5000}, \"192.168.0.1/24\").\n    esockd:deny({echo, 5000}, all).\n    esockd:deny({echo, 5000}, \"10.10.0.0/16\").\n\n### Close a listener\n\n    esockd:close(echo, 5000).\n    esockd:close(echo, {\"127.0.0.1\", 6000}).\n\nSpec:\n\n    -spec(close(Protocol, ListenOn) -\u003e ok when Protocol :: atom(), ListenOn :: inet:port_number() | {host(), inet:port_number()}).\n\n### SSL\n\nConnecting to ssl_echo_server:\n\n    openssl s_client -connect 127.0.0.1:5000 -ssl3\n\n    openssl s_client -connect 127.0.0.1:5000 -tls1\n\n## Design\n\n### Supervisor Tree\n\n    esockd_sup\n        -\u003e esockd_listener_sup\n            -\u003e esockd_listener\n            -\u003e esockd_acceptor_sup\n                -\u003e esockd_acceptor\n                -\u003e esockd_acceptor\n                -\u003e ......\n            -\u003e esockd_connection_sup\n                -\u003e esockd_connection\n                -\u003e esockd_connection\n                -\u003e ......\n\n### Acceptor\n\n1. Acceptor Pool\n\n2. Suspend for one second when e{n, m}file errors happened\n\n### Connection Sup\n\n1. Create a connection, and let it run...\n\n2. Control maximum connections\n\n3. Count active connections\n\n4. Count shutdown reasons\n\n### CIDR\n\nCIDR Wiki: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\n\n## Benchmark\n\nBenchmark 2.1.0-alpha release on one 8 cores, 32G memory ubuntu/14.04 server::\n\n    250K concurrent connections, 50K messages/sec, 40Mbps In/Out consumed 5G memory, 20% CPU/core\n\n## License\n\nApache License Version 2.0\n\n## Author\n\nEMQX Team.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femqx%2Fesockd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femqx%2Fesockd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femqx%2Fesockd/lists"}