diff options
Diffstat (limited to 'docs/doxygen/nel/classNLNET_1_1CCallbackClient.html')
| -rw-r--r-- | docs/doxygen/nel/classNLNET_1_1CCallbackClient.html | 780 |
1 files changed, 780 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLNET_1_1CCallbackClient.html b/docs/doxygen/nel/classNLNET_1_1CCallbackClient.html new file mode 100644 index 00000000..61406fe1 --- /dev/null +++ b/docs/doxygen/nel/classNLNET_1_1CCallbackClient.html @@ -0,0 +1,780 @@ +<!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::CCallbackClient Class Reference</h1>Client class for layer 3. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="callback__client_8h-source.html">callback_client.h</a>></code> +<p> +<p>Inheritance diagram for NLNET::CCallbackClient: +<p><center><img src="classNLNET_1_1CCallbackClient.gif" usemap="#NLNET::CCallbackClient_map" border="0"></center> +<map name="NLNET::CCallbackClient_map"> +<area href="classNLNET_1_1CCallbackNetBase.html" alt="NLNET::CCallbackNetBase" shape="rect" coords="0,56,163,80"> +<area href="classNLNET_1_1CBufClient.html" alt="NLNET::CBufClient" shape="rect" coords="173,56,336,80"> +<area href="classNLNET_1_1CBufNetBase.html" alt="NLNET::CBufNetBase" shape="rect" coords="173,0,336,24"> +</map> +<a href="classNLNET_1_1CCallbackClient-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classNLNET_1_1CCallbackClient.html#a0">CCallbackClient</a> (<a class="el" href="classNLNET_1_1CCallbackNetBase.html#s3">TRecordingState</a> rec=Off, const std::string &recfilename="", bool recordall=true)</td></tr> +<tr><td> </td><td><font size=-1><em>Constructor.</em> <a href="#a0">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_1CCallbackClient.html#a1">send</a> (const <a class="el" href="classNLNET_1_1CMessage.html">CMessage</a> &<a class="el" href="driver__opengl__extension__def_8h.html#a381">buffer</a>, <a class="el" href="namespaceNLNET.html#a0">TSockId</a> hostid=<a class="el" href="namespaceNLNET.html#a1">InvalidSockId</a>, bool log=true)</td></tr> +<tr><td> </td><td><font size=-1><em>Sends a message to the remote host (the second parameter isn't used).</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLNET_1_1CCallbackClient.html#a2">flush</a> (<a class="el" href="namespaceNLNET.html#a0">TSockId</a> hostid=<a class="el" href="namespaceNLNET.html#a1">InvalidSockId</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>Force to send all data pending in the send queue.</em> <a href="#a2">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_1CCallbackClient.html#a3">update</a> (<a class="el" href="memory__common_8h.html#a10">sint32</a> timeout=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Updates the network (call this method evenly).</em> <a href="#a3">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_1CCallbackClient.html#a4">connect</a> (const <a class="el" href="classNLNET_1_1CInetAddress.html">CInetAddress</a> &<a class="el" href="driver__opengl__extension__def_8h.html#a414">addr</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>Connects to the specified host.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classNLNET_1_1CCallbackClient.html#a5">connected</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns true if the connection is still connected (changed when a disconnection event has reached the front of the receive queue, just before calling the disconnection callback if there is one).</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const <a class="el" href="classNLNET_1_1CInetAddress.html">CInetAddress</a> & </td><td valign=bottom><a class="el" href="classNLNET_1_1CCallbackClient.html#a6">hostAddress</a> (<a class="el" href="namespaceNLNET.html#a0">TSockId</a> hostid)</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the address of the specified host.</em> <a href="#a6">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_1CCallbackClient.html#a7">disconnect</a> (<a class="el" href="namespaceNLNET.html#a0">TSockId</a> hostid=<a class="el" href="namespaceNLNET.html#a1">InvalidSockId</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>Disconnect a connection Unlike in <a class="el" href="classNLNET_1_1CCallbackClient.html">CCallbackClient</a>, you can call <a class="el" href="classNLNET_1_1CCallbackClient.html#a7">disconnect</a>() on a socket that is already disconnected (it will do nothing).</em> <a href="#a7">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_1CCallbackClient.html#a8">setDisconnectionCallback</a> (<a class="el" href="namespaceNLNET.html#a2">TNetCallback</a> cb, void *arg)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets callback for disconnections (or NULL to disable callback).</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="namespaceNLNET.html#a0">TSockId</a> </td><td valign=bottom><a class="el" href="classNLNET_1_1CCallbackClient.html#a9">getSockId</a> (<a class="el" href="namespaceNLNET.html#a0">TSockId</a> hostid=<a class="el" href="namespaceNLNET.html#a1">InvalidSockId</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the sockid.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="memory__common_8h.html#a13">uint64</a> </td><td valign=bottom><a class="el" href="classNLNET_1_1CCallbackClient.html#a10">getReceiveQueueSize</a> ()</td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="memory__common_8h.html#a13">uint64</a> </td><td valign=bottom><a class="el" href="classNLNET_1_1CCallbackClient.html#a11">getSendQueueSize</a> ()</td></tr> +<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLNET_1_1CCallbackClient.html#c0">send</a> (const <a class="el" href="classNLMISC_1_1CMemStream.html">NLMISC::CMemStream</a> &<a class="el" href="driver__opengl__extension__def_8h.html#a381">buffer</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>These function is public in the base class and put it private here because user cannot use it in layer 2.</em> <a href="#c0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLNET_1_1CCallbackClient.html#c1">dataAvailable</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Returns true if there are messages to read.</em> <a href="#c1">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_1CCallbackClient.html#c2">receive</a> (<a class="el" href="classNLNET_1_1CMessage.html">CMessage</a> &<a class="el" href="driver__opengl__extension__def_8h.html#a381">buffer</a>, <a class="el" href="namespaceNLNET.html#a0">TSockId</a> *hostid=NULL)</td></tr> +<tr><td> </td><td><font size=-1><em>On this layer, you can't call directly receive, It s the <a class="el" href="classNLNET_1_1CBufClient.html#a7">update</a>() function that receive and call your callaback.</em> <a href="#c2">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="memory__common_8h.html#a11">uint32</a> </td><td valign=bottom><a class="el" href="classNLNET_1_1CCallbackClient.html#o0">SendNextValue</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="memory__common_8h.html#a11">uint32</a> </td><td valign=bottom><a class="el" href="classNLNET_1_1CCallbackClient.html#o1">ReceiveNextValue</a></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Client class for layer 3. +<p> +<dl compact><dt><b> +Author: </b><dd> +Vianney Lecroart, Olivier Cado , Nevrax France </dl><dl compact><dt><b> +Date: </b><dd> +2001 </dl> +<p> + +<p> +Definition at line <a class="el" href="callback__client_8h-source.html#l00046">46</a> of file <a class="el" href="callback__client_8h-source.html">callback_client.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="NLNET::CCallbackClient::CCallbackClient"></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"> NLNET::CCallbackClient::CCallbackClient </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLNET_1_1CCallbackNetBase.html#s3">TRecordingState</a> </td> + <td class="mdname" nowrap> <em>rec</em> = Off, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>const std::string & </td> + <td class="mdname" nowrap> <em>recfilename</em> = "", </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>recordall</em> = true</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor. +<p> + +<p> +Definition at line <a class="el" href="callback__client_8cpp-source.html#l00059">59</a> of file <a class="el" href="callback__client_8cpp-source.html">callback_client.cpp</a>. +<p> +References <a class="el" href="callback__net__base_8h-source.html#l00194">NLNET::CCallbackNetBase::_DefaultCallback</a>, <a class="el" href="callback__net__base_8h-source.html#l00183">NLNET::CCallbackNetBase::_InputSIDA</a>, <a class="el" href="callback__net__base_8h-source.html#l00196">NLNET::CCallbackNetBase::_IsAServer</a>, <a class="el" href="callback__net__base_8h-source.html#l00165">NLNET::CCallbackNetBase::_NewDisconnectionCallback</a>, <a class="el" href="callback__net__base_8cpp-source.html#l00184">NLNET::CCallbackNetBase::addCallbackArray</a>, <a class="el" href="callback__client_8cpp-source.html#l00050">NLNET::ClientMessageAssociationArray</a>, and <a class="el" href="string__id__array_8h-source.html#l00176">NLMISC::CStringIdArray::ignoreAllUnknownId</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a4" doxytag="NLNET::CCallbackClient::connect"></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::CCallbackClient::connect </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLNET_1_1CInetAddress.html">CInetAddress</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>addr</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Connects to the specified host. +<p> + +<p> +Reimplemented from <a class="el" href="classNLNET_1_1CBufClient.html#a2">NLNET::CBufClient</a>. +<p> +Definition at line <a class="el" href="callback__client_8cpp-source.html#l00283">283</a> of file <a class="el" href="callback__client_8cpp-source.html">callback_client.cpp</a>. +<p> +References <a class="el" href="buf__client_8h-source.html#l00197">NLNET::CBufClient::_BufSock</a>, <a class="el" href="buf__client_8h-source.html#l00200">NLNET::CBufClient::_NoDelay</a>, <a class="el" href="buf__client_8h-source.html#l00203">NLNET::CBufClient::_PrevBytesDownloaded</a>, <a class="el" href="buf__client_8h-source.html#l00206">NLNET::CBufClient::_PrevBytesUploaded</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00823">addr</a>, <a class="el" href="callback__net__base_8cpp-source.html#l00531">NLNET::CCallbackNetBase::checkThreadId</a>, <a class="el" href="namespaceNLNET.html#a156a14">NLNET::Connecting</a>, <a class="el" href="namespaceNLNET.html#a156a15">NLNET::ConnFailing</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, <a class="el" href="debug_8h-source.html#l00114">nlwarning</a>, <a class="el" href="callback__client_8h-source.html#l00106">ReceiveNextValue</a>, <a class="el" href="classNLNET_1_1CCallbackNetBase.html#s3s1">NLNET::CCallbackNetBase::Record</a>, <a class="el" href="classNLNET_1_1CCallbackNetBase.html#s3s2">NLNET::CCallbackNetBase::Replay</a>, <a class="el" href="callback__client_8h-source.html#l00106">SendNextValue</a>, and <a class="el" href="message__recorder_8h-source.html#l00049">NLNET::TNetworkEvent</a>. </td> + </tr> +</table> +<a name="a5" doxytag="NLNET::CCallbackClient::connected"></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"> virtual bool NLNET::CCallbackClient::connected </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns true if the connection is still connected (changed when a disconnection event has reached the front of the receive queue, just before calling the disconnection callback if there is one). +<p> + +<p> +Reimplemented from <a class="el" href="classNLNET_1_1CBufClient.html#a12">NLNET::CBufClient</a>. +<p> +Definition at line <a class="el" href="callback__client_8h-source.html#l00069">69</a> of file <a class="el" href="callback__client_8h-source.html">callback_client.h</a>. +<p> +References <a class="el" href="callback__net__base_8cpp-source.html#l00531">NLNET::CCallbackNetBase::checkThreadId</a>. +<p> +Referenced by <a class="el" href="callback__client_8cpp-source.html#l00217">receive</a>, and <a class="el" href="callback__client_8cpp-source.html#l00079">send</a>. </td> + </tr> +</table> +<a name="c1" doxytag="NLNET::CCallbackClient::dataAvailable"></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"> bool NLNET::CCallbackClient::dataAvailable </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> [private]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns true if there are messages to read. +<p> + +<p> +Reimplemented from <a class="el" href="classNLNET_1_1CBufClient.html#a5">NLNET::CBufClient</a>. +<p> +Definition at line <a class="el" href="callback__client_8cpp-source.html#l00189">189</a> of file <a class="el" href="callback__client_8cpp-source.html">callback_client.cpp</a>. +<p> +References <a class="el" href="callback__net__base_8cpp-source.html#l00531">NLNET::CCallbackNetBase::checkThreadId</a>, and <a class="el" href="classNLNET_1_1CCallbackNetBase.html#s3s2">NLNET::CCallbackNetBase::Replay</a>. </td> + </tr> +</table> +<a name="a7" doxytag="NLNET::CCallbackClient::disconnect"></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::CCallbackClient::disconnect </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceNLNET.html#a0">TSockId</a> </td> + <td class="mdname1" valign="top" nowrap> <em>hostid</em> = <a class="el" href="namespaceNLNET.html#a1">InvalidSockId</a> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Disconnect a connection Unlike in <a class="el" href="classNLNET_1_1CCallbackClient.html">CCallbackClient</a>, you can call <a class="el" href="classNLNET_1_1CCallbackClient.html#a7">disconnect</a>() on a socket that is already disconnected (it will do nothing). +<p> + +<p> +Reimplemented from <a class="el" href="classNLNET_1_1CCallbackNetBase.html#a17">NLNET::CCallbackNetBase</a>. +<p> +Definition at line <a class="el" href="callback__client_8cpp-source.html#l00351">351</a> of file <a class="el" href="callback__client_8cpp-source.html">callback_client.cpp</a>. +<p> +References <a class="el" href="buf__client_8h-source.html#l00197">NLNET::CBufClient::_BufSock</a>, <a class="el" href="callback__net__base_8cpp-source.html#l00531">NLNET::CCallbackNetBase::checkThreadId</a>, <a class="el" href="namespaceNLNET.html#a156a17">NLNET::Disconnecting</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, <a class="el" href="debug_8h-source.html#l00114">nlwarning</a>, <a class="el" href="callback__client_8h-source.html#l00106">ReceiveNextValue</a>, <a class="el" href="classNLNET_1_1CCallbackNetBase.html#s3s2">NLNET::CCallbackNetBase::Replay</a>, <a class="el" href="callback__client_8h-source.html#l00106">SendNextValue</a>, and <a class="el" href="buf__net__base_8h-source.html#l00042">NLNET::TSockId</a>. </td> + </tr> +</table> +<a name="a2" doxytag="NLNET::CCallbackClient::flush"></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"> bool NLNET::CCallbackClient::flush </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceNLNET.html#a0">TSockId</a> </td> + <td class="mdname1" valign="top" nowrap> <em>hostid</em> = <a class="el" href="namespaceNLNET.html#a1">InvalidSockId</a> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Force to send all data pending in the send queue. +<p> + +<p> +Implements <a class="el" href="classNLNET_1_1CCallbackNetBase.html#a6">NLNET::CCallbackNetBase</a>. +<p> +Definition at line <a class="el" href="callback__client_8cpp-source.html#l00134">134</a> of file <a class="el" href="callback__client_8cpp-source.html">callback_client.cpp</a>. +<p> +References <a class="el" href="callback__net__base_8cpp-source.html#l00531">NLNET::CCallbackNetBase::checkThreadId</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, <a class="el" href="classNLNET_1_1CCallbackNetBase.html#s3s2">NLNET::CCallbackNetBase::Replay</a>, and <a class="el" href="buf__net__base_8h-source.html#l00042">NLNET::TSockId</a>. </td> + </tr> +</table> +<a name="a10" doxytag="NLNET::CCallbackClient::getReceiveQueueSize"></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"> <a class="el" href="memory__common_8h.html#a13">uint64</a> NLNET::CCallbackClient::getReceiveQueueSize </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> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Implements <a class="el" href="classNLNET_1_1CCallbackNetBase.html#a4">NLNET::CCallbackNetBase</a>. +<p> +Definition at line <a class="el" href="callback__client_8h-source.html#l00085">85</a> of file <a class="el" href="callback__client_8h-source.html">callback_client.h</a>. </td> + </tr> +</table> +<a name="a11" doxytag="NLNET::CCallbackClient::getSendQueueSize"></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"> <a class="el" href="memory__common_8h.html#a13">uint64</a> NLNET::CCallbackClient::getSendQueueSize </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> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Implements <a class="el" href="classNLNET_1_1CCallbackNetBase.html#a5">NLNET::CCallbackNetBase</a>. +<p> +Definition at line <a class="el" href="callback__client_8h-source.html#l00086">86</a> of file <a class="el" href="callback__client_8h-source.html">callback_client.h</a>. </td> + </tr> +</table> +<a name="a9" doxytag="NLNET::CCallbackClient::getSockId"></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"> <a class="el" href="namespaceNLNET.html#a0">TSockId</a> NLNET::CCallbackClient::getSockId </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceNLNET.html#a0">TSockId</a> </td> + <td class="mdname1" valign="top" nowrap> <em>hostid</em> = <a class="el" href="namespaceNLNET.html#a1">InvalidSockId</a> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the sockid. +<p> + +<p> +Implements <a class="el" href="classNLNET_1_1CCallbackNetBase.html#a10">NLNET::CCallbackNetBase</a>. +<p> +Definition at line <a class="el" href="callback__client_8cpp-source.html#l00269">269</a> of file <a class="el" href="callback__client_8cpp-source.html">callback_client.cpp</a>. +<p> +References <a class="el" href="callback__net__base_8cpp-source.html#l00531">NLNET::CCallbackNetBase::checkThreadId</a>, <a class="el" href="buf__client_8h-source.html#l00189">NLNET::CBufClient::id</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, and <a class="el" href="buf__net__base_8h-source.html#l00042">NLNET::TSockId</a>. </td> + </tr> +</table> +<a name="a6" doxytag="NLNET::CCallbackClient::hostAddress"></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"> virtual const <a class="el" href="classNLNET_1_1CInetAddress.html">CInetAddress</a>& NLNET::CCallbackClient::hostAddress </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceNLNET.html#a0">TSockId</a> </td> + <td class="mdname1" valign="top" nowrap> <em>hostid</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the address of the specified host. +<p> + +<p> +Reimplemented from <a class="el" href="classNLNET_1_1CCallbackNetBase.html#a18">NLNET::CCallbackNetBase</a>. +<p> +Definition at line <a class="el" href="callback__client_8h-source.html#l00071">71</a> of file <a class="el" href="callback__client_8h-source.html">callback_client.h</a>. +<p> +References <a class="el" href="buf__client_8h-source.html#l00160">NLNET::CBufClient::remoteAddress</a>, and <a class="el" href="buf__net__base_8h-source.html#l00042">NLNET::TSockId</a>. </td> + </tr> +</table> +<a name="c2" doxytag="NLNET::CCallbackClient::receive"></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::CCallbackClient::receive </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLNET_1_1CMessage.html">CMessage</a> & </td> + <td class="mdname" nowrap> <em>buffer</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="namespaceNLNET.html#a0">TSockId</a> * </td> + <td class="mdname" nowrap> <em>hostid</em> = NULL</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [private, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +On this layer, you can't call directly receive, It s the <a class="el" href="classNLNET_1_1CBufClient.html#a7">update</a>() function that receive and call your callaback. +<p> + +<p> +Implements <a class="el" href="classNLNET_1_1CCallbackNetBase.html#b3">NLNET::CCallbackNetBase</a>. +<p> +Definition at line <a class="el" href="callback__client_8cpp-source.html#l00217">217</a> of file <a class="el" href="callback__client_8cpp-source.html">callback_client.cpp</a>. +<p> +References <a class="el" href="callback__net__base_8cpp-source.html#l00531">NLNET::CCallbackNetBase::checkThreadId</a>, <a class="el" href="callback__client_8h-source.html#l00069">connected</a>, <a class="el" href="buf__client_8h-source.html#l00189">NLNET::CBufClient::id</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, <a class="el" href="stream_8h-source.html#l00058">NLMISC_BSWAP32</a>, <a class="el" href="debug_8h-source.html#l00414">nlstopex</a>, <a class="el" href="callback__client_8h-source.html#l00106">ReceiveNextValue</a>, <a class="el" href="namespaceNLNET.html#a156a13">NLNET::Receiving</a>, <a class="el" href="classNLNET_1_1CCallbackNetBase.html#s3s1">NLNET::CCallbackNetBase::Record</a>, <a class="el" href="classNLNET_1_1CCallbackNetBase.html#s3s2">NLNET::CCallbackNetBase::Replay</a>, and <a class="el" href="buf__net__base_8h-source.html#l00042">NLNET::TSockId</a>. </td> + </tr> +</table> +<a name="c0" doxytag="NLNET::CCallbackClient::send"></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::CCallbackClient::send </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CMemStream.html">NLMISC::CMemStream</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>buffer</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, private]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +These function is public in the base class and put it private here because user cannot use it in layer 2. +<p> + +<p> +Reimplemented from <a class="el" href="classNLNET_1_1CBufClient.html#a4">NLNET::CBufClient</a>. +<p> +Definition at line <a class="el" href="callback__client_8h-source.html#l00091">91</a> of file <a class="el" href="callback__client_8h-source.html">callback_client.h</a>. +<p> +References <a class="el" href="debug_8h-source.html#l00374">nlstop</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NLNET::CCallbackClient::send"></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::CCallbackClient::send </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLNET_1_1CMessage.html">CMessage</a> & </td> + <td class="mdname" nowrap> <em>buffer</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="namespaceNLNET.html#a0">TSockId</a> </td> + <td class="mdname" nowrap> <em>hostid</em> = <a class="el" href="namespaceNLNET.html#a1">InvalidSockId</a>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>log</em> = true</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sends a message to the remote host (the second parameter isn't used). +<p> + +<p> +Implements <a class="el" href="classNLNET_1_1CCallbackNetBase.html#a1">NLNET::CCallbackNetBase</a>. +<p> +Definition at line <a class="el" href="callback__client_8cpp-source.html#l00079">79</a> of file <a class="el" href="callback__client_8cpp-source.html">callback_client.cpp</a>. +<p> +References <a class="el" href="callback__net__base_8h-source.html#l00162">NLNET::CCallbackNetBase::_BytesSent</a>, <a class="el" href="callback__net__base_8cpp-source.html#l00531">NLNET::CCallbackNetBase::checkThreadId</a>, <a class="el" href="callback__client_8h-source.html#l00069">connected</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, <a class="el" href="stream_8h-source.html#l00058">NLMISC_BSWAP32</a>, <a class="el" href="classNLNET_1_1CCallbackNetBase.html#s3s1">NLNET::CCallbackNetBase::Record</a>, <a class="el" href="classNLNET_1_1CCallbackNetBase.html#s3s2">NLNET::CCallbackNetBase::Replay</a>, <a class="el" href="namespaceNLNET.html#a156a12">NLNET::Sending</a>, <a class="el" href="callback__client_8h-source.html#l00106">SendNextValue</a>, and <a class="el" href="buf__net__base_8h-source.html#l00042">NLNET::TSockId</a>. </td> + </tr> +</table> +<a name="a8" doxytag="NLNET::CCallbackClient::setDisconnectionCallback"></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::CCallbackClient::setDisconnectionCallback </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceNLNET.html#a2">TNetCallback</a> </td> + <td class="mdname" nowrap> <em>cb</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>void * </td> + <td class="mdname" nowrap> <em>arg</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets callback for disconnections (or NULL to disable callback). +<p> + +<p> +Reimplemented from <a class="el" href="classNLNET_1_1CCallbackNetBase.html#a9">NLNET::CCallbackNetBase</a>. +<p> +Definition at line <a class="el" href="callback__client_8h-source.html#l00080">80</a> of file <a class="el" href="callback__client_8h-source.html">callback_client.h</a>. +<p> +References <a class="el" href="callback__net__base_8cpp-source.html#l00531">NLNET::CCallbackNetBase::checkThreadId</a>, and <a class="el" href="buf__net__base_8h-source.html#l00047">NLNET::TNetCallback</a>. </td> + </tr> +</table> +<a name="a3" doxytag="NLNET::CCallbackClient::update"></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::CCallbackClient::update </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a10">sint32</a> </td> + <td class="mdname1" valign="top" nowrap> <em>timeout</em> = 0 </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Updates the network (call this method evenly). +<p> + +<p> +Reimplemented from <a class="el" href="classNLNET_1_1CCallbackNetBase.html#a15">NLNET::CCallbackNetBase</a>. +<p> +Definition at line <a class="el" href="callback__client_8cpp-source.html#l00162">162</a> of file <a class="el" href="callback__client_8cpp-source.html">callback_client.cpp</a>. +<p> +References <a class="el" href="callback__net__base_8cpp-source.html#l00328">NLNET::CCallbackNetBase::baseUpdate</a>, <a class="el" href="callback__net__base_8cpp-source.html#l00531">NLNET::CCallbackNetBase::checkThreadId</a>, and <a class="el" href="classNLNET_1_1CCallbackNetBase.html#s3s2">NLNET::CCallbackNetBase::Replay</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="o1" doxytag="NLNET::CCallbackClient::ReceiveNextValue"></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"> <a class="el" href="memory__common_8h.html#a11">uint32</a> NLNET::CCallbackClient::ReceiveNextValue<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="callback__client_8h-source.html#l00106">106</a> of file <a class="el" href="callback__client_8h-source.html">callback_client.h</a>. +<p> +Referenced by <a class="el" href="callback__client_8cpp-source.html#l00283">connect</a>, <a class="el" href="callback__client_8cpp-source.html#l00351">disconnect</a>, and <a class="el" href="callback__client_8cpp-source.html#l00217">receive</a>. </td> + </tr> +</table> +<a name="o0" doxytag="NLNET::CCallbackClient::SendNextValue"></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"> <a class="el" href="memory__common_8h.html#a11">uint32</a> NLNET::CCallbackClient::SendNextValue<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="callback__client_8h-source.html#l00106">106</a> of file <a class="el" href="callback__client_8h-source.html">callback_client.h</a>. +<p> +Referenced by <a class="el" href="callback__client_8cpp-source.html#l00283">connect</a>, <a class="el" href="callback__client_8cpp-source.html#l00351">disconnect</a>, and <a class="el" href="callback__client_8cpp-source.html#l00079">send</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="callback__client_8h-source.html">callback_client.h</a><li><a class="el" href="callback__client_8cpp-source.html">callback_client.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> |