elli

Elli - HTTP API 用 Erlang Web サーバー

Elli は、Erlang アプリケーション内で実行して HTTP API を公開できる Web サーバーです。これは、高スループット、低遅延の HTTP API を構築することのみを目的としています。汎用機能よりも堅牢性とパフォーマンスが重要な場合は、Elli が最適かもしれません。 Web サーバーの実装を詳しく調べている場合は、Elli が最適かもしれません。 Web サイトではなく Web サービスを構築している場合は、Elli が最適かもしれません。

Elli には OTP 22.0 以降が必要です。

インストール

rebar.configへの依存関係としてアプリケーションにelliを追加します。

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

その後、それをコンパイルするために、次を実行できます。

 rebar3 compile 

使用法

Erlang シェル内で 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 ライセンスに基づいてライセンスを取得しています。