sfmlinstaller

sfmlinstaller Mercurial Source Tree


Root/windows/doc/html/Packet_8hpp_source.htm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    <head>
        <title>SFML - Simple and Fast Multimedia Library</title>
        <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
        <!--<link rel='stylesheet' type='text/css' href="http://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>-->
        <link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
    </head>
    <body>
        <div id="banner-container">
            <div id="banner">
                <span id="sfml">SFML</span>
            </div>
        </div>
        <div id="content">
<!-- Generated by Doxygen 1.8.2 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.htm"><span>Main Page</span></a></li>
      <li><a href="modules.htm"><span>Modules</span></a></li>
      <li><a href="annotated.htm"><span>Classes</span></a></li>
      <li class="current"><a href="files.htm"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.htm"><span>File List</span></a></li>
    </ul>
  </div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_f3190241575fd2bd132a392ae6942f4a.htm">include</a></li><li class="navelem"><a class="el" href="dir_692f376662c82a26cfe4cfa3aceebe24.htm">SFML</a></li><li class="navelem"><a class="el" href="dir_b9ac88db2949395b3130dd4ffb1be4e1.htm">Network</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">Packet.hpp</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span> </div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span> <span class="comment">//</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span> <span class="comment">// SFML - Simple and Fast Multimedia Library</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span> <span class="comment">// Copyright (C) 2007-2013 Laurent Gomila (laurent.gom@gmail.com)</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span> <span class="comment">//</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span> <span class="comment">// This software is provided 'as-is', without any express or implied warranty.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span> <span class="comment">// In no event will the authors be held liable for any damages arising from the use of this software.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span> <span class="comment">//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span> <span class="comment">// Permission is granted to anyone to use this software for any purpose,</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span> <span class="comment">// including commercial applications, and to alter it and redistribute it freely,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span> <span class="comment">// subject to the following restrictions:</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span> <span class="comment">//</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span> <span class="comment">// 1. The origin of this software must not be misrepresented;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span> <span class="comment">//    you must not claim that you wrote the original software.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span> <span class="comment">//    If you use this software in a product, an acknowledgment</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span> <span class="comment">//    in the product documentation would be appreciated but is not required.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span> <span class="comment">//</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span> <span class="comment">// 2. Altered source versions must be plainly marked as such,</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span> <span class="comment">//    and must not be misrepresented as being the original software.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span> <span class="comment">//</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span> <span class="comment">// 3. This notice may not be removed or altered from any source distribution.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span> <span class="comment">//</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span> <span class="comment"></span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span> <span class="preprocessor">#ifndef SFML_PACKET_HPP</span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span> <span class="preprocessor"></span><span class="preprocessor">#define SFML_PACKET_HPP</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span> <span class="comment">// Headers</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span> <span class="comment"></span><span class="preprocessor">#include <SFML/Network/Export.hpp></span></div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span> <span class="preprocessor">#include <string></span></div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span> <span class="preprocessor">#include <vector></span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span> </div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span> </div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span> <span class="keyword">namespace </span>sf</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span> {</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span> <span class="keyword">class </span>String;</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span> <span class="keyword">class </span>TcpSocket;</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span> <span class="keyword">class </span>UdpSocket;</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span> </div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="code" href="classsf_1_1Packet.htm">   47</a></span> <span class="keyword">class </span>SFML_NETWORK_API <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a></div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span> {</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>     <span class="comment">// A bool-like type that cannot be converted to integer or pointer types</span></div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>     <span class="keyword">typedef</span> bool (<a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>::*BoolType)(std::size_t);</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span> </div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span> <span class="keyword">public</span> :</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span> </div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>();</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span> </div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>     <span class="keyword">virtual</span> ~<a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>();</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span> </div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>     <span class="keywordtype">void</span> append(<span class="keyword">const</span> <span class="keywordtype">void</span>* data, std::size_t sizeInBytes);</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span> </div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>     <span class="keywordtype">void</span> clear();</div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span> </div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>     <span class="keyword">const</span> <span class="keywordtype">void</span>* getData() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span> </div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>     std::size_t getDataSize() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span> </div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>     <span class="keywordtype">bool</span> endOfPacket() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span> </div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span> </div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>     <span class="keyword">operator</span> BoolType() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span> </div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator >>(<span class="keywordtype">bool</span>&         data);</div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator >>(Int8&         data);</div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator >>(Uint8&        data);</div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator >>(Int16&        data);</div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator >>(Uint16&       data);</div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator >>(Int32&        data);</div>
<div class="line"><a name="l00183"></a><span class="lineno">  183</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator >>(Uint32&       data);</div>
<div class="line"><a name="l00184"></a><span class="lineno">  184</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator >>(<span class="keywordtype">float</span>&        data);</div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator >>(<span class="keywordtype">double</span>&       data);</div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator >>(<span class="keywordtype">char</span>*         data);</div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator >>(std::string&  data);</div>
<div class="line"><a name="l00188"></a><span class="lineno">  188</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator >>(<span class="keywordtype">wchar_t</span>*      data);</div>
<div class="line"><a name="l00189"></a><span class="lineno">  189</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator >>(std::wstring& data);</div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator >>(<a class="code" href="classsf_1_1String.htm" title="Utility string class that automatically handles conversions between types and encodings.">String</a>&       data);</div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span> </div>
<div class="line"><a name="l00196"></a><span class="lineno">  196</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator <<(<span class="keywordtype">bool</span>                data);</div>
<div class="line"><a name="l00197"></a><span class="lineno">  197</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator <<(Int8                data);</div>
<div class="line"><a name="l00198"></a><span class="lineno">  198</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator <<(Uint8               data);</div>
<div class="line"><a name="l00199"></a><span class="lineno">  199</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator <<(Int16               data);</div>
<div class="line"><a name="l00200"></a><span class="lineno">  200</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator <<(Uint16              data);</div>
<div class="line"><a name="l00201"></a><span class="lineno">  201</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator <<(Int32               data);</div>
<div class="line"><a name="l00202"></a><span class="lineno">  202</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator <<(Uint32              data);</div>
<div class="line"><a name="l00203"></a><span class="lineno">  203</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator <<(<span class="keywordtype">float</span>               data);</div>
<div class="line"><a name="l00204"></a><span class="lineno">  204</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator <<(<span class="keywordtype">double</span>              data);</div>
<div class="line"><a name="l00205"></a><span class="lineno">  205</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator <<(<span class="keyword">const</span> <span class="keywordtype">char</span>*         data);</div>
<div class="line"><a name="l00206"></a><span class="lineno">  206</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator <<(<span class="keyword">const</span> std::string&  data);</div>
<div class="line"><a name="l00207"></a><span class="lineno">  207</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator <<(<span class="keyword">const</span> <span class="keywordtype">wchar_t</span>*      data);</div>
<div class="line"><a name="l00208"></a><span class="lineno">  208</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator <<(<span class="keyword">const</span> std::wstring& data);</div>
<div class="line"><a name="l00209"></a><span class="lineno">  209</span>     <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& operator <<(<span class="keyword">const</span> <a class="code" href="classsf_1_1String.htm" title="Utility string class that automatically handles conversions between types and encodings.">String</a>&       data);</div>
<div class="line"><a name="l00210"></a><span class="lineno">  210</span> </div>
<div class="line"><a name="l00211"></a><span class="lineno">  211</span> <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00212"></a><span class="lineno">  212</span> </div>
<div class="line"><a name="l00213"></a><span class="lineno">  213</span>     <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classsf_1_1TcpSocket.htm" title="Specialized socket using the TCP protocol.">TcpSocket</a>;</div>
<div class="line"><a name="l00214"></a><span class="lineno">  214</span>     <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classsf_1_1UdpSocket.htm" title="Specialized socket using the UDP protocol.">UdpSocket</a>;</div>
<div class="line"><a name="l00215"></a><span class="lineno">  215</span> </div>
<div class="line"><a name="l00234"></a><span class="lineno">  234</span>     <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">void</span>* onSend(std::size_t& size);</div>
<div class="line"><a name="l00235"></a><span class="lineno">  235</span> </div>
<div class="line"><a name="l00253"></a><span class="lineno">  253</span>     <span class="keyword">virtual</span> <span class="keywordtype">void</span> onReceive(<span class="keyword">const</span> <span class="keywordtype">void</span>* data, std::size_t size);</div>
<div class="line"><a name="l00254"></a><span class="lineno">  254</span> </div>
<div class="line"><a name="l00255"></a><span class="lineno">  255</span> <span class="keyword">private</span> :</div>
<div class="line"><a name="l00256"></a><span class="lineno">  256</span> </div>
<div class="line"><a name="l00261"></a><span class="lineno">  261</span>     <span class="keywordtype">bool</span> operator ==(<span class="keyword">const</span> <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& right) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00262"></a><span class="lineno">  262</span>     <span class="keywordtype">bool</span> operator !=(<span class="keyword">const</span> <a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& right) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00263"></a><span class="lineno">  263</span> </div>
<div class="line"><a name="l00274"></a><span class="lineno">  274</span>     <span class="keywordtype">bool</span> checkSize(std::size_t size);</div>
<div class="line"><a name="l00275"></a><span class="lineno">  275</span> </div>
<div class="line"><a name="l00277"></a><span class="lineno">  277</span>     <span class="comment">// Member data</span></div>
<div class="line"><a name="l00279"></a><span class="lineno">  279</span> <span class="comment"></span>    std::vector<char> m_data;    </div>
<div class="line"><a name="l00280"></a><span class="lineno">  280</span>     std::size_t       m_readPos; </div>
<div class="line"><a name="l00281"></a><span class="lineno">  281</span>     <span class="keywordtype">bool</span>              m_isValid; </div>
<div class="line"><a name="l00282"></a><span class="lineno">  282</span> };</div>
<div class="line"><a name="l00283"></a><span class="lineno">  283</span> </div>
<div class="line"><a name="l00284"></a><span class="lineno">  284</span> } <span class="comment">// namespace sf</span></div>
<div class="line"><a name="l00285"></a><span class="lineno">  285</span> </div>
<div class="line"><a name="l00286"></a><span class="lineno">  286</span> </div>
<div class="line"><a name="l00287"></a><span class="lineno">  287</span> <span class="preprocessor">#endif // SFML_PACKET_HPP</span></div>
<div class="line"><a name="l00288"></a><span class="lineno">  288</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00289"></a><span class="lineno">  289</span> </div>
</div><!-- fragment --></div><!-- contents -->
        </div>
        <div id="footer-container">
            <div id="footer">
                Copyright � Laurent Gomila  :: 
                Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a>  :: 
            </div>
        </div>
    <script>
  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
 
  ga('create', 'UA-41898676-1', 'srchub.org');
  ga('send', 'pageview');
Page rendered in 1.83950s using 11 queries.
Source at commit tip created 11 years 11 months ago.
By Nathan Adams, Initial commit

Archive Download this file

Branches

Tags

Page rendered in 1.83950s using 11 queries.