diff options
| author | neodarz <neodarz@neodarz.net> | 2018-08-11 20:21:34 +0200 |
|---|---|---|
| committer | neodarz <neodarz@neodarz.net> | 2018-08-11 20:21:34 +0200 |
| commit | 0ea5fc66924303d1bf73ba283a383e2aadee02f2 (patch) | |
| tree | 2568e71a7ccc44ec23b8bb3f0ff97fb6bf2ed709 /docs/doxygen/nel/classNLNET_1_1CBufSock.html | |
| download | nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.tar.xz nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.zip | |
Initial commit
Diffstat (limited to 'docs/doxygen/nel/classNLNET_1_1CBufSock.html')
| -rw-r--r-- | docs/doxygen/nel/classNLNET_1_1CBufSock.html | 1322 |
1 files changed, 1322 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLNET_1_1CBufSock.html b/docs/doxygen/nel/classNLNET_1_1CBufSock.html new file mode 100644 index 00000000..227e3c00 --- /dev/null +++ b/docs/doxygen/nel/classNLNET_1_1CBufSock.html @@ -0,0 +1,1322 @@ +<!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::CBufSock Class Reference</h1><a class="el" href="classNLNET_1_1CBufSock.html">CBufSock</a> A socket and its sending buffer. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>></code> +<p> +<p>Inheritance diagram for NLNET::CBufSock: +<p><center><img src="classNLNET_1_1CBufSock.gif" usemap="#NLNET::CBufSock_map" border="0"></center> +<map name="NLNET::CBufSock_map"> +<area href="classNLNET_1_1CServerBufSock.html" alt="NLNET::CServerBufSock" shape="rect" coords="0,56,153,80"> +</map> +<a href="classNLNET_1_1CBufSock-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>virtual </td><td valign=bottom><a class="el" href="classNLNET_1_1CBufSock.html#a0">~CBufSock</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Destructor.</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_1CBufSock.html#a1">setAppId</a> (<a class="el" href="memory__common_8h.html#a13">uint64</a> <a class="el" href="driver__opengl__extension__def_8h.html#a356">id</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets the application identifier.</em> <a href="#a1">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_1CBufSock.html#a2">appId</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the application identifier.</em> <a href="#a2">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_1CBufSock.html#a3">asString</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns a string with the characteristics of the object.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classNLNET_1_1CBufSock.html#m0">AuthorizedCallback</a></td></tr> +<tr><td> </td><td><font size=-1><em>Little tricky but this string is used by Layer4 to know which callback is authorized. This is empty when all callback are authorized.</em> <a href="#m0">More...</a><em></em></font><br><br></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_1CBufSock.html#m1">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_1CBufSock.html#m2">ReceiveNextValue</a></td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classNLNET_1_1CBufSock.html#b0">CBufSock</a> (<a class="el" href="classNLNET_1_1CTcpSock.html">CTcpSock</a> *sock=NULL)</td></tr> +<tr><td> </td><td><font size=-1><em>Constructor.</em> <a href="#b0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual std::string </td><td valign=bottom><a class="el" href="classNLNET_1_1CBufSock.html#b1">typeStr</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns "CLT " (client).</em> <a href="#b1">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_1CBufSock.html#b2">advertiseDisconnection</a> (<a class="el" href="classNLNET_1_1CBufNetBase.html">CBufNetBase</a> *bnb, <a class="el" href="namespaceNLNET.html#a0">TSockId</a> sockid)</td></tr> +<tr><td> </td><td><font size=-1><em>Pushes a disconnection message into bnb's receive queue, if it has not already been done (returns true in this case).</em> <a href="#b2">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_1CBufSock.html#b3">advertiseSystemEvent</a> (<a class="el" href="classNLNET_1_1CBufNetBase.html">CBufNetBase</a> *bnb, <a class="el" href="namespaceNLNET.html#a0">TSockId</a> sockid, bool &flag, bool <a class="el" href="driver__opengl__extension__def_8h.html#a376">condition</a>, <a class="el" href="classNLNET_1_1CBufNetBase.html#s3">CBufNetBase::TEventType</a> event)</td></tr> +<tr><td> </td><td><font size=-1><em>Pushes a system message into bnb's receive queue, if the flags meets the condition, then resets the flag and returns true.</em> <a href="#b3">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_1CBufSock.html#b4">pushBuffer</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>Pushes a buffer to the send queue and update, or returns false if the socket is not physically connected the or an error occured during sending.</em> <a href="#b4">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_1CBufSock.html#b5">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>, bool nodelay, bool connectedstate)</td></tr> +<tr><td> </td><td><font size=-1><em>Connects to the specified addr; set connectedstate to true if no connection advertising is needed.</em> <a href="#b5">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_1CBufSock.html#b6">disconnect</a> (bool connectedstate)</td></tr> +<tr><td> </td><td><font size=-1><em>Disconnects; set connectedstate to false if no disconnection advertising is needed.</em> <a href="#b6">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_1CBufSock.html#b7">setConnectedState</a> (bool connectedstate)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets the "logically connected" state (changed when processing a connection/disconnection callback).</em> <a href="#b7">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_1CBufSock.html#b8">connectedState</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the "logically connected" state (changed when processing a connection/disconnection callback).</em> <a href="#b8">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">Sending data</div></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLNET_1_1CBufSock.html#z347_0">update</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Update the network sending (call this method evenly). Returns false if an error occured.</em> <a href="#z347_0">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_1CBufSock.html#z347_1">setTimeFlushTrigger</a> (<a class="el" href="memory__common_8h.html#a10">sint32</a> ms)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets the time flush trigger (in millisecond).</em> <a href="#z347_1">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_1CBufSock.html#z347_2">setSizeFlushTrigger</a> (<a class="el" href="memory__common_8h.html#a10">sint32</a> <a class="el" href="cf__lexical_8cpp.html#a94">size</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets the size flush trigger.</em> <a href="#z347_2">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_1CBufSock.html#z347_3">flush</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Forces to send all data pending in the send queue.</em> <a href="#z347_3">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLMISC_1_1CBufFIFO.html">NLMISC::CBufFIFO</a> </td><td valign=bottom><a class="el" href="classNLNET_1_1CBufSock.html#n0">SendFifo</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLNET_1_1CTcpSock.html">CTcpSock</a> * </td><td valign=bottom><a class="el" href="classNLNET_1_1CBufSock.html#n1">Sock</a></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLNET_1_1CBufSock.html#n2">_KnowConnected</a></td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="namespaceNLMISC.html#a183">NLMISC::TTime</a> </td><td valign=bottom><a class="el" href="classNLNET_1_1CBufSock.html#o0">_LastFlushTime</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="namespaceNLMISC.html#a183">NLMISC::TTime</a> </td><td valign=bottom><a class="el" href="classNLNET_1_1CBufSock.html#o1">_TriggerTime</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="memory__common_8h.html#a10">sint32</a> </td><td valign=bottom><a class="el" href="classNLNET_1_1CBufSock.html#o2">_TriggerSize</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLMISC_1_1CObjectVector.html">NLMISC::CObjectVector</a>< <a class="el" href="memory__common_8h.html#a7">uint8</a> > </td><td valign=bottom><a class="el" href="classNLNET_1_1CBufSock.html#o3">_ReadyToSendBuffer</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="namespaceNLNET.html#a6">TBlockSize</a> </td><td valign=bottom><a class="el" href="classNLNET_1_1CBufSock.html#o4">_RTSBIndex</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_1CBufSock.html#o5">_AppId</a></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLNET_1_1CBufSock.html#o6">_ConnectedState</a></td></tr> +<tr><td colspan=2><br><h2>Friends</h2></td></tr> +<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classNLNET_1_1CBufSock.html#l0">CBufClient</a></td></tr> +<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classNLNET_1_1CBufSock.html#l1">CBufServer</a></td></tr> +<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classNLNET_1_1CBufSock.html#l2">CClientReceiveTask</a></td></tr> +<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classNLNET_1_1CBufSock.html#l3">CServerReceiveTask</a></td></tr> +<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classNLNET_1_1CBufSock.html#l4">CCallbackClient</a></td></tr> +<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classNLNET_1_1CBufSock.html#l5">CCallbackServer</a></td></tr> +<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classNLNET_1_1CBufSock.html#l6">CCallbackNetBase</a></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +<a class="el" href="classNLNET_1_1CBufSock.html">CBufSock</a> A socket and its sending buffer. +<p> + +<p> +Definition at line <a class="el" href="buf__sock_8h-source.html#l00052">52</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="NLNET::CBufSock::~CBufSock"></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::CBufSock::~CBufSock </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> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Destructor. +<p> + +<p> +Definition at line <a class="el" href="buf__sock_8cpp-source.html#l00081">81</a> of file <a class="el" href="buf__sock_8cpp-source.html">buf_sock.cpp</a>. +<p> +References <a class="el" href="buf__sock_8h-source.html#l00262">_AppId</a>, <a class="el" href="buf__sock_8h-source.html#l00265">_ConnectedState</a>, <a class="el" href="buf__sock_8h-source.html#l00246">_KnowConnected</a>, <a class="el" href="buf__sock_8h-source.html#l00255">_LastFlushTime</a>, <a class="el" href="buf__sock_8h-source.html#l00259">_ReadyToSendBuffer</a>, <a class="el" href="buf__sock_8h-source.html#l00260">_RTSBIndex</a>, <a class="el" href="buf__sock_8h-source.html#l00257">_TriggerSize</a>, <a class="el" href="buf__sock_8h-source.html#l00256">_TriggerTime</a>, <a class="el" href="buf__sock_8h-source.html#l00070">AuthorizedCallback</a>, <a class="el" href="object__vector_8h-source.html#l00118">NLMISC::CObjectVector< uint8 >::clear</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, <a class="el" href="buf__sock_8h-source.html#l00040">nlnettrace</a>, and <a class="el" href="buf__sock_8h-source.html#l00243">Sock</a>. </td> + </tr> +</table> +<a name="b0" doxytag="NLNET::CBufSock::CBufSock"></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::CBufSock::CBufSock </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLNET_1_1CTcpSock.html">CTcpSock</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>sock</em> = NULL </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [protected]</code></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="buf__sock_8cpp-source.html#l00052">52</a> of file <a class="el" href="buf__sock_8cpp-source.html">buf_sock.cpp</a>. +<p> +References <a class="el" href="buf__sock_8h-source.html#l00255">_LastFlushTime</a>, <a class="el" href="buf__sock_8h-source.html#l00040">nlnettrace</a>, and <a class="el" href="buf__sock_8h-source.html#l00243">Sock</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="b2" doxytag="NLNET::CBufSock::advertiseDisconnection"></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::CBufSock::advertiseDisconnection </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLNET_1_1CBufNetBase.html">CBufNetBase</a> * </td> + <td class="mdname" nowrap> <em>bnb</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>sockid</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline, protected]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Pushes a disconnection message into bnb's receive queue, if it has not already been done (returns true in this case). +<p> +You can either specify a sockid (for server) or InvalidSockId (for client) +<p> +Definition at line <a class="el" href="buf__sock_8h-source.html#l00120">120</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. +<p> +References <a class="el" href="buf__sock_8h-source.html#l00246">_KnowConnected</a>, <a class="el" href="buf__sock_8h-source.html#l00135">advertiseSystemEvent</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="b3" doxytag="NLNET::CBufSock::advertiseSystemEvent"></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::CBufSock::advertiseSystemEvent </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLNET_1_1CBufNetBase.html">CBufNetBase</a> * </td> + <td class="mdname" nowrap> <em>bnb</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>sockid</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>bool & </td> + <td class="mdname" nowrap> <em>flag</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>condition</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="classNLNET_1_1CBufNetBase.html#s3">CBufNetBase::TEventType</a> </td> + <td class="mdname" nowrap> <em>event</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline, protected]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Pushes a system message into bnb's receive queue, if the flags meets the condition, then resets the flag and returns true. +<p> +You can either specify a sockid (for server) or InvalidSockId (for client). +<p> +Definition at line <a class="el" href="buf__sock_8h-source.html#l00135">135</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. +<p> +References <a class="el" href="buf__sock_8cpp-source.html#l00325">asString</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00371">condition</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, <a class="el" href="debug_8h-source.html#l00087">nldebug</a>, and <a class="el" href="buf__net__base_8h-source.html#l00042">NLNET::TSockId</a>. +<p> +Referenced by <a class="el" href="buf__sock_8h-source.html#l00306">NLNET::CServerBufSock::advertiseConnection</a>, and <a class="el" href="buf__sock_8h-source.html#l00120">advertiseDisconnection</a>. </td> + </tr> +</table> +<a name="a2" doxytag="NLNET::CBufSock::appId"></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::CBufSock::appId </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]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the application identifier. +<p> + +<p> +Definition at line <a class="el" href="buf__sock_8h-source.html#l00063">63</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. +<p> +References <a class="el" href="buf__sock_8h-source.html#l00262">_AppId</a>. </td> + </tr> +</table> +<a name="a3" doxytag="NLNET::CBufSock::asString"></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"> string NLNET::CBufSock::asString </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</td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns a string with the characteristics of the object. +<p> + +<p> +Definition at line <a class="el" href="buf__sock_8cpp-source.html#l00325">325</a> of file <a class="el" href="buf__sock_8cpp-source.html">buf_sock.cpp</a>. +<p> +References <a class="el" href="buf__sock_8h-source.html#l00243">Sock</a>, and <a class="el" href="buf__sock_8h-source.html#l00115">typeStr</a>. +<p> +Referenced by <a class="el" href="buf__sock_8h-source.html#l00135">advertiseSystemEvent</a>, <a class="el" href="buf__sock_8cpp-source.html#l00138">flush</a>, and <a class="el" href="buf__sock_8cpp-source.html#l00370">NLNET::CServerBufSock::receivePart</a>. </td> + </tr> +</table> +<a name="b5" doxytag="NLNET::CBufSock::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::CBufSock::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="mdname" nowrap> <em>addr</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>nodelay</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>connectedstate</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [protected]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Connects to the specified addr; set connectedstate to true if no connection advertising is needed. +<p> + +<p> +Definition at line <a class="el" href="buf__sock_8cpp-source.html#l00291">291</a> of file <a class="el" href="buf__sock_8cpp-source.html">buf_sock.cpp</a>. +<p> +References <a class="el" href="buf__sock_8h-source.html#l00265">_ConnectedState</a>, <a class="el" href="buf__sock_8h-source.html#l00246">_KnowConnected</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00823">addr</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, <a class="el" href="buf__sock_8h-source.html#l00074">ReceiveNextValue</a>, <a class="el" href="buf__sock_8h-source.html#l00074">SendNextValue</a>, and <a class="el" href="buf__sock_8h-source.html#l00243">Sock</a>. </td> + </tr> +</table> +<a name="b8" doxytag="NLNET::CBufSock::connectedState"></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::CBufSock::connectedState </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, protected]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the "logically connected" state (changed when processing a connection/disconnection callback). +<p> + +<p> +Definition at line <a class="el" href="buf__sock_8h-source.html#l00237">237</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. +<p> +References <a class="el" href="buf__sock_8h-source.html#l00265">_ConnectedState</a>. </td> + </tr> +</table> +<a name="b6" doxytag="NLNET::CBufSock::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::CBufSock::disconnect </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname1" valign="top" nowrap> <em>connectedstate</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [protected]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Disconnects; set connectedstate to false if no disconnection advertising is needed. +<p> + +<p> +Definition at line <a class="el" href="buf__sock_8cpp-source.html#l00311">311</a> of file <a class="el" href="buf__sock_8cpp-source.html">buf_sock.cpp</a>. +<p> +References <a class="el" href="buf__sock_8h-source.html#l00265">_ConnectedState</a>, <a class="el" href="buf__sock_8h-source.html#l00246">_KnowConnected</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, <a class="el" href="buf__sock_8h-source.html#l00074">ReceiveNextValue</a>, <a class="el" href="buf__sock_8h-source.html#l00074">SendNextValue</a>, and <a class="el" href="buf__sock_8h-source.html#l00243">Sock</a>. </td> + </tr> +</table> +<a name="z347_3" doxytag="NLNET::CBufSock::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::CBufSock::flush </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> [protected]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Forces to send all data pending in the send queue. +<p> +<dl compact><dt><b> +Returns: </b><dd> +False if an error has occured (e.g. the remote host is disconnected). To retrieve the reason of the error, call <a class="el" href="classNLNET_1_1CSock.html#d2">CSock::getLastError</a>() and/or <a class="el" href="classNLNET_1_1CSock.html#d3">CSock::errorString</a>() </dl> +<p> +Definition at line <a class="el" href="buf__sock_8cpp-source.html#l00138">138</a> of file <a class="el" href="buf__sock_8cpp-source.html">buf_sock.cpp</a>. +<p> +References <a class="el" href="buf__sock_8h-source.html#l00259">_ReadyToSendBuffer</a>, <a class="el" href="buf__sock_8h-source.html#l00260">_RTSBIndex</a>, <a class="el" href="buf__sock_8cpp-source.html#l00325">asString</a>, <a class="el" href="object__vector_8h-source.html#l00118">NLMISC::CObjectVector< uint8 >::clear</a>, <a class="el" href="buf__fifo_8h-source.html#l00100">NLMISC::CBufFIFO::empty</a>, <a class="el" href="buf__fifo_8cpp-source.html#l00226">NLMISC::CBufFIFO::front</a>, <a class="el" href="object__vector_8h-source.html#l00180">NLMISC::CObjectVector< uint8 >::getPtr</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, <a class="el" href="debug_8h-source.html#l00293">nlassertex</a>, <a class="el" href="debug_8h-source.html#l00087">nldebug</a>, <a class="el" href="buf__fifo_8cpp-source.html#l00157">NLMISC::CBufFIFO::pop</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00815">res</a>, <a class="el" href="object__vector_8h-source.html#l00131">NLMISC::CObjectVector< uint8 >::resize</a>, <a class="el" href="buf__sock_8h-source.html#l00240">SendFifo</a>, <a class="el" href="object__vector_8h-source.html#l00169">NLMISC::CObjectVector< uint8 >::size</a>, <a class="el" href="buf__sock_8h-source.html#l00243">Sock</a>, and <a class="el" href="buf__net__base_8h-source.html#l00059">NLNET::TBlockSize</a>. +<p> +Referenced by <a class="el" href="buf__sock_8cpp-source.html#l00243">update</a>. </td> + </tr> +</table> +<a name="b4" doxytag="NLNET::CBufSock::pushBuffer"></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::CBufSock::pushBuffer </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, protected]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Pushes a buffer to the send queue and update, or returns false if the socket is not physically connected the or an error occured during sending. +<p> + +<p> +Definition at line <a class="el" href="buf__sock_8h-source.html#l00178">178</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. +<p> +References <a class="el" href="mem__stream_8h-source.html#l00152">NLMISC::CMemStream::length</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="buf__fifo_8h-source.html#l00072">NLMISC::CBufFIFO::push</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00815">res</a>, <a class="el" href="buf__sock_8h-source.html#l00240">SendFifo</a>, <a class="el" href="buf__sock_8h-source.html#l00243">Sock</a>, and <a class="el" href="buf__sock_8cpp-source.html#l00243">update</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NLNET::CBufSock::setAppId"></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::CBufSock::setAppId </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a13">uint64</a> </td> + <td class="mdname1" valign="top" nowrap> <em>id</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets the application identifier. +<p> + +<p> +Definition at line <a class="el" href="buf__sock_8h-source.html#l00060">60</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. +<p> +References <a class="el" href="buf__sock_8h-source.html#l00262">_AppId</a>, and <a class="el" href="driver__opengl__extension__def_8h-source.html#l00218">id</a>. </td> + </tr> +</table> +<a name="b7" doxytag="NLNET::CBufSock::setConnectedState"></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::CBufSock::setConnectedState </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname1" valign="top" nowrap> <em>connectedstate</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, protected]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets the "logically connected" state (changed when processing a connection/disconnection callback). +<p> + +<p> +Definition at line <a class="el" href="buf__sock_8h-source.html#l00234">234</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. +<p> +References <a class="el" href="buf__sock_8h-source.html#l00265">_ConnectedState</a>. </td> + </tr> +</table> +<a name="z347_2" doxytag="NLNET::CBufSock::setSizeFlushTrigger"></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::CBufSock::setSizeFlushTrigger </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>size</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, protected]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets the size flush trigger. +<p> +When the size of the send queue reaches or exceeds this calue, all data in the send queue is automatically sent (-1 to disable this trigger ) +<p> +Definition at line <a class="el" href="buf__sock_8h-source.html#l00104">104</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. +<p> +References <a class="el" href="buf__sock_8h-source.html#l00257">_TriggerSize</a>. </td> + </tr> +</table> +<a name="z347_1" doxytag="NLNET::CBufSock::setTimeFlushTrigger"></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::CBufSock::setTimeFlushTrigger </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>ms</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [protected]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets the time flush trigger (in millisecond). +<p> +When this time is elapsed, all data in the send queue is automatically sent (-1 to disable this trigger) +<p> +Definition at line <a class="el" href="buf__sock_8cpp-source.html#l00232">232</a> of file <a class="el" href="buf__sock_8cpp-source.html">buf_sock.cpp</a>. +<p> +References <a class="el" href="buf__sock_8h-source.html#l00255">_LastFlushTime</a>, <a class="el" href="buf__sock_8h-source.html#l00256">_TriggerTime</a>, and <a class="el" href="debug_8h-source.html#l00254">nlassert</a>. </td> + </tr> +</table> +<a name="b1" doxytag="NLNET::CBufSock::typeStr"></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 std::string NLNET::CBufSock::typeStr </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, protected, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns "CLT " (client). +<p> + +<p> +Reimplemented in <a class="el" href="classNLNET_1_1CServerBufSock.html#b6">NLNET::CServerBufSock</a>. +<p> +Definition at line <a class="el" href="buf__sock_8h-source.html#l00115">115</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. +<p> +Referenced by <a class="el" href="buf__sock_8cpp-source.html#l00325">asString</a>. </td> + </tr> +</table> +<a name="z347_0" doxytag="NLNET::CBufSock::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"> bool NLNET::CBufSock::update </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> [protected]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Update the network sending (call this method evenly). Returns false if an error occured. +<p> + +<p> +Definition at line <a class="el" href="buf__sock_8cpp-source.html#l00243">243</a> of file <a class="el" href="buf__sock_8cpp-source.html">buf_sock.cpp</a>. +<p> +References <a class="el" href="buf__sock_8h-source.html#l00255">_LastFlushTime</a>, <a class="el" href="buf__sock_8h-source.html#l00257">_TriggerSize</a>, <a class="el" href="buf__sock_8h-source.html#l00256">_TriggerTime</a>, <a class="el" href="buf__sock_8cpp-source.html#l00138">flush</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, <a class="el" href="buf__sock_8h-source.html#l00240">SendFifo</a>, <a class="el" href="buf__fifo_8cpp-source.html#l00395">NLMISC::CBufFIFO::size</a>, and <a class="el" href="time__nl_8h-source.html#l00047">NLMISC::TTime</a>. +<p> +Referenced by <a class="el" href="buf__sock_8h-source.html#l00178">pushBuffer</a>. </td> + </tr> +</table> +<hr><h2>Friends And Related Function Documentation</h2> +<a name="l0" doxytag="NLNET::CBufSock::CBufClient"></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"> friend class CBufClient<code> [friend]</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="buf__sock_8h-source.html#l00078">78</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. </td> + </tr> +</table> +<a name="l1" doxytag="NLNET::CBufSock::CBufServer"></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"> friend class CBufServer<code> [friend]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Reimplemented in <a class="el" href="classNLNET_1_1CServerBufSock.html#l0">NLNET::CServerBufSock</a>. +<p> +Definition at line <a class="el" href="buf__sock_8h-source.html#l00079">79</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. </td> + </tr> +</table> +<a name="l4" doxytag="NLNET::CBufSock::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"> friend class CCallbackClient<code> [friend]</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="buf__sock_8h-source.html#l00083">83</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. </td> + </tr> +</table> +<a name="l6" doxytag="NLNET::CBufSock::CCallbackNetBase"></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"> friend class CCallbackNetBase<code> [friend]</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="buf__sock_8h-source.html#l00085">85</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. </td> + </tr> +</table> +<a name="l5" doxytag="NLNET::CBufSock::CCallbackServer"></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"> friend class CCallbackServer<code> [friend]</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="buf__sock_8h-source.html#l00084">84</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. </td> + </tr> +</table> +<a name="l2" doxytag="NLNET::CBufSock::CClientReceiveTask"></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"> friend class CClientReceiveTask<code> [friend]</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="buf__sock_8h-source.html#l00080">80</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. </td> + </tr> +</table> +<a name="l3" doxytag="NLNET::CBufSock::CServerReceiveTask"></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"> friend class CServerReceiveTask<code> [friend]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Reimplemented in <a class="el" href="classNLNET_1_1CServerBufSock.html#l2">NLNET::CServerBufSock</a>. +<p> +Definition at line <a class="el" href="buf__sock_8h-source.html#l00081">81</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="o5" doxytag="NLNET::CBufSock::_AppId"></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::CBufSock::_AppId<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="buf__sock_8h-source.html#l00262">262</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. +<p> +Referenced by <a class="el" href="buf__sock_8h-source.html#l00063">appId</a>, <a class="el" href="buf__sock_8h-source.html#l00060">setAppId</a>, and <a class="el" href="buf__sock_8cpp-source.html#l00081">~CBufSock</a>. </td> + </tr> +</table> +<a name="o6" doxytag="NLNET::CBufSock::_ConnectedState"></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::CBufSock::_ConnectedState<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="buf__sock_8h-source.html#l00265">265</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. +<p> +Referenced by <a class="el" href="buf__sock_8cpp-source.html#l00291">connect</a>, <a class="el" href="buf__sock_8h-source.html#l00237">connectedState</a>, <a class="el" href="buf__sock_8cpp-source.html#l00311">disconnect</a>, <a class="el" href="buf__sock_8h-source.html#l00234">setConnectedState</a>, and <a class="el" href="buf__sock_8cpp-source.html#l00081">~CBufSock</a>. </td> + </tr> +</table> +<a name="n2" doxytag="NLNET::CBufSock::_KnowConnected"></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::CBufSock::_KnowConnected<code> [protected]</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="buf__sock_8h-source.html#l00246">246</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. +<p> +Referenced by <a class="el" href="buf__sock_8h-source.html#l00306">NLNET::CServerBufSock::advertiseConnection</a>, <a class="el" href="buf__sock_8h-source.html#l00120">advertiseDisconnection</a>, <a class="el" href="buf__sock_8cpp-source.html#l00291">connect</a>, <a class="el" href="buf__sock_8cpp-source.html#l00311">disconnect</a>, and <a class="el" href="buf__sock_8cpp-source.html#l00081">~CBufSock</a>. </td> + </tr> +</table> +<a name="o0" doxytag="NLNET::CBufSock::_LastFlushTime"></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="namespaceNLMISC.html#a183">NLMISC::TTime</a> NLNET::CBufSock::_LastFlushTime<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="buf__sock_8h-source.html#l00255">255</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. +<p> +Referenced by <a class="el" href="buf__sock_8cpp-source.html#l00052">CBufSock</a>, <a class="el" href="buf__sock_8cpp-source.html#l00232">setTimeFlushTrigger</a>, <a class="el" href="buf__sock_8cpp-source.html#l00243">update</a>, and <a class="el" href="buf__sock_8cpp-source.html#l00081">~CBufSock</a>. </td> + </tr> +</table> +<a name="o3" doxytag="NLNET::CBufSock::_ReadyToSendBuffer"></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="classNLMISC_1_1CObjectVector.html">NLMISC::CObjectVector</a><<a class="el" href="memory__common_8h.html#a7">uint8</a>> NLNET::CBufSock::_ReadyToSendBuffer<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="buf__sock_8h-source.html#l00259">259</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. +<p> +Referenced by <a class="el" href="buf__sock_8cpp-source.html#l00138">flush</a>, and <a class="el" href="buf__sock_8cpp-source.html#l00081">~CBufSock</a>. </td> + </tr> +</table> +<a name="o4" doxytag="NLNET::CBufSock::_RTSBIndex"></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#a6">TBlockSize</a> NLNET::CBufSock::_RTSBIndex<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="buf__sock_8h-source.html#l00260">260</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. +<p> +Referenced by <a class="el" href="buf__sock_8cpp-source.html#l00138">flush</a>, and <a class="el" href="buf__sock_8cpp-source.html#l00081">~CBufSock</a>. </td> + </tr> +</table> +<a name="o2" doxytag="NLNET::CBufSock::_TriggerSize"></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#a10">sint32</a> NLNET::CBufSock::_TriggerSize<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="buf__sock_8h-source.html#l00257">257</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. +<p> +Referenced by <a class="el" href="buf__sock_8h-source.html#l00104">setSizeFlushTrigger</a>, <a class="el" href="buf__sock_8cpp-source.html#l00243">update</a>, and <a class="el" href="buf__sock_8cpp-source.html#l00081">~CBufSock</a>. </td> + </tr> +</table> +<a name="o1" doxytag="NLNET::CBufSock::_TriggerTime"></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="namespaceNLMISC.html#a183">NLMISC::TTime</a> NLNET::CBufSock::_TriggerTime<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="buf__sock_8h-source.html#l00256">256</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. +<p> +Referenced by <a class="el" href="buf__sock_8cpp-source.html#l00232">setTimeFlushTrigger</a>, <a class="el" href="buf__sock_8cpp-source.html#l00243">update</a>, and <a class="el" href="buf__sock_8cpp-source.html#l00081">~CBufSock</a>. </td> + </tr> +</table> +<a name="m0" doxytag="NLNET::CBufSock::AuthorizedCallback"></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::CBufSock::AuthorizedCallback + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Little tricky but this string is used by Layer4 to know which callback is authorized. This is empty when all callback are authorized. +<p> + +<p> +Definition at line <a class="el" href="buf__sock_8h-source.html#l00070">70</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. +<p> +Referenced by <a class="el" href="buf__sock_8cpp-source.html#l00081">~CBufSock</a>. </td> + </tr> +</table> +<a name="m2" doxytag="NLNET::CBufSock::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::CBufSock::ReceiveNextValue + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="buf__sock_8h-source.html#l00074">74</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. +<p> +Referenced by <a class="el" href="buf__sock_8cpp-source.html#l00291">connect</a>, and <a class="el" href="buf__sock_8cpp-source.html#l00311">disconnect</a>. </td> + </tr> +</table> +<a name="n0" doxytag="NLNET::CBufSock::SendFifo"></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="classNLMISC_1_1CBufFIFO.html">NLMISC::CBufFIFO</a> NLNET::CBufSock::SendFifo<code> [protected]</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="buf__sock_8h-source.html#l00240">240</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. +<p> +Referenced by <a class="el" href="buf__sock_8cpp-source.html#l00138">flush</a>, <a class="el" href="buf__sock_8h-source.html#l00178">pushBuffer</a>, and <a class="el" href="buf__sock_8cpp-source.html#l00243">update</a>. </td> + </tr> +</table> +<a name="m1" doxytag="NLNET::CBufSock::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::CBufSock::SendNextValue + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="buf__sock_8h-source.html#l00074">74</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. +<p> +Referenced by <a class="el" href="buf__sock_8cpp-source.html#l00291">connect</a>, and <a class="el" href="buf__sock_8cpp-source.html#l00311">disconnect</a>. </td> + </tr> +</table> +<a name="n1" doxytag="NLNET::CBufSock::Sock"></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="classNLNET_1_1CTcpSock.html">CTcpSock</a>* NLNET::CBufSock::Sock<code> [protected]</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="buf__sock_8h-source.html#l00243">243</a> of file <a class="el" href="buf__sock_8h-source.html">buf_sock.h</a>. +<p> +Referenced by <a class="el" href="buf__sock_8cpp-source.html#l00325">asString</a>, <a class="el" href="buf__sock_8cpp-source.html#l00052">CBufSock</a>, <a class="el" href="buf__sock_8cpp-source.html#l00291">connect</a>, <a class="el" href="buf__sock_8cpp-source.html#l00311">disconnect</a>, <a class="el" href="buf__sock_8cpp-source.html#l00138">flush</a>, <a class="el" href="buf__sock_8h-source.html#l00178">pushBuffer</a>, <a class="el" href="buf__sock_8cpp-source.html#l00370">NLNET::CServerBufSock::receivePart</a>, and <a class="el" href="buf__sock_8cpp-source.html#l00081">~CBufSock</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="buf__sock_8h-source.html">buf_sock.h</a><li><a class="el" href="buf__sock_8cpp-source.html">buf_sock.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> |