HTTP Return Codes¶

These constants are an easy way to reference the HTTP return codes in your modules

ngx_http_request_t¶

ngx_http_request_t¶

A structure containing the details of a request and response. There are many members of this structure so only the parts you would be expected to use are listed here

ngx_connection_t *connection¶

The connection object for the structure. Useful for its log member.

ngx_http_upstream_t *upstream¶

An object to set details for an upstream request

ngx_pool_t *pool¶

The memory pool to use for allocations with the request

ngx_http_headers_in_t headers_in¶

An object containing the http headers that came in with the request

ngx_http_headers_out_t headers_out¶

An object containing the http headers to be returned to the client

ngx_str_t uri¶

A string containing the requested path

ngx_str_t args¶

A string containing the get request arguments after the question mark

ngx_http_request_t *main¶

A pointer to the main request, points to its own structure if it is the main request

ngx_http_request_t *parent¶

A pointer to the parent request

header_only:1¶

Set to 1 to disable sending the body to a client

ngx_http_headers_in_t¶

ngx_http_headers_in_t¶

A structure to store the incoming header data

ngx_list_t headers¶

A list containing the incoming headers

ngx_table_elt_t *host¶

The host header

ngx_table_elt_t *connection¶

Desired connection options (such as close and keep-alive)

ngx_table_elt_t *if_modified_since¶

The If-Modified-Since incoming header

ngx_table_elt_t *if_unmodified_since¶

The If-Unmodified-Since incoming header

ngx_table_elt_t *if_match¶

The If-Match incoming header

ngx_table_elt_t *if_none_match¶

The If-None-Match incoming header

ngx_table_elt_t *user_agent¶

The client’s user agent

ngx_table_elt_t *referer¶

The referer supplied by the client

ngx_table_elt_t *content_length¶

The content length of client POST data

ngx_table_elt_t *content_type¶

The content type of client POST data

ngx_table_elt_t *range¶

The requested byte range for the content

ngx_table_elt_t *if_range¶

The If-Range incoming header

ngx_table_elt_t *transfer_encoding¶

The encoding for the data transfer

ngx_table_elt_t *expect¶

The Expect incoming header

ngx_table_elt_t *upgrade¶

The connection upgrade request from the client

ngx_table_elt_t *accept_encoding¶

The encodings the client will accept

ngx_table_elt_t *via¶

Details of the proxy used by the client

ngx_table_elt_t *authorization¶

The autorization request header

ngx_table_elt_t *keep_alive¶

The client keep-alive request header

ngx_array_t x_forwarded_for¶

The X-Forwarded-For header for a load balancer

ngx_table_elt_t *x_real_ip¶

The X-Real-IP header for a load balanacer

ngx_table_elt_t *accept¶

The content types which are acceptable for a response

ngx_table_elt_t *accept_language¶

The acceptable human languages to be used for a response

ngx_table_elt_t *depth¶

The Depth incoming header

ngx_table_elt_t *destination¶

The Destination incoming header

ngx_table_elt_t *overwrite¶

The Overwrite incoming header

ngx_table_elt_t *date¶

The client date/time of the request

ngx_str_t user¶

The decoded user from the authorization header

ngx_str_t passwd¶

The decoded password from the authorization header

ngx_array_t cookies¶

An array containting the incoming cookies

ngx_str_t server¶

The server string from the upstream

off_t content_length_n¶

The length of the incoming content

time_t keep_alive_n¶

The keep alive timeout time

unsigned connection_type:2¶

A flag stating whether the connection is NGX_HTTP_CONNECTION_KEEP_ALIVE or NGX_HTTP_CONNECTION_CLOSE

unsigned chunked:1¶

A boolean specifying chunked encoding

unsigned msie:1¶

A boolean specifying Internet Explorer as the client

unsigned msie6:1¶

A boolean specifying Internet Explorer 6 as the client

unsigned opera:1¶

A boolean specifying Opera as the client

unsigned gecko:1¶

A boolean specifying the Gecko rendering engine as the client (ie. Firefox)

unsigned chrome:1¶

A boolean specifying Chrome as the client

unsigned safari:1¶

A boolean specifying Safari as the client

unsigned konqueror:1¶

A boolean specifying Konqueror as the client

ngx_http_headers_out_t¶

ngx_http_headers_out_t¶

A structure to store the outgoing header data

ngx_list_t headers¶

A list containing additional headers to be added

ngx_uint_t status¶

The status to return, possible options are the HTTP Return Codes

ngx_table_elt_t *content_encoding¶

Stores the “Content-Encoding” header, both key and value.

size_t content_type_len¶

The length of the content type, normally this should be set to the same as content_type.len

ngx_str_t content_type¶

A string containing the mime type for the content

off_t content_length_n¶

The length of the content body

time_t last_modified_time¶

The last modified time for the returned content

ngx_http_post_subrequest_t¶

ngx_http_post_subrequest_t¶

A structure to store a callback function for a subrequest

ngx_int_t (*ngx_http_post_subrequest_pt)(ngx_http_request_t *r, void *data, ngx_int_t rc)¶

The callback function to be triggered

void *data¶

A pointer to arbitrary data to send to the callback function

ngx_http_upstream_t¶

ngx_http_upstream_t¶

ngx_peer_connection_t peer¶

Connection details for the upstream peer.

ngx_http_upstream_conf_t *conf¶

A pointer to the configuration object for the upstream.

ngx_int_t (*create_request)(ngx_http_request_t *r)¶

A callback function which should allocate the required buffers for a request. It should return NGX_OK on success or NGX_ERROR on failure.

ngx_int_t (*reinit_request)(ngx_http_request_t *r)¶

A callback to reinitialize a state pointers if an attempt to communicate with an upstream fails. It should return NGX_OK on success.

ngx_int_t (*process_header)(ngx_http_request_t *r)¶

A callback to set the header for the client response after the upstream header has been retrieved. It should return NGX_OK on success.

void (*abort_request)(ngx_http_request_t *r)¶

A callback triggered when the client aborts a request.

void (*finalize_request)(ngx_http_request_t *r, ngx_int_t rc)¶

A callback triggered to finish the request.

ngx_table_elt_t¶

ngx_table_elt_t¶

An element from an NGINX hash table.

hash¶

Set to 1 to use this element or 0 to ignore it

key¶

A string containing the key for the hash element

value¶

A string containing the value for the hash element

ngx_http_upstream_conf_t¶

ngx_http_upstream_conf_t¶

An upstream configuration object used for upstream/proxy handlers

ngx_msec_t connect_timeout¶

The connect timeout for the upstream

ngx_msec_t send_timeout¶

The send timeout for the upstream

ngx_msec_t read_timeout¶

The read timeout for the upstream

ngx_msec_t next_upstream_timeout¶

Timeout before switching to the next upstream

ngx_uint_t store_access¶

Permissions for storing files such as temporary files to disk

ngx_bufs_t bufs¶

Buffers for the upstream body data

ngx_flag_t buffering¶

Whether or not to buffer the data

size_t buffer_size¶

The size of each buffer, it should normally be set to ngx_pagesize

size_t max_temp_file_size¶

The maximum size of temporary files

size_t temp_file_write_size¶

The amount of data before the body should be stored to disk

ngx_array_t *hide_headers¶

A list of header fields to not pass downstream

ngx_array_t *pass_headers¶

A list of header fields to pass downstream that are normally disabled. These are: “Date”, “Server”, “X-Pad”, and “X-Accel-…”

ngx_http_subrequest¶

ngx_int_t 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)¶

Executes a subrequest to a given URL

Parameters:	r – The main request object uri – The URI to call args – The GET arguments for the subrequest sr – A pointer to a pointer which is set by the function with the new request object psr – A callback to be triggered when the request is finihsed flags – Use NGX_HTTP_SUBREQUEST_IN_MEMORY to keep the subrequest result in memory after the subrequest is finished
Returns:	NGX_OK upon success or NGX_ERROR upon error setting up the request

ngx_http_get_module_ctx¶

void *ngx_http_get_module_ctx(ngx_http_request_t *r, ngx_module_t module)¶

A macro to get the context data for a given module and request

Parameters:	r – The request to get the context for module – The module to get the context for
Returns:	A pointer to the context

ngx_http_set_ctx¶

void ngx_http_set_ctx(ngx_http_request_t *r, void *c, ngx_module_t module)¶

A macro to set the context data for a given module and request

Parameters:	r – The request to set the context for c – The context data pointer module – The module to set the context for

ngx_http_parse_time¶

time_t ngx_http_parse_time(unsigned char *value, size_t len)¶

Converts a string containing RFC822, RFC850 or ISO C time formats into a time_t format.

Parameters:	value – The time string to convert len – The length of the string
Returns:	The converted time_t object

ngx_http_output_header_filter_pt¶

ngx_int_t (*ngx_http_output_header_filter+pt)(ngx_http_request_t *r)¶

A callback to a header filter. In modules this is normally used as follows:

static ngx_http_output_header_filter_pt ngx_http_next_header_filter;

ngx_http_output_body_filter_pt¶

ngx_int_t (*ngx_http_output_body_filter_pt)(ngx_http_request_t *r, ngx_chain_t *chain)¶

A callback to a body filter. In modules this is normally used as follows:

static ngx_http_output_body_filter_pt ngx_http_next_body_filter;