diff options
Diffstat (limited to 'docs/doxygen/nel/buf__client_8h-source.html')
| -rw-r--r-- | docs/doxygen/nel/buf__client_8h-source.html | 225 |
1 files changed, 225 insertions, 0 deletions
diff --git a/docs/doxygen/nel/buf__client_8h-source.html b/docs/doxygen/nel/buf__client_8h-source.html new file mode 100644 index 00000000..99bffb67 --- /dev/null +++ b/docs/doxygen/nel/buf__client_8h-source.html @@ -0,0 +1,225 @@ +<!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>buf_client.h</h1><a href="buf__client_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 +00007 <font class="comment">/* Copyright, 2001 Nevrax Ltd.</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This file is part of NEVRAX NEL.</font> +00010 <font class="comment"> * NEVRAX NEL is free software; you can redistribute it and/or modify</font> +00011 <font class="comment"> * it under the terms of the GNU General Public License as published by</font> +00012 <font class="comment"> * the Free Software Foundation; either version 2, or (at your option)</font> +00013 <font class="comment"> * any later version.</font> +00014 <font class="comment"></font> +00015 <font class="comment"> * NEVRAX NEL is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"></font> +00020 <font class="comment"> * You should have received a copy of the GNU General Public License</font> +00021 <font class="comment"> * along with NEVRAX NEL; see the file COPYING. If not, write to the</font> +00022 <font class="comment"> * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,</font> +00023 <font class="comment"> * MA 02111-1307, USA.</font> +00024 <font class="comment"> */</font> +00025 +00026 <font class="preprocessor">#ifndef NL_BUF_CLIENT_H</font> +00027 <font class="preprocessor"></font><font class="preprocessor">#define NL_BUF_CLIENT_H</font> +00028 <font class="preprocessor"></font> +00029 <font class="preprocessor">#include "<a class="code" href="types__nl_8h.html">nel/misc/types_nl.h</a>"</font> +00030 <font class="preprocessor">#include "<a class="code" href="buf__net__base_8h.html">nel/net/buf_net_base.h</a>"</font> +00031 <font class="preprocessor">#include "<a class="code" href="tcp__sock_8h.html">nel/net/tcp_sock.h</a>"</font> +00032 <font class="preprocessor">#include "<a class="code" href="buf__sock_8h.html">nel/net/buf_sock.h</a>"</font> +00033 +00034 +<a name="l00035"></a><a class="code" href="namespaceNLNET.html">00035</a> <font class="keyword">namespace </font>NLNET { +00036 +00037 +00038 <font class="keyword">class </font>CInetAddress; +00039 <font class="keyword">class </font>CBufClient; +00040 +00041 +<a name="l00045"></a><a class="code" href="classNLNET_1_1CClientReceiveTask.html">00045</a> <font class="keyword">class </font>CClientReceiveTask : <font class="keyword">public</font> NLMISC::IRunnable +00046 { +00047 <font class="keyword">public</font>: +00048 +<a name="l00050"></a><a class="code" href="classNLNET_1_1CClientReceiveTask.html#a0">00050</a> <a class="code" href="classNLNET_1_1CClientReceiveTask.html#a0">CClientReceiveTask</a>( CBufClient *client, <a class="code" href="namespaceNLNET.html#a0">TSockId</a> sockid ) : <a class="code" href="classNLNET_1_1CClientReceiveTask.html#o0">_Client</a>(client), <a class="code" href="classNLNET_1_1CClientReceiveTask.html#o1">_SockId</a>(sockid) {} +00051 +00053 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLNET_1_1CClientReceiveTask.html#a1">run</a>(); +00054 +<a name="l00056"></a><a class="code" href="classNLNET_1_1CClientReceiveTask.html#a2">00056</a> CTcpSock *<a class="code" href="classNLNET_1_1CClientReceiveTask.html#a2">sock</a>() { <font class="keywordflow">return</font> <a class="code" href="classNLNET_1_1CClientReceiveTask.html#o1">_SockId</a>->Sock; } +00057 +<a name="l00059"></a><a class="code" href="classNLNET_1_1CClientReceiveTask.html#a3">00059</a> <a class="code" href="namespaceNLNET.html#a0">TSockId</a> <a class="code" href="classNLNET_1_1CClientReceiveTask.html#a3">sockId</a>() { <font class="keywordflow">return</font> <a class="code" href="classNLNET_1_1CClientReceiveTask.html#o1">_SockId</a>; } +00060 +00061 <font class="keyword">private</font>: +00062 +<a name="l00063"></a><a class="code" href="classNLNET_1_1CClientReceiveTask.html#o0">00063</a> CBufClient *<a class="code" href="classNLNET_1_1CClientReceiveTask.html#o0">_Client</a>; +00064 +<a name="l00065"></a><a class="code" href="classNLNET_1_1CClientReceiveTask.html#o1">00065</a> <a class="code" href="namespaceNLNET.html#a0">TSockId</a> <a class="code" href="classNLNET_1_1CClientReceiveTask.html#o1">_SockId</a>; +00066 }; +00067 +00068 +00069 +<a name="l00091"></a><a class="code" href="classNLNET_1_1CBufClient.html">00091</a> <font class="keyword">class </font>CBufClient : <font class="keyword">public</font> CBufNetBase +00092 { +00093 <font class="keyword">public</font>: +00094 +00096 <a class="code" href="classNLNET_1_1CBufClient.html#a0">CBufClient</a>( <font class="keywordtype">bool</font> nodelay=<font class="keyword">true</font>, <font class="keywordtype">bool</font> replaymode=<font class="keyword">false</font> ); +00097 +00099 <font class="keyword">virtual</font> <a class="code" href="classNLNET_1_1CBufClient.html#a1">~CBufClient</a>(); +00100 +00102 <font class="keywordtype">void</font> <a class="code" href="classNLNET_1_1CBufClient.html#a2">connect</a>( <font class="keyword">const</font> CInetAddress& <a class="code" href="driver__opengl__extension__def_8h.html#a414">addr</a> ); +00103 +00109 <font class="keywordtype">void</font> <a class="code" href="classNLNET_1_1CBufClient.html#a3">disconnect</a>( <font class="keywordtype">bool</font> quick=<font class="keyword">false</font> ); +00110 +00113 <font class="comment">//void send( const std::vector<uint8>& buffer );</font> +00114 <font class="keywordtype">void</font> <a class="code" href="classNLNET_1_1CBufClient.html#a4">send</a>( <font class="keyword">const</font> <a class="code" href="classNLMISC_1_1CMemStream.html">NLMISC::CMemStream</a>& buffer ); +00115 +00119 <font class="keywordtype">bool</font> <a class="code" href="classNLNET_1_1CBufClient.html#a5">dataAvailable</a>(); +00120 +00124 <font class="comment">//void receive( std::vector<uint8>& buffer );</font> +00125 <font class="keywordtype">void</font> <a class="code" href="classNLNET_1_1CBufClient.html#a6">receive</a>( <a class="code" href="classNLMISC_1_1CMemStream.html">NLMISC::CMemStream</a>& buffer ); +00126 +00128 <font class="keywordtype">void</font> <a class="code" href="classNLNET_1_1CBufClient.html#a7">update</a>(); +00129 +00130 +00131 +00132 <font class="comment">// Returns the size in bytes of the data stored in the send queue.</font> +<a name="l00133"></a><a class="code" href="classNLNET_1_1CBufClient.html#a8">00133</a> uint32 <a class="code" href="classNLNET_1_1CBufClient.html#a8">getSendQueueSize</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLNET_1_1CBufClient.html#n0">_BufSock</a>->SendFifo.size(); } +00134 +<a name="l00138"></a><a class="code" href="classNLNET_1_1CBufClient.html#a9">00138</a> <font class="keywordtype">void</font> <a class="code" href="classNLNET_1_1CBufClient.html#a9">setTimeFlushTrigger</a>( sint32 ms ) { <a class="code" href="classNLNET_1_1CBufClient.html#n0">_BufSock</a>->setTimeFlushTrigger( ms ); } +00139 +<a name="l00143"></a><a class="code" href="classNLNET_1_1CBufClient.html#a10">00143</a> <font class="keywordtype">void</font> <a class="code" href="classNLNET_1_1CBufClient.html#a10">setSizeFlushTrigger</a>( sint32 size ) { <a class="code" href="classNLNET_1_1CBufClient.html#n0">_BufSock</a>->setSizeFlushTrigger( size ); } +00144 +<a name="l00149"></a><a class="code" href="classNLNET_1_1CBufClient.html#a11">00149</a> <font class="keywordtype">bool</font> <a class="code" href="classNLNET_1_1CBufClient.html#a11">flush</a>() { <font class="keywordflow">return</font> <a class="code" href="classNLNET_1_1CBufClient.html#n0">_BufSock</a>->flush(); } +00150 +00151 +00152 +<a name="l00157"></a><a class="code" href="classNLNET_1_1CBufClient.html#a12">00157</a> <font class="keywordtype">bool</font> <a class="code" href="classNLNET_1_1CBufClient.html#a12">connected</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLNET_1_1CBufClient.html#n0">_BufSock</a>->connectedState(); } +00158 +<a name="l00160"></a><a class="code" href="classNLNET_1_1CBufClient.html#a13">00160</a> <font class="keyword">const</font> CInetAddress& <a class="code" href="classNLNET_1_1CBufClient.html#a13">remoteAddress</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLNET_1_1CBufClient.html#n0">_BufSock</a>->Sock->remoteAddr(); } +00161 +<a name="l00163"></a><a class="code" href="classNLNET_1_1CBufClient.html#a14">00163</a> uint64 <a class="code" href="classNLNET_1_1CBufClient.html#a14">bytesDownloaded</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLNET_1_1CBufClient.html#n0">_BufSock</a>->Sock->bytesReceived(); } +00164 +<a name="l00166"></a><a class="code" href="classNLNET_1_1CBufClient.html#a15">00166</a> uint64 <a class="code" href="classNLNET_1_1CBufClient.html#a15">bytesUploaded</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLNET_1_1CBufClient.html#n0">_BufSock</a>->Sock->bytesSent(); } +00167 +00169 uint64 <a class="code" href="classNLNET_1_1CBufClient.html#a16">newBytesDownloaded</a>(); +00170 +00172 uint64 <a class="code" href="classNLNET_1_1CBufClient.html#a17">newBytesUploaded</a>(); +00173 +00174 <font class="comment">/*//Not right because we add callbacks in the receive queue</font> +00176 <font class="comment"> uint64 bytesReceived() { }</font> +00177 <font class="comment"> </font> +00179 <font class="comment"> uint64 bytesSent() { return bytesUploaded() + getSendQueueSize(); }</font> +00180 <font class="comment"></font> +00182 <font class="comment"> uint64 newBytesReceived();</font> +00183 <font class="comment"></font> +00185 <font class="comment"> uint64 newBytesSent();</font> +00186 <font class="comment"> */</font> +00187 +<a name="l00189"></a><a class="code" href="classNLNET_1_1CBufClient.html#a18">00189</a> <a class="code" href="namespaceNLNET.html#a0">TSockId</a> <a class="code" href="classNLNET_1_1CBufClient.html#a18">id</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLNET_1_1CBufClient.html#n0">_BufSock</a>; <font class="comment">/*_RecvTask->sockId();*/</font> } +00190 +00191 +00192 <font class="keyword">protected</font>: +00193 +<a name="l00194"></a><a class="code" href="classNLNET_1_1CBufClient.html#l0">00194</a> <font class="keyword">friend</font> <font class="keyword">class </font><a class="code" href="classNLNET_1_1CBufClient.html#l0">CClientReceiveTask</a>; +00195 +<a name="l00197"></a><a class="code" href="classNLNET_1_1CBufClient.html#n0">00197</a> CBufSock *<a class="code" href="classNLNET_1_1CBufClient.html#n0">_BufSock</a>; +00198 +<a name="l00200"></a><a class="code" href="classNLNET_1_1CBufClient.html#n1">00200</a> <font class="keywordtype">bool</font> <a class="code" href="classNLNET_1_1CBufClient.html#n1">_NoDelay</a>; +00201 +<a name="l00203"></a><a class="code" href="classNLNET_1_1CBufClient.html#n2">00203</a> uint64 <a class="code" href="classNLNET_1_1CBufClient.html#n2">_PrevBytesDownloaded</a>; +00204 +<a name="l00206"></a><a class="code" href="classNLNET_1_1CBufClient.html#n3">00206</a> uint64 <a class="code" href="classNLNET_1_1CBufClient.html#n3">_PrevBytesUploaded</a>; +00207 +00208 <font class="comment">/*</font> +00210 <font class="comment"> uint32 _PrevBytesReceived;</font> +00211 <font class="comment"></font> +00213 <font class="comment"> uint32 _PrevBytesSent;</font> +00214 <font class="comment"> */</font> +00215 +00216 <font class="keyword">private</font>: +00217 +<a name="l00219"></a><a class="code" href="classNLNET_1_1CBufClient.html#o0">00219</a> <a class="code" href="classNLNET_1_1CBufClient.html#l0">CClientReceiveTask</a> *<a class="code" href="classNLNET_1_1CBufClient.html#o0">_RecvTask</a>; +00220 +<a name="l00222"></a><a class="code" href="classNLNET_1_1CBufClient.html#o1">00222</a> <a class="code" href="classNLMISC_1_1IThread.html">NLMISC::IThread</a> *<a class="code" href="classNLNET_1_1CBufClient.html#o1">_RecvThread</a>; +00223 +00224 }; +00225 +00226 +00227 +00228 } <font class="comment">// NLNET</font> +00229 +00230 +00231 <font class="preprocessor">#endif // NL_BUF_CLIENT_H</font> +00232 <font class="preprocessor"></font> +00233 <font class="comment">/* End of buf_client.h */</font> +</pre></div> + +<!-- 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> |