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

MOD_SESSION_NOTES_KEY

#define MOD_SESSION_NOTES_KEY   "mod_session_key"

MOD_SESSION_PW

#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.

MOD_SESSION_USER

#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

ap_hook_session_decode()

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

r	The request
z	A pointer to where the session will be written.

ap_hook_session_encode()

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

r	The request
z	A pointer to where the session will be written.

ap_hook_session_load()

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

r	The request
z	A pointer to where the session will be written.

ap_hook_session_save()

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

r	The request
z	A pointer to where the session will be written.

ap_session_get()

apr_status_t ap_session_get	(	request_rec *	r,
		session_rec *	z,
		const char *	key,
		const char **	value
	)

ap_session_load()

apr_status_t ap_session_load	(	request_rec *	,
		session_rec **
	)

ap_session_save()

apr_status_t ap_session_save	(	request_rec *	,
		session_rec *
	)

ap_session_set()

apr_status_t ap_session_set	(	request_rec *	r,
		session_rec *	z,
		const char *	key,
		const char *	value
	)

Variable Documentation

session_module

module AP_MODULE_DECLARE_DATA session_module

extern

The name of the module.