Main Page | Modules | Data Structures | Directories | File List | Data Fields | Globals

Sessions


Functions

int session_set (session_t *, const char *, const char *)
 Set session variable with given name to a value.
const char * session_get (session_t *, const char *)
 Get session variable with given name.
vars_t * session_get_vars (session_t *)
 Get session variables.
int session_del (session_t *, const char *)
 Delete session variable given a name.
int session_clean (session_t *)
 Remove all session variables.
int session_age (session_t *)
 Get the amount of time a session has been inactive.

Detailed Description


Function Documentation

int session_set session_t ss,
const char *  name,
const char *  value
 

Put variable with name and value into ss.

Parameters:
ss session object
name session variable name
value session variable value
Returns:
0 if successful, non-zero on error

Definition at line 569 of file session.c.

References var_set_value(), session_s::vars, vars_add(), and vars_get().

const char * session_get session_t ss,
const char *  name
 

Return a string representation of variable in ss with given name.

Parameters:
ss session object
name session variable name
Returns:
the variable value corresponding to the given name (may be NULL)

Definition at line 547 of file session.c.

References var_get_value(), session_s::vars, and vars_get().

vars_t * session_get_vars session_t ss  ) 
 

Return a vars_t containing the session variables.

Parameters:
ss session object
Returns:
the variables' list of the given ss (may be NULL)

Definition at line 529 of file session.c.

References session_s::vars.

int session_del session_t ss,
const char *  name
 

Delete session variable name in ss.

Parameters:
ss session object
name session variable name
Returns:
  • 0 if successful
  • ~0 on error

Definition at line 658 of file session.c.

References session_s::vars, vars_del(), and vars_get().

int session_clean session_t ss  ) 
 

Remove all session variables from ss.

Parameters:
ss session object
Returns:
0 if successful, non-zero on error

Definition at line 629 of file session.c.

References session_s::vars, vars_del(), and vars_getn().

int session_age session_t ss  ) 
 

Return the number of seconds since the session was last modified.

Parameters:
ss session object
Returns:
  • the number of seconds since last modification
  • -1 on error

Definition at line 608 of file session.c.

References session_s::mtime.