-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_packet_8h_source.html
160 lines (160 loc) · 19.7 KB
/
_packet_8h_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Gamedev Framework (gf): Packet.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="gf_logo.png"/></td>
<td id="projectalign">
<div id="projectname">Gamedev Framework (gf)<span id="projectnumber"> 0.21.0</span>
</div>
<div id="projectbrief">A C++17 framework for 2D games</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_6d069d519ae9d12fa11dd8e685586b60.html">gf</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">Packet.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Gamedev Framework (gf)</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * Copyright (C) 2016-2021 Julien Bernard</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * This software is provided 'as-is', without any express or implied</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * warranty. In no event will the authors be held liable for any damages</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * arising from the use of this software.</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * Permission is granted to anyone to use this software for any purpose,</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * including commercial applications, and to alter it and redistribute it</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * freely, subject to the following restrictions:</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> *</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * 1. The origin of this software must not be misrepresented; you must not</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * claim that you wrote the original software. If you use this software</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * in a product, an acknowledgment in the product documentation would be</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * appreciated but is not required.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * 2. Altered source versions must be plainly marked as such, and must not be</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> * misrepresented as being the original software.</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"> * 3. This notice may not be removed or altered from any source distribution.</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"> */</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#ifndef GF_PACKET_H</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#define GF_PACKET_H</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include <cassert></span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <cstdint></span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include <vector></span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include "Id.h"</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include "NetApi.h"</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include "Packet.h"</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include "Streams.h"</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#include "Serialization.h"</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#include "SerializationOps.h"</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacegf.html">gf</a> {</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="keyword">inline</span> <span class="keyword">namespace </span>v1 {</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="structgf_1_1_packet.html"> 44</a></span> <span class="keyword">struct </span>GF_NET_API <a class="code hl_struct" href="structgf_1_1_packet.html">Packet</a> {</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="structgf_1_1_packet.html#ab830bde70b7b075cddaf27fe633849f2"> 45</a></span> <a class="code hl_typedef" href="group__core__vocabulary.html#ga375ce9d7d861b67c78398d51c1769410">Id</a> type = <a class="code hl_variable" href="group__core__vocabulary.html#ga63cc77139085fae86503ed552b1c52ee">InvalidId</a>; </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="structgf_1_1_packet.html#a3478711569785a7ad6740589a54b0614"> 46</a></span> std::vector<uint8_t> <a class="code hl_variable" href="structgf_1_1_packet.html#a3478711569785a7ad6740589a54b0614">bytes</a>; </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="structgf_1_1_packet.html#a5b64ba67a25901093547d51d0aa438f7"> 51</a></span> <a class="code hl_typedef" href="group__core__vocabulary.html#ga375ce9d7d861b67c78398d51c1769410">Id</a> <a class="code hl_function" href="structgf_1_1_packet.html#a5b64ba67a25901093547d51d0aa438f7">getType</a>() {</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordflow">if</span> (type != <a class="code hl_variable" href="group__core__vocabulary.html#ga63cc77139085fae86503ed552b1c52ee">InvalidId</a>) {</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keywordflow">return</span> type;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> }</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <a class="code hl_class" href="classgf_1_1_buffer_input_stream.html">BufferInputStream</a> stream(&bytes);</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <a class="code hl_class" href="classgf_1_1_deserializer.html">Deserializer</a> deserializer(stream);</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> deserializer | type;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keywordflow">return</span> type;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> }</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="structgf_1_1_packet.html#afd90d1ff3d887097ed96f5138633b42c"> 66</a></span> <a class="code hl_enumvalue" href="group__graphics__devices.html#gga795d7d5e2f2a4f38b16b95e0e78cb626ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> <a class="code hl_function" href="structgf_1_1_packet.html#afd90d1ff3d887097ed96f5138633b42c">as</a>() {</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <a class="code hl_class" href="classgf_1_1_buffer_input_stream.html">BufferInputStream</a> stream(&bytes);</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <a class="code hl_class" href="classgf_1_1_deserializer.html">Deserializer</a> deserializer(stream);</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <a class="code hl_enumvalue" href="group__graphics__devices.html#gga795d7d5e2f2a4f38b16b95e0e78cb626ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> data;</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> deserializer | type | data;</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> assert(T::type == type);</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="keywordflow">return</span> data;</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> }</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"><a class="line" href="structgf_1_1_packet.html#aee416d94aa991ba805d1bf7d38e3bcf9"> 80</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="structgf_1_1_packet.html#aee416d94aa991ba805d1bf7d38e3bcf9">is</a>(<span class="keyword">const</span> T& data) {</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> bytes.clear();</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> type = T::type;</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <a class="code hl_class" href="classgf_1_1_buffer_output_stream.html">gf::BufferOutputStream</a> stream(&bytes);</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <a class="code hl_class" href="classgf_1_1_serializer.html">gf::Serializer</a> serializer(stream);</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> serializer | type | <span class="keyword">const_cast<</span><a class="code hl_enumvalue" href="group__graphics__devices.html#gga795d7d5e2f2a4f38b16b95e0e78cb626ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a>&<span class="keyword">></span>(data);</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> }</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> };</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span>}</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span>}</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span><span class="preprocessor">#endif </span><span class="comment">// GF_PACKET_H</span></div>
<div class="ttc" id="aclassgf_1_1_buffer_input_stream_html"><div class="ttname"><a href="classgf_1_1_buffer_input_stream.html">gf::BufferInputStream</a></div><div class="ttdoc">Buffer input stream.</div><div class="ttdef"><b>Definition:</b> Streams.h:140</div></div>
<div class="ttc" id="aclassgf_1_1_buffer_output_stream_html"><div class="ttname"><a href="classgf_1_1_buffer_output_stream.html">gf::BufferOutputStream</a></div><div class="ttdoc">Buffer output stream.</div><div class="ttdef"><b>Definition:</b> Streams.h:266</div></div>
<div class="ttc" id="aclassgf_1_1_deserializer_html"><div class="ttname"><a href="classgf_1_1_deserializer.html">gf::Deserializer</a></div><div class="ttdoc">A deserializer from a binary file.</div><div class="ttdef"><b>Definition:</b> Serialization.h:151</div></div>
<div class="ttc" id="aclassgf_1_1_serializer_html"><div class="ttname"><a href="classgf_1_1_serializer.html">gf::Serializer</a></div><div class="ttdoc">A serializer to a binary file.</div><div class="ttdef"><b>Definition:</b> Serialization.h:43</div></div>
<div class="ttc" id="agroup__core__vocabulary_html_ga375ce9d7d861b67c78398d51c1769410"><div class="ttname"><a href="group__core__vocabulary.html#ga375ce9d7d861b67c78398d51c1769410">gf::Id</a></div><div class="ttdeci">uint64_t Id</div><div class="ttdoc">An identifier.</div><div class="ttdef"><b>Definition:</b> Id.h:37</div></div>
<div class="ttc" id="agroup__core__vocabulary_html_ga63cc77139085fae86503ed552b1c52ee"><div class="ttname"><a href="group__core__vocabulary.html#ga63cc77139085fae86503ed552b1c52ee">gf::InvalidId</a></div><div class="ttdeci">constexpr Id InvalidId</div><div class="ttdoc">The invalid id (which is 0)</div><div class="ttdef"><b>Definition:</b> Id.h:43</div></div>
<div class="ttc" id="agroup__graphics__devices_html_gga795d7d5e2f2a4f38b16b95e0e78cb626ab9ece18c950afbfa6b0fdbfa4ff731d3"><div class="ttname"><a href="group__graphics__devices.html#gga795d7d5e2f2a4f38b16b95e0e78cb626ab9ece18c950afbfa6b0fdbfa4ff731d3">gf::Scancode::T</a></div><div class="ttdeci">@ T</div></div>
<div class="ttc" id="anamespacegf_html"><div class="ttname"><a href="namespacegf.html">gf</a></div><div class="ttdoc">The namespace for gf classes.</div><div class="ttdef"><b>Definition:</b> Action.h:35</div></div>
<div class="ttc" id="astructgf_1_1_packet_html"><div class="ttname"><a href="structgf_1_1_packet.html">gf::Packet</a></div><div class="ttdoc">A packet of bytes.</div><div class="ttdef"><b>Definition:</b> Packet.h:44</div></div>
<div class="ttc" id="astructgf_1_1_packet_html_a3478711569785a7ad6740589a54b0614"><div class="ttname"><a href="structgf_1_1_packet.html#a3478711569785a7ad6740589a54b0614">gf::Packet::bytes</a></div><div class="ttdeci">std::vector< uint8_t > bytes</div><div class="ttdoc">The bytes representing the object.</div><div class="ttdef"><b>Definition:</b> Packet.h:46</div></div>
<div class="ttc" id="astructgf_1_1_packet_html_a5b64ba67a25901093547d51d0aa438f7"><div class="ttname"><a href="structgf_1_1_packet.html#a5b64ba67a25901093547d51d0aa438f7">gf::Packet::getType</a></div><div class="ttdeci">Id getType()</div><div class="ttdoc">Get the type of the underlying bytes.</div><div class="ttdef"><b>Definition:</b> Packet.h:51</div></div>
<div class="ttc" id="astructgf_1_1_packet_html_aee416d94aa991ba805d1bf7d38e3bcf9"><div class="ttname"><a href="structgf_1_1_packet.html#aee416d94aa991ba805d1bf7d38e3bcf9">gf::Packet::is</a></div><div class="ttdeci">void is(const T &data)</div><div class="ttdoc">Serialize the object into bytes.</div><div class="ttdef"><b>Definition:</b> Packet.h:80</div></div>
<div class="ttc" id="astructgf_1_1_packet_html_afd90d1ff3d887097ed96f5138633b42c"><div class="ttname"><a href="structgf_1_1_packet.html#afd90d1ff3d887097ed96f5138633b42c">gf::Packet::as</a></div><div class="ttdeci">T as()</div><div class="ttdoc">Deserialize the underlying bytes into an object.</div><div class="ttdef"><b>Definition:</b> Packet.h:66</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3
</small></address>
</body>
</html>