Home Explore Help
Sign In
SoftwareDesign
/
csu3_am335x
8
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 59c08eac4e
Branches Tags
csu3_am335x
/
EVSE
/
GPL
/
libwebsockets-v2.1-stable-org
/
doc
/
html
/
group__generic-sessions.html

group__generic-sessions.html 13 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.11"/>
    7. 

  7. <title>libwebsockets: plugin: generic-sessions</title>
    8. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <script type="text/javascript" src="jquery.js"></script>
    10. 

  10. <script type="text/javascript" src="dynsections.js"></script>
    11. 

  11. <link href="navtree.css" rel="stylesheet" type="text/css"/>
    12. 

  12. <script type="text/javascript" src="resize.js"></script>
    13. 

  13. <script type="text/javascript" src="navtreedata.js"></script>
    14. 

  14. <script type="text/javascript" src="navtree.js"></script>
    15. 

  15. <script type="text/javascript">
    16. 

  16.   $(document).ready(initResizable);
    17. 

  17.   $(window).load(resizeHeight);
    18. 

  18. </script>
    19. 

  19. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    20. 

  20. </head>
    21. 

  21. <body>
    22. 

  22. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    23. 

  23. <div id="titlearea">
    24. 

  24. <table cellspacing="0" cellpadding="0">
    25. 

  25.  <tbody>
    26. 

  26.  <tr style="height: 56px;">
    27. 

  27.   <td id="projectlogo"><img alt="Logo" src="libwebsockets.org-logo.png"/></td>
    28. 

  28.   <td id="projectalign" style="padding-left: 0.5em;">
    29. 

  29.    <div id="projectname">libwebsockets
    30. 

  30.    </div>
    31. 

  31.    <div id="projectbrief">Lightweight C library for HTML5 websockets</div>
    32. 

  32.   </td>
    33. 

  33.  </tr>
    34. 

  34.  </tbody>
    35. 

  35. </table>
    36. 

  36. </div>
    37. 

  37. <!-- end header part -->
    38. 

  38. <!-- Generated by Doxygen 1.8.11 -->
    39. 

  39.   <div id="navrow1" class="tabs">
    40. 

  40.     <ul class="tablist">
    41. 

  41.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    42. 

  42.       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
    43. 

  43.       <li class="current"><a href="modules.html"><span>Modules</span></a></li>
    44. 

  44.       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
    45. 

  45.       <li><a href="files.html"><span>Files</span></a></li>
    46. 

  46.     </ul>
    47. 

  47.   </div>
    48. 

  48. </div><!-- top -->
    49. 

  49. <div id="side-nav" class="ui-resizable side-nav-resizable">
    50. 

  50.   <div id="nav-tree">
    51. 

  51.     <div id="nav-tree-contents">
    52. 

  52.       <div id="nav-sync" class="sync"></div>
    53. 

  53.     </div>
    54. 

  54.   </div>
    55. 

  55.   <div id="splitbar" style="-moz-user-select:none;" 
    56. 

  56.        class="ui-resizable-handle">
    57. 

  57.   </div>
    58. 

  58. </div>
    59. 

  59. <script type="text/javascript">
    60. 

  60. $(document).ready(function(){initNavTree('group__generic-sessions.html','');});
    61. 

  61. </script>
    62. 

  62. <div id="doc-content">
    63. 

  63. <div class="header">
    64. 

  64.   <div class="summary">
    65. 

  65. <a href="#nested-classes">Data Structures</a> &#124;
    66. 

  66. <a href="#enum-members">Enumerations</a>  </div>
    67. 

  67.   <div class="headertitle">
    68. 

  68. <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>
    69. 

  69. </div><!--header-->
    70. 

  70. <div class="contents">
    71. 

  71. <table class="memberdecls">
    72. 

  72. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
    73. 

  73. Data Structures</h2></td></tr>
    74. 

  74. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlwsgw__hash__bin.html">lwsgw_hash_bin</a></td></tr>
    75. 

  75. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
    76. 

  76. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlwsgw__hash.html">lwsgw_hash</a></td></tr>
    77. 

  77. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
    78. 

  78. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__session__info.html">lws_session_info</a></td></tr>
    79. 

  79. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
    80. 

  80. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__gs__event__args.html">lws_gs_event_args</a></td></tr>
    81. 

  81. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
    82. 

  82. </table><table class="memberdecls">
    83. 

  83. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
    84. 

  84. Enumerations</h2></td></tr>
    85. 

  85. <tr class="memitem:ga7c2dc7bfb4ccb91c5d771f9e9ea237e1"><td class="memItemLeft" align="right" valign="top">enum &#160;</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, 
    86. 

  86. <a class="el" href="group__generic-sessions.html#gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a0657a9e846814781b128c397fe4b10bf">LWSGS_AUTH_ADMIN</a> = 2, 
    87. 

  87. <a class="el" href="group__generic-sessions.html#gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a5a607e4668d20cadada62c4b8007f887">LWSGS_AUTH_VERIFIED</a> = 4, 
    88. 

  88. <a class="el" href="group__generic-sessions.html#gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a2cd8fb86e3b85c106e7711c03f0ddd0a">LWSGS_AUTH_FORGOT_FLOW</a> = 8
    89. 

  89.  }</td></tr>
    90. 

  90. <tr class="separator:ga7c2dc7bfb4ccb91c5d771f9e9ea237e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
    91. 

  91. <tr class="memitem:gaa93946b3d921072209d5cd8cdfa5332e"><td class="memItemLeft" align="right" valign="top">enum &#160;</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>, 
    92. 

  92. <a class="el" href="group__generic-sessions.html#ggaa93946b3d921072209d5cd8cdfa5332ead908cdc5689c5d22c9d3c8934e94dcde">LWSGSE_DELETED</a>
    93. 

  93.  }</td></tr>
    94. 

  94. <tr class="separator:gaa93946b3d921072209d5cd8cdfa5332e"><td class="memSeparator" colspan="2">&#160;</td></tr>
    95. 

  95. </table>
    96. 

  96. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    97. 

  97. <h2>Plugin Generic-sessions related</h2>
    98. 

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

  99. <h2 class="groupheader">Enumeration Type Documentation</h2>
    100. 

  100. <a class="anchor" id="gaa93946b3d921072209d5cd8cdfa5332e"></a>
    101. 

  101. <div class="memitem">
    102. 

  102. <div class="memproto">
    103. 

  103.       <table class="memname">
    104. 

  104.         <tr>
    105. 

  105.           <td class="memname">enum <a class="el" href="group__generic-sessions.html#gaa93946b3d921072209d5cd8cdfa5332e">lws_gs_event</a></td>
    106. 

  106.         </tr>
    107. 

  107.       </table>
    108. 

  108. </div><div class="memdoc">
    109. 

  109. 

  110. <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
    111. 

  111. <p>enum lws_gs_event </p>
    112. 

  112. <table class="fieldtable">
    113. 

  113. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggaa93946b3d921072209d5cd8cdfa5332ea596010a165bf13473c5eea3a34cd4308"></a>LWSGSE_CREATED&#160;</td><td class="fielddoc">
    114. 

  114. <p>a new user was created </p>
    115. 

  115. </td></tr>
    116. 

  116. <tr><td class="fieldname"><a class="anchor" id="ggaa93946b3d921072209d5cd8cdfa5332ead908cdc5689c5d22c9d3c8934e94dcde"></a>LWSGSE_DELETED&#160;</td><td class="fielddoc">
    117. 

  117. <p>an existing user was deleted </p>
    118. 

  118. </td></tr>
    119. 

  119. </table>
    120. 

  120. <div class="fragment"><div class="line"><a name="l01457"></a><span class="lineno"> 1457</span>&#160;                  {</div><div class="line"><a name="l01458"></a><span class="lineno"> 1458</span>&#160;        <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>&#160;        <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>&#160;};</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>
    121. 

  121. <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>
    122. 

  122. </div><!-- fragment -->
    123. 

  123. </div>
    124. 

  124. </div>
    125. 

  125. <a class="anchor" id="ga7c2dc7bfb4ccb91c5d771f9e9ea237e1"></a>
    126. 

  126. <div class="memitem">
    127. 

  127. <div class="memproto">
    128. 

  128.       <table class="memname">
    129. 

  129.         <tr>
    130. 

  130.           <td class="memname">enum <a class="el" href="group__generic-sessions.html#ga7c2dc7bfb4ccb91c5d771f9e9ea237e1">lwsgs_auth_bits</a></td>
    131. 

  131.         </tr>
    132. 

  132.       </table>
    133. 

  133. </div><div class="memdoc">
    134. 

  134. 

  135. <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
    136. 

  136. <p>enum lwsgs_auth_bits </p>
    137. 

  137. <table class="fieldtable">
    138. 

  138. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a81e63075115dedd150265d81b8f7fa57"></a>LWSGS_AUTH_LOGGED_IN&#160;</td><td class="fielddoc">
    139. 

  139. <p>user is logged in as somebody </p>
    140. 

  140. </td></tr>
    141. 

  141. <tr><td class="fieldname"><a class="anchor" id="gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a0657a9e846814781b128c397fe4b10bf"></a>LWSGS_AUTH_ADMIN&#160;</td><td class="fielddoc">
    142. 

  142. <p>logged in as the admin user </p>
    143. 

  143. </td></tr>
    144. 

  144. <tr><td class="fieldname"><a class="anchor" id="gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a5a607e4668d20cadada62c4b8007f887"></a>LWSGS_AUTH_VERIFIED&#160;</td><td class="fielddoc">
    145. 

  145. <p>user has verified his email </p>
    146. 

  146. </td></tr>
    147. 

  147. <tr><td class="fieldname"><a class="anchor" id="gga7c2dc7bfb4ccb91c5d771f9e9ea237e1a2cd8fb86e3b85c106e7711c03f0ddd0a"></a>LWSGS_AUTH_FORGOT_FLOW&#160;</td><td class="fielddoc">
    148. 

  148. <p>he just completed "forgot password" flow </p>
    149. 

  149. </td></tr>
    150. 

  150. </table>
    151. 

  151. <div class="fragment"><div class="line"><a name="l01439"></a><span class="lineno"> 1439</span>&#160;                     {</div><div class="line"><a name="l01440"></a><span class="lineno"> 1440</span>&#160;        <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>&#160;        <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>&#160;        <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>&#160;        <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>&#160;};</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>
    152. 

  152. <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>
    153. 

  153. <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>
    154. 

  154. <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>
    155. 

  155. </div><!-- fragment -->
    156. 

  156. </div>
    157. 

  157. </div>
    158. 

  158. </div><!-- contents -->
    159. 

  159. </div><!-- doc-content -->
    160. 

  160. <!-- start footer part -->
    161. 

  161. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
    162. 

  162.   <ul>
    163. 

  163.     <li class="footer">Generated by
    164. 

  164.     <a href="http://www.doxygen.org/index.html">
    165. 

  165.     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
    166. 

  166.   </ul>
    167. 

  167. </div>
    168. 

  168. </body>
    169. 

  169. </html>
    170.