elli

Elli - 用于 HTTP API 的 Erlang Web 服务器

Elli 是一个网络服务器，您可以在 Erlang 应用程序中运行以公开 HTTP API。它专门致力于构建高吞吐量、低延迟的 HTTP API。如果稳健性和性能对您来说比通用功能更重要，那么 Elli 可能适合您。如果您发现自己正在深入研究网络服务器的实现，那么 Elli 可能适合您。如果您正在构建网络服务，而不是网站，那么 Elli 可能适合您。

Elli 需要 OTP 22.0 或更高版本。

安装

将elli添加到您的应用程序作为rebar.config的依赖项：

{ deps , [
  { elli , " 3.3.0 " }
]}.

然后，要编译它，您可以运行：

 rebar3 compile 

用法

要在 Erlang shell 中启动 Elli，请运行：

 rebar3 shell 

 % % starting elli
1 > { ok , Pid } = elli : start_link ([{ callback , elli_example_callback }, { port , 3000 }]).

示例

回调模块

学习如何编写回调模块的最佳来源是elli_example_callback 。还有大量测试中使用的示例以及所有事件的描述。

最小的回调模块看起来像这样：

- module ( elli_minimal_callback ).
- behaviour ( elli_handler ).

- include_lib ( " elli/include/elli.hrl " ).

- export ([ handle / 2 , handle_event / 3 ]).

handle ( Req , _Args ) ->
    % % Delegate to our handler function
    Method = Req # req . method ,
    Path = elli_request : path ( Req ),
    handle ( Method , Path , Req ).

handle ( 'GET' = _Method , [<< " hello " >>, << " world " >>] = _Path , _Req ) ->
    % % Reply with a normal response. `ok' can be used instead of `200'
    % % to signal success.
    StatusCode = ok ,
    Headers = [],
    Body = << " Hello World! " >>,
    { StatusCode , Headers , Body };

handle ( _Method , _Path , _Req ) ->
    { 404 , [], << " Not Found " >>}.

% % @doc Handle request events: request completed, exception
% % thrown, client timeout, etc. Must return `ok'.
handle_event ( _Event , _Data , _Args ) ->
    ok .

主管儿童规范

要将elli添加到主管，您可以使用以下示例并根据您的需要进行调整。

- module ( elli_minimal_sup ).
- behaviour ( supervisor ).

- export ([ start_link / 0 , init / 1 ]).

start_link () ->
    SupName = { local , ? MODULE },
    Module = ? MODULE ,
    Args = [],
    supervisor : start_link ( SupName , Module , Args ).

init ([] = _Args ) ->
    ElliOpts = [
        { callback , elli_minimal_callback },
        { port , 3000 }
    ],
    ElliSpec = {
        _Id = elli_minimal_http ,
        _Start = { elli , start_link , [ ElliOpts ]},
        _Restart = permanent ,
        _Shutdown = 5000 ,
        _Worker = worker ,
        _Modules = [ elli ]},

    { ok , {{ _Strategy = one_for_one , _Intensity = 5 , _Period = 10 }, [ ElliSpec ]} }.

进一步阅读

有关 Elli 的功能和设计理念的更多信息，请查看overview 。

执照

Elli 获得了 MIT 许可证的许可。