1496 lines
97 KiB
HTML
1496 lines
97 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<title>SFML - Simple and Fast Multimedia Library</title>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
|
|
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link rel="stylesheet" type="text/css" href="search/search.css" />
|
|
<link rel="stylesheet" type="text/css" href="searchOverrides.css" />
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_search(); });
|
|
/* @license-end */
|
|
</script>
|
|
</head>
|
|
<body>
|
|
<div id="banner-container">
|
|
<div id="banner">
|
|
<span id="sfml">SFML 3.0.0</span>
|
|
</div>
|
|
</div>
|
|
<div id="content">
|
|
<div>
|
|
<!-- Generated by Doxygen 1.12.0 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="topics.html"><span>Topics</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
|
|
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){ initResizable(false); });
|
|
/* @license-end */
|
|
</script>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespacesf.html">sf</a></li><li class="navelem"><a class="el" href="classsf_1_1Packet.html">Packet</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="classsf_1_1Packet-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">sf::Packet Class Reference<div class="ingroups"><a class="el" href="group__network.html">Network module</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Utility class to build blocks of data to transfer over the network.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Packet_8hpp_source.html">SFML/Network/Packet.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a7cf6fae63bcf55d0b434a87865a70228" id="r_a7cf6fae63bcf55d0b434a87865a70228"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7cf6fae63bcf55d0b434a87865a70228">Packet</a> ()=default</td></tr>
|
|
<tr class="memdesc:a7cf6fae63bcf55d0b434a87865a70228"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:a7cf6fae63bcf55d0b434a87865a70228"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa9282b80b1bd36dbb6ec344ac1549a90" id="r_aa9282b80b1bd36dbb6ec344ac1549a90"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa9282b80b1bd36dbb6ec344ac1549a90">~Packet</a> ()=default</td></tr>
|
|
<tr class="memdesc:aa9282b80b1bd36dbb6ec344ac1549a90"><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <br /></td></tr>
|
|
<tr class="separator:aa9282b80b1bd36dbb6ec344ac1549a90"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad687cec99e27bfb69828535a234e298e" id="r_ad687cec99e27bfb69828535a234e298e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad687cec99e27bfb69828535a234e298e">Packet</a> (const <a class="el" href="classsf_1_1Packet.html">Packet</a> &)=default</td></tr>
|
|
<tr class="memdesc:ad687cec99e27bfb69828535a234e298e"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br /></td></tr>
|
|
<tr class="separator:ad687cec99e27bfb69828535a234e298e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a03e3f3f9b8fbef859be8901b5b215bb2" id="r_a03e3f3f9b8fbef859be8901b5b215bb2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a03e3f3f9b8fbef859be8901b5b215bb2">operator=</a> (const <a class="el" href="classsf_1_1Packet.html">Packet</a> &)=default</td></tr>
|
|
<tr class="memdesc:a03e3f3f9b8fbef859be8901b5b215bb2"><td class="mdescLeft"> </td><td class="mdescRight">Copy assignment. <br /></td></tr>
|
|
<tr class="separator:a03e3f3f9b8fbef859be8901b5b215bb2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a39cdcdb426c9f81f111ee95840afaf6d" id="r_a39cdcdb426c9f81f111ee95840afaf6d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a39cdcdb426c9f81f111ee95840afaf6d">Packet</a> (<a class="el" href="classsf_1_1Packet.html">Packet</a> &&) noexcept=default</td></tr>
|
|
<tr class="memdesc:a39cdcdb426c9f81f111ee95840afaf6d"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <br /></td></tr>
|
|
<tr class="separator:a39cdcdb426c9f81f111ee95840afaf6d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a256e13eac488cdc9d03eff2da08f529c" id="r_a256e13eac488cdc9d03eff2da08f529c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a256e13eac488cdc9d03eff2da08f529c">operator=</a> (<a class="el" href="classsf_1_1Packet.html">Packet</a> &&) noexcept=default</td></tr>
|
|
<tr class="memdesc:a256e13eac488cdc9d03eff2da08f529c"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment. <br /></td></tr>
|
|
<tr class="separator:a256e13eac488cdc9d03eff2da08f529c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7dd6e429b87520008326c4d71f1cf011" id="r_a7dd6e429b87520008326c4d71f1cf011"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7dd6e429b87520008326c4d71f1cf011">append</a> (const void *data, std::size_t sizeInBytes)</td></tr>
|
|
<tr class="memdesc:a7dd6e429b87520008326c4d71f1cf011"><td class="mdescLeft"> </td><td class="mdescRight">Append data to the end of the packet. <br /></td></tr>
|
|
<tr class="separator:a7dd6e429b87520008326c4d71f1cf011"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c2dc9878afaf30e88d922776201f6c3" id="r_a5c2dc9878afaf30e88d922776201f6c3"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5c2dc9878afaf30e88d922776201f6c3">getReadPosition</a> () const</td></tr>
|
|
<tr class="memdesc:a5c2dc9878afaf30e88d922776201f6c3"><td class="mdescLeft"> </td><td class="mdescRight">Get the current reading position in the packet. <br /></td></tr>
|
|
<tr class="separator:a5c2dc9878afaf30e88d922776201f6c3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a133ea8b8fe6e93c230f0d79f19a3bf0d" id="r_a133ea8b8fe6e93c230f0d79f19a3bf0d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a133ea8b8fe6e93c230f0d79f19a3bf0d">clear</a> ()</td></tr>
|
|
<tr class="memdesc:a133ea8b8fe6e93c230f0d79f19a3bf0d"><td class="mdescLeft"> </td><td class="mdescRight">Clear the packet. <br /></td></tr>
|
|
<tr class="separator:a133ea8b8fe6e93c230f0d79f19a3bf0d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a998b70df024bee4792e2ecdc915ae46e" id="r_a998b70df024bee4792e2ecdc915ae46e"><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="#a998b70df024bee4792e2ecdc915ae46e">getData</a> () const</td></tr>
|
|
<tr class="memdesc:a998b70df024bee4792e2ecdc915ae46e"><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to the data contained in the packet. <br /></td></tr>
|
|
<tr class="separator:a998b70df024bee4792e2ecdc915ae46e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0fae6eccf2ca704fc5099cd90a9f56f7" id="r_a0fae6eccf2ca704fc5099cd90a9f56f7"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0fae6eccf2ca704fc5099cd90a9f56f7">getDataSize</a> () const</td></tr>
|
|
<tr class="memdesc:a0fae6eccf2ca704fc5099cd90a9f56f7"><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the data contained in the packet. <br /></td></tr>
|
|
<tr class="separator:a0fae6eccf2ca704fc5099cd90a9f56f7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a61e354fa670da053907c14b738839560" id="r_a61e354fa670da053907c14b738839560"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a61e354fa670da053907c14b738839560">endOfPacket</a> () const</td></tr>
|
|
<tr class="memdesc:a61e354fa670da053907c14b738839560"><td class="mdescLeft"> </td><td class="mdescRight">Tell if the reading position has reached the end of the packet. <br /></td></tr>
|
|
<tr class="separator:a61e354fa670da053907c14b738839560"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8863ff08b73f728a341c775758abbfb4" id="r_a8863ff08b73f728a341c775758abbfb4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8863ff08b73f728a341c775758abbfb4">operator bool</a> () const</td></tr>
|
|
<tr class="memdesc:a8863ff08b73f728a341c775758abbfb4"><td class="mdescLeft"> </td><td class="mdescRight">Test the validity of the packet, for reading. <br /></td></tr>
|
|
<tr class="separator:a8863ff08b73f728a341c775758abbfb4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8b6403506fec6b69f033278de33c8145" id="r_a8b6403506fec6b69f033278de33c8145"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8b6403506fec6b69f033278de33c8145">operator>></a> (bool &data)</td></tr>
|
|
<tr class="memdesc:a8b6403506fec6b69f033278de33c8145"><td class="mdescLeft"> </td><td class="mdescRight">Overload of <code>operator>></code> to read data from the packet. <br /></td></tr>
|
|
<tr class="separator:a8b6403506fec6b69f033278de33c8145"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae44f412c1b4e3bffffe7a65ff70f7f2a" id="r_ae44f412c1b4e3bffffe7a65ff70f7f2a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae44f412c1b4e3bffffe7a65ff70f7f2a">operator>></a> (std::int8_t &data)</td></tr>
|
|
<tr class="memdesc:ae44f412c1b4e3bffffe7a65ff70f7f2a"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:ae44f412c1b4e3bffffe7a65ff70f7f2a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab64e609a2cf46356f5f9a00f36111090" id="r_ab64e609a2cf46356f5f9a00f36111090"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab64e609a2cf46356f5f9a00f36111090">operator>></a> (std::uint8_t &data)</td></tr>
|
|
<tr class="memdesc:ab64e609a2cf46356f5f9a00f36111090"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:ab64e609a2cf46356f5f9a00f36111090"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3113773cdbb07e18f8ba9a8d3e846f85" id="r_a3113773cdbb07e18f8ba9a8d3e846f85"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3113773cdbb07e18f8ba9a8d3e846f85">operator>></a> (std::int16_t &data)</td></tr>
|
|
<tr class="memdesc:a3113773cdbb07e18f8ba9a8d3e846f85"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:a3113773cdbb07e18f8ba9a8d3e846f85"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9f53a2c54cf09727285f3d953933c372" id="r_a9f53a2c54cf09727285f3d953933c372"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9f53a2c54cf09727285f3d953933c372">operator>></a> (std::uint16_t &data)</td></tr>
|
|
<tr class="memdesc:a9f53a2c54cf09727285f3d953933c372"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:a9f53a2c54cf09727285f3d953933c372"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a534f51c0d24174f2ef1d72616ed8ba92" id="r_a534f51c0d24174f2ef1d72616ed8ba92"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a534f51c0d24174f2ef1d72616ed8ba92">operator>></a> (std::int32_t &data)</td></tr>
|
|
<tr class="memdesc:a534f51c0d24174f2ef1d72616ed8ba92"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:a534f51c0d24174f2ef1d72616ed8ba92"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5fb6d71162e35662e70ec229ca6cc3ec" id="r_a5fb6d71162e35662e70ec229ca6cc3ec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5fb6d71162e35662e70ec229ca6cc3ec">operator>></a> (std::uint32_t &data)</td></tr>
|
|
<tr class="memdesc:a5fb6d71162e35662e70ec229ca6cc3ec"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:a5fb6d71162e35662e70ec229ca6cc3ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a10fc2ab9f5fb7b8aa09ea3e016335bf1" id="r_a10fc2ab9f5fb7b8aa09ea3e016335bf1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a10fc2ab9f5fb7b8aa09ea3e016335bf1">operator>></a> (std::int64_t &data)</td></tr>
|
|
<tr class="memdesc:a10fc2ab9f5fb7b8aa09ea3e016335bf1"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:a10fc2ab9f5fb7b8aa09ea3e016335bf1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a819152d58f0e87111e6ff5eda34e9d6b" id="r_a819152d58f0e87111e6ff5eda34e9d6b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a819152d58f0e87111e6ff5eda34e9d6b">operator>></a> (std::uint64_t &data)</td></tr>
|
|
<tr class="memdesc:a819152d58f0e87111e6ff5eda34e9d6b"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:a819152d58f0e87111e6ff5eda34e9d6b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a741849607d428e93c532e11eadcc39f1" id="r_a741849607d428e93c532e11eadcc39f1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a741849607d428e93c532e11eadcc39f1">operator>></a> (float &data)</td></tr>
|
|
<tr class="memdesc:a741849607d428e93c532e11eadcc39f1"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:a741849607d428e93c532e11eadcc39f1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1854ca771105fb281edf349fc6507c73" id="r_a1854ca771105fb281edf349fc6507c73"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1854ca771105fb281edf349fc6507c73">operator>></a> (double &data)</td></tr>
|
|
<tr class="memdesc:a1854ca771105fb281edf349fc6507c73"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:a1854ca771105fb281edf349fc6507c73"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaed01fec1a3eae27a028506195607f82" id="r_aaed01fec1a3eae27a028506195607f82"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#aaed01fec1a3eae27a028506195607f82">operator>></a> (char *data)</td></tr>
|
|
<tr class="memdesc:aaed01fec1a3eae27a028506195607f82"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:aaed01fec1a3eae27a028506195607f82"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a60484dff69997db11e2d4ab3704ab921" id="r_a60484dff69997db11e2d4ab3704ab921"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a60484dff69997db11e2d4ab3704ab921">operator>></a> (std::string &data)</td></tr>
|
|
<tr class="memdesc:a60484dff69997db11e2d4ab3704ab921"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:a60484dff69997db11e2d4ab3704ab921"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8805e66013f9f84ec8a883e42ae259d4" id="r_a8805e66013f9f84ec8a883e42ae259d4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8805e66013f9f84ec8a883e42ae259d4">operator>></a> (wchar_t *data)</td></tr>
|
|
<tr class="memdesc:a8805e66013f9f84ec8a883e42ae259d4"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:a8805e66013f9f84ec8a883e42ae259d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8621056995c32bcf59809e2aecf08635" id="r_a8621056995c32bcf59809e2aecf08635"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8621056995c32bcf59809e2aecf08635">operator>></a> (std::wstring &data)</td></tr>
|
|
<tr class="memdesc:a8621056995c32bcf59809e2aecf08635"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:a8621056995c32bcf59809e2aecf08635"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a27d0ae92891dbf8a7914e5d5232940d0" id="r_a27d0ae92891dbf8a7914e5d5232940d0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a27d0ae92891dbf8a7914e5d5232940d0">operator>></a> (<a class="el" href="classsf_1_1String.html">String</a> &data)</td></tr>
|
|
<tr class="memdesc:a27d0ae92891dbf8a7914e5d5232940d0"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:a27d0ae92891dbf8a7914e5d5232940d0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae02c874e0aac18a0497fca982a8f9083" id="r_ae02c874e0aac18a0497fca982a8f9083"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae02c874e0aac18a0497fca982a8f9083">operator<<</a> (bool data)</td></tr>
|
|
<tr class="memdesc:ae02c874e0aac18a0497fca982a8f9083"><td class="mdescLeft"> </td><td class="mdescRight">Overload of <code>operator<<</code> to write data into the packet. <br /></td></tr>
|
|
<tr class="separator:ae02c874e0aac18a0497fca982a8f9083"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac63b8ccaa7e08ad0b2c32f15fbe31488" id="r_ac63b8ccaa7e08ad0b2c32f15fbe31488"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac63b8ccaa7e08ad0b2c32f15fbe31488">operator<<</a> (std::int8_t data)</td></tr>
|
|
<tr class="memdesc:ac63b8ccaa7e08ad0b2c32f15fbe31488"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:ac63b8ccaa7e08ad0b2c32f15fbe31488"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7542b9842e51f3ea4690fff9e6cb267f" id="r_a7542b9842e51f3ea4690fff9e6cb267f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7542b9842e51f3ea4690fff9e6cb267f">operator<<</a> (std::uint8_t data)</td></tr>
|
|
<tr class="memdesc:a7542b9842e51f3ea4690fff9e6cb267f"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:a7542b9842e51f3ea4690fff9e6cb267f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb0fa0fcdac192af1dcc474ab3771c0e" id="r_afb0fa0fcdac192af1dcc474ab3771c0e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#afb0fa0fcdac192af1dcc474ab3771c0e">operator<<</a> (std::int16_t data)</td></tr>
|
|
<tr class="memdesc:afb0fa0fcdac192af1dcc474ab3771c0e"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:afb0fa0fcdac192af1dcc474ab3771c0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a345afa315ea0b638ea0c2be666c0243b" id="r_a345afa315ea0b638ea0c2be666c0243b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a345afa315ea0b638ea0c2be666c0243b">operator<<</a> (std::uint16_t data)</td></tr>
|
|
<tr class="memdesc:a345afa315ea0b638ea0c2be666c0243b"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:a345afa315ea0b638ea0c2be666c0243b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad89227a67ffd0526f275cd05888a4269" id="r_ad89227a67ffd0526f275cd05888a4269"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad89227a67ffd0526f275cd05888a4269">operator<<</a> (std::int32_t data)</td></tr>
|
|
<tr class="memdesc:ad89227a67ffd0526f275cd05888a4269"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:ad89227a67ffd0526f275cd05888a4269"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0ac5e4f188a74301e310751d9d0804ba" id="r_a0ac5e4f188a74301e310751d9d0804ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0ac5e4f188a74301e310751d9d0804ba">operator<<</a> (std::uint32_t data)</td></tr>
|
|
<tr class="memdesc:a0ac5e4f188a74301e310751d9d0804ba"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:a0ac5e4f188a74301e310751d9d0804ba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1f9d66489418bc05810b9e9ca8c21ba8" id="r_a1f9d66489418bc05810b9e9ca8c21ba8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1f9d66489418bc05810b9e9ca8c21ba8">operator<<</a> (std::int64_t data)</td></tr>
|
|
<tr class="memdesc:a1f9d66489418bc05810b9e9ca8c21ba8"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:a1f9d66489418bc05810b9e9ca8c21ba8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a95233cc63de8733eb451de7107e834a0" id="r_a95233cc63de8733eb451de7107e834a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a95233cc63de8733eb451de7107e834a0">operator<<</a> (std::uint64_t data)</td></tr>
|
|
<tr class="memdesc:a95233cc63de8733eb451de7107e834a0"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:a95233cc63de8733eb451de7107e834a0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acf1a231e48452a1cd55af2c027a1c1ee" id="r_acf1a231e48452a1cd55af2c027a1c1ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#acf1a231e48452a1cd55af2c027a1c1ee">operator<<</a> (float data)</td></tr>
|
|
<tr class="memdesc:acf1a231e48452a1cd55af2c027a1c1ee"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:acf1a231e48452a1cd55af2c027a1c1ee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abee2df335bdc3ab40521248cdb187c02" id="r_abee2df335bdc3ab40521248cdb187c02"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#abee2df335bdc3ab40521248cdb187c02">operator<<</a> (double data)</td></tr>
|
|
<tr class="memdesc:abee2df335bdc3ab40521248cdb187c02"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:abee2df335bdc3ab40521248cdb187c02"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a94522071d95189ddff1ae7ca832695ff" id="r_a94522071d95189ddff1ae7ca832695ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a94522071d95189ddff1ae7ca832695ff">operator<<</a> (const char *data)</td></tr>
|
|
<tr class="memdesc:a94522071d95189ddff1ae7ca832695ff"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:a94522071d95189ddff1ae7ca832695ff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac45aab054ddee7de9599bc3b2d8e025f" id="r_ac45aab054ddee7de9599bc3b2d8e025f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac45aab054ddee7de9599bc3b2d8e025f">operator<<</a> (const std::string &data)</td></tr>
|
|
<tr class="memdesc:ac45aab054ddee7de9599bc3b2d8e025f"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:ac45aab054ddee7de9599bc3b2d8e025f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac5a13e3280cac77799f7fdadfe3e37b6" id="r_ac5a13e3280cac77799f7fdadfe3e37b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac5a13e3280cac77799f7fdadfe3e37b6">operator<<</a> (const wchar_t *data)</td></tr>
|
|
<tr class="memdesc:ac5a13e3280cac77799f7fdadfe3e37b6"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:ac5a13e3280cac77799f7fdadfe3e37b6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a97acaefaee7d3ffb36f4e8a00d4c3970" id="r_a97acaefaee7d3ffb36f4e8a00d4c3970"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a97acaefaee7d3ffb36f4e8a00d4c3970">operator<<</a> (const std::wstring &data)</td></tr>
|
|
<tr class="memdesc:a97acaefaee7d3ffb36f4e8a00d4c3970"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:a97acaefaee7d3ffb36f4e8a00d4c3970"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ef2e3308b93b80214b42a7d4683704a" id="r_a5ef2e3308b93b80214b42a7d4683704a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Packet.html">Packet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5ef2e3308b93b80214b42a7d4683704a">operator<<</a> (const <a class="el" href="classsf_1_1String.html">String</a> &data)</td></tr>
|
|
<tr class="memdesc:a5ef2e3308b93b80214b42a7d4683704a"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br /></td></tr>
|
|
<tr class="separator:a5ef2e3308b93b80214b42a7d4683704a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:af0003506bcb290407dcf5fe7f13a887d" id="r_af0003506bcb290407dcf5fe7f13a887d"><td class="memItemLeft" align="right" valign="top">virtual const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="#af0003506bcb290407dcf5fe7f13a887d">onSend</a> (std::size_t &size)</td></tr>
|
|
<tr class="memdesc:af0003506bcb290407dcf5fe7f13a887d"><td class="mdescLeft"> </td><td class="mdescRight">Called before the packet is sent over the network. <br /></td></tr>
|
|
<tr class="separator:af0003506bcb290407dcf5fe7f13a887d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab71a31ef0f1d5d856de6f9fc75434128" id="r_ab71a31ef0f1d5d856de6f9fc75434128"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab71a31ef0f1d5d856de6f9fc75434128">onReceive</a> (const void *data, std::size_t size)</td></tr>
|
|
<tr class="memdesc:ab71a31ef0f1d5d856de6f9fc75434128"><td class="mdescLeft"> </td><td class="mdescRight">Called after the packet is received over the network. <br /></td></tr>
|
|
<tr class="separator:ab71a31ef0f1d5d856de6f9fc75434128"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:aa8b32310b01d4bb702d6bcb969d5f130" id="r_aa8b32310b01d4bb702d6bcb969d5f130"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa8b32310b01d4bb702d6bcb969d5f130">TcpSocket</a></td></tr>
|
|
<tr class="separator:aa8b32310b01d4bb702d6bcb969d5f130"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae128c6687ced82c6157c5f865f8dec5c" id="r_ae128c6687ced82c6157c5f865f8dec5c"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae128c6687ced82c6157c5f865f8dec5c">UdpSocket</a></td></tr>
|
|
<tr class="separator:ae128c6687ced82c6157c5f865f8dec5c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Utility class to build blocks of data to transfer over the network. </p>
|
|
<p>Packets provide a safe and easy way to serialize data, in order to send it over the network using sockets (<code><a class="el" href="classsf_1_1TcpSocket.html" title="Specialized socket using the TCP protocol.">sf::TcpSocket</a></code>, <code><a class="el" href="classsf_1_1UdpSocket.html" title="Specialized socket using the UDP protocol.">sf::UdpSocket</a></code>).</p>
|
|
<p>Packets solve 2 fundamental problems that arise when transferring data over the network: </p><ul>
|
|
<li>data is interpreted correctly according to the endianness </li>
|
|
<li>the bounds of the packet are preserved (one send == one receive)</li>
|
|
</ul>
|
|
<p>The <code><a class="el" href="classsf_1_1Packet.html" title="Utility class to build blocks of data to transfer over the network.">sf::Packet</a></code> class provides both input and output modes. It is designed to follow the behavior of standard C++ streams, using operators >> and << to extract and insert data.</p>
|
|
<p>It is recommended to use only fixed-size types (like <code>std::int32_t</code>, etc.), to avoid possible differences between the sender and the receiver. Indeed, the native C++ types may have different sizes on two platforms and your data may be corrupted if that happens.</p>
|
|
<p>Usage example: </p><div class="fragment"><div class="line">std::uint32_t x = 24;</div>
|
|
<div class="line">std::string s = <span class="stringliteral">"hello"</span>;</div>
|
|
<div class="line"><span class="keywordtype">double</span> d = 5.89;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="comment">// Group the variables to send into a packet</span></div>
|
|
<div class="line"><a class="code hl_class" href="classsf_1_1Packet.html">sf::Packet</a> packet;</div>
|
|
<div class="line">packet << x << s << d;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="comment">// Send it over the network (socket is a valid sf::TcpSocket)</span></div>
|
|
<div class="line">socket.send(packet);</div>
|
|
<div class="line"> </div>
|
|
<div class="line">-----------------------------------------------------------------</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="comment">// Receive the packet at the other end</span></div>
|
|
<div class="line"><a class="code hl_class" href="classsf_1_1Packet.html">sf::Packet</a> packet;</div>
|
|
<div class="line">socket.receive(packet);</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="comment">// Extract the variables contained in the packet</span></div>
|
|
<div class="line">std::uint32_t x;</div>
|
|
<div class="line">std::string s;</div>
|
|
<div class="line"><span class="keywordtype">double</span> d;</div>
|
|
<div class="line"><span class="keywordflow">if</span> (packet >> x >> s >> d)</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> <span class="comment">// Data extracted successfully...</span></div>
|
|
<div class="line">}</div>
|
|
<div class="ttc" id="aclasssf_1_1Packet_html"><div class="ttname"><a href="classsf_1_1Packet.html">sf::Packet</a></div><div class="ttdoc">Utility class to build blocks of data to transfer over the network.</div><div class="ttdef"><b>Definition</b> <a href="Packet_8hpp_source.html#l00048">Packet.hpp:49</a></div></div>
|
|
</div><!-- fragment --><p>Packets have built-in <code>operator>></code> and << overloads for standard types: </p><ul>
|
|
<li><code>bool</code> </li>
|
|
<li>fixed-size integer types (<code>int[8|16|32]_t</code>, <code>uint[8|16|32]_t</code>) </li>
|
|
<li>floating point numbers (<code>float</code>, <code>double</code>) </li>
|
|
<li>string types (<code>char*</code>, <code>wchar_t*</code>, <code>std::string</code>, <code>std::wstring</code>, <code><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a></code>)</li>
|
|
</ul>
|
|
<p>Like standard streams, it is also possible to define your own overloads of operators >> and << in order to handle your custom types.</p>
|
|
<div class="fragment"><div class="line"><span class="keyword">struct </span>MyStruct</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> <span class="keywordtype">float</span> number{};</div>
|
|
<div class="line"> std::int8_t integer{};</div>
|
|
<div class="line"> std::string str;</div>
|
|
<div class="line">};</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><a class="code hl_class" href="classsf_1_1Packet.html">sf::Packet</a>& <a class="code hl_function" href="#ae02c874e0aac18a0497fca982a8f9083">operator <<</a>(<a class="code hl_class" href="classsf_1_1Packet.html">sf::Packet</a>& packet, <span class="keyword">const</span> MyStruct& m)</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> <span class="keywordflow">return</span> packet << m.number << m.integer << m.str;</div>
|
|
<div class="line">}</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><a class="code hl_class" href="classsf_1_1Packet.html">sf::Packet</a>& <a class="code hl_function" href="#a8b6403506fec6b69f033278de33c8145">operator >></a>(<a class="code hl_class" href="classsf_1_1Packet.html">sf::Packet</a>& packet, MyStruct& m)</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> <span class="keywordflow">return</span> packet >> m.number >> m.integer >> m.str;</div>
|
|
<div class="line">}</div>
|
|
<div class="ttc" id="aclasssf_1_1Packet_html_a8b6403506fec6b69f033278de33c8145"><div class="ttname"><a href="#a8b6403506fec6b69f033278de33c8145">sf::Packet::operator>></a></div><div class="ttdeci">Packet & operator>>(bool &data)</div><div class="ttdoc">Overload of operator>> to read data from the packet.</div></div>
|
|
<div class="ttc" id="aclasssf_1_1Packet_html_ae02c874e0aac18a0497fca982a8f9083"><div class="ttname"><a href="#ae02c874e0aac18a0497fca982a8f9083">sf::Packet::operator<<</a></div><div class="ttdeci">Packet & operator<<(bool data)</div><div class="ttdoc">Overload of operator<< to write data into the packet.</div></div>
|
|
</div><!-- fragment --><p>Packets also provide an extra feature that allows to apply custom transformations to the data before it is sent, and after it is received. This is typically used to handle automatic compression or encryption of the data. This is achieved by inheriting from <code><a class="el" href="classsf_1_1Packet.html" title="Utility class to build blocks of data to transfer over the network.">sf::Packet</a></code>, and overriding the onSend and onReceive functions.</p>
|
|
<p>Here is an example: </p><div class="fragment"><div class="line"><span class="keyword">class </span>ZipPacket : <span class="keyword">public</span> <a class="code hl_class" href="classsf_1_1Packet.html">sf::Packet</a></div>
|
|
<div class="line">{</div>
|
|
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">void</span>* <a class="code hl_function" href="#af0003506bcb290407dcf5fe7f13a887d">onSend</a>(std::size_t& size)<span class="keyword"> override</span></div>
|
|
<div class="line"><span class="keyword"> </span>{</div>
|
|
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">void</span>* srcData = <a class="code hl_function" href="#a998b70df024bee4792e2ecdc915ae46e">getData</a>();</div>
|
|
<div class="line"> std::size_t srcSize = <a class="code hl_function" href="#a0fae6eccf2ca704fc5099cd90a9f56f7">getDataSize</a>();</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="keywordflow">return</span> MySuperZipFunction(srcData, srcSize, &size);</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="keywordtype">void</span> <a class="code hl_function" href="#ab71a31ef0f1d5d856de6f9fc75434128">onReceive</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* data, std::size_t size)<span class="keyword"> override</span></div>
|
|
<div class="line"><span class="keyword"> </span>{</div>
|
|
<div class="line"> std::size_t dstSize;</div>
|
|
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">void</span>* dstData = MySuperUnzipFunction(data, size, &dstSize);</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <a class="code hl_function" href="#a7dd6e429b87520008326c4d71f1cf011">append</a>(dstData, dstSize);</div>
|
|
<div class="line"> }</div>
|
|
<div class="line">};</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="comment">// Use like regular packets:</span></div>
|
|
<div class="line">ZipPacket packet;</div>
|
|
<div class="line">packet << x << s << d;</div>
|
|
<div class="line">...</div>
|
|
<div class="ttc" id="aclasssf_1_1Packet_html_a0fae6eccf2ca704fc5099cd90a9f56f7"><div class="ttname"><a href="#a0fae6eccf2ca704fc5099cd90a9f56f7">sf::Packet::getDataSize</a></div><div class="ttdeci">std::size_t getDataSize() const</div><div class="ttdoc">Get the size of the data contained in the packet.</div></div>
|
|
<div class="ttc" id="aclasssf_1_1Packet_html_a7dd6e429b87520008326c4d71f1cf011"><div class="ttname"><a href="#a7dd6e429b87520008326c4d71f1cf011">sf::Packet::append</a></div><div class="ttdeci">void append(const void *data, std::size_t sizeInBytes)</div><div class="ttdoc">Append data to the end of the packet.</div></div>
|
|
<div class="ttc" id="aclasssf_1_1Packet_html_a998b70df024bee4792e2ecdc915ae46e"><div class="ttname"><a href="#a998b70df024bee4792e2ecdc915ae46e">sf::Packet::getData</a></div><div class="ttdeci">const void * getData() const</div><div class="ttdoc">Get a pointer to the data contained in the packet.</div></div>
|
|
<div class="ttc" id="aclasssf_1_1Packet_html_ab71a31ef0f1d5d856de6f9fc75434128"><div class="ttname"><a href="#ab71a31ef0f1d5d856de6f9fc75434128">sf::Packet::onReceive</a></div><div class="ttdeci">virtual void onReceive(const void *data, std::size_t size)</div><div class="ttdoc">Called after the packet is received over the network.</div></div>
|
|
<div class="ttc" id="aclasssf_1_1Packet_html_af0003506bcb290407dcf5fe7f13a887d"><div class="ttname"><a href="#af0003506bcb290407dcf5fe7f13a887d">sf::Packet::onSend</a></div><div class="ttdeci">virtual const void * onSend(std::size_t &size)</div><div class="ttdoc">Called before the packet is sent over the network.</div></div>
|
|
</div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><code><a class="el" href="classsf_1_1TcpSocket.html" title="Specialized socket using the TCP protocol.">sf::TcpSocket</a></code>, <code><a class="el" href="classsf_1_1UdpSocket.html" title="Specialized socket using the UDP protocol.">sf::UdpSocket</a></code> </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Packet_8hpp_source.html#l00048">48</a> of file <a class="el" href="Packet_8hpp_source.html">Packet.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a7cf6fae63bcf55d0b434a87865a70228" name="a7cf6fae63bcf55d0b434a87865a70228"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7cf6fae63bcf55d0b434a87865a70228">◆ </a></span>Packet() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::Packet::Packet </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
<p>Creates an empty packet. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa9282b80b1bd36dbb6ec344ac1549a90" name="aa9282b80b1bd36dbb6ec344ac1549a90"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa9282b80b1bd36dbb6ec344ac1549a90">◆ </a></span>~Packet()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual sf::Packet::~Packet </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Virtual destructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad687cec99e27bfb69828535a234e298e" name="ad687cec99e27bfb69828535a234e298e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad687cec99e27bfb69828535a234e298e">◆ </a></span>Packet() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::Packet::Packet </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Packet.html">Packet</a> &</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Copy constructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a39cdcdb426c9f81f111ee95840afaf6d" name="a39cdcdb426c9f81f111ee95840afaf6d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a39cdcdb426c9f81f111ee95840afaf6d">◆ </a></span>Packet() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::Packet::Packet </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classsf_1_1Packet.html">Packet</a> &&</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Move constructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a7dd6e429b87520008326c4d71f1cf011" name="a7dd6e429b87520008326c4d71f1cf011"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7dd6e429b87520008326c4d71f1cf011">◆ </a></span>append()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Packet::append </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>data</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>sizeInBytes</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Append data to the end of the packet. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Pointer to the sequence of bytes to append </td></tr>
|
|
<tr><td class="paramname">sizeInBytes</td><td>Number of bytes to append</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a133ea8b8fe6e93c230f0d79f19a3bf0d" title="Clear the packet.">clear</a></code> </dd>
|
|
<dd>
|
|
<code><a class="el" href="#a5c2dc9878afaf30e88d922776201f6c3" title="Get the current reading position in the packet.">getReadPosition</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a133ea8b8fe6e93c230f0d79f19a3bf0d" name="a133ea8b8fe6e93c230f0d79f19a3bf0d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a133ea8b8fe6e93c230f0d79f19a3bf0d">◆ </a></span>clear()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Packet::clear </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clear the packet. </p>
|
|
<p>After calling Clear, the packet is empty.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a7dd6e429b87520008326c4d71f1cf011" title="Append data to the end of the packet.">append</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a61e354fa670da053907c14b738839560" name="a61e354fa670da053907c14b738839560"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a61e354fa670da053907c14b738839560">◆ </a></span>endOfPacket()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool sf::Packet::endOfPacket </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Tell if the reading position has reached the end of the packet. </p>
|
|
<p>This function is useful to know if there is some data left to be read, without actually reading it.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if all data was read, <code>false</code> otherwise</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code>operator</code> bool </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a998b70df024bee4792e2ecdc915ae46e" name="a998b70df024bee4792e2ecdc915ae46e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a998b70df024bee4792e2ecdc915ae46e">◆ </a></span>getData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const void * sf::Packet::getData </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get a pointer to the data contained in the packet. </p>
|
|
<p>Warning: the returned pointer may become invalid after you append data to the packet, therefore it should never be stored. The return pointer is a <code>nullptr</code> if the packet is empty.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Pointer to the data</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a0fae6eccf2ca704fc5099cd90a9f56f7" title="Get the size of the data contained in the packet.">getDataSize</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0fae6eccf2ca704fc5099cd90a9f56f7" name="a0fae6eccf2ca704fc5099cd90a9f56f7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0fae6eccf2ca704fc5099cd90a9f56f7">◆ </a></span>getDataSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::size_t sf::Packet::getDataSize </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the size of the data contained in the packet. </p>
|
|
<p>This function returns the number of bytes pointed to by what <code>getData</code> returns.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Data size, in bytes</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a998b70df024bee4792e2ecdc915ae46e" title="Get a pointer to the data contained in the packet.">getData</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5c2dc9878afaf30e88d922776201f6c3" name="a5c2dc9878afaf30e88d922776201f6c3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5c2dc9878afaf30e88d922776201f6c3">◆ </a></span>getReadPosition()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::size_t sf::Packet::getReadPosition </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the current reading position in the packet. </p>
|
|
<p>The next read operation will read data from this position</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The byte offset of the current read position</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a7dd6e429b87520008326c4d71f1cf011" title="Append data to the end of the packet.">append</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab71a31ef0f1d5d856de6f9fc75434128" name="ab71a31ef0f1d5d856de6f9fc75434128"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab71a31ef0f1d5d856de6f9fc75434128">◆ </a></span>onReceive()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void sf::Packet::onReceive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>data</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>size</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Called after the packet is received over the network. </p>
|
|
<p>This function can be defined by derived classes to transform the data after it is received; this can be used for decompression, decryption, etc. The function receives a pointer to the received data, and must fill the packet with the transformed bytes. The default implementation fills the packet directly without transforming the data.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Pointer to the received bytes </td></tr>
|
|
<tr><td class="paramname">size</td><td>Number of bytes</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#af0003506bcb290407dcf5fe7f13a887d" title="Called before the packet is sent over the network.">onSend</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af0003506bcb290407dcf5fe7f13a887d" name="af0003506bcb290407dcf5fe7f13a887d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af0003506bcb290407dcf5fe7f13a887d">◆ </a></span>onSend()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual const void * sf::Packet::onSend </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::size_t &</td> <td class="paramname"><span class="paramname"><em>size</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Called before the packet is sent over the network. </p>
|
|
<p>This function can be defined by derived classes to transform the data before it is sent; this can be used for compression, encryption, etc. The function must return a pointer to the modified data, as well as the number of bytes pointed. The default implementation provides the packet's data without transforming it.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">size</td><td>Variable to fill with the size of data to send</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Pointer to the array of bytes to send</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#ab71a31ef0f1d5d856de6f9fc75434128" title="Called after the packet is received over the network.">onReceive</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8863ff08b73f728a341c775758abbfb4" name="a8863ff08b73f728a341c775758abbfb4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8863ff08b73f728a341c775758abbfb4">◆ </a></span>operator bool()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::Packet::operator bool </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Test the validity of the packet, for reading. </p>
|
|
<p>This operator allows to test the packet as a boolean variable, to check if a reading operation was successful.</p>
|
|
<p>A packet will be in an invalid state if it has no more data to read.</p>
|
|
<p>This behavior is the same as standard C++ streams.</p>
|
|
<p>Usage example: </p><div class="fragment"><div class="line"><span class="keywordtype">float</span> x;</div>
|
|
<div class="line">packet >> x;</div>
|
|
<div class="line"><span class="keywordflow">if</span> (packet)</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> <span class="comment">// ok, x was extracted successfully</span></div>
|
|
<div class="line">}</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="comment">// -- or --</span></div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="keywordtype">float</span> x;</div>
|
|
<div class="line"><span class="keywordflow">if</span> (packet >> x)</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> <span class="comment">// ok, x was extracted successfully</span></div>
|
|
<div class="line">}</div>
|
|
</div><!-- fragment --><p>Don't focus on the return type, it's equivalent to bool but it disallows unwanted implicit conversions to integer or pointer types.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if last data extraction from packet was successful</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a61e354fa670da053907c14b738839560" title="Tell if the reading position has reached the end of the packet.">endOfPacket</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae02c874e0aac18a0497fca982a8f9083" name="ae02c874e0aac18a0497fca982a8f9083"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae02c874e0aac18a0497fca982a8f9083">◆ </a></span>operator<<() <span class="overload">[1/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Overload of <code>operator<<</code> to write data into the packet. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a94522071d95189ddff1ae7ca832695ff" name="a94522071d95189ddff1ae7ca832695ff"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a94522071d95189ddff1ae7ca832695ff">◆ </a></span>operator<<() <span class="overload">[2/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac45aab054ddee7de9599bc3b2d8e025f" name="ac45aab054ddee7de9599bc3b2d8e025f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac45aab054ddee7de9599bc3b2d8e025f">◆ </a></span>operator<<() <span class="overload">[3/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a97acaefaee7d3ffb36f4e8a00d4c3970" name="a97acaefaee7d3ffb36f4e8a00d4c3970"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a97acaefaee7d3ffb36f4e8a00d4c3970">◆ </a></span>operator<<() <span class="overload">[4/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::wstring &</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5ef2e3308b93b80214b42a7d4683704a" name="a5ef2e3308b93b80214b42a7d4683704a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5ef2e3308b93b80214b42a7d4683704a">◆ </a></span>operator<<() <span class="overload">[5/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac5a13e3280cac77799f7fdadfe3e37b6" name="ac5a13e3280cac77799f7fdadfe3e37b6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac5a13e3280cac77799f7fdadfe3e37b6">◆ </a></span>operator<<() <span class="overload">[6/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const wchar_t *</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abee2df335bdc3ab40521248cdb187c02" name="abee2df335bdc3ab40521248cdb187c02"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abee2df335bdc3ab40521248cdb187c02">◆ </a></span>operator<<() <span class="overload">[7/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acf1a231e48452a1cd55af2c027a1c1ee" name="acf1a231e48452a1cd55af2c027a1c1ee"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acf1a231e48452a1cd55af2c027a1c1ee">◆ </a></span>operator<<() <span class="overload">[8/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afb0fa0fcdac192af1dcc474ab3771c0e" name="afb0fa0fcdac192af1dcc474ab3771c0e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afb0fa0fcdac192af1dcc474ab3771c0e">◆ </a></span>operator<<() <span class="overload">[9/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::int16_t</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad89227a67ffd0526f275cd05888a4269" name="ad89227a67ffd0526f275cd05888a4269"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad89227a67ffd0526f275cd05888a4269">◆ </a></span>operator<<() <span class="overload">[10/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::int32_t</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1f9d66489418bc05810b9e9ca8c21ba8" name="a1f9d66489418bc05810b9e9ca8c21ba8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1f9d66489418bc05810b9e9ca8c21ba8">◆ </a></span>operator<<() <span class="overload">[11/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::int64_t</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac63b8ccaa7e08ad0b2c32f15fbe31488" name="ac63b8ccaa7e08ad0b2c32f15fbe31488"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac63b8ccaa7e08ad0b2c32f15fbe31488">◆ </a></span>operator<<() <span class="overload">[12/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::int8_t</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a345afa315ea0b638ea0c2be666c0243b" name="a345afa315ea0b638ea0c2be666c0243b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a345afa315ea0b638ea0c2be666c0243b">◆ </a></span>operator<<() <span class="overload">[13/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::uint16_t</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0ac5e4f188a74301e310751d9d0804ba" name="a0ac5e4f188a74301e310751d9d0804ba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0ac5e4f188a74301e310751d9d0804ba">◆ </a></span>operator<<() <span class="overload">[14/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::uint32_t</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a95233cc63de8733eb451de7107e834a0" name="a95233cc63de8733eb451de7107e834a0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a95233cc63de8733eb451de7107e834a0">◆ </a></span>operator<<() <span class="overload">[15/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::uint64_t</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7542b9842e51f3ea4690fff9e6cb267f" name="a7542b9842e51f3ea4690fff9e6cb267f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7542b9842e51f3ea4690fff9e6cb267f">◆ </a></span>operator<<() <span class="overload">[16/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::uint8_t</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a03e3f3f9b8fbef859be8901b5b215bb2" name="a03e3f3f9b8fbef859be8901b5b215bb2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a03e3f3f9b8fbef859be8901b5b215bb2">◆ </a></span>operator=() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Packet.html">Packet</a> &</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Copy assignment. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a256e13eac488cdc9d03eff2da08f529c" name="a256e13eac488cdc9d03eff2da08f529c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a256e13eac488cdc9d03eff2da08f529c">◆ </a></span>operator=() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classsf_1_1Packet.html">Packet</a> &&</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Move assignment. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8b6403506fec6b69f033278de33c8145" name="a8b6403506fec6b69f033278de33c8145"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8b6403506fec6b69f033278de33c8145">◆ </a></span>operator>>() <span class="overload">[1/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator>> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool &</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Overload of <code>operator>></code> to read data from the packet. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaed01fec1a3eae27a028506195607f82" name="aaed01fec1a3eae27a028506195607f82"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaed01fec1a3eae27a028506195607f82">◆ </a></span>operator>>() <span class="overload">[2/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator>> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1854ca771105fb281edf349fc6507c73" name="a1854ca771105fb281edf349fc6507c73"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1854ca771105fb281edf349fc6507c73">◆ </a></span>operator>>() <span class="overload">[3/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator>> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">double &</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a741849607d428e93c532e11eadcc39f1" name="a741849607d428e93c532e11eadcc39f1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a741849607d428e93c532e11eadcc39f1">◆ </a></span>operator>>() <span class="overload">[4/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator>> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float &</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3113773cdbb07e18f8ba9a8d3e846f85" name="a3113773cdbb07e18f8ba9a8d3e846f85"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3113773cdbb07e18f8ba9a8d3e846f85">◆ </a></span>operator>>() <span class="overload">[5/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator>> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::int16_t &</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a534f51c0d24174f2ef1d72616ed8ba92" name="a534f51c0d24174f2ef1d72616ed8ba92"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a534f51c0d24174f2ef1d72616ed8ba92">◆ </a></span>operator>>() <span class="overload">[6/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator>> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::int32_t &</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a10fc2ab9f5fb7b8aa09ea3e016335bf1" name="a10fc2ab9f5fb7b8aa09ea3e016335bf1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a10fc2ab9f5fb7b8aa09ea3e016335bf1">◆ </a></span>operator>>() <span class="overload">[7/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator>> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::int64_t &</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae44f412c1b4e3bffffe7a65ff70f7f2a" name="ae44f412c1b4e3bffffe7a65ff70f7f2a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae44f412c1b4e3bffffe7a65ff70f7f2a">◆ </a></span>operator>>() <span class="overload">[8/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator>> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::int8_t &</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a60484dff69997db11e2d4ab3704ab921" name="a60484dff69997db11e2d4ab3704ab921"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a60484dff69997db11e2d4ab3704ab921">◆ </a></span>operator>>() <span class="overload">[9/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator>> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::string &</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9f53a2c54cf09727285f3d953933c372" name="a9f53a2c54cf09727285f3d953933c372"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9f53a2c54cf09727285f3d953933c372">◆ </a></span>operator>>() <span class="overload">[10/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator>> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::uint16_t &</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5fb6d71162e35662e70ec229ca6cc3ec" name="a5fb6d71162e35662e70ec229ca6cc3ec"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5fb6d71162e35662e70ec229ca6cc3ec">◆ </a></span>operator>>() <span class="overload">[11/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator>> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::uint32_t &</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a819152d58f0e87111e6ff5eda34e9d6b" name="a819152d58f0e87111e6ff5eda34e9d6b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a819152d58f0e87111e6ff5eda34e9d6b">◆ </a></span>operator>>() <span class="overload">[12/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator>> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::uint64_t &</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab64e609a2cf46356f5f9a00f36111090" name="ab64e609a2cf46356f5f9a00f36111090"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab64e609a2cf46356f5f9a00f36111090">◆ </a></span>operator>>() <span class="overload">[13/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator>> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::uint8_t &</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8621056995c32bcf59809e2aecf08635" name="a8621056995c32bcf59809e2aecf08635"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8621056995c32bcf59809e2aecf08635">◆ </a></span>operator>>() <span class="overload">[14/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator>> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::wstring &</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a27d0ae92891dbf8a7914e5d5232940d0" name="a27d0ae92891dbf8a7914e5d5232940d0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a27d0ae92891dbf8a7914e5d5232940d0">◆ </a></span>operator>>() <span class="overload">[15/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator>> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classsf_1_1String.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8805e66013f9f84ec8a883e42ae259d4" name="a8805e66013f9f84ec8a883e42ae259d4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8805e66013f9f84ec8a883e42ae259d4">◆ </a></span>operator>>() <span class="overload">[16/16]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Packet.html">Packet</a> & sf::Packet::operator>> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wchar_t *</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
|
|
<a id="aa8b32310b01d4bb702d6bcb969d5f130" name="aa8b32310b01d4bb702d6bcb969d5f130"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa8b32310b01d4bb702d6bcb969d5f130">◆ </a></span>TcpSocket</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">friend class <a class="el" href="classsf_1_1TcpSocket.html">TcpSocket</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Packet_8hpp_source.html#l00368">368</a> of file <a class="el" href="Packet_8hpp_source.html">Packet.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae128c6687ced82c6157c5f865f8dec5c" name="ae128c6687ced82c6157c5f865f8dec5c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae128c6687ced82c6157c5f865f8dec5c">◆ </a></span>UdpSocket</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">friend class <a class="el" href="classsf_1_1UdpSocket.html">UdpSocket</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Packet_8hpp_source.html#l00369">369</a> of file <a class="el" href="Packet_8hpp_source.html">Packet.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Packet_8hpp_source.html">Packet.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div>
|
|
<div id="footer-container">
|
|
<div id="footer">
|
|
SFML is licensed under the terms and conditions of the <a href="https://www.sfml-dev.org/license.php">zlib/png license</a>.<br />
|
|
Copyright © Laurent Gomila ::
|
|
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> ::
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|