Apache2
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
mod_session
Collaboration diagram for mod_session:

Data Structures

struct  session_rec
 
struct  session_dir_conf
 

Macros

#define MOD_SESSION_NOTES_KEY   "mod_session_key"
 
#define MOD_SESSION_USER   "user"
 
#define MOD_SESSION_PW   "pw"
 

Functions

apr_status_t ap_hook_session_load (request_rec *r, session_rec **z)
 
apr_status_t ap_hook_session_save (request_rec *r, session_rec *z)
 
apr_status_t ap_hook_session_encode (request_rec *r, session_rec *z)
 
apr_status_t ap_hook_session_decode (request_rec *r, session_rec *z)
 
apr_status_t ap_session_get (request_rec *r, session_rec *z, const char *key, const char **value)
 
apr_status_t ap_session_set (request_rec *r, session_rec *z, const char *key, const char *value)
 
apr_status_t ap_session_load (request_rec *, session_rec **)
 
apr_status_t ap_session_save (request_rec *, session_rec *)
 

Variables

module AP_MODULE_DECLARE_DATA session_module
 

Detailed Description

Macro Definition Documentation

#define MOD_SESSION_NOTES_KEY   "mod_session_key"
#define MOD_SESSION_PW   "pw"

Define the name of a password stored in the session, so that modules interested in the password can find it in a standard place.

#define MOD_SESSION_USER   "user"

Define the name of a username stored in the session, so that modules interested in the username can find it in a standard place.

Function Documentation

apr_status_t ap_hook_session_decode ( request_rec r,
session_rec z 
)

Hook to decode the session.

In the default implementation, the key value pairs are encoded using key value pairs separated by equals, in turn separated by ampersand, like a web form.

Parameters
rThe request
zA pointer to where the session will be written.
apr_status_t ap_hook_session_encode ( request_rec r,
session_rec z 
)

Hook to encode the session.

In the default implementation, the key value pairs are encoded using key value pairs separated by equals, in turn separated by ampersand, like a web form.

Parameters
rThe request
zA pointer to where the session will be written.
apr_status_t ap_hook_session_load ( request_rec r,
session_rec **  z 
)

Hook to load the session.

If the session doesn't exist, a blank one will be created.

Parameters
rThe request
zA pointer to where the session will be written.
apr_status_t ap_hook_session_save ( request_rec r,
session_rec z 
)

Hook to save the session.

In most implementations the session is only saved if the dirty flag is true. This prevents the session being saved unnecessarily.

Parameters
rThe request
zA pointer to where the session will be written.
apr_status_t ap_session_get ( request_rec r,
session_rec z,
const char *  key,
const char **  value 
)
apr_status_t ap_session_load ( request_rec ,
session_rec **   
)
apr_status_t ap_session_save ( request_rec ,
session_rec  
)
apr_status_t ap_session_set ( request_rec r,
session_rec z,
const char *  key,
const char *  value 
)

Variable Documentation

The name of the module.