Apache2
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
apreq.h File Reference

Main header file...Define the common data structures. More...

#include "ap_config.h"
#include "apr_tables.h"
#include <stddef.h>
Include dependency graph for apreq.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  apreq_value_t
 libapreq's pre-extensible string type More...
 

Macros

#define APREQ_DEFAULT_READ_BLOCK_SIZE   (64 * 1024)
 
#define APREQ_DEFAULT_READ_LIMIT   (64 * 1024 * 1024)
 
#define APREQ_DEFAULT_BRIGADE_LIMIT   (256 * 1024)
 
#define APREQ_DEFAULT_NELTS   8
 
#define APREQ_FLAGS_OFF(f, name)   ((f) &= ~(name##_MASK << name##_BIT))
 
#define APREQ_FLAGS_ON(f, name)   ((f) |= (name##_MASK << name##_BIT))
 
#define APREQ_FLAGS_GET(f, name)   (((f) >> name##_BIT) & name##_MASK)
 
#define APREQ_FLAGS_SET(f, name, value)
 
#define APREQ_CHARSET_BIT   0
 
#define APREQ_CHARSET_MASK   255
 
#define APREQ_TAINTED_BIT   8
 
#define APREQ_TAINTED_MASK   1
 
#define APREQ_COOKIE_VERSION_BIT   11
 
#define APREQ_COOKIE_VERSION_MASK   3
 
#define APREQ_COOKIE_SECURE_BIT   13
 
#define APREQ_COOKIE_SECURE_MASK   1
 
#define APREQ_COOKIE_HTTPONLY_BIT   14
 
#define APREQ_COOKIE_HTTPONLY_MASK   1
 
#define apreq_attr_to_type(T, A, P)   ( (T*) ((char*)(P)-offsetof(T,A)) )
 

Typedefs

typedef struct apreq_value_t apreq_value_t
 libapreq's pre-extensible string type More...
 

Enumerations

enum  apreq_charset_t { APREQ_CHARSET_ASCII =0, APREQ_CHARSET_LATIN1 =1, APREQ_CHARSET_CP1252 =2, APREQ_CHARSET_UTF8 =8 }
 
enum  apreq_join_t { APREQ_JOIN_AS_IS, APREQ_JOIN_ENCODE, APREQ_JOIN_DECODE, APREQ_JOIN_QUOTE }
 
enum  apreq_match_t { APREQ_MATCH_FULL, APREQ_MATCH_PARTIAL }
 
enum  apreq_expires_t { APREQ_EXPIRES_HTTP, APREQ_EXPIRES_NSCOOKIE }
 

Functions

apr_status_t apreq_initialize (apr_pool_t *pool)
 
apr_status_t apreq_pre_initialize (apr_pool_t *pool)
 
apr_status_t apreq_post_initialize (apr_pool_t *pool)
 

Detailed Description

Main header file...

Define the common data structures.

Macro Definition Documentation

#define apreq_attr_to_type (   T,
  A,
 
)    ( (T*) ((char*)(P)-offsetof(T,A)) )
Parameters
Ttype
Aattribute
PXXX
#define APREQ_CHARSET_BIT   0
#define APREQ_CHARSET_MASK   255
#define APREQ_COOKIE_HTTPONLY_BIT   14
#define APREQ_COOKIE_HTTPONLY_MASK   1
#define APREQ_COOKIE_SECURE_BIT   13
#define APREQ_COOKIE_SECURE_MASK   1
#define APREQ_COOKIE_VERSION_BIT   11
#define APREQ_COOKIE_VERSION_MASK   3
#define APREQ_DEFAULT_BRIGADE_LIMIT   (256 * 1024)

Maximum number of bytes mod_apreq2 will let accumulate within the heap-buckets in a brigade. Excess data will be spooled to an appended file bucket

See Also
ap_set_brigade_read_limit
#define APREQ_DEFAULT_NELTS   8

Number of elements in the initial apr_table

See Also
apr_table_make
#define APREQ_DEFAULT_READ_BLOCK_SIZE   (64 * 1024)

Read chucks of data in 64k blocks from the request

#define APREQ_DEFAULT_READ_LIMIT   (64 * 1024 * 1024)

Maximum number of bytes mod_apreq2 will send off to libapreq2 for parsing. mod_apreq2 will log this event and subsequently remove itself from the filter chain.

See Also
ap_set_read_limit
#define APREQ_FLAGS_GET (   f,
  name 
)    (((f) >> name##_BIT) & name##_MASK)

Get specified bit f in bitfield name

#define APREQ_FLAGS_OFF (   f,
  name 
)    ((f) &= ~(name##_MASK << name##_BIT))

Check to see if specified bit f is off in bitfield name

#define APREQ_FLAGS_ON (   f,
  name 
)    ((f) |= (name##_MASK << name##_BIT))

Check to see if specified bit f is on in bitfield name

#define APREQ_FLAGS_SET (   f,
  name,
  value 
)
Value:
((f) = (((f) & ~(name##_MASK << name##_BIT)) \
| ((name##_MASK & (value)) << name##_BIT)))
const char * name
Definition: mod_dav.h:726

Set specified bit f in bitfield name to value Note the below BIT/Mask defines are used sans the _BIT, _MASK because of the this define's ##_MASK, ##_BIT usage. Each come in a pair

#define APREQ_TAINTED_BIT   8
#define APREQ_TAINTED_MASK   1

Typedef Documentation

typedef struct apreq_value_t apreq_value_t

libapreq's pre-extensible string type

Enumeration Type Documentation

Character encodings.

Enumerator
APREQ_CHARSET_ASCII 
APREQ_CHARSET_LATIN1 
APREQ_CHARSET_CP1252 
APREQ_CHARSET_UTF8 

Expiration date format

Enumerator
APREQ_EXPIRES_HTTP 

Use date formatting consistent with RFC 2616

APREQ_EXPIRES_NSCOOKIE 

Use format consistent with Netscape's Cookie Spec

Join type

Enumerator
APREQ_JOIN_AS_IS 

Join the strings without modification

APREQ_JOIN_ENCODE 

Url-encode the strings before joining them

APREQ_JOIN_DECODE 

Url-decode the strings before joining them

APREQ_JOIN_QUOTE 

Quote the strings, backslashing existing quote marks.

Match type

Enumerator
APREQ_MATCH_FULL 

Full match only.

APREQ_MATCH_PARTIAL 

Partial matches are ok.

Function Documentation

apr_status_t apreq_initialize ( apr_pool_t pool)

Initialize libapreq2. Applications (except apache modules using mod_apreq) should call this exactly once before they use any libapreq2 modules. If you want to modify the list of default parsers with apreq_register_parser(), please use apreq_pre_initialize() and apreq_post_initialize() instead.

Parameters
poola base pool persisting while libapreq2 is used
Remarks
after you destroy the pool, you have to call this function again with a new pool if you still plan to use libapreq2
apr_status_t apreq_post_initialize ( apr_pool_t pool)

Post-initialize libapreq2. Applications (except apache modules using mod_apreq2) should this exactly once before they use any libapreq2 modules for parsing.

Parameters
poolthe same pool that was used in apreq_pre_initialize().
apr_status_t apreq_pre_initialize ( apr_pool_t pool)

Pre-initialize libapreq2. Applications (except apache modules using mod_apreq2) should call this exactly once before they register custom parsers with libapreq2. mod_apreq2 does this automatically during the post-config phase, so modules that need call apreq_register_parser should create a post-config hook using APR_HOOK_MIDDLE.

Parameters
poola base pool persisting while libapreq2 is used
Remarks
after you destroyed the pool, you have to call this function again with a new pool if you still plan to use libapreq2