Application and session functions

Defines
#define	rxv_spin_app_sget(ctx, key)   rxv_spin_string(rxv_spin_app_get((ctx),(key)))
#define	rxv_spin_app_sset(ctx, key, val)   rxv_spin_app_set((ctx),(key),rxv_spin_datum(rxv_spin_pool(ctx),(val),NULL))
#define	rxv_spin_ses_sget(ctx, key)   rxv_spin_string(rxv_spin_ses_get((ctx),(key)))
#define	rxv_spin_ses_sset(ctx, key, val)   rxv_spin_ses_set((ctx),(key),rxv_spin_datum(rxv_spin_pool(ctx),(val),NULL))
Functions
rxv_spin_data_t *	rxv_spin_app_get (rxv_spin_ctx_t *ctx, const char *key)
rxv_spin_data_t *	rxv_spin_app_set (rxv_spin_ctx_t *ctx, const char *key, rxv_spin_data_t *val)
apr_status_t	rxv_spin_app_del (rxv_spin_ctx_t *ctx, const char *key)
rxv_spin_data_t *	rxv_spin_ses_get (rxv_spin_ctx_t *ctx, const char *key)
rxv_spin_data_t *	rxv_spin_ses_set (rxv_spin_ctx_t *ctx, const char *key, rxv_spin_data_t *val)
apr_status_t	rxv_spin_ses_del (rxv_spin_ctx_t *ctx, const char *key)
void	rxv_spin_ses_kill (rxv_spin_ctx_t *ctx)
char *	rxv_spin_ses_id (rxv_spin_ctx_t *ctx)
int	rxv_spin_ses_valid (rxv_spin_ctx_t *ctx)
apr_time_t	rxv_spin_ses_atime (rxv_spin_ctx_t *ctx)

---

Detailed Description

Application and session functions (mod_spin API)

---

Define Documentation

#define rxv_spin_app_sget	(	ctx,
		key		)	rxv_spin_string(rxv_spin_app_get((ctx),(key)))

get a string from application instead of single

#define rxv_spin_app_sset	(	ctx,
		key,
		val		)	rxv_spin_app_set((ctx),(key),rxv_spin_datum(rxv_spin_pool(ctx),(val),NULL))

set string into application instead of single

#define rxv_spin_ses_sget	(	ctx,
		key		)	rxv_spin_string(rxv_spin_ses_get((ctx),(key)))

get a string from session instead of single

#define rxv_spin_ses_sset	(	ctx,
		key,
		val		)	rxv_spin_ses_set((ctx),(key),rxv_spin_datum(rxv_spin_pool(ctx),(val),NULL))

set string into application instead of single

---

Function Documentation

rxv_spin_data_t* rxv_spin_app_get	(	rxv_spin_ctx_t *	ctx,
		const char *	key
	)

Retrieve a value from the application store.

Parameters:

	ctx	Context
	key	Unique key by which this value is identified

Returns:

pointer to the value, NULL on error

Example:

 rxv_spin_app_get(ctx,"some application key");

rxv_spin_data_t* rxv_spin_app_set	(	rxv_spin_ctx_t *	ctx,
		const char *	key,
		rxv_spin_data_t *	val
	)

Put value in the application store.

Parameters:

	ctx	Context
	key	Unique key by which this value is identified
	val	Value to be placed in the store (single)

Returns:

pointer to the value, NULL on error

Example:

 rxv_spin_app_set(ctx,"some application key",
                  rxv_spin_datum(pool,"some application value",NULL));

Warning:

The data set into the application store has to have at least the lifetime of the request. Anything less and the pool used to hold the data may get cleaned before the bucket holding the value gets created. In most cases, this will result in a segfault.

apr_status_t rxv_spin_app_del	(	rxv_spin_ctx_t *	ctx,
		const char *	key
	)

Delete a record in the application store.

Parameters:

	ctx	Context
	key	Unique key by which record is identified

Returns:

APR_SUCCESS on success, otherwise an error

Example:

 rxv_spin_app_del(ctx,"some application key");

Remarks:

It is not an error to delete and non-existent record.

rxv_spin_data_t* rxv_spin_ses_get	(	rxv_spin_ctx_t *	ctx,
		const char *	key
	)

Retrieve a value from the session store.

Parameters:

	ctx	Context
	key	Unique key by which this value is identified

Returns:

pointer to the value, NULL on error

Example:

 rxv_spin_ses_get(ctx,"some session key");

rxv_spin_data_t* rxv_spin_ses_set	(	rxv_spin_ctx_t *	ctx,
		const char *	key,
		rxv_spin_data_t *	val
	)

Put value in the session store.

Parameters:

	ctx	Context
	key	Unique key by which this value is identified
	val	Value to be placed in the store (single)

Returns:

pointer to the value, NULL on error

Example:

 rxv_spin_ses_set(ctx,"some session key",
                  rxv_spin_datum(pool,"some session value",NULL));

Warning:

The data set into the session store has to have at least the lifetime of the request. Anything less and the pool used to hold the data may get cleaned before the bucket holding the value gets created. In most cases, this will result in a segfault.

apr_status_t rxv_spin_ses_del	(	rxv_spin_ctx_t *	ctx,
		const char *	key
	)

Delete a record in the session store.

Parameters:

	ctx	Context
	key	Unique key by which record is identified

Returns:

APR_SUCCESS on success, otherwise an error

Example:

 rxv_spin_ses_del(ctx,"some session key");

Remarks:

It is not an error to delete and non-existent record.

void rxv_spin_ses_kill

(

rxv_spin_ctx_t *

ctx

)

Kill the session

Parameters:

ctx

Context

Example:

 rxv_spin_ses_kill(ctx);

Remarks:

Destroys the session by marking session data for removal from the store. Note that session cookie will still get served. This function would usually be used to log users out of the system, as any session data would have to be reestablished once user logs back in.

char* rxv_spin_ses_id

(

rxv_spin_ctx_t *

ctx

)

Get session id

Parameters:

ctx

Context

Returns:

Session id or NULL if no session support exists

Example:

 rxv_spin_ses_id(ctx);

Remarks:

This function fetches a string representation of the session id, which draws is origin from mod_unique_id. If mod_unique_id isn't present in Apache, this function returns NULL. Note that the fact that one can get a session id does not mean that there is a valid session in existence (that is to say, that the client accepted the session). Use rxv_spin_ses_valid() function to find that out.

int rxv_spin_ses_valid

(

rxv_spin_ctx_t *

ctx

)

Find out if the session is valid.

Parameters:

ctx

Context

Returns:

1 if valid, otherwise 0

Example:

 rxv_spin_ses_valid(ctx);

Remarks:

If the client accepted this session, this function returns 1. This will only be true if the client submitted a valid session id and its relevant hash to mod_spin. Also, the session will not be considered valid if there are path tricks in the session id (this is unlikely to happen, due to hash checking, but nevertheless).

apr_time_t rxv_spin_ses_atime

(

rxv_spin_ctx_t *

ctx

)

Last access time for the session.

Parameters:

ctx

Context

Returns:

Access time, 0 if session has been killed or on error

Example:

 rxv_spin_ses_atime(ctx);