ESP3D/docs/html/class_authentication_service.html
2020-01-06 14:46:56 +01:00

214 lines
11 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ESP3D: AuthenticationService Class Reference</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>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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="ESP3D_social_mini.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ESP3D
&#160;<span id="projectnumber">3.0</span>
</div>
<div id="projectbrief">Firmware for ESP boards connected to 3D Printer</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_authentication_service.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="class_authentication_service-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">AuthenticationService Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="authentication__service_8h_source.html">authentication_service.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a974b9f1d74ce8f750564810b81ae4e43"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_authentication_service.html#a974b9f1d74ce8f750564810b81ae4e43">AuthenticationService</a> ()</td></tr>
<tr class="separator:a974b9f1d74ce8f750564810b81ae4e43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afbb845804d8a15d84ada7d3baf417715"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_authentication_service.html#afbb845804d8a15d84ada7d3baf417715">~AuthenticationService</a> ()</td></tr>
<tr class="separator:afbb845804d8a15d84ada7d3baf417715"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a6d2dfb017c0809fd6d20cf4f05e52421"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="authentication__service_8h.html#a3095411b68dbc51b5b535151b5bf0ae6">level_authenticate_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_authentication_service.html#a6d2dfb017c0809fd6d20cf4f05e52421">authenticated_level</a> (const char *pwd=nullptr)</td></tr>
<tr class="separator:a6d2dfb017c0809fd6d20cf4f05e52421"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="authentication__service_8h_source.html#l00058">58</a> of file <a class="el" href="authentication__service_8h_source.html">authentication_service.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a974b9f1d74ce8f750564810b81ae4e43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a974b9f1d74ce8f750564810b81ae4e43">&#9670;&nbsp;</a></span>AuthenticationService()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AuthenticationService::AuthenticationService </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="authentication__service_8cpp_source.html#l00050">50</a> of file <a class="el" href="authentication__service_8cpp_source.html">authentication_service.cpp</a>.</p>
</div>
</div>
<a id="afbb845804d8a15d84ada7d3baf417715"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbb845804d8a15d84ada7d3baf417715">&#9670;&nbsp;</a></span>~AuthenticationService()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AuthenticationService::~AuthenticationService </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="authentication__service_8cpp_source.html#l00053">53</a> of file <a class="el" href="authentication__service_8cpp_source.html">authentication_service.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6d2dfb017c0809fd6d20cf4f05e52421"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d2dfb017c0809fd6d20cf4f05e52421">&#9670;&nbsp;</a></span>authenticated_level()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="authentication__service_8h.html#a3095411b68dbc51b5b535151b5bf0ae6">level_authenticate_type</a> AuthenticationService::authenticated_level </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>pwd</em> = <code>nullptr</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="authentication__service_8cpp_source.html#l00061">61</a> of file <a class="el" href="authentication__service_8cpp_source.html">authentication_service.cpp</a>.</p>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_authentication_service_a6d2dfb017c0809fd6d20cf4f05e52421_icgraph.png" border="0" usemap="#class_authentication_service_a6d2dfb017c0809fd6d20cf4f05e52421_icgraph" alt=""/></div>
<map name="class_authentication_service_a6d2dfb017c0809fd6d20cf4f05e52421_icgraph" id="class_authentication_service_a6d2dfb017c0809fd6d20cf4f05e52421_icgraph">
<area shape="rect" title=" " alt="" coords="1244,74,1391,115"/>
<area shape="rect" href="class_commands.html#ae3516c283e84729667119c390d697eb7" title=" " alt="" coords="1005,74,1196,115"/>
<area shape="rect" href="class_commands.html#ad1efcbcb621f598f3cd4ab4ebfb2f173" title=" " alt="" coords="815,56,957,83"/>
<area shape="rect" href="class_gcode_host.html#ae3c261bf836a76d3441724eae30555b5" title=" " alt="" coords="588,56,767,83"/>
<area shape="rect" href="class_gcode_host.html#af17ebce982e939ebc8205ea587b88bee" title=" " alt="" coords="375,5,540,32"/>
<area shape="rect" href="class_gcode_host.html#a1c624777512a678e5d5b662fc6c28f02" title=" " alt="" coords="376,56,539,83"/>
<area shape="rect" href="class_commands.html#a16350ec121b0ec859f6458d045a5a60d" title=" " alt="" coords="168,95,312,121"/>
<area shape="rect" href="class_gcode_host.html#ade23e0a1b4602dfdab7080505b26ff42" title=" " alt="" coords="153,19,327,45"/>
<area shape="rect" href="class_esp3_d.html#afb33f64a43ad00448d494e66e970339a" title=" " alt="" coords="5,19,105,45"/>
</map>
</div>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>esp3d/src/modules/authentication/<a class="el" href="authentication__service_8h_source.html">authentication_service.h</a></li>
<li>esp3d/src/modules/authentication/<a class="el" href="authentication__service_8cpp_source.html">authentication_service.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_authentication_service.html">AuthenticationService</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>