diff options
| author | FWoltermann@gmail.com <FWoltermann@gmail.com@076cb2c4-205e-83fd-5cf3-1be9aa105544> | 2012-05-31 14:46:27 +0000 |
|---|---|---|
| committer | FWoltermann@gmail.com <FWoltermann@gmail.com@076cb2c4-205e-83fd-5cf3-1be9aa105544> | 2012-05-31 14:46:27 +0000 |
| commit | 8898ad9b25fca6afe2374d293a981db02a83d7e9 (patch) | |
| tree | 8041e6eb069b6da70b83e82efdb998662140e716 /Doc/doxygen/html/class_net_auth.html | |
| parent | 985b945e4b49b5d5a1394e93fc3a95289c05e449 (diff) | |
| download | starshatter-8898ad9b25fca6afe2374d293a981db02a83d7e9.zip starshatter-8898ad9b25fca6afe2374d293a981db02a83d7e9.tar.gz starshatter-8898ad9b25fca6afe2374d293a981db02a83d7e9.tar.bz2 | |
Committing the documentation to svn to have it accessible online
Diffstat (limited to 'Doc/doxygen/html/class_net_auth.html')
| -rw-r--r-- | Doc/doxygen/html/class_net_auth.html | 352 |
1 files changed, 352 insertions, 0 deletions
diff --git a/Doc/doxygen/html/class_net_auth.html b/Doc/doxygen/html/class_net_auth.html new file mode 100644 index 0000000..adc8bfc --- /dev/null +++ b/Doc/doxygen/html/class_net_auth.html @@ -0,0 +1,352 @@ +<!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"/> +<title>Starshatter_Open: NetAuth 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="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</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 style="padding-left: 0.5em;"> + <div id="projectname">Starshatter_Open + </div> + <div id="projectbrief">Open source Starshatter engine</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.1 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</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> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('class_net_auth.html','');}); +</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)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a></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-types">Public Types</a> | +<a href="#pub-static-methods">Static Public Member Functions</a> </div> + <div class="headertitle"> +<div class="title">NetAuth Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_net_auth_8h_source.html">NetAuth.h</a>></code></p> + +<p><a href="class_net_auth-members.html">List of all members.</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2><a name="pub-types"></a> +Public Types</h2></td></tr> +<tr class="memitem:a79708cb2d4efcab8320ac9ec64e708de"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_auth.html#a79708cb2d4efcab8320ac9ec64e708de">AUTH_STATE</a> { <a class="el" href="class_net_auth.html#a79708cb2d4efcab8320ac9ec64e708deaaeae5ba3ea0f24b44163a3ce42e02b24">NET_AUTH_INITIAL</a> = 0, +<a class="el" href="class_net_auth.html#a79708cb2d4efcab8320ac9ec64e708dea7310eee68461b2e7e5a425d1f58ad1eb">NET_AUTH_FAILED</a> = 1, +<a class="el" href="class_net_auth.html#a79708cb2d4efcab8320ac9ec64e708dea97fe5335182e199ca0461a07f19caa41">NET_AUTH_OK</a> = 2 + }</td></tr> +<tr class="memitem:a13030c5ba464e076c665430e5a334cfc"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_auth.html#a13030c5ba464e076c665430e5a334cfc">AUTH_LEVEL</a> { <a class="el" href="class_net_auth.html#a13030c5ba464e076c665430e5a334cfca3c667e2621a43cdfa9bc63db4de9270c">NET_AUTH_MINIMAL</a> = 0, +<a class="el" href="class_net_auth.html#a13030c5ba464e076c665430e5a334cfca3e9d77dd1918efcaa71953a2b706fb8b">NET_AUTH_STANDARD</a> = 1, +<a class="el" href="class_net_auth.html#a13030c5ba464e076c665430e5a334cfcadfb6aa78d95511fa832f24d66c404c35">NET_AUTH_SECURE</a> = 2 + }</td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2><a name="pub-static-methods"></a> +Static Public Member Functions</h2></td></tr> +<tr class="memitem:a15a79cbda9aefd8818e11ac8201ff6b3"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_auth.html#a15a79cbda9aefd8818e11ac8201ff6b3">AuthLevel</a> ()</td></tr> +<tr class="memitem:aba516dab005caf3771368bb9e19c5cfd"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_auth.html#aba516dab005caf3771368bb9e19c5cfd">SetAuthLevel</a> (int n)</td></tr> +<tr class="memitem:a49976b2f2ce1cc75864200d5804b50d4"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_text.html">Text</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_auth.html#a49976b2f2ce1cc75864200d5804b50d4">CreateAuthRequest</a> (<a class="el" href="class_net_user.html">NetUser</a> *u)</td></tr> +<tr class="memitem:a93f9fc4de37e01f25b4d258888f08c21"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_text.html">Text</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_auth.html#a93f9fc4de37e01f25b4d258888f08c21">CreateAuthResponse</a> (int level, const char *salt)</td></tr> +<tr class="memitem:adb0722a0a4e03f28a3caa4a168cb34be"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_auth.html#adb0722a0a4e03f28a3caa4a168cb34be">AuthUser</a> (<a class="el" href="class_net_user.html">NetUser</a> *u, <a class="el" href="class_text.html">Text</a> response)</td></tr> +</table> +<hr/><a name="details" id="details"></a><h2>Detailed Description</h2> +<div class="textblock"> +<p>Definition at line <a class="el" href="_net_auth_8h_source.html#l00026">26</a> of file <a class="el" href="_net_auth_8h_source.html">NetAuth.h</a>.</p> +</div><hr/><h2>Member Enumeration Documentation</h2> +<a class="anchor" id="a13030c5ba464e076c665430e5a334cfc"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="class_net_auth.html#a13030c5ba464e076c665430e5a334cfc">NetAuth::AUTH_LEVEL</a></td> + </tr> + </table> +</div><div class="memdoc"> +<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" id="a13030c5ba464e076c665430e5a334cfca3c667e2621a43cdfa9bc63db4de9270c"></a>NET_AUTH_MINIMAL</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a13030c5ba464e076c665430e5a334cfca3e9d77dd1918efcaa71953a2b706fb8b"></a>NET_AUTH_STANDARD</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a13030c5ba464e076c665430e5a334cfcadfb6aa78d95511fa832f24d66c404c35"></a>NET_AUTH_SECURE</em> </td><td> +</td></tr> +</table> +</dd> +</dl> + +<p>Definition at line <a class="el" href="_net_auth_8h_source.html#l00035">35</a> of file <a class="el" href="_net_auth_8h_source.html">NetAuth.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a79708cb2d4efcab8320ac9ec64e708de"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="class_net_auth.html#a79708cb2d4efcab8320ac9ec64e708de">NetAuth::AUTH_STATE</a></td> + </tr> + </table> +</div><div class="memdoc"> +<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" id="a79708cb2d4efcab8320ac9ec64e708deaaeae5ba3ea0f24b44163a3ce42e02b24"></a>NET_AUTH_INITIAL</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a79708cb2d4efcab8320ac9ec64e708dea7310eee68461b2e7e5a425d1f58ad1eb"></a>NET_AUTH_FAILED</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a79708cb2d4efcab8320ac9ec64e708dea97fe5335182e199ca0461a07f19caa41"></a>NET_AUTH_OK</em> </td><td> +</td></tr> +</table> +</dd> +</dl> + +<p>Definition at line <a class="el" href="_net_auth_8h_source.html#l00029">29</a> of file <a class="el" href="_net_auth_8h_source.html">NetAuth.h</a>.</p> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a15a79cbda9aefd8818e11ac8201ff6b3"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">int NetAuth::AuthLevel </td> + <td>(</td> + <td class="paramname"></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>Definition at line <a class="el" href="_net_auth_8cpp_source.html#l00030">30</a> of file <a class="el" href="_net_auth_8cpp_source.html">NetAuth.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="adb0722a0a4e03f28a3caa4a168cb34be"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool NetAuth::AuthUser </td> + <td>(</td> + <td class="paramtype"><a class="el" href="class_net_user.html">NetUser</a> * </td> + <td class="paramname"><em>u</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="class_text.html">Text</a> </td> + <td class="paramname"><em>response</em> </td> + </tr> + <tr> + <td></td> + <td>)</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>Definition at line <a class="el" href="_net_auth_8cpp_source.html#l00192">192</a> of file <a class="el" href="_net_auth_8cpp_source.html">NetAuth.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a49976b2f2ce1cc75864200d5804b50d4"></a> +<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="class_text.html">Text</a> NetAuth::CreateAuthRequest </td> + <td>(</td> + <td class="paramtype"><a class="el" href="class_net_user.html">NetUser</a> * </td> + <td class="paramname"><em>u</em></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>Definition at line <a class="el" href="_net_auth_8cpp_source.html#l00046">46</a> of file <a class="el" href="_net_auth_8cpp_source.html">NetAuth.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a93f9fc4de37e01f25b4d258888f08c21"></a> +<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="class_text.html">Text</a> NetAuth::CreateAuthResponse </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>level</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>salt</em> </td> + </tr> + <tr> + <td></td> + <td>)</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>Definition at line <a class="el" href="_net_auth_8cpp_source.html#l00131">131</a> of file <a class="el" href="_net_auth_8cpp_source.html">NetAuth.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="aba516dab005caf3771368bb9e19c5cfd"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void NetAuth::SetAuthLevel </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>n</em></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>Definition at line <a class="el" href="_net_auth_8cpp_source.html#l00037">37</a> of file <a class="el" href="_net_auth_8cpp_source.html">NetAuth.cpp</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>D:/SRC/StarshatterSVN/Stars45/<a class="el" href="_net_auth_8h_source.html">NetAuth.h</a></li> +<li>D:/SRC/StarshatterSVN/Stars45/<a class="el" href="_net_auth_8cpp_source.html">NetAuth.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_net_auth.html">NetAuth</a></li> + <li class="footer">Generated on Thu May 31 2012 16:32:07 for Starshatter_Open by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1 </li> + </ul> +</div> +</body> +</html> |