elli

Elli — веб-сервер Erlang для HTTP API

Elli — это веб-сервер, который вы можете запустить внутри своего приложения Erlang, чтобы предоставить HTTP API. Он нацелен исключительно на создание HTTP API с высокой пропускной способностью и малой задержкой. Если надежность и производительность для вас важнее, чем функции общего назначения, тогда Elli может подойти вам. Если вы углубитесь в реализацию веб-сервера, то Elli может подойти вам. Если вы создаете веб-сервисы, а не веб-сайты, то Elli может подойти вам.

Элли требуется OTP 22.0 или новее.

Установка

Добавьте elli в свое приложение в качестве зависимости от вашего rebar.config :

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

После этого, чтобы скомпилировать его, вы можете запустить:

 rebar3 compile 

Использование

Чтобы загрузить Elli внутри оболочки Erlang, запустите:

 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 .

Супервизор ChildSpec

Чтобы добавить 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 .

Лицензия

Элли имеет лицензию MIT License.