これらの定数はモジュール内でHTTPリターンコードを参照するのが簡単です
オプション | 値 |
---|---|
NGX_HTTP_CONTINUE |
100 |
NGX_HTTP_SWITCHING_PROTOCOLS |
101 |
NGX_HTTP_PROCESSING |
102 |
NGX_HTTP_OK |
200 |
NGX_HTTP_CREATED |
201 |
NGX_HTTP_ACCEPTED |
202 |
NGX_HTTP_NO_CONTENT |
204 |
NGX_HTTP_PARTIAL_CONTENT |
206 |
NGX_HTTP_SPECIAL_RESPONSE |
300 |
NGX_HTTP_MOVED_PERMANENTLY |
301 |
NGX_HTTP_MOVED_TEMPORARILY |
302 |
NGX_HTTP_SEE_OTHER |
303 |
NGX_HTTP_NOT_MODIFIED |
304 |
NGX_HTTP_TEMPORARY_REDIRECT |
307 |
NGX_HTTP_BAD_REQUEST |
400 |
NGX_HTTP_UNAUTHORIZED |
401 |
NGX_HTTP_FORBIDDEN |
403 |
NGX_HTTP_NOT_FOUND |
404 |
NGX_HTTP_NOT_ALLOWED |
405 |
NGX_HTTP_REQUEST_TIME_OUT |
408 |
NGX_HTTP_CONFLICT |
409 |
NGX_HTTP_LENGTH_REQUIRED |
411 |
NGX_HTTP_PRECONDITION_FAILED |
412 |
NGX_HTTP_REQUEST_ENTITY_TOO_LARGE |
413 |
NGX_HTTP_REQUEST_URI_TOO_LARGE |
414 |
NGX_HTTP_UNSUPPORTED_MEDIA_TYPE |
415 |
NGX_HTTP_RANGE_NOT_SATISFIABLE |
416 |
NGX_HTTP_CLOSE |
444 |
NGX_HTTP_NGINX_CODES |
494 |
NGX_HTTP_REQUEST_HEADER_TOO_LARGE |
494 |
NGX_HTTPS_CERT_ERROR |
495 |
NGX_HTTPS_NO_CERT |
496 |
NGX_HTTP_TO_HTTPS |
497 |
NGX_HTTP_CLIENT_CLOSED_REQUEST |
499 |
NGX_HTTP_INTERNAL_SERVER_ERROR |
500 |
NGX_HTTP_NOT_IMPLEMENTED |
501 |
NGX_HTTP_BAD_GATEWAY |
502 |
NGX_HTTP_SERVICE_UNAVAILABLE |
503 |
NGX_HTTP_GATEWAY_TIME_OUT |
504 |
NGX_HTTP_INSUFFICIENT_STORAGE |
507 |
ngx_http_request_t
¶リクエストと応答の詳細を含む構造この構造の多くのメンバーがあるため、ここでは使われるであろう一部分だけをリスト化します
connection
¶構造のための接続オブジェクトUseful for its log
member.
upstream
¶upstreamリクエストのための詳細を設定するオブジェクト
pool
¶リクエストを持つ割り当てのために使われるメモリプール
headers_in
¶リクエストに伴ってやってくるhttpヘッダを含むオブジェクト
headers_out
¶クライアントに返されるhttpヘッダを含むオブジェクト
main
¶メインリクエストへのポインタ。それがメインリクエストである場合は自身の構造を指します
parent
¶親のリクエストへのポインタ
header_only:1
¶ボディのクライアントへの送信を無効にするためには1
を設定します
ngx_http_headers_in_t
¶やってくるヘッダデータを格納するための構造
headers
¶やってくるヘッダを含むリスト
host
¶hostヘッダ
connection
¶望ましい接続オプション (close
とkeep-alive
のようなもの)
if_modified_since
¶やってくるヘッダのIf-Modified-Since
if_unmodified_since
¶やってくるヘッダのIf-Unmodified-Since
if_match
¶やってくるヘッダのIf-Match
if_none_match
¶やってくるヘッダのIf-None-Match
user_agent
¶クライアントのユーザエージェント
referer
¶クライアントによって提供されるrefere
content_length
¶クライアントのPOSTデータの内容の長さ
content_type
¶クライアントのPOSTデータの内容の種類
range
¶内容として要求された領域のバイト
if_range
¶やってくるヘッダのIf-Range
transfer_encoding
¶データ転送のためのエンコーディング
expect
¶やってくるヘッダのExpect
upgrade
¶The connection upgrade request from the client
accept_encoding
¶クライアントが受け取るであろうエンコーディング
via
¶クライアントによって使われるプロキシの詳細
認証リクエストヘッダ
keep_alive
¶クライアントの keep-alive リクエストヘッダ
x_forwarded_for
¶ロードバランサのためのX-Forwarded-For
ヘッダ
x_real_ip
¶ロードバランサのためのX-Real-IP
ヘッダ
accept
¶応答として受け付けられる内容の種類
accept_language
¶応答として使われる受け付けられる人間の言語
depth
¶やってくるヘッダのDepth
destination
¶やってくるヘッダのDestination
overwrite
¶やってくるヘッダのOverwrite
date
¶クライアントのリクエストの date/time
やってくるクッキーを含む配列
content_length_n
¶やってくる内容の長さ
keep_alive_n
¶keep alive タイムアウト時間
connection_type:2
¶接続が NGX_HTTP_CONNECTION_KEEP_ALIVE
あるいは NGX_HTTP_CONNECTION_CLOSE
かどうかを説明するフラグ
chunked:1
¶chunkedエンコーディングを指定するboolean
msie:1
¶クライアントとしてInternet Explorerを指定するboolean
msie6:1
¶クライアントとしてInternet Explorer 6 を指定するboolean
opera:1
¶クライアントとしてOperaを指定するboolean
gecko:1
¶クライアントとしてGeckoレンダリングエンジンを指定するboolean (ie. Firefox)
chrome:1
¶クライアントとしてChromeを指定するboolean
safari:1
¶クライアントとしてSafariを指定するboolean
konqueror:1
¶クライアントとしてKonquerorを指定するboolean
ngx_http_headers_out_t
¶外に行くヘッダデータを格納する構造
headers
¶追加される付加的なヘッダを含むリスト
status
¶返すステータス。あり得る選択肢は HTTP Return Codes
content_encoding
¶"Content-Encoding"ヘッダのキーと値の両方を格納します。
content_type_len
¶コンテントタイプの長さ。通常これはcontent_type.len
と同じに設定されなければなりません
content_length_n
¶contentのボディの長さ
last_modified_time
¶返されるcontentの最終更新時間
ngx_http_upstream_t
¶peer
¶upstream peer のための接続の詳細
conf
¶upstreamのための設定オブジェクトへのポインタ
(*create_request)
(ngx_http_request_t *r)¶リクエストのために要求されたバッファを割りあてるべきコールバック関数。成功時にはNGX_OK
を返し、エラー時にはNGX_ERROR
を返します。
(*reinit_request)
(ngx_http_request_t *r)¶upstreamとの通信の試行が失敗した場合に、状態ポインタを再初期化するコールバック。成功時にはNGX_OK
を返します。
(*process_header)
(ngx_http_request_t *r)¶upstreamヘッダを取り出した後でクライアント応答のためにヘッダを設定するコールバック。成功時にはNGX_OK
を返します。
(*abort_request)
(ngx_http_request_t *r)¶クライアントがリクエストを中断した場合に引き起こされるコールバック。
(*finalize_request)
(ngx_http_request_t *r, ngx_int_t rc)¶リクエストを終了するために引き起こされるコールバック。
ngx_http_upstream_conf_t
¶upstream/proxyハンドラのために使われるupstream設定オブジェクト
connect_timeout
¶upstreamについての接続タイムアウト
send_timeout
¶upstreamについての送信タイムアウト
read_timeout
¶upstreamについてのreadタイムアウト
next_upstream_timeout
¶次のupstreamに切り替わるまでのタイムアウト
store_access
¶ディスクへの一時ファイルのようなファイルを格納するためのパーミッション
bufs
¶upstreamボディデータのためのバッファ
buffering
¶データをバッファするかどうか
buffer_size
¶各バッファのサイズ。通常はngx_pagesize
に設定されるべきです
max_temp_file_size
¶一時ファイルの最大サイズ
temp_file_write_size
¶ボディがディスクに格納されるデータの総サイズ
hide_headers
¶downstreamに渡さないヘッダフィールドのリスト
pass_headers
¶通常無効にされているdownstreamへ渡すヘッダフィールドのリストこれらは: “Date”, “Server”, “X-Pad”, and “X-Accel-...”
ngx_http_subrequest
(ngx_http_request_t *r, ngx_str_t *uri, ngx_str_t *args, ngx_http_request_t **sr, ngx_http_post_subrequest_t *psr, ngx_uint_t flags)¶指定されたURLへのサブリクエストを実行します
パラメータ: |
|
---|---|
返り値: | リクエストをセットアップするのに成功した場合には |
ngx_http_get_module_ctx
(ngx_http_request_t *r, ngx_module_t module)¶指定されたモジュールとリクエストについてのコンテキストデータを取得するためのマクロ
パラメータ: |
|
---|---|
返り値: | コンテキストへのポインタ |
ngx_http_set_ctx
(ngx_http_request_t *r, void *c, ngx_module_t module)¶指定されたモジュールとリクエストについてのコンテキストデータを設定するためのマクロ
パラメータ: |
|
---|
(*ngx_http_output_header_filter+pt)
(ngx_http_request_t *r)¶ヘッダフィルタへのコールバック。モジュール内ではこれは通常以下のように使われます:
static ngx_http_output_header_filter_pt ngx_http_next_header_filter;
(*ngx_http_output_body_filter_pt)
(ngx_http_request_t *r, ngx_chain_t *chain)¶ボディフィルタへのコールバック。モジュール内ではこれは通常以下のように使われます:
static ngx_http_output_body_filter_pt ngx_http_next_body_filter;