diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/classNLNET_1_1CLoginServer.html | 298 |
1 files changed, 298 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLNET_1_1CLoginServer.html b/docs/doxygen/nel/classNLNET_1_1CLoginServer.html new file mode 100644 index 00000000..a2e8a396 --- /dev/null +++ b/docs/doxygen/nel/classNLNET_1_1CLoginServer.html @@ -0,0 +1,298 @@ +<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> +<HTML> +<HEAD> + <TITLE>nevrax.org : docs</TITLE> + <LINK REL=stylesheet TYPE="text/css" HREF="http://www.nevrax.org/inc/css/nevrax.css"> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +</HEAD> +<BODY MARGINHEIGHT="0" MARGINWIDTH="0"> + +<!-- uplinks --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A> </TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A> </TD> + </TR> +</TABLE> + +<!-- banner Nevrax --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 WIDTH=100%> + <TR><TD BGCOLOR="#000000" BACKGROUND="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR> +</TABLE> + +<!-- main table --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 height=100%> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + + <!------ Begin Box ------> + <TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0 cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black> + <FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td colspan=2 bgcolor=#FFFFFF> + <TABLE cellspacing=0 cellpadding=1 border=0> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr> + </TABLE> + </TD></TR></TABLE></TD></TR></TABLE> + <!------ End Box ------> + + </TD> + <TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + +<!-- title --> +<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td> +<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A> +</td><td><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT=""> +</td></tr></table> + + +<!-- block --> +<TABLE bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="http://www.nevrax.org/inc/img/reddots.gif"></TD> + <TD><B>Documentation</B></TD> + <TD ALIGN=RIGHT> </td> +</tr></table> +<!-- Generated by Doxygen 1.2.14 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindexRef" doxygen="_cgi:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> </center> +<hr><h1>NLNET::CLoginServer Class Reference</h1>This class is the server part of the Login System. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="login__server_8h-source.html">login_server.h</a>></code> +<p> +<a href="classNLNET_1_1CLoginServer-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLNET_1_1CLoginServer.html#d0">init</a> (<a class="el" href="classNLNET_1_1CCallbackServer.html">CCallbackServer</a> &server, <a class="el" href="namespaceNLNET.html#a10">TNewClientCallback</a> ncl)</td></tr> +<tr><td> </td><td><font size=-1><em>Create the connection to the Welcome Service and install callbacks to the callback server (for a TCP cnx) <a class="el" href="classNLNET_1_1CLoginServer.html#d0">init</a>() will try to find the ListenAddress in the config file and it will be used to say to the client the address to connect to this frontend (using the login system). You can modify this in real time in the config file or with the ls_listen_address command The ListenAddress must be in the form of "itsalive.nevrax.org:38000" (ip+port).</em> <a href="#d0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLNET_1_1CLoginServer.html#d1">init</a> (<a class="el" href="classNLNET_1_1CUdpSock.html">CUdpSock</a> &server, <a class="el" href="namespaceNLNET.html#a11">TDisconnectClientCallback</a> dc)</td></tr> +<tr><td> </td><td><font size=-1><em>Create the connection to the Welcome Service for an UDP connection the dc will be call when the Welcome Service decides to disconnect a player (double login...).</em> <a href="#d1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classNLNET_1_1CLoginServer.html#d2">CLoginServer::isValidCookie</a> (const <a class="el" href="classNLNET_1_1CLoginCookie.html">CLoginCookie</a> &lc)</td></tr> +<tr><td> </td><td><font size=-1><em>Used only in UDP, check if the cookie is valid. return empty string if valid, reason otherwise.</em> <a href="#d2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLNET_1_1CLoginServer.html#d3">clientDisconnected</a> (<a class="el" href="types__nl_8h.html#a9">uint32</a> userId)</td></tr> +<tr><td> </td><td><font size=-1><em>Call this method when a user is disconnected or the server disconnect the user. This method will warn the login system that the user is not here anymore.</em> <a href="#d3">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Static Private Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLNET_1_1CLoginServer.html#f0">connectToWS</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>This function is used by <a class="el" href="classNLNET_1_1CLoginServer.html#d0">init</a>() to create the connection to the Welcome Service.</em> <a href="#f0">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This class is the server part of the Login System. +<p> +It is used in the Front End Service. At the begining, it connects to the WS. When a new player comes in and is authenticated, a callback is called to warn the user code that a new player is here. Example: <div class="fragment"><pre> +</pre></div> <dl compact><dt><b> +Author: </b><dd> +Vianney Lecroart , Nevrax France </dl><dl compact><dt><b> +Date: </b><dd> +2001 </dl> +<p> + +<p> +Definition at line <a class="el" href="login__server_8h-source.html#l00065">65</a> of file <a class="el" href="login__server_8h-source.html">login_server.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="d3" doxytag="NLNET::CLoginServer::clientDisconnected"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLNET::CLoginServer::clientDisconnected </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="types__nl_8h.html#a9">uint32</a> </td> + <td class="mdname1" valign="top" nowrap> <em>userId</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Call this method when a user is disconnected or the server disconnect the user. This method will warn the login system that the user is not here anymore. +<p> + +<p> +Definition at line <a class="el" href="login__server_8cpp-source.html#l00373">373</a> of file <a class="el" href="login__server_8cpp-source.html">login_server.cpp</a>. +<p> +References <a class="el" href="types__nl_8h-source.html#l00193">uint32</a>, <a class="el" href="types__nl_8h-source.html#l00189">uint8</a>, and <a class="el" href="login__server_8cpp-source.html#l00056">NLNET::UserIdSockAssociations</a>. </td> + </tr> +</table> +<a name="d2" doxytag="NLNET::CLoginServer::CLoginServer::isValidCookie"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::string NLNET::CLoginServer::CLoginServer::isValidCookie </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLNET_1_1CLoginCookie.html">CLoginCookie</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>lc</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Used only in UDP, check if the cookie is valid. return empty string if valid, reason otherwise. +<p> + </td> + </tr> +</table> +<a name="f0" doxytag="NLNET::CLoginServer::connectToWS"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLNET::CLoginServer::connectToWS </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static, private]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This function is used by <a class="el" href="classNLNET_1_1CLoginServer.html#d0">init</a>() to create the connection to the Welcome Service. +<p> + +<p> +Definition at line <a class="el" href="login__server_8cpp-source.html#l00352">352</a> of file <a class="el" href="login__server_8cpp-source.html">login_server.cpp</a>. +<p> +References <a class="el" href="debug_8h-source.html#l00247">nlassert</a>, <a class="el" href="types__nl_8h-source.html#l00191">uint16</a>, <a class="el" href="login__server_8cpp-source.html#l00172">NLNET::WSCallbackArray</a>, and <a class="el" href="login__server_8cpp-source.html#l00178">NLNET::WSCallbackArray5</a>. +<p> +Referenced by <a class="el" href="login__server_8cpp-source.html#l00264">init</a>. </td> + </tr> +</table> +<a name="d1" doxytag="NLNET::CLoginServer::init"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLNET::CLoginServer::init </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLNET_1_1CUdpSock.html">CUdpSock</a> & </td> + <td class="mdname" nowrap> <em>server</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="namespaceNLNET.html#a11">TDisconnectClientCallback</a> </td> + <td class="mdname" nowrap> <em>dc</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Create the connection to the Welcome Service for an UDP connection the dc will be call when the Welcome Service decides to disconnect a player (double login...). +<p> + +<p> +Definition at line <a class="el" href="login__server_8cpp-source.html#l00294">294</a> of file <a class="el" href="login__server_8cpp-source.html">login_server.cpp</a>. +<p> +References <a class="el" href="login__server_8cpp-source.html#l00243">NLNET::cfcbListenAddress</a>, <a class="el" href="login__server_8cpp-source.html#l00352">connectToWS</a>, <a class="el" href="login__server_8cpp-source.html#l00053">NLNET::DisconnectClientCallback</a>, <a class="el" href="login__server_8cpp-source.html#l00051">NLNET::ListenAddr</a>, <a class="el" href="debug_8h-source.html#l00087">nlinfo</a>, and <a class="el" href="login__server_8h-source.html#l00050">NLNET::TDisconnectClientCallback</a>. </td> + </tr> +</table> +<a name="d0" doxytag="NLNET::CLoginServer::init"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLNET::CLoginServer::init </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLNET_1_1CCallbackServer.html">CCallbackServer</a> & </td> + <td class="mdname" nowrap> <em>server</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="namespaceNLNET.html#a10">TNewClientCallback</a> </td> + <td class="mdname" nowrap> <em>ncl</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Create the connection to the Welcome Service and install callbacks to the callback server (for a TCP cnx) <a class="el" href="classNLNET_1_1CLoginServer.html#d0">init</a>() will try to find the ListenAddress in the config file and it will be used to say to the client the address to connect to this frontend (using the login system). You can modify this in real time in the config file or with the ls_listen_address command The ListenAddress must be in the form of "itsalive.nevrax.org:38000" (ip+port). +<p> + +<p> +Definition at line <a class="el" href="login__server_8cpp-source.html#l00264">264</a> of file <a class="el" href="login__server_8cpp-source.html">login_server.cpp</a>. +<p> +References <a class="el" href="login__server_8cpp-source.html#l00243">NLNET::cfcbListenAddress</a>, <a class="el" href="login__server_8cpp-source.html#l00238">NLNET::ClientCallbackArray</a>, <a class="el" href="login__server_8cpp-source.html#l00229">NLNET::ClientConnection</a>, <a class="el" href="login__server_8cpp-source.html#l00352">connectToWS</a>, <a class="el" href="login__server_8cpp-source.html#l00051">NLNET::ListenAddr</a>, <a class="el" href="login__server_8cpp-source.html#l00058">NLNET::NewClientCallback</a>, <a class="el" href="debug_8h-source.html#l00087">nlinfo</a>, <a class="el" href="login__server_8cpp-source.html#l00050">NLNET::Server</a>, and <a class="el" href="login__server_8h-source.html#l00047">NLNET::TNewClientCallback</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="login__server_8h-source.html">login_server.h</a><li><a class="el" href="login__server_8cpp-source.html">login_server.cpp</a></ul> + + +<!-- footer --> +<BR><FONT Size=+5> </FONT> +</TD> +<TD WIDTH=15><IMG SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD> +</TR> +</TABLE> +</BODY> +</HTML> |