da/d46/session_8h_source.html

#ifndef __CWIST_SESSION_H__

#define __CWIST_SESSION_H__


#include <cwist/net/http/http.h>

#include <cwist/sys/app/app.h>

#include <cwist/query.h>

#include <stdbool.h>


#ifdef __cplusplus

extern "C" {

#endif


typedef struct cwist_session cwist_session_t;


int cwist_app_use_session(cwist_app *app, const char *secret);


void cwist_app_set_session_name(cwist_app *app, const char *name);


void cwist_app_set_session_max_age(cwist_app *app, int seconds);


cwist_session_t *cwist_session_start(cwist_app *app, cwist_http_request *req,

                                     cwist_http_response *res);


const char *cwist_session_get(cwist_session_t *session, const char *key);


int cwist_session_set(cwist_session_t *session, const char *key, const char *value);


void cwist_session_delete(cwist_session_t *session, const char *key);


int cwist_session_commit(cwist_session_t *session, cwist_http_response *res);


void cwist_session_invalidate(cwist_session_t *session);


void cwist_session_destroy(cwist_session_t *session);


cwist_middleware_func cwist_mw_session(cwist_app *app);


#ifdef __cplusplus

}

#endif


#endif /* __CWIST_SESSION_H__ */

http.h
HTTP Protocol Definitions and Helpers.

query.h
Compatibility header: forwards to <cwist/net/http/query.h>.

cwist_session_start
cwist_session_t * cwist_session_start(cwist_app *app, cwist_http_request *req, cwist_http_response *res)
Load or create a session for the current request.
Definition session.c:366

cwist_session_invalidate
void cwist_session_invalidate(cwist_session_t *session)
Mark the session for destruction (clears cookie on commit).
Definition session.c:454

cwist_session_t
struct cwist_session cwist_session_t
Opaque session handle attached to a request.
Definition session.h:21

cwist_session_delete
void cwist_session_delete(cwist_session_t *session, const char *key)
Delete a session key.
Definition session.c:443

cwist_app_set_session_max_age
void cwist_app_set_session_max_age(cwist_app *app, int seconds)
Set session cookie max-age in seconds. Defaults to 86400 (1 day).
Definition session.c:274

cwist_app_set_session_name
void cwist_app_set_session_name(cwist_app *app, const char *name)
Set session cookie name. Defaults to "cwist_session".
Definition session.c:259

cwist_app_use_session
int cwist_app_use_session(cwist_app *app, const char *secret)
Initialize session handling for an app with a signing secret.
Definition session.c:239

cwist_session_get
const char * cwist_session_get(cwist_session_t *session, const char *key)
Get a session value by key.
Definition session.c:414

cwist_session_set
int cwist_session_set(cwist_session_t *session, const char *key, const char *value)
Set a session value. Value is copied.
Definition session.c:428

cwist_mw_session
cwist_middleware_func cwist_mw_session(cwist_app *app)
Session middleware factory.
Definition session.c:556

cwist_session_destroy
void cwist_session_destroy(cwist_session_t *session)
Destroy a session handle and its data.
Definition session.c:464

cwist_session_commit
int cwist_session_commit(cwist_session_t *session, cwist_http_response *res)
Persist the session to the response cookie.
Definition session.c:477

cwist_app
Main Application Context.
Definition app.h:155

cwist_http_request
Definition http.h:65

cwist_http_response
HTTP Response Object. Supports standard string body or Zero-Copy pointer body.
Definition http.h:82

app.h
Core Application Structure and Lifecycle Management.

cwist_middleware_func
void(* cwist_middleware_func)(cwist_http_request *req, cwist_http_response *res, cwist_handler_func next)
Middleware type that receives req/res pair and the next stage in the chain.
Definition app.h:115