OpenLiteSpeed logo Open LiteSpeed Web Serverユーザーズマニュアル

モジュール設定

モジュールのサポートは、OpenLiteSpeed 1.3およびLSWS Enterprise 5.0以降で利用できます。 必要なモジュールはすべて、サーバーモジュール設定タブに登録する必要があります。 モジュールファイルは、登録可能にするため、サーバーのroot/modulesフォルダーに置く必要があります。 起動時に、サーバーは登録されているすべてのモジュールをロードします。 新しいモジュールが登録された後、サーバーを再起動する必要があります。

モジュールは、サーバーモジュール設定タブでグローバルに設定できます。 構成データは、リスナーおよびバーチャルホスト・モジュール構成が継承または変更するために使用できます。

目次

サーバーモジュール

リスナーモジュール

バーチャルホストモジュール

バーチャルホストモジュールのコンテキスト

サーバーモジュール

説明

サーバーモジュール構成は、モジュール構成データをグローバルに定義します。 一度定義されると、リスナーとバーチャルホストはモジュールとモジュール構成にアクセスできます。

処理されるすべてのモジュールは、サーバー構成に登録する必要があります。 サーバー構成では、モジュール・パラメーター・データのデフォルト値も定義されています。 これらの値は、リスナーおよびバーチャルホスト構成データによって継承または上書きできます。

モジュールの優先順位は、サーバーレベルでのみ定義され、リスナーとバーチャルホストの設定によって継承されます。

モジュール

説明

モジュールの名前。 モジュール名はモジュールファイル名と同じになります。 モジュール・ファイルは、サーバー・アプリケーションによってロードされるために$SERVER_ROOT/modules/modulename.soの下になければなりません。 サーバーは起動時に登録されたモジュールをロードします。 このためには、新しいモジュールが登録された後でサーバーを再起動する必要があります。

構文

.soのライブラリ名。

内部

説明

モジュールが外部の.soライブラリではなく、静的にリンクされている内部モジュールであるかどうかを指定します。

構文

ラジオボックスから選択

モジュールのパラメータ

説明

モジュールのパラメータを設定します。 モジュールパラメータは、モジュール開発者によって定義されます。

デフォルト値をグローバルに割り当てるようにサーバー構成内の値を設定します。 ユーザーは、この設定をリスナー、バーチャルホストまたはコンテキスト・レベルでオーバーライドできます。 「未設定」ラジオボタンが選択されている場合、それは上位レベルから継承されます。

構文

モジュールインタフェースで指定されます。

フックを有効にする

説明

モジュールフックをグローバルに有効または無効にします。
「未設定」ラジオボタンが選択され、モジュールにフック機能が含まれている場合、デフォルトが有効になります。 ユーザーは、各レベルでこのグローバル設定を上書きできます。

構文

ラジオボックスから選択

フック::L4_BEGINSESSION 優先度

説明

このモジュールコールバックの優先度をL4 Begin Session フック内で設定します。

TCP/IP接続が開始されると、L4 Begin Session フックがトリガーされます。

モジュールにフックポイントがある場合にのみ有効です。 設定されていない場合、優先度はモジュールで定義されたデフォルト値になります。

構文

整数値は-6000から6000です。値が小さいほど優先度が高くなります。

フック::L4_ENDSESSION 優先度

説明

このモジュールコールバックの優先度をL4 End Session フック内で設定します。

TCP/IP接続が終了すると、L4 End Session フックがトリガーされます。

モジュールにフックポイントがある場合にのみ有効です。 設定されていない場合、優先度はモジュールで定義されたデフォルト値になります。

構文

整数値は-6000から6000です。値が小さいほど優先度が高くなります。

フック::L4_RECVING 優先度

説明

L4 Receiving フック内のこのモジュールコールバックの優先度を設定します。

TCP/IP接続がデータを受信すると、L4 Receiving フックがトリガーされます。

モジュールにフックポイントがある場合にのみ有効です。 設定されていない場合、優先度はモジュールで定義されたデフォルト値になります。

構文

整数値は-6000から6000です。値が小さいほど優先度が高くなります。

フック::L4_SENDING 優先度

説明

このモジュールコールバックの優先度をL4 Sendingフック内で設定します。

L4_SENDINGフックは、TCP/IP接続がデータを送信するときにトリガーされます。

モジュールにフックポイントがある場合にのみ有効です。 設定されていない場合、優先度はモジュールで定義されたデフォルト値になります。

構文

整数値は-6000から6000です。値が小さいほど優先度が高くなります。

フック::HTTP_BEGIN 優先度

説明

HTTP Begin フック内のこのモジュールコールバックの優先度を設定します。

TCP/IP接続がHTTPセッションを開始すると、HTTP Begin フックがトリガーされます。

モジュールにフックポイントがある場合にのみ有効です。 設定されていない場合、優先度はモジュールで定義されたデフォルト値になります。

構文

整数値は-6000から6000です。値が小さいほど優先度が高くなります。

フック::RECV_REQ_HEADER 優先度

説明

HTTP受信要求ヘッダーフック内のこのモジュールコールバックの優先度を設定します。

HTTP受信要求ヘッダーフックは、Webサーバーが要求ヘッダーを受信するとトリガーされます。

モジュールにフックポイントがある場合にのみ有効です。 設定されていない場合、優先度はモジュールで定義されたデフォルト値になります。

構文

整数値は-6000から6000です。値が小さいほど優先度が高くなります。

フック::URI_MAP 優先度

説明

このモジュールコールバックの優先度をHTTP URIマップフック内で設定します。

HTTP URI マップフックは、WebサーバーがURI要求をコンテキストにマップするときにトリガーされます。

モジュールにフックポイントがある場合にのみ有効です。 設定されていない場合、優先度はモジュールで定義されたデフォルト値になります。

構文

整数値は-6000から6000です。値が小さいほど優先度が高くなります。

フック::HTTP_AUTH 優先度

説明

HTTP認証フック内のこのモジュールコールバックの優先度を設定します。

HTTP認証フックは、リソースマッピング後およびハンドラ処理の前にトリガーされます。 HTTP組み込み認証の後に発生し、追加の認証チェックを実行するために使用できます。

モジュールにフックポイントがある場合にのみ有効です。 設定されていない場合、優先度はモジュールで定義されたデフォルト値になります。

構文

整数値は-6000から6000です。値が小さいほど優先度が高くなります。

フック::RECV_REQ_BODY 優先度

説明

HTTP受信要求ボディフック内のこのモジュールコールバックの優先度を設定します。

Webサーバーが要求本体データを受信すると、HTTP受信要求ボディフックがトリガーされます。

モジュールにフックポイントがある場合にのみ有効です。 設定されていない場合、優先度はモジュールで定義されたデフォルト値になります。

構文

整数値は-6000から6000です。値が小さいほど優先度が高くなります。

フック::RCVD_REQ_BODY 優先度

説明

HTTP受信済みリクエストボディフック内のこのモジュールコールバックの優先度を設定します。

Webサーバーが要求本体データの受信を終了すると、HTTP受信要求本体フックがトリガーされます。

モジュールにフックポイントがある場合にのみ有効です。 設定されていない場合、優先度はモジュールで定義されたデフォルト値になります。

構文

整数値は-6000から6000です。値が小さいほど優先度が高くなります。

フック::RECV_RESP_HEADER 優先度

説明

HTTP受信応答ヘッダーフック内のこのモジュールコールバックの優先度を設定します。

HTTP受信応答ヘッダーフックは、Webサーバーが応答ヘッダーを作成するときにトリガーされます。

モジュールにフックポイントがある場合にのみ有効です。 設定されていない場合、優先度はモジュールで定義されたデフォルト値になります。

構文

整数値は-6000から6000です。値が小さいほど優先度が高くなります。

フック::RECV_RESP_BODY 優先度

説明

HTTP受信応答ボディフック内のこのモジュールコールバックの優先度を設定します。

HTTP受信応答ボディフックは、Webサーバーのバックエンドが応答本体を受信するとトリガーされます。

モジュールにフックポイントがある場合にのみ有効です。 設定されていない場合、優先度はモジュールで定義されたデフォルト値になります。

構文

整数値は-6000から6000です。値が小さいほど優先度が高くなります。

フック::RCVD_RESP_BODY 優先度

説明

HTTP受信応答ボディフック内のこのモジュールコールバックの優先度を設定します。

HTTP受信応答ボディフックは、Webサーバーのバックエンドが応答本体の受信を終了するとトリガーされます。

モジュールにフックポイントがある場合にのみ有効です。 設定されていない場合、優先度はモジュールで定義されたデフォルト値になります。

構文

整数値は-6000から6000です。値が小さいほど優先度が高くなります。

フック::HANDLER_RESTART 優先度

説明

このモジュールコールバックの優先度をHTTPハンドラの再起動フック内で設定します。

Webサーバが現在の応答を破棄し、内部リダイレクトが要求されたときなど、最初から処理を開始する必要があるときに、HTTPハンドラの再起動フックがトリガーされます。

モジュールにフックポイントがある場合にのみ有効です。 設定されていない場合、優先度はモジュールで定義されたデフォルト値になります。

構文

整数値は-6000から6000です。値が小さいほど優先度が高くなります。

フック::SEND_RESP_HEADER 優先度

説明

このモジュールコールバックの優先度を、HTTP送信応答ヘッダーフック内で設定します。

Webサーバーが応答ヘッダーを送信する準備ができたら、HTTP送信応答ヘッダーフックがトリガーされます。

モジュールにフックポイントがある場合にのみ有効です。 設定されていない場合、優先度はモジュールで定義されたデフォルト値になります。

構文

整数値は-6000から6000です。値が小さいほど優先度が高くなります。

フック::SEND_RESP_BODY 優先度

説明

HTTP送信レスポンスボディフック内のこのモジュールコールバックの優先度を設定します。

HTTP送信レスポンスボディフックは、Webサーバがレスポンスボディを送信するときにトリガーされます。

モジュールにフックポイントがある場合にのみ有効です。 設定されていない場合、優先度はモジュールで定義されたデフォルト値になります。

構文

整数値は-6000から6000です。値が小さいほど優先度が高くなります。

フック::HTTP_END 優先度

説明

HTTPセッション終了フック内のこのモジュールコールバックの優先度を設定します。

HTTPセッション終了フックは、HTTP接続が終了したときにトリガーされます。

モジュールにフックポイントがある場合にのみ有効です。 設定されていない場合、優先度はモジュールで定義されたデフォルト値になります。

構文

整数値は-6000から6000です。値が小さいほど優先度が高くなります。

フック::MAIN_INITED 優先度

説明

メイン初期化フック内のこのモジュールコールバックの優先度を設定します。

メイン初期化フックは、起動時、メイン(コントローラ)プロセスによってサーバー構成と初期化が完了した後、および要求が処理される前に一度起動されます。

モジュールにフックポイントがある場合にのみ有効です。 設定されていない場合、優先順位はモジュールで定義されたデフォルト値になります。

構文

整数値は-6000から6000です。値が小さいほど優先度が高くなります。

フック::MAIN_PREFORK 優先度

説明

Main Prefork フック内のこのモジュールコールバックの優先度を設定します。

Main Prefork フックは、新しいワーカープロセスが開始(分岐)される直前にメイン(コントローラ)プロセスによってトリガーされます。 これは各ワーカーに呼び出され、システムの起動時やワーカが再起動されたときに発生する可能性があります。

モジュールにフックポイントがある場合にのみ有効です。 設定されていない場合、優先度はモジュールで定義されたデフォルト値になります。

構文

整数値は-6000から6000です。値が小さいほど優先度が高くなります。

フック::MAIN_POSTFORK 優先度

説明

Main Postfork フック内のこのモジュールコールバックの優先度を設定します。

Main Postfork フックは、新しいワーカープロセスが開始(フォーク)された直後にメイン(コントローラ)プロセスによってトリガーされます。 これは各ワーカーに呼び出され、システムの起動時やワーカが再起動されたときに発生する可能性があります。

モジュールにフックポイントがある場合にのみ有効です。 設定されていない場合、優先度はモジュールで定義されたデフォルト値になります。

構文

整数値は-6000から6000です。値が小さいほど優先度が高くなります。

フック::WORKER_POSTFORK 優先度

説明

Worker Postfork フック内のこのモジュールコールバックの優先度を設定します。

Worker Postfork フックは、メイン(コントローラ)プロセスによって作成された後、ワーカープロセスによってトリガーされます。 対応するMain Postfork フックは、このコールバックの前または後のメインプロセスによって呼び出されることに注意してください。

モジュールにフックポイントがある場合にのみ有効です。 設定されていない場合、優先度はモジュールで定義されたデフォルト値になります。

構文

整数値は-6000から6000です。値が小さいほど優先度が高くなります。

フック::WORKER_ATEXIT 優先度

説明

このモジュールコールバックの優先度を、終了時のワーカーのフック内で設定します。

退出時のワーカーは、退出する直前のワーカープロセスによってトリガーされます。 これは、ワーカーによって呼び出される最後のフックポイントです。

モジュールにフックポイントがある場合にのみ有効です。 設定されていない場合、優先度はモジュールで定義されたデフォルト値になります。

構文

整数値は-6000から6000です。値が小さいほど優先度が高くなります。

フック::MAIN_ATEXIT 優先度

説明

メインの出口フック内のこのモジュールコールバックの優先度を設定します

メインの出口フックは、終了する直前のメイン(コントローラ)プロセスによって起動されます。 これは、メインプロセスによって呼び出される最後のフックポイントです。

モジュールにフックポイントがある場合にのみ有効です。 設定されていない場合、優先度はモジュールで定義されたデフォルト値になります。

構文

整数値は-6000から6000です。値が小さいほど優先度が高くなります。

リスナーモジュール

説明

リスナーモジュール設定データは、デフォルトでサーバーモジュール設定から継承されます。 リスナモジュールは、TCP / IPレイヤ4フックに限定されています。

フックを有効にする

説明

リスナーレベルでモジュールフックを有効または無効にします。 モジュールにTCP/IPレベルのフック(L4_BEGSESSION、L4_ENDSESSION、L4_RECVING、L4_SENDING)がある場合のみ、この設定が有効になります。

「未設定」ラジオボタンが選択されている場合、デフォルトはサーバー設定から継承されます。 ユーザーはデフォルト設定を上書きするためにここで設定するだけです。

構文

ラジオボックスから選択

バーチャルホストモジュール

説明

バーチャルホストモジュール構成データは、デフォルトでサーバーモジュール設定から継承されます。 バーチャルホストモジュールはHTTPレベルのフックに制限されています。

フックを有効にする

説明

バーチャルホストまたはコンテキスト・レベルでモジュール・フックを使用可能または使用不可にします。 モジュールにHTTPレベルのフックがある場合のみ、この設定が有効になります。

「未設定」ラジオボタンを選択すると、バーチャルホストレベルのデフォルト設定がサーバー設定から継承されます。 コンテキストレベルの設定は、バーチャルホストレベルから継承されます。 ユーザーはデフォルト設定を上書きするためにここで設定するだけです。

構文

ラジオボックスから選択

バーチャルホストモジュールのコンテキスト

説明

バーチャルホストコンテキストのモジュール設定をカスタマイズするための集中管理された場所です。 コンテキストURIの設定は、バーチャルホストまたはサーバーレベルの設定を上書きします。

URI

説明

このコンテキストのURIを指定します。

構文

URIは通常のURI("/"で始まる)またはPerl互換の正規表現URI("exp:"で始まる)にできます。通常のURIが"/"で終わる場合、このコンテキストはこのURI配下のすべてのサブURIを含みます。コンテキストがファイルシステム上のディレクトリにマップされる場合は、末尾に"/"を追加する必要があります。

参照

場所