ngx_http_variables.h File Reference

#include <ngx_config.h>
#include <ngx_core.h>
#include <ngx_http.h>

Include dependency graph for ngx_http_variables.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	ngx_http_variable_s
struct	ngx_http_map_t

Macros
#define	ngx_http_variable(v)   { sizeof(v) - 1, 1, 0, 0, 0, (u_char *) v }
#define	NGX_HTTP_VAR_CHANGEABLE   1
#define	NGX_HTTP_VAR_NOCACHEABLE   2
#define	NGX_HTTP_VAR_INDEXED   4
#define	NGX_HTTP_VAR_NOHASH   8

Typedefs
typedef ngx_variable_value_t	ngx_http_variable_value_t
typedef struct ngx_http_variable_s	ngx_http_variable_t
typedef void(*	ngx_http_set_variable_pt )(ngx_http_request_t *r, ngx_http_variable_value_t *v, uintptr_t data)
typedef ngx_int_t(*	ngx_http_get_variable_pt )(ngx_http_request_t *r, ngx_http_variable_value_t *v, uintptr_t data)

Functions
ngx_http_variable_t *	ngx_http_add_variable (ngx_conf_t *cf, ngx_str_t *name, ngx_uint_t flags)
ngx_int_t	ngx_http_get_variable_index (ngx_conf_t *cf, ngx_str_t *name)
ngx_http_variable_value_t *	ngx_http_get_indexed_variable (ngx_http_request_t *r, ngx_uint_t index)
ngx_http_variable_value_t *	ngx_http_get_flushed_variable (ngx_http_request_t *r, ngx_uint_t index)
ngx_http_variable_value_t *	ngx_http_get_variable (ngx_http_request_t *r, ngx_str_t *name, ngx_uint_t key)
ngx_int_t	ngx_http_variable_unknown_header (ngx_http_variable_value_t *v, ngx_str_t *var, ngx_list_part_t *part, size_t prefix)
void *	ngx_http_map_find (ngx_http_request_t *r, ngx_http_map_t *map, ngx_str_t *match)
ngx_int_t	ngx_http_variables_add_core_vars (ngx_conf_t *cf)
ngx_int_t	ngx_http_variables_init_vars (ngx_conf_t *cf)

Variables
ngx_http_variable_value_t	ngx_http_variable_null_value
ngx_http_variable_value_t	ngx_http_variable_true_value

Macro Definition Documentation

#define NGX_HTTP_VAR_CHANGEABLE   1

Definition at line 29 of file ngx_http_variables.h.

#define NGX_HTTP_VAR_INDEXED   4

Definition at line 31 of file ngx_http_variables.h.

#define NGX_HTTP_VAR_NOCACHEABLE   2

Definition at line 30 of file ngx_http_variables.h.

#define NGX_HTTP_VAR_NOHASH   8

Definition at line 32 of file ngx_http_variables.h.

#define ngx_http_variable

(

v

)

{ sizeof(v) - 1, 1, 0, 0, 0, (u_char *) v }

Definition at line 19 of file ngx_http_variables.h.

Typedef Documentation

typedef ngx_int_t(* ngx_http_get_variable_pt)(ngx_http_request_t *r, ngx_http_variable_value_t *v, uintptr_t data)

Definition at line 25 of file ngx_http_variables.h.

typedef void(* ngx_http_set_variable_pt)(ngx_http_request_t *r, ngx_http_variable_value_t *v, uintptr_t data)

Definition at line 23 of file ngx_http_variables.h.

typedef struct ngx_http_variable_s ngx_http_variable_t

Definition at line 21 of file ngx_http_variables.h.

typedef ngx_variable_value_t ngx_http_variable_value_t

Definition at line 17 of file ngx_http_variables.h.

Function Documentation

ngx_http_variable_t* ngx_http_add_variable	(	ngx_conf_t *	cf,
		ngx_str_t *	name,
		ngx_uint_t	flags
	)

Definition at line 350 of file ngx_http_variables.c.

Here is the call graph for this function:

ngx_http_variable_value_t* ngx_http_get_flushed_variable	(	ngx_http_request_t *	r,
		ngx_uint_t	index
	)

Definition at line 518 of file ngx_http_variables.c.

Here is the call graph for this function:

Here is the caller graph for this function:

ngx_http_variable_value_t* ngx_http_get_indexed_variable	(	ngx_http_request_t *	r,
		ngx_uint_t	index
	)

Definition at line 481 of file ngx_http_variables.c.

Here is the call graph for this function:

Here is the caller graph for this function:

ngx_http_variable_value_t* ngx_http_get_variable	(	ngx_http_request_t *	r,
		ngx_str_t *	name,
		ngx_uint_t	key
	)

Definition at line 538 of file ngx_http_variables.c.

Here is the call graph for this function:

ngx_int_t ngx_http_get_variable_index	(	ngx_conf_t *	cf,
		ngx_str_t *	name
	)

Definition at line 421 of file ngx_http_variables.c.

Here is the call graph for this function:

void* ngx_http_map_find	(	ngx_http_request_t *	r,
		ngx_http_map_t *	map,
		ngx_str_t *	match
	)

Definition at line 2164 of file ngx_http_variables.c.

Here is the call graph for this function:

ngx_int_t ngx_http_variable_unknown_header	(	ngx_http_variable_value_t *	v,
		ngx_str_t *	var,
		ngx_list_part_t *	part,
		size_t	prefix
	)

Definition at line 843 of file ngx_http_variables.c.

Here is the caller graph for this function:

ngx_int_t ngx_http_variables_add_core_vars

(

ngx_conf_t *

cf

)

Definition at line 2379 of file ngx_http_variables.c.

Here is the call graph for this function:

ngx_int_t ngx_http_variables_init_vars

(

ngx_conf_t *

cf

)

Definition at line 2430 of file ngx_http_variables.c.

Here is the call graph for this function:

Variable Documentation

ngx_http_variable_value_t ngx_http_variable_null_value

Definition at line 343 of file ngx_http_variables.c.

ngx_http_variable_value_t ngx_http_variable_true_value

Definition at line 345 of file ngx_http_variables.c.