diff options
Diffstat (limited to 'docs/doxygen/nel/a02828.html')
| -rw-r--r-- | docs/doxygen/nel/a02828.html | 364 |
1 files changed, 364 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a02828.html b/docs/doxygen/nel/a02828.html new file mode 100644 index 00000000..3d392cc6 --- /dev/null +++ b/docs/doxygen/nel/a02828.html @@ -0,0 +1,364 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>NeL: NLNET::CLoginServer class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.3.6 --> +<div class="qindex"> <form class="search" action="search.php" method="get"> +<a class="qindex" href="main.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">Data Structures</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">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div> +<h1>NLNET::CLoginServer Class Reference</h1><code>#include <<a class="el" href="a05963.html">login_server.h</a>></code> +<p> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This class is the server part of the Login System. 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: <pre class="fragment"><div></div></pre><dl compact><dt><b>Author:</b></dt><dd>Vianney Lecroart <p> +Nevrax France </dd></dl> +<dl compact><dt><b>Date:</b></dt><dd>2001 </dd></dl> + +<p> + +<p> +Definition at line <a class="el" href="a05963.html#l00065">65</a> of file <a class="el" href="a05963.html">login_server.h</a>.<table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02828.html#NLNET_1_1CLoginServere0">clientDisconnected</a> (<a class="el" href="a04558.html#a11">uint32</a> userId)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="a02828.html#NLNET_1_1CLoginServere1">CLoginServer::isValidCookie</a> (const <a class="el" href="a02827.html">CLoginCookie</a> &lc, std::string &userName, std::string &userPriv)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Used only in UDP, check if the cookie is valid. return empty string if valid, reason otherwise. <a href="#NLNET_1_1CLoginServere1"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02828.html#NLNET_1_1CLoginServere2">init</a> (<a class="el" href="a03628.html">CUdpSock</a> &server, <a class="el" href="a05379.html#a85">TDisconnectClientCallback</a> dc)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02828.html#NLNET_1_1CLoginServere3">init</a> (<a class="el" href="a02307.html">CCallbackServer</a> &server, <a class="el" href="a05379.html#a84">TNewClientCallback</a> ncl)</td></tr> + +<tr><td colspan=2><br><h2>Static Private Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02828.html#NLNET_1_1CLoginServerh0">connectToWS</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This function is used by <a class="el" href="a02828.html#NLNET_1_1CLoginServere3">init()</a> to create the connection to the Welcome Service. <a href="#NLNET_1_1CLoginServerh0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02828.html#NLNET_1_1CLoginServerh1">init</a> (const std::string &listenAddress)</td></tr> + +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NLNET_1_1CLoginServere0" doxytag="NLNET::CLoginServer::clientDisconnected" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <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="a04558.html#a11">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> +Definition at line <a class="el" href="a05962.html#l00413">413</a> of file <a class="el" href="a05962.html">login_server.cpp</a>. +<p> +References <a class="el" href="a05962.html#l00063">NLNET::ModeTcp</a>, <a class="el" href="a05979.html#l00420">NLMISC::CMemStream::serial()</a>, <a class="el" href="a05981.html#l00100">uint32</a>, <a class="el" href="a05981.html#l00096">uint8</a>, and <a class="el" href="a05962.html#l00069">NLNET::UserIdSockAssociations</a>. +<p> +<div class="fragment"><pre>00414 { +00415 <a class="code" href="a04558.html#a7">uint8</a> con = 0; +00416 <a class="code" href="a02918.html">CMessage</a> msgout (<span class="stringliteral">"CC"</span>); +00417 msgout.<a class="code" href="a02271.html#NLNET_1_1CMessagea41">serial</a> (userId); +00418 msgout.<a class="code" href="a02271.html#NLNET_1_1CMessagea41">serial</a> (con); +00419 +00420 CUnifiedNetwork::getInstance()->send(<span class="stringliteral">"WS"</span>, msgout); +00421 +00422 <span class="comment">// remove the user association</span> +00423 <span class="keywordflow">if</span> (<a class="code" href="a05379.html#a26">ModeTcp</a>) +00424 <a class="code" href="a05379.html#a28">UserIdSockAssociations</a>.erase (userId); +00425 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLNET_1_1CLoginServere1" doxytag="NLNET::CLoginServer::CLoginServer::isValidCookie" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <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="a02827.html">CLoginCookie</a> & </td> + <td class="mdname" nowrap> <em>lc</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>std::string & </td> + <td class="mdname" nowrap> <em>userName</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>std::string & </td> + <td class="mdname" nowrap> <em>userPriv</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> +Used only in UDP, check if the cookie is valid. return empty string if valid, reason otherwise. +<p> + </td> + </tr> +</table> +<a class="anchor" name="NLNET_1_1CLoginServerh0" doxytag="NLNET::CLoginServer::connectToWS" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <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="a02828.html#NLNET_1_1CLoginServere3">init()</a> to create the connection to the Welcome Service. +<p> + +<p> +Definition at line <a class="el" href="a05962.html#l00408">408</a> of file <a class="el" href="a05962.html">login_server.cpp</a>. +<p> +References <a class="el" href="a05962.html#l00169">NLNET::WSCallbackArray</a>. +<p> +Referenced by <a class="el" href="a05962.html#l00295">init()</a>. +<p> +<div class="fragment"><pre>00409 { +00410 CUnifiedNetwork::getInstance()->addCallbackArray(WSCallbackArray, <span class="keyword">sizeof</span>(WSCallbackArray)/<span class="keyword">sizeof</span>(WSCallbackArray[0])); +00411 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLNET_1_1CLoginServerh1" doxytag="NLNET::CLoginServer::init" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <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">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>listenAddress</em> </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> + +<p> +Definition at line <a class="el" href="a05962.html#l00295">295</a> of file <a class="el" href="a05962.html">login_server.cpp</a>. +<p> +References <a class="el" href="a05962.html#l00272">NLNET::cfcbAcceptInvalidCookie()</a>, <a class="el" href="a05962.html#l00264">NLNET::cfcbDefaultUserPriv()</a>, <a class="el" href="a05962.html#l00259">NLNET::cfcbListenAddress()</a>, <a class="el" href="a05962.html#l00280">NLNET::cfcbTimeBeforeEraseCookie()</a>, <a class="el" href="a05962.html#l00408">connectToWS()</a>, and <a class="el" href="a05962.html#l00244">NLNET::setListenAddress()</a>. +<p> +<div class="fragment"><pre>00296 { +00297 <span class="comment">// connect to the welcome service</span> +00298 <a class="code" href="a02828.html#NLNET_1_1CLoginServerh0">connectToWS</a> (); +00299 +00300 <span class="keywordflow">try</span> { +00301 <a class="code" href="a05379.html#a150">cfcbDefaultUserPriv</a>(IService::getInstance()->ConfigFile.getVar(<span class="stringliteral">"DefaultUserPriv"</span>)); +00302 IService::getInstance()->ConfigFile.setCallback(<span class="stringliteral">"DefaultUserPriv"</span>, cfcbDefaultUserPriv); +00303 } <span class="keywordflow">catch</span>(<a class="code" href="a02482.html">Exception</a> &) { } +00304 +00305 <span class="keywordflow">try</span> { +00306 <a class="code" href="a05379.html#a151">cfcbAcceptInvalidCookie</a> (IService::getInstance()->ConfigFile.getVar(<span class="stringliteral">"AcceptInvalidCookie"</span>)); +00307 IService::getInstance()->ConfigFile.setCallback(<span class="stringliteral">"AcceptInvalidCookie"</span>, cfcbAcceptInvalidCookie); +00308 } <span class="keywordflow">catch</span>(<a class="code" href="a02482.html">Exception</a> &) { } +00309 +00310 <span class="keywordflow">try</span> { +00311 <a class="code" href="a05379.html#a152">cfcbTimeBeforeEraseCookie</a> (IService::getInstance()->ConfigFile.getVar(<span class="stringliteral">"TimeBeforeEraseCookie"</span>)); +00312 IService::getInstance()->ConfigFile.setCallback(<span class="stringliteral">"TimeBeforeEraseCookie"</span>, cfcbTimeBeforeEraseCookie); +00313 } <span class="keywordflow">catch</span>(<a class="code" href="a02482.html">Exception</a> &) { } +00314 +00315 <span class="comment">// setup the listen address</span> +00316 +00317 string la; +00318 +00319 <span class="keywordflow">if</span> (IService::getInstance()->haveArg(<span class="charliteral">'D'</span>)) +00320 { +00321 <span class="comment">// use the command line param if set</span> +00322 la = IService::getInstance()->getArg(<span class="charliteral">'D'</span>); +00323 } +00324 <span class="keywordflow">else</span> <span class="keywordflow">if</span> (IService::getInstance()->ConfigFile.exists (<span class="stringliteral">"ListenAddress"</span>)) +00325 { +00326 <span class="comment">// use the config file param if set</span> +00327 la = IService::getInstance()->ConfigFile.getVar (<span class="stringliteral">"ListenAddress"</span>).asString(); +00328 } +00329 <span class="keywordflow">else</span> +00330 { +00331 la = listenAddress; +00332 } +00333 <a class="code" href="a05379.html#a148">setListenAddress</a> (la); +00334 IService::getInstance()->ConfigFile.setCallback(<span class="stringliteral">"ListenAddress"</span>, cfcbListenAddress); +00335 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLNET_1_1CLoginServere2" doxytag="NLNET::CLoginServer::init" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <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="a03628.html">CUdpSock</a> & </td> + <td class="mdname" nowrap> <em>server</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a05379.html#a85">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> +Definition at line <a class="el" href="a05962.html#l00353">353</a> of file <a class="el" href="a05962.html">login_server.cpp</a>. +<p> +References <a class="el" href="a05810.html#l00397">NLNET::CInetAddress::asIPString()</a>, <a class="el" href="a05962.html#l00060">NLNET::DisconnectClientCallback</a>, <a class="el" href="a05962.html#l00338">init()</a>, <a class="el" href="a06405.html#l00235">NLNET::CSock::localAddr()</a>, <a class="el" href="a05962.html#l00063">NLNET::ModeTcp</a>, and <a class="el" href="a05963.html#l00050">NLNET::TDisconnectClientCallback</a>. +<p> +<div class="fragment"><pre>00354 { +00355 <a class="code" href="a02828.html#NLNET_1_1CLoginServere3">init</a> (server.localAddr ().asIPString()); +00356 +00357 <a class="code" href="a05379.html#a25">DisconnectClientCallback</a> = dc; +00358 +00359 <a class="code" href="a05379.html#a26">ModeTcp</a> = <span class="keyword">false</span>; +00360 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLNET_1_1CLoginServere3" doxytag="NLNET::CLoginServer::init" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <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="a02307.html">CCallbackServer</a> & </td> + <td class="mdname" nowrap> <em>server</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a05379.html#a84">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 connection) <a class="el" href="a02828.html#NLNET_1_1CLoginServere3">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> +Definition at line <a class="el" href="a05962.html#l00338">338</a> of file <a class="el" href="a05962.html">login_server.cpp</a>. +<p> +References <a class="el" href="a05526.html#l00184">NLNET::CCallbackNetBase::addCallbackArray()</a>, <a class="el" href="a05810.html#l00397">NLNET::CInetAddress::asIPString()</a>, <a class="el" href="a05962.html#l00239">NLNET::ClientCallbackArray</a>, <a class="el" href="a05962.html#l00230">NLNET::ClientConnection()</a>, <a class="el" href="a05513.html#l00238">NLNET::CBufServer::listenAddress()</a>, <a class="el" href="a05962.html#l00063">NLNET::ModeTcp</a>, <a class="el" href="a05962.html#l00071">NLNET::NewClientCallback</a>, <a class="el" href="a05962.html#l00053">NLNET::Server</a>, <a class="el" href="a05529.html#l00061">NLNET::CCallbackServer::setConnectionCallback()</a>, and <a class="el" href="a05963.html#l00047">NLNET::TNewClientCallback</a>. +<p> +Referenced by <a class="el" href="a05962.html#l00353">init()</a>. +<p> +<div class="fragment"><pre>00339 { +00340 <a class="code" href="a02828.html#NLNET_1_1CLoginServere3">init</a> (server.listenAddress ().asIPString()); +00341 +00342 <span class="comment">// add callback to the server</span> +00343 server.addCallbackArray (ClientCallbackArray, <span class="keyword">sizeof</span> (ClientCallbackArray) / <span class="keyword">sizeof</span> (ClientCallbackArray[0])); +00344 server.setConnectionCallback (ClientConnection, NULL); +00345 +00346 <a class="code" href="a05379.html#a29">NewClientCallback</a> = ncl; +00347 <a class="code" href="a05379.html#a21">Server</a> = &server; +00348 +00349 <a class="code" href="a05379.html#a26">ModeTcp</a> = <span class="keyword">true</span>; +00350 } +</pre></div> </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="a05963.html">login_server.h</a><li><a class="el" href="a05962.html">login_server.cpp</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 13:58:38 2004 for NeL by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border=0 > +</a>1.3.6 </small></address> +</body> +</html> |