Main Page | Modules | Namespace List | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Related Pages | Examples

Apache Hooks


Functions

 AP_DECLARE_HOOK (int, get_mgmt_items,(apr_pool_t *p, const char *val, apr_hash_t *ht)) APR_DECLARE_OPTIONAL_FN(void
 AP_DECLARE_HOOK (void, insert_error_filter,(request_rec *r)) AP_DECLARE_DATA extern ap_filter_rec_t *ap_old_write_func
 AP_DECLARE_HOOK (int, create_request,(request_rec *r)) AP_DECLARE_HOOK(int
request_rec *r AP_DECLARE_HOOK (int, map_to_storage,(request_rec *r)) AP_DECLARE_HOOK(int
request_rec *r request_rec *r AP_DECLARE_HOOK (int, fixups,(request_rec *r)) AP_DECLARE_HOOK(int
request_rec *r request_rec
*r request_rec *r 
AP_DECLARE_HOOK (int, access_checker,(request_rec *r)) AP_DECLARE_HOOK(int
request_rec *r request_rec
*r request_rec *r request_rec
*r 
AP_DECLARE_HOOK (void, insert_filter,(request_rec *r)) AP_DECLARE(int) ap_location_walk(request_rec *r)

Function Documentation

request_rec* r request_rec* r request_rec* r request_rec* r AP_DECLARE_HOOK void  ,
insert_filter  ,
(request_rec *r
 

This hook allows modules to insert filters for the current request

Parameters:
r the current request

request_rec* r request_rec* r request_rec* r AP_DECLARE_HOOK int  ,
access_checker  ,
(request_rec *r
 

This hook is used to check to see if the resource being requested is available for the authenticated user (r->user and r->ap_auth_type). It runs after the access_checker and check_user_id hooks. Note that it will *only* be called if Apache determines that access control has been applied to this resource (through a 'Require' directive).

Parameters:
r the current request
Returns:
OK, DECLINED, or HTTP_...

request_rec* r request_rec* r AP_DECLARE_HOOK int  ,
fixups  ,
(request_rec *r
 

This routine is called to determine and/or set the various document type information bits, like Content-type (via r->content_type), language, et cetera.

Parameters:
r the current request
Returns:
OK, DECLINED, or HTTP_...

request_rec* r AP_DECLARE_HOOK int  ,
map_to_storage  ,
(request_rec *r
 

This hook is used to analyze the request headers, authenticate the user, and set the user information in the request record (r->user and r->ap_auth_type). This hook is only run when Apache determines that authentication/authorization is required for this resource (as determined by the 'Require' directive). It runs after the access_checker hook, and before the auth_checker hook.

Parameters:
r The current request
Returns:
OK, DECLINED, or HTTP_...

AP_DECLARE_HOOK int  ,
create_request  ,
(request_rec *r
 

This hook allow modules an opportunity to translate the URI into an actual filename. If no modules do anything special, the server's default rules will be followed.

Parameters:
r The current request
Returns:
OK, DECLINED, or HTTP_...

AP_DECLARE_HOOK void  ,
insert_error_filter  ,
(request_rec *r
 

This hook allows modules to insert filters for the current error response

Parameters:
r the current request

AP_DECLARE_HOOK int  ,
get_mgmt_items  ,
(apr_pool_t *p, const char *val, apr_hash_t *ht
 

This hook provdes a way for modules to provide metrics/statistics about their operational status.

Parameters:
p A pool to use to create entries in the hash table
val The name of the parameter(s) that is wanted. This is tree-structured would be in the form ('*' is all the tree, 'module.*' all of the module , 'module.foo.*', or 'module.foo.bar' )
ht The hash table to store the results. Keys are item names, and the values point to ap_mgmt_item_t structures.