diff options
Diffstat (limited to 'docs/doxygen/nel/message_8h-source.html')
| -rw-r--r-- | docs/doxygen/nel/message_8h-source.html | 190 |
1 files changed, 190 insertions, 0 deletions
diff --git a/docs/doxygen/nel/message_8h-source.html b/docs/doxygen/nel/message_8h-source.html new file mode 100644 index 00000000..e87d0f12 --- /dev/null +++ b/docs/doxygen/nel/message_8h-source.html @@ -0,0 +1,190 @@ +<!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>message.h</h1><a href="message_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 +00007 <font class="comment">/* Copyright, 2000 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_MESSAGE_H</font> +00027 <font class="preprocessor"></font><font class="preprocessor">#define NL_MESSAGE_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 +00031 <font class="preprocessor">#include <sstream></font> +00032 +00033 <font class="preprocessor">#include "<a class="code" href="mem__stream_8h.html">nel/misc/mem_stream.h</a>"</font> +00034 +00035 <font class="preprocessor">#include "<a class="code" href="string__id__array_8h.html">nel/misc/string_id_array.h</a>"</font> +00036 +00037 <font class="preprocessor">#include <vector></font> +00038 +00039 <font class="keyword">namespace </font>NLNET +00040 { +00041 +00042 +<a name="l00056"></a><a class="code" href="classNLNET_1_1CMessage.html">00056</a> <font class="keyword">class </font>CMessage : <font class="keyword">public</font> NLMISC::CMemStream +00057 { +00058 <font class="keyword">public</font>: +00059 +<a name="l00060"></a><a class="code" href="classNLNET_1_1CMessage.html#s3">00060</a> <font class="keyword">enum</font> <a class="code" href="classNLNET_1_1CMessage.html#s3">TStreamFormat</a> { <a class="code" href="classNLNET_1_1CMessage.html#s3s0">UseDefault</a>, <a class="code" href="classNLNET_1_1CMessage.html#s3s1">Binary</a>, <a class="code" href="classNLNET_1_1CMessage.html#s3s2">String</a> }; +00061 +00062 <a class="code" href="classNLNET_1_1CMessage.html#a0">CMessage</a> (<a class="code" href="classNLMISC_1_1CStringIdArray.html">NLMISC::CStringIdArray</a> &sida, <font class="keyword">const</font> std::string &name = <font class="stringliteral">""</font>, <font class="keywordtype">bool</font> inputStream = <font class="keyword">false</font>, <a class="code" href="classNLNET_1_1CMessage.html#s3">TStreamFormat</a> streamformat = <a class="code" href="classNLNET_1_1CMessage.html#s3s0">UseDefault</a>, uint32 defaultCapacity = 1000); +00063 +00064 <a class="code" href="classNLNET_1_1CMessage.html#a0">CMessage</a> (<font class="keyword">const</font> std::string &name = <font class="stringliteral">""</font>, <font class="keywordtype">bool</font> inputStream = <font class="keyword">false</font>, <a class="code" href="classNLNET_1_1CMessage.html#s3">TStreamFormat</a> streamformat = <a class="code" href="classNLNET_1_1CMessage.html#s3s0">UseDefault</a>, uint32 defaultCapacity = 1000); +00065 +00066 <a class="code" href="classNLNET_1_1CMessage.html#a0">CMessage</a> (<a class="code" href="classNLMISC_1_1CMemStream.html">NLMISC::CMemStream</a> &memstr); +00067 +00069 <a class="code" href="classNLNET_1_1CMessage.html#a0">CMessage</a> (<font class="keyword">const</font> <a class="code" href="classNLNET_1_1CMessage.html#a0">CMessage</a> &other); +00070 +00072 <a class="code" href="classNLNET_1_1CMessage.html#a0">CMessage</a> &<a class="code" href="classNLNET_1_1CMessage.html#a4">operator= </a>(<font class="keyword">const</font> <a class="code" href="classNLNET_1_1CMessage.html#a0">CMessage</a> &other); +00073 +00075 <font class="keywordtype">void</font> <a class="code" href="classNLNET_1_1CMessage.html#a5">setType</a> (<a class="code" href="classNLMISC_1_1CStringIdArray.html#s0">NLMISC::CStringIdArray::TStringId</a> <a class="code" href="driver__opengl__extension__def_8h.html#a356">id</a>); +00076 +00078 <font class="keywordtype">void</font> <a class="code" href="classNLNET_1_1CMessage.html#a5">setType</a> (<font class="keyword">const</font> std::string &name); +00079 +00081 uint32 <a class="code" href="classNLNET_1_1CMessage.html#a7">getHeaderSize</a> (); +00082 +00083 <font class="comment">// The message was filled with an CMemStream, Now, we'll get the message type on this buffer</font> +00084 <font class="keywordtype">void</font> <a class="code" href="classNLNET_1_1CMessage.html#a8">readType</a> (); +00085 +00086 <font class="comment">// Returns true if the message type was already set</font> +00087 <font class="keywordtype">bool</font> <a class="code" href="classNLNET_1_1CMessage.html#a9">typeIsSet</a> () <font class="keyword">const</font>; +00088 +00089 <font class="comment">// Transforms the message from input to output or from output to input</font> +<a name="l00090"></a><a class="code" href="classNLNET_1_1CMessage.html#a10">00090</a> <font class="keywordtype">void</font> <a class="code" href="classNLNET_1_1CMessage.html#a10">invert</a>() +00091 { +00092 CMemStream::invert(); +00093 +00094 <font class="keywordflow">if</font> ( <a class="code" href="classNLMISC_1_1IStream.html#a4">isReading</a>() ) +00095 { +00096 <font class="comment">// Write -> Read: skip the header </font> +00097 <a class="code" href="classNLNET_1_1CMessage.html#o0">_TypeSet</a> = <font class="keyword">false</font>; +00098 <a class="code" href="classNLNET_1_1CMessage.html#a8">readType</a>(); +00099 } +00100 <font class="comment">// For Read -> Write, please use clear()</font> +00101 } +00102 +00103 <font class="comment">// Clear the message. With this function, you can reuse a message to create another message</font> +00104 <font class="keywordtype">void</font> <a class="code" href="classNLNET_1_1CMessage.html#a11">clear</a> (); +00105 +00107 std::string <a class="code" href="classNLNET_1_1CMessage.html#a12">getName</a> () <font class="keyword">const</font>; +00108 +00110 <a class="code" href="classNLMISC_1_1CStringIdArray.html#s0">NLMISC::CStringIdArray::TStringId</a> <a class="code" href="classNLNET_1_1CMessage.html#a13">getId</a> () <font class="keyword">const</font>; +00111 +00115 std::string <a class="code" href="classNLNET_1_1CMessage.html#a14">toString</a> () <font class="keyword">const</font>; +00116 +<a name="l00118"></a><a class="code" href="classNLNET_1_1CMessage.html#d0">00118</a> <font class="keyword">static</font> <font class="keywordtype">void</font> <a class="code" href="classNLNET_1_1CMessage.html#d0">setDefaultStringMode</a>( <font class="keywordtype">bool</font> stringmode ) { <a class="code" href="classNLNET_1_1CMessage.html#r0">_DefaultStringMode</a> = stringmode; } +00119 +<a name="l00120"></a><a class="code" href="classNLNET_1_1CMessage.html#m0">00120</a> <font class="keywordtype">bool</font> <a class="code" href="classNLNET_1_1CMessage.html#m0">TypeHasAnId</a>; +<a name="l00121"></a><a class="code" href="classNLNET_1_1CMessage.html#m1">00121</a> <font class="keywordtype">bool</font> <a class="code" href="classNLNET_1_1CMessage.html#m1">TypeHasAName</a>; +00122 +00123 <font class="keyword">protected</font>: +00124 +00126 <font class="keywordtype">void</font> <a class="code" href="classNLNET_1_1CMessage.html#b0">init</a>( <font class="keyword">const</font> std::string &name, <a class="code" href="classNLNET_1_1CMessage.html#s3">TStreamFormat</a> streamformat ); +00127 +00128 <font class="keyword">private</font>: +<a name="l00129"></a><a class="code" href="classNLNET_1_1CMessage.html#o0">00129</a> <font class="keywordtype">bool</font> <a class="code" href="classNLNET_1_1CMessage.html#o0">_TypeSet</a>; +<a name="l00130"></a><a class="code" href="classNLNET_1_1CMessage.html#o1">00130</a> <a class="code" href="classNLMISC_1_1CStringIdArray.html">NLMISC::CStringIdArray</a> *<a class="code" href="classNLNET_1_1CMessage.html#o1">_SIDA</a>; +00131 +<a name="l00132"></a><a class="code" href="classNLNET_1_1CMessage.html#o2">00132</a> std::string <a class="code" href="classNLNET_1_1CMessage.html#o2">_Name</a>; +<a name="l00133"></a><a class="code" href="classNLNET_1_1CMessage.html#o3">00133</a> <a class="code" href="classNLMISC_1_1CStringIdArray.html#s0">NLMISC::CStringIdArray::TStringId</a> <a class="code" href="classNLNET_1_1CMessage.html#o3">_Id</a>; +00134 +00135 <font class="comment">// Size of the header (that contains the name type or number type)</font> +<a name="l00136"></a><a class="code" href="classNLNET_1_1CMessage.html#o4">00136</a> uint32 <a class="code" href="classNLNET_1_1CMessage.html#o4">_HeaderSize</a>; +00137 +00138 <font class="comment">// Default stream format</font> +00139 <font class="keyword">static</font> <font class="keywordtype">bool</font> <a class="code" href="classNLNET_1_1CMessage.html#r0">_DefaultStringMode</a>; +00140 }; +00141 +00142 } +00143 +00144 <font class="preprocessor">#endif // NL_MESSAGE_H</font> +00145 <font class="preprocessor"></font> +00146 <font class="comment">/* End of message.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> |