libwebsockets
Lightweight C library for HTML5 websockets
plugin: generic-sessions

Data Structures

struct  lwsgw_hash_bin
 
struct  lwsgw_hash
 
struct  lws_session_info
 
struct  lws_gs_event_args
 

Macros

#define LWSGS_EMAIL_CONTENT_SIZE   16384
 

Enumerations

enum  lwsgs_auth_bits { LWSGS_AUTH_LOGGED_IN = 1, LWSGS_AUTH_ADMIN = 2, LWSGS_AUTH_VERIFIED = 4, LWSGS_AUTH_FORGOT_FLOW = 8 }
 
enum  lws_gs_event { LWSGSE_CREATED, LWSGSE_DELETED }
 

Detailed Description

Plugin Generic-sessions related

generic-sessions plugin provides a reusable, generic session and login / register / forgot password framework including email verification.

Macro Definition Documentation

◆ LWSGS_EMAIL_CONTENT_SIZE

#define LWSGS_EMAIL_CONTENT_SIZE   16384

#include <include/libwebsockets/lws-plugin-generic-sessions.h>

Maximum size of email we might send

Enumeration Type Documentation

◆ lws_gs_event

#include <include/libwebsockets/lws-plugin-generic-sessions.h>

enum lws_gs_event

Enumerator
LWSGSE_CREATED 

a new user was created

LWSGSE_DELETED 

an existing user was deleted

62  {
65 };
Definition: lws-plugin-generic-sessions.h:64
Definition: lws-plugin-generic-sessions.h:63

◆ lwsgs_auth_bits

#include <include/libwebsockets/lws-plugin-generic-sessions.h>

enum lwsgs_auth_bits

Enumerator
LWSGS_AUTH_LOGGED_IN 

user is logged in as somebody

LWSGS_AUTH_ADMIN 

logged in as the admin user

LWSGS_AUTH_VERIFIED 

user has verified his email

LWSGS_AUTH_FORGOT_FLOW 

just completed "forgot password"

44  {
46  LWSGS_AUTH_ADMIN = 2,
49 };
Definition: lws-plugin-generic-sessions.h:47
Definition: lws-plugin-generic-sessions.h:48
Definition: lws-plugin-generic-sessions.h:46
Definition: lws-plugin-generic-sessions.h:45