src/http/modules/xxslt/ngx_http_xxslt_filter_module.h File Reference

#include <ngx_config.h>
#include <ngx_core.h>
#include <ngx_http.h>
#include "ngx_http_xxslt_selector.h"
#include "ngx_http_xxslt_udata.h"
#include "ngx_http_xxslt_parse.h"

Go to the source code of this file.

Data Structures
struct	ngx_http_xxslt_filter_main_conf_t
	XXSLT filter main configuration. More...
struct	ngx_http_xxslt_filter_loc_conf_t
	XXSLT filter local configuration. More...
struct	ngx_http_xxslt_out_data_s
	XXSLT filter output data structure. More...
struct	ngx_http_xxslt_filter_ctx_t
	XXSLT filter context. More...
Defines
#define	NGX_XXSLT_DATA_PARSE   2
#define	NGX_XXSLT_DATA_UNKNOWN   3
#define	XXSLT_USE_CACHE   11
#define	XXSLT_NO_CACHE   12
Typedefs
typedef struct ngx_http_xxslt_out_data_s	ngx_http_xxslt_out_data_t
Functions
void	ngx_http_xxslt_enqueue_data (ngx_http_xxslt_out_data_t *data)
	Enqueues data pack in global output data queue.
ngx_int_t	ngx_http_xxslt_process_data (ngx_http_request_t *r)
	Processes output data packs.
ngx_int_t	ngx_http_xxslt_finalize_with_error (ngx_http_request_t *r, ngx_int_t err, char *msg,...)
	Finalizes request and generates an appropriate error page.

---

Define Documentation

#define NGX_XXSLT_DATA_PARSE   2

Definition at line 33 of file ngx_http_xxslt_filter_module.h.

#define NGX_XXSLT_DATA_UNKNOWN   3

Definition at line 34 of file ngx_http_xxslt_filter_module.h.

#define XXSLT_NO_CACHE   12

Definition at line 37 of file ngx_http_xxslt_filter_module.h.

#define XXSLT_USE_CACHE   11

Definition at line 36 of file ngx_http_xxslt_filter_module.h.

---

Typedef Documentation

typedef struct ngx_http_xxslt_out_data_s ngx_http_xxslt_out_data_t

Definition at line 40 of file ngx_http_xxslt_filter_module.h.

---

Function Documentation

void ngx_http_xxslt_enqueue_data

(

ngx_http_xxslt_out_data_t *

data

)

Enqueues data pack in global output data queue.

That queue is checked and processed every ngx_http_xxslt_process_data call.

Parameters:

data

output data pack

Definition at line 143 of file ngx_http_xxslt_filter_module.c.

References ngx_http_xxslt_filter_ctx_t::act_data, ngx_http_xxslt_out_data_s::next, ngx_http_xxslt_filter_module, ngx_http_xxslt_filter_ctx_t::out_data, ngx_http_xxslt_filter_ctx_t::out_data_tail, and ngx_http_xxslt_out_data_s::r.

Referenced by ngx_http_xxslt_selector_parse_match(), and ngx_http_xxslt_selector_unknown_match().

ngx_int_t ngx_http_xxslt_finalize_with_error	(	ngx_http_request_t *	r,
		ngx_int_t	err,
		char *	msg,
			...
	)

Finalizes request and generates an appropriate error page.

If err is greater than 0, then the page will be generated with your msg, otherwise the standard nginx 503 page.

Parameters:

	r	nginx http request
	err	error code
	msg	error page message

Returns:

NGX_ERROR

Definition at line 330 of file ngx_http_xxslt_filter_module.c.

References ngx_http_xxslt_send().

Referenced by ngx_http_xxslt_parse_add_data_chunk(), ngx_http_xxslt_parse_apply(), ngx_http_xxslt_parse_get_external_include(), ngx_http_xxslt_parse_get_local_include(), ngx_http_xxslt_parse_process_include(), and ngx_http_xxslt_unknown_add_data_chunk().

ngx_int_t ngx_http_xxslt_process_data

(

ngx_http_request_t *

r

)

Processes output data packs.

Passes through the queue and performs actions specific to the data type.

Parameters:

r

nginx http request

Returns:

NGX_OK if all data processed, NGX_ERROR on error, or NGX_DONE if not all data are ready

Definition at line 177 of file ngx_http_xxslt_filter_module.c.

References ngx_http_xxslt_filter_ctx_t::act_data, ngx_http_xxslt_out_data_s::data_type, ngx_http_xxslt_parse_data_t::done, ngx_http_xxslt_unknown_data_t::done, ngx_http_xxslt_out_data_s::last, ngx_http_xxslt_out_data_s::next, ngx_http_xxslt_filter_module, ngx_http_xxslt_finalize(), ngx_http_xxslt_parse_apply(), ngx_http_xxslt_process_parse_result(), ngx_http_xxslt_process_unknown_result(), NGX_HTTP_XXSLT_SELECTOR_PARSE, NGX_HTTP_XXSLT_SELECTOR_UNKNOWN, ngx_http_xxslt_filter_ctx_t::out_data_tail, ngx_http_xxslt_out_data_s::parse, and ngx_http_xxslt_out_data_s::unknown.

Referenced by ngx_http_xxslt_parse_process_include(), ngx_http_xxslt_selector_add_data_chunk(), and ngx_http_xxslt_unknown_add_data_chunk().