diff options
Diffstat (limited to 'doc/html/classsf_1_1Packet.htm')
| -rwxr-xr-x | doc/html/classsf_1_1Packet.htm | 220 |
1 files changed, 123 insertions, 97 deletions
diff --git a/doc/html/classsf_1_1Packet.htm b/doc/html/classsf_1_1Packet.htm index 8352e32..bfc150a 100755 --- a/doc/html/classsf_1_1Packet.htm +++ b/doc/html/classsf_1_1Packet.htm @@ -10,149 +10,152 @@ <div id="logo"> <img src="./logo.jpg" width="770" height="200" title="SFML home" alt="SFML logo" /> </div> -<!-- Generated by Doxygen 1.5.2 --> -<div class="tabs"> - <ul> - <li><a href="index.htm"><span>Main Page</span></a></li> - <li><a href="namespaces.htm"><span>Namespaces</span></a></li> - <li class="current"><a href="classes.htm"><span>Classes</span></a></li> - <li><a href="files.htm"><span>Files</span></a></li> - </ul> +<!-- Generated by Doxygen 1.5.8 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.htm"><span>Main Page</span></a></li> + <li><a href="namespaces.htm"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.htm"><span>Classes</span></a></li> + <li><a href="files.htm"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.htm"><span>Class List</span></a></li> + <li><a href="classes.htm"><span>Class Index</span></a></li> + <li><a href="hierarchy.htm"><span>Class Hierarchy</span></a></li> + <li><a href="functions.htm"><span>Class Members</span></a></li> + </ul> + </div> + <div class="navpath"><b>sf</b>::<a class="el" href="classsf_1_1Packet.htm">Packet</a> + </div> </div> -<div class="tabs"> - <ul> - <li><a href="classes.htm"><span>Alphabetical List</span></a></li> - <li><a href="annotated.htm"><span>Class List</span></a></li> - <li><a href="hierarchy.htm"><span>Class Hierarchy</span></a></li> - <li><a href="functions.htm"><span>Class Members</span></a></li> - </ul> -</div> -<div class="nav"> -<a class="el" href="namespacesf.htm">sf</a>::<a class="el" href="classsf_1_1Packet.htm">Packet</a></div> +<div class="contents"> <h1>sf::Packet Class Reference</h1><!-- doxytag: class="sf::Packet" --><a class="el" href="classsf_1_1Packet.htm" title="Packet wraps data to send / to receive through the network.">Packet</a> wraps data to send / to receive through the network. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="Packet_8hpp-source.htm">Packet.hpp</a>></code> <p> + +<p> <a href="classsf_1_1Packet-members.htm">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Packet.htm#786e5d4ced83992ceefa1799963ea858">Packet</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#786e5d4ced83992ceefa1799963ea858"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Packet.htm#dc0490ca3c7c3d1e321bd742e5213913">~Packet</a> ()</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Packet.htm#bd57f3b7a6e0e9119f4021754b5b19e5">~Packet</a> ()</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <a href="#dc0490ca3c7c3d1e321bd742e5213913"></a><br></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <a href="#bd57f3b7a6e0e9119f4021754b5b19e5"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Packet.htm#aaa020852bd7be75625b9f64b3a77c64">Append</a> (const void *Data, std::size_t SizeInBytes)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Append data to the end of the packet. <a href="#aaa020852bd7be75625b9f64b3a77c64"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Packet.htm#3a7a30fb7a39e59df0cbd773756f60da">Clear</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Clear the packet data. <a href="#3a7a30fb7a39e59df0cbd773756f60da"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Packet.htm#dde92b425fd926576176be5f9ca8ca62">GetData</a> () const</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Packet.htm#78286172beef1f89bd2a77edb7118c7a">GetData</a> () const </td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to the data contained in the packet Warning : the returned pointer may be invalid after you append data to the packet. <a href="#dde92b425fd926576176be5f9ca8ca62"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Packet.htm#f8a6cd1eca4db48586ee85241bdb19bc">GetDataSize</a> () const</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to the data contained in the packet Warning : the returned pointer may be invalid after you append data to the packet. <a href="#78286172beef1f89bd2a77edb7118c7a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Packet.htm#4e6fcdc0ff42ad45b33cea22be253b0d">GetDataSize</a> () const </td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the data contained in the packet. <a href="#f8a6cd1eca4db48586ee85241bdb19bc"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Packet.htm#a9df9a2c6d78d70081d2b169a0f75db6">EndOfPacket</a> () const</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the data contained in the packet. <a href="#4e6fcdc0ff42ad45b33cea22be253b0d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Packet.htm#8d587905fb63e62419f1cc338eceed36">EndOfPacket</a> () const </td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell if the reading position has reached the end of the packet. <a href="#a9df9a2c6d78d70081d2b169a0f75db6"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Packet.htm#8863ff08b73f728a341c775758abbfb4">operator bool</a> () const</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell if the reading position has reached the end of the packet. <a href="#8d587905fb63e62419f1cc338eceed36"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Packet.htm#087ae98bb7e93f8c82b29b88aee2f8d6">operator bool</a> () const </td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the validity of packet. <a href="#8863ff08b73f728a341c775758abbfb4"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Packet.htm#15bd4cb464ea568bb7395966e669656e">operator>></a> (bool &Data)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the validity of packet. <a href="#087ae98bb7e93f8c82b29b88aee2f8d6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Packet.htm#8dfd4b8767cfd705a71d79b76d12ee16">operator>></a> (bool &Data)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Operator >> overloads to extract data from the packet. <a href="#15bd4cb464ea568bb7395966e669656e"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="484fb71d187a220aeb0f60d0e02248b1"></a><!-- doxytag: member="sf::Packet::operator>>" ref="484fb71d187a220aeb0f60d0e02248b1" args="(Int8 &Data)" --> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Operator >> overloads to extract data from the packet. <a href="#8dfd4b8767cfd705a71d79b76d12ee16"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aae75c289e3719ed8bed8e38113a2173"></a><!-- doxytag: member="sf::Packet::operator>>" ref="aae75c289e3719ed8bed8e38113a2173" args="(Int8 &Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator>></b> (Int8 &Data)</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e72b3c0185674c421a64d4d601c379de"></a><!-- doxytag: member="sf::Packet::operator>>" ref="e72b3c0185674c421a64d4d601c379de" args="(Uint8 &Data)" --> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f94175e49e7de4f0ad0182cc1a8d6e9d"></a><!-- doxytag: member="sf::Packet::operator>>" ref="f94175e49e7de4f0ad0182cc1a8d6e9d" args="(Uint8 &Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator>></b> (Uint8 &Data)</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0891c958736d7f299f1c5b4b6ef0ed85"></a><!-- doxytag: member="sf::Packet::operator>>" ref="0891c958736d7f299f1c5b4b6ef0ed85" args="(Int16 &Data)" --> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7555b63985eeb8e4c84c4cd4d366c912"></a><!-- doxytag: member="sf::Packet::operator>>" ref="7555b63985eeb8e4c84c4cd4d366c912" args="(Int16 &Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator>></b> (Int16 &Data)</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6afa971b1d6b0819f366c31892b7e734"></a><!-- doxytag: member="sf::Packet::operator>>" ref="6afa971b1d6b0819f366c31892b7e734" args="(Uint16 &Data)" --> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="616d87ff0ef554ebb40cf03e21e1a098"></a><!-- doxytag: member="sf::Packet::operator>>" ref="616d87ff0ef554ebb40cf03e21e1a098" args="(Uint16 &Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator>></b> (Uint16 &Data)</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7f8a7c4cb5cfc0ec724c7ca6d7f779c3"></a><!-- doxytag: member="sf::Packet::operator>>" ref="7f8a7c4cb5cfc0ec724c7ca6d7f779c3" args="(Int32 &Data)" --> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3207d48a8f67d97c47feba75ced003b1"></a><!-- doxytag: member="sf::Packet::operator>>" ref="3207d48a8f67d97c47feba75ced003b1" args="(Int32 &Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator>></b> (Int32 &Data)</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bc432f86a6ccf164a0980a7b386f0873"></a><!-- doxytag: member="sf::Packet::operator>>" ref="bc432f86a6ccf164a0980a7b386f0873" args="(Uint32 &Data)" --> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7046e2ca352612fc733c53e593f62254"></a><!-- doxytag: member="sf::Packet::operator>>" ref="7046e2ca352612fc733c53e593f62254" args="(Uint32 &Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator>></b> (Uint32 &Data)</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="319acda455620fd574a7807c172965fa"></a><!-- doxytag: member="sf::Packet::operator>>" ref="319acda455620fd574a7807c172965fa" args="(float &Data)" --> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="92ae7aea969f9464b8e060ceaf111eb4"></a><!-- doxytag: member="sf::Packet::operator>>" ref="92ae7aea969f9464b8e060ceaf111eb4" args="(float &Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator>></b> (float &Data)</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="431746d3f46d3632c76e10ff45605e61"></a><!-- doxytag: member="sf::Packet::operator>>" ref="431746d3f46d3632c76e10ff45605e61" args="(double &Data)" --> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b19341a5f43de09c6756ecca7134b716"></a><!-- doxytag: member="sf::Packet::operator>>" ref="b19341a5f43de09c6756ecca7134b716" args="(double &Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator>></b> (double &Data)</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9480c0d1afd73eadd18bcbd3078f17f2"></a><!-- doxytag: member="sf::Packet::operator>>" ref="9480c0d1afd73eadd18bcbd3078f17f2" args="(char *Data)" --> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a53e1bf31bc9b7c24fbbee317109aed2"></a><!-- doxytag: member="sf::Packet::operator>>" ref="a53e1bf31bc9b7c24fbbee317109aed2" args="(char *Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator>></b> (char *Data)</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e63aea69004385c65d979b825d93e425"></a><!-- doxytag: member="sf::Packet::operator>>" ref="e63aea69004385c65d979b825d93e425" args="(std::string &Data)" --> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="071a9e306370c58ff629faac35bd2c8f"></a><!-- doxytag: member="sf::Packet::operator>>" ref="071a9e306370c58ff629faac35bd2c8f" args="(std::string &Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator>></b> (std::string &Data)</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="26095a4ea18e94f68ee4d350d113ed8c"></a><!-- doxytag: member="sf::Packet::operator>>" ref="26095a4ea18e94f68ee4d350d113ed8c" args="(wchar_t *Data)" --> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6a4a58d98d14b8b6b519f405da4a6b65"></a><!-- doxytag: member="sf::Packet::operator>>" ref="6a4a58d98d14b8b6b519f405da4a6b65" args="(wchar_t *Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator>></b> (wchar_t *Data)</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c47b76e338316c166e32595bb9d08240"></a><!-- doxytag: member="sf::Packet::operator>>" ref="c47b76e338316c166e32595bb9d08240" args="(std::wstring &Data)" --> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="57b2fb61a444a4ef782b8cbdeea2b250"></a><!-- doxytag: member="sf::Packet::operator>>" ref="57b2fb61a444a4ef782b8cbdeea2b250" args="(std::wstring &Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator>></b> (std::wstring &Data)</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Packet.htm#cddb7edad1a56e720b4d170124fada02">operator<<</a> (bool Data)</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Packet.htm#63d813d3e0e7f8438ad15a0130b4f550">operator<<</a> (bool Data)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Operator << overloads to put data into the packet. <a href="#cddb7edad1a56e720b4d170124fada02"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2fc96a50366d81c3dfee1b4c6e6bf3fa"></a><!-- doxytag: member="sf::Packet::operator<<" ref="2fc96a50366d81c3dfee1b4c6e6bf3fa" args="(Int8 Data)" --> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Operator << overloads to put data into the packet. <a href="#63d813d3e0e7f8438ad15a0130b4f550"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9347ec41af2959871aed0402081e1776"></a><!-- doxytag: member="sf::Packet::operator<<" ref="9347ec41af2959871aed0402081e1776" args="(Int8 Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (Int8 Data)</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ab3d35975734be35f95c9e40f4d21e36"></a><!-- doxytag: member="sf::Packet::operator<<" ref="ab3d35975734be35f95c9e40f4d21e36" args="(Uint8 Data)" --> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="503dbc5fcb30dafad82f4ba03122ca15"></a><!-- doxytag: member="sf::Packet::operator<<" ref="503dbc5fcb30dafad82f4ba03122ca15" args="(Uint8 Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (Uint8 Data)</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="213bf92121281f21c6b404574bc6a021"></a><!-- doxytag: member="sf::Packet::operator<<" ref="213bf92121281f21c6b404574bc6a021" args="(Int16 Data)" --> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="652c760093d4d99957b65504ee10a8f8"></a><!-- doxytag: member="sf::Packet::operator<<" ref="652c760093d4d99957b65504ee10a8f8" args="(Int16 Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (Int16 Data)</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7df8893e7a3777726760fd732620252a"></a><!-- doxytag: member="sf::Packet::operator<<" ref="7df8893e7a3777726760fd732620252a" args="(Uint16 Data)" --> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3bff4e704ea629291ba68c9e5e30843c"></a><!-- doxytag: member="sf::Packet::operator<<" ref="3bff4e704ea629291ba68c9e5e30843c" args="(Uint16 Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (Uint16 Data)</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ec74698e69de5ac06782d5799d1c1644"></a><!-- doxytag: member="sf::Packet::operator<<" ref="ec74698e69de5ac06782d5799d1c1644" args="(Int32 Data)" --> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="49b57b56fc00355aaca3ff6f92fd14c1"></a><!-- doxytag: member="sf::Packet::operator<<" ref="49b57b56fc00355aaca3ff6f92fd14c1" args="(Int32 Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (Int32 Data)</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2232620548f0482178d290593524b0bc"></a><!-- doxytag: member="sf::Packet::operator<<" ref="2232620548f0482178d290593524b0bc" args="(Uint32 Data)" --> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="efa8ac0dd13312872c78a9eada54dd5a"></a><!-- doxytag: member="sf::Packet::operator<<" ref="efa8ac0dd13312872c78a9eada54dd5a" args="(Uint32 Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (Uint32 Data)</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="deef4cf269fb44b9e6979edaf8fabc68"></a><!-- doxytag: member="sf::Packet::operator<<" ref="deef4cf269fb44b9e6979edaf8fabc68" args="(float Data)" --> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2a401cc304feedeb5841cc31d27198fc"></a><!-- doxytag: member="sf::Packet::operator<<" ref="2a401cc304feedeb5841cc31d27198fc" args="(float Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (float Data)</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d631efa97145e7d03c40035e8325cdf3"></a><!-- doxytag: member="sf::Packet::operator<<" ref="d631efa97145e7d03c40035e8325cdf3" args="(double Data)" --> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2ffe815c2515026437b674201121be16"></a><!-- doxytag: member="sf::Packet::operator<<" ref="2ffe815c2515026437b674201121be16" args="(double Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (double Data)</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fbb132f3eb540021c661df377671d31f"></a><!-- doxytag: member="sf::Packet::operator<<" ref="fbb132f3eb540021c661df377671d31f" args="(const char *Data)" --> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="31d185239d6e99120bd08ea833e63462"></a><!-- doxytag: member="sf::Packet::operator<<" ref="31d185239d6e99120bd08ea833e63462" args="(const char *Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (const char *Data)</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ce87f7cabd4b104b4cb45e5f277e2b5a"></a><!-- doxytag: member="sf::Packet::operator<<" ref="ce87f7cabd4b104b4cb45e5f277e2b5a" args="(const std::string &Data)" --> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8523cea4df1dbd52bae71c9c4f4e98e6"></a><!-- doxytag: member="sf::Packet::operator<<" ref="8523cea4df1dbd52bae71c9c4f4e98e6" args="(const std::string &Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (const std::string &Data)</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0165e60a9429ded898bdaf45627e7341"></a><!-- doxytag: member="sf::Packet::operator<<" ref="0165e60a9429ded898bdaf45627e7341" args="(const wchar_t *Data)" --> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="13e8c5fda6973f905e67107bb568f259"></a><!-- doxytag: member="sf::Packet::operator<<" ref="13e8c5fda6973f905e67107bb568f259" args="(const wchar_t *Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (const wchar_t *Data)</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ac9474ec99de6ee5f098ab5f899461d3"></a><!-- doxytag: member="sf::Packet::operator<<" ref="ac9474ec99de6ee5f098ab5f899461d3" args="(const std::wstring &Data)" --> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cbc23fdf72e8ef25d6a6e04fc46393ed"></a><!-- doxytag: member="sf::Packet::operator<<" ref="cbc23fdf72e8ef25d6a6e04fc46393ed" args="(const std::wstring &Data)" --> <a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (const std::wstring &Data)</td></tr> <tr><td colspan="2"><br><h2>Friends</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="96e899eb92ab68761ba10f3bcd3101bb"></a><!-- doxytag: member="sf::Packet::SocketTCP" ref="96e899eb92ab68761ba10f3bcd3101bb" args="" --> -class </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Packet.htm#96e899eb92ab68761ba10f3bcd3101bb">SocketTCP</a></td></tr> +class </td><td class="memItemRight" valign="bottom"><b>SocketTCP</b></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="89a79a0a0dd881f68463c69c9e980412"></a><!-- doxytag: member="sf::Packet::SocketUDP" ref="89a79a0a0dd881f68463c69c9e980412" args="" --> -class </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Packet.htm#89a79a0a0dd881f68463c69c9e980412">SocketUDP</a></td></tr> +class </td><td class="memItemRight" valign="bottom"><b>SocketUDP</b></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> <a class="el" href="classsf_1_1Packet.htm" title="Packet wraps data to send / to receive through the network.">Packet</a> wraps data to send / to receive through the network. -<p> - -<p> -Definition at line <a class="el" href="Packet_8hpp-source.htm#l00041">41</a> of file <a class="el" href="Packet_8hpp-source.htm">Packet.hpp</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<p>Definition at line <a class="el" href="Packet_8hpp-source.htm#l00041">41</a> of file <a class="el" href="Packet_8hpp-source.htm">Packet.hpp</a>.</p> +<hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="786e5d4ced83992ceefa1799963ea858"></a><!-- doxytag: member="sf::Packet::Packet" ref="786e5d4ced83992ceefa1799963ea858" args="()" --> <div class="memitem"> <div class="memproto"> @@ -162,7 +165,7 @@ Definition at line <a class="el" href="Packet_8hpp-source.htm#l00041">41</a> of <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> @@ -172,18 +175,20 @@ Definition at line <a class="el" href="Packet_8hpp-source.htm#l00041">41</a> of Default constructor. <p> +<p>Definition at line <a class="el" href="Packet_8cpp-source.htm#l00038">38</a> of file <a class="el" href="Packet_8cpp-source.htm">Packet.cpp</a>.</p> + </div> </div><p> -<a class="anchor" name="dc0490ca3c7c3d1e321bd742e5213913"></a><!-- doxytag: member="sf::Packet::~Packet" ref="dc0490ca3c7c3d1e321bd742e5213913" args="()" --> +<a class="anchor" name="bd57f3b7a6e0e9119f4021754b5b19e5"></a><!-- doxytag: member="sf::Packet::~Packet" ref="bd57f3b7a6e0e9119f4021754b5b19e5" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual sf::Packet::~Packet </td> + <td class="memname">sf::Packet::~Packet </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"><code> [virtual]</code></td> + <td><code> [virtual]</code></td> </tr> </table> </div> @@ -193,6 +198,8 @@ Default constructor. Virtual destructor. <p> +<p>Definition at line <a class="el" href="Packet_8cpp-source.htm#l00049">49</a> of file <a class="el" href="Packet_8cpp-source.htm">Packet.cpp</a>.</p> + </div> </div><p> <hr><h2>Member Function Documentation</h2> @@ -215,7 +222,7 @@ Virtual destructor. <tr> <td></td> <td>)</td> - <td></td><td></td><td width="100%"></td> + <td></td><td></td><td></td> </tr> </table> </div> @@ -231,6 +238,8 @@ Append data to the end of the packet. </table> </dl> +<p>Definition at line <a class="el" href="Packet_8cpp-source.htm#l00058">58</a> of file <a class="el" href="Packet_8cpp-source.htm">Packet.cpp</a>.</p> + </div> </div><p> <a class="anchor" name="3a7a30fb7a39e59df0cbd773756f60da"></a><!-- doxytag: member="sf::Packet::Clear" ref="3a7a30fb7a39e59df0cbd773756f60da" args="()" --> @@ -242,7 +251,7 @@ Append data to the end of the packet. <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> @@ -252,75 +261,84 @@ Append data to the end of the packet. Clear the packet data. <p> +<p>Definition at line <a class="el" href="Packet_8cpp-source.htm#l00072">72</a> of file <a class="el" href="Packet_8cpp-source.htm">Packet.cpp</a>.</p> + </div> </div><p> -<a class="anchor" name="dde92b425fd926576176be5f9ca8ca62"></a><!-- doxytag: member="sf::Packet::GetData" ref="dde92b425fd926576176be5f9ca8ca62" args="() const" --> +<a class="anchor" name="8d587905fb63e62419f1cc338eceed36"></a><!-- doxytag: member="sf::Packet::EndOfPacket" ref="8d587905fb63e62419f1cc338eceed36" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">const char* sf::Packet::GetData </td> + <td class="memname">bool sf::Packet::EndOfPacket </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"> const</td> + <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> -Get a pointer to the data contained in the packet Warning : the returned pointer may be invalid after you append data to the packet. +Tell if the reading position has reached the end of the packet. <p> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the data </dd></dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if all data have been read into the packet </dd></dl> + +<p>Definition at line <a class="el" href="Packet_8cpp-source.htm#l00103">103</a> of file <a class="el" href="Packet_8cpp-source.htm">Packet.cpp</a>.</p> </div> </div><p> -<a class="anchor" name="f8a6cd1eca4db48586ee85241bdb19bc"></a><!-- doxytag: member="sf::Packet::GetDataSize" ref="f8a6cd1eca4db48586ee85241bdb19bc" args="() const" --> +<a class="anchor" name="78286172beef1f89bd2a77edb7118c7a"></a><!-- doxytag: member="sf::Packet::GetData" ref="78286172beef1f89bd2a77edb7118c7a" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">std::size_t sf::Packet::GetDataSize </td> + <td class="memname">const char * sf::Packet::GetData </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"> const</td> + <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> -Get the size of the data contained in the packet. +Get a pointer to the data contained in the packet Warning : the returned pointer may be invalid after you append data to the packet. <p> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>Data size, in bytes </dd></dl> +Get a pointer to the data contained in the packet Warning : the returned pointer may be invalid after you append data to the packet.<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the data </dd></dl> + +<p>Definition at line <a class="el" href="Packet_8cpp-source.htm#l00085">85</a> of file <a class="el" href="Packet_8cpp-source.htm">Packet.cpp</a>.</p> </div> </div><p> -<a class="anchor" name="a9df9a2c6d78d70081d2b169a0f75db6"></a><!-- doxytag: member="sf::Packet::EndOfPacket" ref="a9df9a2c6d78d70081d2b169a0f75db6" args="() const" --> +<a class="anchor" name="4e6fcdc0ff42ad45b33cea22be253b0d"></a><!-- doxytag: member="sf::Packet::GetDataSize" ref="4e6fcdc0ff42ad45b33cea22be253b0d" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">bool sf::Packet::EndOfPacket </td> + <td class="memname">std::size_t sf::Packet::GetDataSize </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"> const</td> + <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> -Tell if the reading position has reached the end of the packet. +Get the size of the data contained in the packet. <p> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if all data have been read into the packet </dd></dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Data size, in bytes </dd></dl> + +<p>Definition at line <a class="el" href="Packet_8cpp-source.htm#l00094">94</a> of file <a class="el" href="Packet_8cpp-source.htm">Packet.cpp</a>.</p> </div> </div><p> -<a class="anchor" name="8863ff08b73f728a341c775758abbfb4"></a><!-- doxytag: member="sf::Packet::operator bool" ref="8863ff08b73f728a341c775758abbfb4" args="() const" --> +<a class="anchor" name="087ae98bb7e93f8c82b29b88aee2f8d6"></a><!-- doxytag: member="sf::Packet::operator bool" ref="087ae98bb7e93f8c82b29b88aee2f8d6" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -329,7 +347,7 @@ Tell if the reading position has reached the end of the packet. <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"> const</td> + <td> const</td> </tr> </table> </div> @@ -338,56 +356,64 @@ Tell if the reading position has reached the end of the packet. <p> Return the validity of packet. <p> +Tell if the packet is valid for reading.<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if last data extraction from packet was successful </dd></dl> +<p>Definition at line <a class="el" href="Packet_8cpp-source.htm#l00112">112</a> of file <a class="el" href="Packet_8cpp-source.htm">Packet.cpp</a>.</p> + </div> </div><p> -<a class="anchor" name="15bd4cb464ea568bb7395966e669656e"></a><!-- doxytag: member="sf::Packet::operator>>" ref="15bd4cb464ea568bb7395966e669656e" args="(bool &Data)" --> +<a class="anchor" name="63d813d3e0e7f8438ad15a0130b4f550"></a><!-- doxytag: member="sf::Packet::operator<<" ref="63d813d3e0e7f8438ad15a0130b4f550" args="(bool Data)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="classsf_1_1Packet.htm">Packet</a>& sf::Packet::operator>> </td> + <td class="memname"><a class="el" href="classsf_1_1Packet.htm">Packet</a> & sf::Packet::operator<< </td> <td>(</td> - <td class="paramtype">bool & </td> + <td class="paramtype">bool </td> <td class="paramname"> <em>Data</em> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> <div class="memdoc"> <p> -Operator >> overloads to extract data from the packet. +Operator << overloads to put data into the packet. <p> +<p>Definition at line <a class="el" href="Packet_8cpp-source.htm#l00290">290</a> of file <a class="el" href="Packet_8cpp-source.htm">Packet.cpp</a>.</p> + </div> </div><p> -<a class="anchor" name="cddb7edad1a56e720b4d170124fada02"></a><!-- doxytag: member="sf::Packet::operator<<" ref="cddb7edad1a56e720b4d170124fada02" args="(bool Data)" --> +<a class="anchor" name="8dfd4b8767cfd705a71d79b76d12ee16"></a><!-- doxytag: member="sf::Packet::operator>>" ref="8dfd4b8767cfd705a71d79b76d12ee16" args="(bool &Data)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="classsf_1_1Packet.htm">Packet</a>& sf::Packet::operator<< </td> + <td class="memname"><a class="el" href="classsf_1_1Packet.htm">Packet</a> & sf::Packet::operator>> </td> <td>(</td> - <td class="paramtype">bool </td> + <td class="paramtype">bool & </td> <td class="paramname"> <em>Data</em> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> <div class="memdoc"> <p> -Operator << overloads to put data into the packet. +Operator >> overloads to extract data from the packet. <p> +<p>Definition at line <a class="el" href="Packet_8cpp-source.htm#l00121">121</a> of file <a class="el" href="Packet_8cpp-source.htm">Packet.cpp</a>.</p> + </div> </div><p> -<hr>The documentation for this class was generated from the following file:<ul> -<li><a class="el" href="Packet_8hpp-source.htm">Packet.hpp</a></ul> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="Packet_8hpp-source.htm">Packet.hpp</a><li><a class="el" href="Packet_8cpp-source.htm">Packet.cpp</a></ul> +</div> <p id="footer"> :: Copyright © 2007-2008 Laurent Gomila, all rights reserved :: |