メイン モジュール API¶
型¶
ngx_msec_t¶
-
ngx_msec_t¶ ミリ秒のカウントを格納するためのタイプ。
ngx_uint_tのエイリアス
構造¶
ngx_module_t¶
-
ngx_module_t¶ いくつかの基本的なモジュールホックを定義するために必要とされる構造。
例では以下が使われています: Catch Body Filter Example
-
NGX_MODULE_V1¶ 構造のヘッダのためのマクロ
-
void *
ctx¶ NGINXのAPIによって作成された呼び出しに渡されるあなたのモジュールへのポインタ
-
ngx_command_t *
commands¶ モジュールによって使われる特別な設定ディレクティブを定義する構造へのポインタ
-
ngx_uint_t
type¶ The type of module defined. 以下のマクロのうちの一つを使って埋められなければなりません:
Macro 種類 NGX_CORE_MODULE コア モジュール NGX_HTTP_MODULE HTTP モジュール NGX_EVENT_MODULE event モジュール NGX_MAIL_MODULE メール モジュール NGX_STREAM_MODULE TCP/IP ストリーム モジュール
-
ngx_int_t
(*init_module)(ngx_cycle_t *cycle)¶ モジュールの初期化フェーズへのホックこれはマスタープロセスのフォークの前に起きます。
-
ngx_int_t
(*init_process)(ngx_cycle_t *cycle)¶ 新しいプロセスのフェーズ内のモジュールの初期化へのホック。これはワーカープロセスがフォークされた時に起きます。
-
ngx_int_t
(*init_thread)(ngx_cycle_t *cycle)¶ スレッドの初期化へのホック
注意
このホックは現在のところ実装されていません
-
void
(*exit_thread)(ngx_cycle_t *cycle)¶ スレッドの終了へのホック
注意
このホックは現在のところ実装されていません
-
void
(*exit_process)(ngx_cycle_t *cycle)¶ (ワーカープロセスのような)子プロセスの終了へのホック
-
void
(*exit_master)(ngx_cycle_t *cycle)¶ マスタープロセスの終了へのホック
-
NGX_MODULE_V1_PADDING¶ 構造のフッタのためのマクロ
-
例¶
ngx_module_t ngx_http_my_module = {
NGX_MODULE_V1,
&ngx_http_my_module_ctx, /* module context */
ngx_http_my_module_commands, /* module directives */
NGX_HTTP_MODULE, /* module type */
NULL, /* init master */
NULL, /* init module */
NULL, /* init process */
NULL, /* init thread */
NULL, /* exit thread */
NULL, /* exit process */
NULL, /* exit master */
NGX_MODULE_V1_PADDING
};
ngx_core_module_t¶
-
ngx_core_module_t¶ -
-
void *
(*create_conf)(ngx_cycle_t *cycle)¶ 設定の割り当ておよび初期化のためのコールバック
-
char *
(*init_conf)(ngx_cycle_t *cycle)¶ 設定ファイルの中で提供されるディレクティブに基づいた設定を設定するためのコールバック
-
void *
ngx_http_module_t¶
-
ngx_http_module_t¶ HTTPモジュールのモジュールコンテキストを定義します。
例では以下が使われています: Catch Body Filter Example
-
ngx_int_t
(*preconfiguration)(ngx_conf_t *cf)¶ 事前設定のコールバック
-
ngx_int_t
(*postconfiguration)(ngx_conf_t *cf)¶ 事後設定のコールバック
-
void *
(*create_main_conf)(ngx_conf_t *cf)¶ メインブロックの設定のための設定の割り当てと初期化のためのコールバック
-
char *
(*init_main_conf)(ngx_conf_t *cf, void *conf)¶ 設定ファイルの中で提供されるディレクティブに基づいた設定を設定するためのコールバック
-
void *
(*create_srv_conf)(ngx_conf_t *cf)¶ serverブロック設定のための設定の割り当てと初期化のためのコールバック
-
char *
(*merge_srv_conf)(ngx_conf_t *cf, void *prev, void *conf)¶ サーバブロック設定とメインブロックをマージするためのコールバック
-
void *
(*create_loc_conf)(ngx_conf_t *cf)¶ locationブロック設定のための設定の割り当てと初期化のためのコールバック
-
char *
(*merge_loc_conf)(ngx_conf_t *cf, void *prev, void *conf)¶ locationブロック設定とserverブロックをマージするためのコールバック
-
ngx_int_t
ngx_mail_module_t¶
-
ngx_mail_module_t¶ -
ngx_mail_protocol_t *
protocol¶ ngx_mail_protocol_t構造へのポインタ
-
void *
(*create_main_conf)(ngx_conf_t *cf)¶ メインブロックの設定のための設定の割り当てと初期化のためのコールバック
-
char *
(*init_main_conf)(ngx_conf_t *cf, void *conf)¶ 設定ファイルの中で提供されるディレクティブに基づいた設定を設定するためのコールバック
-
void *
(*create_srv_conf)(ngx_conf_t *cf)¶ serverブロック設定のための設定の割り当てと初期化のためのコールバック
-
char *
(*merge_srv_conf)(ngx_conf_t *cf, void *prev, void *conf)¶ サーバブロック設定とメインブロックをマージするためのコールバック
-
ngx_mail_protocol_t *