Session State API

Functions
AP_SESSION_API void	AP_SESSION_SetSessionStateByName (AP_SESSION_Interface *smi, const char *sessionName, AP_SESSION_State state, bool generateNewId=false)
AP_SESSION_API void	AP_SESSION_SetSessionStateById (AP_SESSION_Interface *smi, AP_int64 sourceId, AP_SESSION_State state, bool generateNewId=false)
AP_SESSION_API AP_SESSION_State	AP_SESSION_GetSessionStateByName (AP_SESSION_Interface *smi, const char *sessionName)
AP_SESSION_API AP_SESSION_State	AP_SESSION_GetSessionStateById (AP_SESSION_Interface *smi, AP_int64 sourceId)
AP_SESSION_API HashMap *	AP_SESSION_GetAllSessionStates (AP_SESSION_Interface *smi)

Detailed Description

Session State API

See also

AP_SESSION_State

Function Documentation

AP_SESSION_GetAllSessionStates()

AP_SESSION_API HashMap* AP_SESSION_GetAllSessionStates

(

AP_SESSION_Interface *

smi

)

Get all Sessions States.

Parameters

smi	The AP_SESSION_Interface to use.

Returns

A pointer to a HashMap of session names to states.

AP_SESSION_GetSessionStateById()

AP_SESSION_API AP_SESSION_State AP_SESSION_GetSessionStateById	(	AP_SESSION_Interface *	smi,
		AP_int64	sourceId
	)

Get a Sessions State by Id.

Parameters

smi	The AP_SESSION_Interface to use.
sourceId	The Id of the session to get the state.

Returns

The session state.

AP_SESSION_GetSessionStateByName()

AP_SESSION_API AP_SESSION_State AP_SESSION_GetSessionStateByName	(	AP_SESSION_Interface *	smi,
		const char *	sessionName
	)

Get a Sessions State by name.

Parameters

smi	The AP_SESSION_Interface to use.
sessionName	The name of the session to get the state.

Returns

The session state.

AP_SESSION_SetSessionStateById()

AP_SESSION_API void AP_SESSION_SetSessionStateById	(	AP_SESSION_Interface *	smi,
		AP_int64	sourceId,
		AP_SESSION_State	state,
		bool	generateNewId = false
	)

Set a Sessions State by Id.

Parameters

smi	The AP_SESSION_Interface to use.
sourceId	The id of the session to set the state.
state	The state to set the session to.
generateNewId	Whether to generate a new connection Id.

AP_SESSION_SetSessionStateByName()

AP_SESSION_API void AP_SESSION_SetSessionStateByName	(	AP_SESSION_Interface *	smi,
		const char *	sessionName,
		AP_SESSION_State	state,
		bool	generateNewId = false
	)

Set a Sessions State by name.

Parameters

smi	The AP_SESSION_Interface to use.
sessionName	The name of the session to set the state.
state	The state to set the session to.
generateNewId	Whether to generate a new connection Id.