apreq_module.h File Reference

Module API. More...

#include "apreq_cookie.h"
#include "apreq_parser.h"
#include "apreq_error.h"

Include dependency graph for apreq_module.h:

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

Go to the source code of this file.

Data Structures
struct	apreq_handle_t
struct	apreq_module_t
	Vtable describing the necessary module functions. More...

Macros
#define	APREQ_MODULE(pre, mmn)
#define	apreq_cookie(req, name)   apreq_jar_get(req, name)

Typedefs
typedef struct apreq_handle_t	apreq_handle_t
typedef struct apreq_module_t	apreq_module_t
	Vtable describing the necessary module functions. More...

Functions
apreq_handle_t *	apreq_handle_cgi (apr_pool_t *pool)
apreq_handle_t *	apreq_handle_custom (apr_pool_t *pool, const char *query_string, const char *cookie, apreq_parser_t *parser, apr_uint64_t read_limit, apr_bucket_brigade *in)
apreq_param_t *	apreq_param (apreq_handle_t *req, const char *key)
apr_table_t *	apreq_params (apreq_handle_t *req, apr_pool_t *p)
apr_table_t *	apreq_cookies (apreq_handle_t *req, apr_pool_t *p)

Detailed Description

Module API.

Macro Definition Documentation

apreq_cookie

#define apreq_cookie	(		req,
			name
	)		apreq_jar_get(req, name)

Find the first cookie with the specified name. The match is case-insensitive.

Parameters

req	request handle.
name	desired cookie name

Returns

The first matching cookie or NULL.

APREQ_MODULE

#define APREQ_MODULE	(		pre,
			mmn
	)

Value:

  const apreq_module_t     \
  pre##_module = { #pre, mmn,                           \
  pre##_jar,        pre##_args,       pre##_body,       \
  pre##_jar_get,    pre##_args_get,   pre##_body_get,   \
  pre##_parser_get, pre##_parser_set, pre##_hook_add,   \
  pre##_brigade_limit_get, pre##_brigade_limit_set,     \
  pre##_read_limit_get,    pre##_read_limit_set,        \
  pre##_temp_dir_get,      pre##_temp_dir_set,          \
  }

Convenience macro for defining a module by mapping a function prefix to an associated apreq_module_t structure.

Parameters

pre	Prefix to define new module. All attributes of the apreq_module_t struct are defined with this as their prefix. The generated struct is named by appending "_module" to the prefix.
mmn	Magic number (i.e. version number) of this module.

Typedef Documentation

apreq_handle_t

typedef struct apreq_handle_t apreq_handle_t

An apreq handle associated with a module. The structure may have variable size, because the module may append its own data structures after it.

apreq_module_t

typedef struct apreq_module_t apreq_module_t

Vtable describing the necessary module functions.

Function Documentation

apreq_cookies()

apr_table_t* apreq_cookies	(	apreq_handle_t *	req,
		apr_pool_t *	p
	)

Returns a table containing all request cookies.

Parameters

req	the apreq request handle
p	Allocates the returned table.

apreq_handle_cgi()

apreq_handle_t* apreq_handle_cgi

(

apr_pool_t *

pool

)

Create an apreq handle which is suitable for a CGI program. It reads input from stdin and writes output to stdout.

Parameters

pool	Pool associated to this handle.

Returns

New handle; can only be NULL if the pool allocation failed.

Remarks

The handle gets cached in the pool's userdata, so subsequent calls will retrieve the original cached handle.

apreq_handle_custom()

apreq_handle_t* apreq_handle_custom	(	apr_pool_t *	pool,
		const char *	query_string,
		const char *	cookie,
		apreq_parser_t *	parser,
		apr_uint64_t	read_limit,
		apr_bucket_brigade *	in
	)

Create a custom apreq handle which knows only some static values. Useful if you want to test the parser code or if you have got data from a custom source (neither Apache 2 nor CGI).

Parameters

pool	allocates the parse data,
query_string	parsed into args table
cookie	value of the request "Cookie" header
parser	parses the request body
read_limit	maximum bytes to read from the body
in	brigade containing the request body

Returns

new handle; can only be NULL if the pool allocation failed.

apreq_param()

apreq_param_t* apreq_param	(	apreq_handle_t *	req,
		const char *	key
	)

Find the first query string parameter or body parameter with the specified name. The match is case-insensitive.

Parameters

req	request handle.
key	desired parameter name

Returns

The first matching parameter (with args searched first) or NULL.

apreq_params()

apr_table_t* apreq_params	(	apreq_handle_t *	req,
		apr_pool_t *	p
	)

Returns a table containing key-value pairs for the full request (args + body).

Parameters

req	request handle
p	allocates the returned table.

Returns

table representing all available params; is never NULL.