2016-06-20 17:05:31 +08:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=9" / >
< meta name = "generator" content = "Doxygen 1.8.11" / >
< title > libwebsockets: plugin: generic-sessions< / title >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
< link href = "navtree.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "resize.js" > < / script >
< script type = "text/javascript" src = "navtreedata.js" > < / script >
< script type = "text/javascript" src = "navtree.js" > < / script >
< script type = "text/javascript" >
$(document).ready(initResizable);
$(window).load(resizeHeight);
< / script >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr style = "height: 56px;" >
< td id = "projectlogo" > < img alt = "Logo" src = "libwebsockets.org-logo.png" / > < / td >
< td id = "projectalign" style = "padding-left: 0.5em;" >
< div id = "projectname" > libwebsockets
< / div >
< div id = "projectbrief" > Lightweight C library for HTML5 websockets< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
< div id = "navrow1" class = "tabs" >
< ul class = "tablist" >
< li > < a href = "index.html" > < span > Main  Page< / span > < / a > < / li >
< li > < a href = "pages.html" > < span > Related  Pages< / span > < / a > < / li >
< li class = "current" > < a href = "modules.html" > < span > Modules< / span > < / a > < / li >
< li > < a href = "annotated.html" > < span > Data  Structures< / span > < / a > < / li >
< li > < a href = "files.html" > < span > Files< / span > < / a > < / li >
< / ul >
< / div >
< / div > <!-- top -->
< div id = "side-nav" class = "ui-resizable side-nav-resizable" >
< div id = "nav-tree" >
< div id = "nav-tree-contents" >
< div id = "nav-sync" class = "sync" > < / div >
< / div >
< / div >
< div id = "splitbar" style = "-moz-user-select:none;"
class="ui-resizable-handle">
< / div >
< / div >
< script type = "text/javascript" >
$(document).ready(function(){initNavTree('group__generic-sessions.html','');});
< / script >
< div id = "doc-content" >
< div class = "header" >
< div class = "summary" >
< a href = "#nested-classes" > Data Structures< / a > |
< a href = "#enum-members" > Enumerations< / a > < / div >
< div class = "headertitle" >
< div class = "title" > plugin: generic-sessions< div class = "ingroups" > < a class = "el" href = "group__Protocols-and-Plugins.html" > Protocols and Plugins< / a > < / div > < / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "nested-classes" > < / a >
Data Structures< / h2 > < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structlwsgw__hash__bin.html" > lwsgw_hash_bin< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structlwsgw__hash.html" > lwsgw_hash< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structlws__session__info.html" > lws_session_info< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structlws__gs__event__args.html" > lws_gs_event_args< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "enum-members" > < / a >
Enumerations< / h2 > < / td > < / tr >
< tr class = "memitem:ga7c2dc7bfb4ccb91c5d771f9e9ea237e1" > < td class = "memItemLeft" align = "right" valign = "top" > enum   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__generic-sessions.html#ga7c2dc7bfb4ccb91c5d771f9e9ea237e1" > lwsgs_auth_bits< / a > { < a class = "el" href = "group__generic-sessions.html#gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a81e63075115dedd150265d81b8f7fa57" > LWSGS_AUTH_LOGGED_IN< / a > = 1,
< a class = "el" href = "group__generic-sessions.html#gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a0657a9e846814781b128c397fe4b10bf" > LWSGS_AUTH_ADMIN< / a > = 2,
< a class = "el" href = "group__generic-sessions.html#gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a5a607e4668d20cadada62c4b8007f887" > LWSGS_AUTH_VERIFIED< / a > = 4,
< a class = "el" href = "group__generic-sessions.html#gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a2cd8fb86e3b85c106e7711c03f0ddd0a" > LWSGS_AUTH_FORGOT_FLOW< / a > = 8
}< / td > < / tr >
< tr class = "separator:ga7c2dc7bfb4ccb91c5d771f9e9ea237e1" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gaa93946b3d921072209d5cd8cdfa5332e" > < td class = "memItemLeft" align = "right" valign = "top" > enum   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__generic-sessions.html#gaa93946b3d921072209d5cd8cdfa5332e" > lws_gs_event< / a > { < a class = "el" href = "group__generic-sessions.html#ggaa93946b3d921072209d5cd8cdfa5332ea596010a165bf13473c5eea3a34cd4308" > LWSGSE_CREATED< / a > ,
< a class = "el" href = "group__generic-sessions.html#ggaa93946b3d921072209d5cd8cdfa5332ead908cdc5689c5d22c9d3c8934e94dcde" > LWSGSE_DELETED< / a >
}< / td > < / tr >
< tr class = "separator:gaa93946b3d921072209d5cd8cdfa5332e" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< h2 > Plugin Generic-sessions related< / h2 >
< p > generic-sessions plugin provides a reusable, generic session and login / register / forgot password framework including email verification. < / p >
< h2 class = "groupheader" > Enumeration Type Documentation< / h2 >
< a class = "anchor" id = "gaa93946b3d921072209d5cd8cdfa5332e" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > enum < a class = "el" href = "group__generic-sessions.html#gaa93946b3d921072209d5cd8cdfa5332e" > lws_gs_event< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > < code > #include < < a class = "el" href = "libwebsockets_8h.html" > lib/libwebsockets.h< / a > > < / code > < / p >
< p > enum lws_gs_event < / p >
< table class = "fieldtable" >
< tr > < th colspan = "2" > Enumerator< / th > < / tr > < tr > < td class = "fieldname" > < a class = "anchor" id = "ggaa93946b3d921072209d5cd8cdfa5332ea596010a165bf13473c5eea3a34cd4308" > < / a > LWSGSE_CREATED  < / td > < td class = "fielddoc" >
< p > a new user was created < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < a class = "anchor" id = "ggaa93946b3d921072209d5cd8cdfa5332ead908cdc5689c5d22c9d3c8934e94dcde" > < / a > LWSGSE_DELETED  < / td > < td class = "fielddoc" >
< p > an existing user was deleted < / p >
< / td > < / tr >
< / table >
2016-10-05 13:49:46 +08:00
< div class = "fragment" > < div class = "line" > < a name = "l01457" > < / a > < span class = "lineno" > 1457< / span >   {< / div > < div class = "line" > < a name = "l01458" > < / a > < span class = "lineno" > 1458< / span >   < a class = "code" href = "group__generic-sessions.html#ggaa93946b3d921072209d5cd8cdfa5332ea596010a165bf13473c5eea3a34cd4308" > LWSGSE_CREATED< / a > , < / div > < div class = "line" > < a name = "l01459" > < / a > < span class = "lineno" > 1459< / span >   < a class = "code" href = "group__generic-sessions.html#ggaa93946b3d921072209d5cd8cdfa5332ead908cdc5689c5d22c9d3c8934e94dcde" > LWSGSE_DELETED< / a > < / div > < div class = "line" > < a name = "l01460" > < / a > < span class = "lineno" > 1460< / span >   };< / div > < div class = "ttc" id = "group__generic-sessions_html_ggaa93946b3d921072209d5cd8cdfa5332ead908cdc5689c5d22c9d3c8934e94dcde" > < div class = "ttname" > < a href = "group__generic-sessions.html#ggaa93946b3d921072209d5cd8cdfa5332ead908cdc5689c5d22c9d3c8934e94dcde" > LWSGSE_DELETED< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > libwebsockets.h:1459< / div > < / div >
< div class = "ttc" id = "group__generic-sessions_html_ggaa93946b3d921072209d5cd8cdfa5332ea596010a165bf13473c5eea3a34cd4308" > < div class = "ttname" > < a href = "group__generic-sessions.html#ggaa93946b3d921072209d5cd8cdfa5332ea596010a165bf13473c5eea3a34cd4308" > LWSGSE_CREATED< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > libwebsockets.h:1458< / div > < / div >
2016-06-20 17:05:31 +08:00
< / div > <!-- fragment -->
< / div >
< / div >
< a class = "anchor" id = "ga7c2dc7bfb4ccb91c5d771f9e9ea237e1" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > enum < a class = "el" href = "group__generic-sessions.html#ga7c2dc7bfb4ccb91c5d771f9e9ea237e1" > lwsgs_auth_bits< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > < code > #include < < a class = "el" href = "libwebsockets_8h.html" > lib/libwebsockets.h< / a > > < / code > < / p >
< p > enum lwsgs_auth_bits < / p >
< table class = "fieldtable" >
< tr > < th colspan = "2" > Enumerator< / th > < / tr > < tr > < td class = "fieldname" > < a class = "anchor" id = "gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a81e63075115dedd150265d81b8f7fa57" > < / a > LWSGS_AUTH_LOGGED_IN  < / td > < td class = "fielddoc" >
< p > user is logged in as somebody < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < a class = "anchor" id = "gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a0657a9e846814781b128c397fe4b10bf" > < / a > LWSGS_AUTH_ADMIN  < / td > < td class = "fielddoc" >
< p > logged in as the admin user < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < a class = "anchor" id = "gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a5a607e4668d20cadada62c4b8007f887" > < / a > LWSGS_AUTH_VERIFIED  < / td > < td class = "fielddoc" >
< p > user has verified his email < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < a class = "anchor" id = "gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a2cd8fb86e3b85c106e7711c03f0ddd0a" > < / a > LWSGS_AUTH_FORGOT_FLOW  < / td > < td class = "fielddoc" >
< p > he just completed "forgot password" flow < / p >
< / td > < / tr >
< / table >
2016-10-05 13:49:46 +08:00
< div class = "fragment" > < div class = "line" > < a name = "l01439" > < / a > < span class = "lineno" > 1439< / span >   {< / div > < div class = "line" > < a name = "l01440" > < / a > < span class = "lineno" > 1440< / span >   < a class = "code" href = "group__generic-sessions.html#gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a81e63075115dedd150265d81b8f7fa57" > LWSGS_AUTH_LOGGED_IN< / a > = 1, < / div > < div class = "line" > < a name = "l01441" > < / a > < span class = "lineno" > 1441< / span >   < a class = "code" href = "group__generic-sessions.html#gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a0657a9e846814781b128c397fe4b10bf" > LWSGS_AUTH_ADMIN< / a > = 2, < / div > < div class = "line" > < a name = "l01442" > < / a > < span class = "lineno" > 1442< / span >   < a class = "code" href = "group__generic-sessions.html#gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a5a607e4668d20cadada62c4b8007f887" > LWSGS_AUTH_VERIFIED< / a > = 4, < / div > < div class = "line" > < a name = "l01443" > < / a > < span class = "lineno" > 1443< / span >   < a class = "code" href = "group__generic-sessions.html#gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a2cd8fb86e3b85c106e7711c03f0ddd0a" > LWSGS_AUTH_FORGOT_FLOW< / a > = 8, < / div > < div class = "line" > < a name = "l01444" > < / a > < span class = "lineno" > 1444< / span >   };< / div > < div class = "ttc" id = "group__generic-sessions_html_gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a5a607e4668d20cadada62c4b8007f887" > < div class = "ttname" > < a href = "group__generic-sessions.html#gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a5a607e4668d20cadada62c4b8007f887" > LWSGS_AUTH_VERIFIED< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > libwebsockets.h:1442< / div > < / div >
< div class = "ttc" id = "group__generic-sessions_html_gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a2cd8fb86e3b85c106e7711c03f0ddd0a" > < div class = "ttname" > < a href = "group__generic-sessions.html#gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a2cd8fb86e3b85c106e7711c03f0ddd0a" > LWSGS_AUTH_FORGOT_FLOW< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > libwebsockets.h:1443< / div > < / div >
< div class = "ttc" id = "group__generic-sessions_html_gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a0657a9e846814781b128c397fe4b10bf" > < div class = "ttname" > < a href = "group__generic-sessions.html#gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a0657a9e846814781b128c397fe4b10bf" > LWSGS_AUTH_ADMIN< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > libwebsockets.h:1441< / div > < / div >
< div class = "ttc" id = "group__generic-sessions_html_gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a81e63075115dedd150265d81b8f7fa57" > < div class = "ttname" > < a href = "group__generic-sessions.html#gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a81e63075115dedd150265d81b8f7fa57" > LWSGS_AUTH_LOGGED_IN< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > libwebsockets.h:1440< / div > < / div >
2016-06-20 17:05:31 +08:00
< / div > <!-- fragment -->
< / div >
< / div >
< / div > <!-- contents -->
< / div > <!-- doc - content -->
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
< li class = "footer" > Generated by
< a href = "http://www.doxygen.org/index.html" >
< img class = "footer" src = "doxygen.png" alt = "doxygen" / > < / a > 1.8.11 < / li >
< / ul >
< / div >
< / body >
< / html >
