mod_session

Classes
struct	session_rec
struct	session_dir_conf
struct	ap_LINK_session_load_t
struct	ap_LINK_session_save_t
struct	ap_LINK_session_encode_t
struct	ap_LINK_session_decode_t

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

Typedefs
typedef apr_status_t	ap_HOOK_session_load_t(request_rec *r, session_rec **z)
typedef struct ap_LINK_session_load_t	ap_LINK_session_load_t
typedef apr_status_t	ap_HOOK_session_save_t(request_rec *r, session_rec *z)
typedef struct ap_LINK_session_save_t	ap_LINK_session_save_t
typedef apr_status_t	ap_HOOK_session_encode_t(request_rec *r, session_rec *z)
typedef struct ap_LINK_session_encode_t	ap_LINK_session_encode_t
typedef apr_status_t	ap_HOOK_session_decode_t(request_rec *r, session_rec *z)
typedef struct ap_LINK_session_decode_t	ap_LINK_session_decode_t
typedef apr_status_t()	apr_OFN_ap_session_get_t(request_rec *r, session_rec *z, const char *key, const char **value)
typedef apr_status_t()	apr_OFN_ap_session_set_t(request_rec *r, session_rec *z, const char *key, const char *value)
typedef apr_status_t()	apr_OFN_ap_session_load_t(request_rec *, session_rec **)
typedef apr_status_t()	apr_OFN_ap_session_save_t(request_rec *, session_rec *)

Functions
void	ap_hook_session_load (ap_HOOK_session_load_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
apr_status_t	ap_run_session_load (request_rec *r, session_rec **z)
apr_array_header_t *	ap_hook_get_session_load (void)
void	ap_hook_session_save (ap_HOOK_session_save_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
apr_status_t	ap_run_session_save (request_rec *r, session_rec *z)
apr_array_header_t *	ap_hook_get_session_save (void)
void	ap_hook_session_encode (ap_HOOK_session_encode_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
apr_status_t	ap_run_session_encode (request_rec *r, session_rec *z)
apr_array_header_t *	ap_hook_get_session_encode (void)
void	ap_hook_session_decode (ap_HOOK_session_decode_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
apr_status_t	ap_run_session_decode (request_rec *r, session_rec *z)
apr_array_header_t *	ap_hook_get_session_decode (void)

Detailed Description

Macro Definition Documentation

MOD_SESSION_NOTES_KEY

#define MOD_SESSION_NOTES_KEY   "mod_session_key"

Definition at line 61 of file mod_session.h.

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.

Definition at line 73 of file mod_session.h.

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.

Definition at line 67 of file mod_session.h.

Typedef Documentation

ap_HOOK_session_decode_t

typedef apr_status_t ap_HOOK_session_decode_t(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.

Definition at line 170 of file mod_session.h.

ap_HOOK_session_encode_t

typedef apr_status_t ap_HOOK_session_encode_t(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.

Definition at line 157 of file mod_session.h.

ap_HOOK_session_load_t

typedef apr_status_t ap_HOOK_session_load_t(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.

Definition at line 132 of file mod_session.h.

ap_HOOK_session_save_t

typedef apr_status_t ap_HOOK_session_save_t(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.

Definition at line 144 of file mod_session.h.

ap_LINK_session_decode_t

typedef struct ap_LINK_session_decode_t ap_LINK_session_decode_t

ap_LINK_session_encode_t

typedef struct ap_LINK_session_encode_t ap_LINK_session_encode_t

ap_LINK_session_load_t

typedef struct ap_LINK_session_load_t ap_LINK_session_load_t

ap_LINK_session_save_t

typedef struct ap_LINK_session_save_t ap_LINK_session_save_t

apr_OFN_ap_session_get_t

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

Definition at line 175 of file mod_session.h.

apr_OFN_ap_session_load_t

typedef apr_status_t() apr_OFN_ap_session_load_t(request_rec *, session_rec **)

Definition at line 179 of file mod_session.h.

apr_OFN_ap_session_save_t

typedef apr_status_t() apr_OFN_ap_session_save_t(request_rec *, session_rec *)

Definition at line 181 of file mod_session.h.

apr_OFN_ap_session_set_t

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

Definition at line 177 of file mod_session.h.

Function Documentation

ap_hook_get_session_decode()

apr_array_header_t * ap_hook_get_session_decode

(

void

)

Definition at line 41 of file mod_session.c.

ap_hook_get_session_encode()

apr_array_header_t * ap_hook_get_session_encode

(

void

)

Definition at line 39 of file mod_session.c.

ap_hook_get_session_load()

apr_array_header_t * ap_hook_get_session_load

(

void

)

Definition at line 35 of file mod_session.c.

ap_hook_get_session_save()

apr_array_header_t * ap_hook_get_session_save

(

void

)

Definition at line 37 of file mod_session.c.

ap_hook_session_decode()

void ap_hook_session_decode	(	ap_HOOK_session_decode_t *	pf,
		const char *const *	aszPre,
		const char *const *	aszSucc,
		int	nOrder
	)

Definition at line 41 of file mod_session.c.

ap_hook_session_encode()

void ap_hook_session_encode	(	ap_HOOK_session_encode_t *	pf,
		const char *const *	aszPre,
		const char *const *	aszSucc,
		int	nOrder
	)

Definition at line 39 of file mod_session.c.

ap_hook_session_load()

void ap_hook_session_load	(	ap_HOOK_session_load_t *	pf,
		const char *const *	aszPre,
		const char *const *	aszSucc,
		int	nOrder
	)

Definition at line 35 of file mod_session.c.

ap_hook_session_save()

void ap_hook_session_save	(	ap_HOOK_session_save_t *	pf,
		const char *const *	aszPre,
		const char *const *	aszSucc,
		int	nOrder
	)

Definition at line 37 of file mod_session.c.

ap_run_session_decode()

apr_status_t ap_run_session_decode	(	request_rec *	r,
		session_rec *	z
	)

< Module has handled this stage.

< Module has handled this stage.

< Module declines to handle

< Module has handled this stage.

Definition at line 41 of file mod_session.c.

ap_run_session_encode()

apr_status_t ap_run_session_encode	(	request_rec *	r,
		session_rec *	z
	)

< Module has handled this stage.

< Module has handled this stage.

< Module declines to handle

< Module has handled this stage.

Definition at line 39 of file mod_session.c.

ap_run_session_load()

apr_status_t ap_run_session_load	(	request_rec *	r,
		session_rec **	z
	)

< Module declines to handle

< Module declines to handle

Definition at line 35 of file mod_session.c.

ap_run_session_save()

apr_status_t ap_run_session_save	(	request_rec *	r,
		session_rec *	z
	)

< Module declines to handle

< Module declines to handle

Definition at line 37 of file mod_session.c.