-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathUdpSocket_8hpp_source.htm
More file actions
142 lines (142 loc) · 18.2 KB
/
Copy pathUdpSocket_8hpp_source.htm
File metadata and controls
142 lines (142 loc) · 18.2 KB
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
<!doctype html>
<html class="no-js" lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpp3ds · Documentation</title>
<link rel="stylesheet" href="../css/app.css" />
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
<script src="../bower_components/modernizr/modernizr.js"></script>
</head>
<body>
<div id="topnav" class="text-center">
<dl class="sub-nav">
<dd id="navlogo"><a href="/">
<img src="../img/logo.svg" />
</a></dd>
<dd><a href="/#what">What is it?</a></dd>
<dd><a href="/#download">Download</a></dd>
<dd><a href="/#faqs">FAQs</a></dd>
<dd class="active"><a href="/docs">Docs</a></dd>
</dl>
</div>
<div id="content">
<!-- Generated by Doxygen 1.8.10 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.htm"><span>Main Page</span></a></li>
<li><a href="modules.htm"><span>Modules</span></a></li>
<li><a href="annotated.htm"><span>Classes</span></a></li>
<li class="current"><a href="files.htm"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.htm"><span>File List</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_0b93ed46ee854382aab85c778b89946e.htm">include</a></li><li class="navelem"><a class="el" href="dir_18d409fe281a3b15bd325ab753ead42a.htm">cpp3ds</a></li><li class="navelem"><a class="el" href="dir_fced38657a416244b2be3c8c8a080720.htm">Network</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">UdpSocket.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// SFML - Simple and Fast Multimedia Library</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">//</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// This software is provided 'as-is', without any express or implied warranty.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// In no event will the authors be held liable for any damages arising from the use of this software.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// Permission is granted to anyone to use this software for any purpose,</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// including commercial applications, and to alter it and redistribute it freely,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// subject to the following restrictions:</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">//</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// 1. The origin of this software must not be misrepresented;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// you must not claim that you wrote the original software.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// If you use this software in a product, an acknowledgment</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// in the product documentation would be appreciated but is not required.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">//</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// 2. Altered source versions must be plainly marked as such,</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// and must not be misrepresented as being the original software.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">//</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// 3. This notice may not be removed or altered from any source distribution.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">//</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef CPP3DS_UDPSOCKET_HPP</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#define CPP3DS_UDPSOCKET_HPP</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// Headers</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span><span class="preprocessor">#include <cpp3ds/Network/Socket.hpp></span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <vector></span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">namespace </span><a class="code" href="namespacecpp3ds.htm">cpp3ds</a></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> {</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">class </span>IpAddress;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">class </span>Packet;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classcpp3ds_1_1UdpSocket.htm"> 44</a></span> <span class="keyword">class </span><a class="code" href="classcpp3ds_1_1UdpSocket.htm">UdpSocket</a> : <span class="keyword">public</span> <a class="code" href="classcpp3ds_1_1Socket.htm">Socket</a></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> {</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// Constants</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"></span> <span class="keyword">enum</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  {</div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classcpp3ds_1_1UdpSocket.htm#a0a12711699d84d12f7b3f24484bf5496a25c797fae3883981ad821a25cb480630"> 53</a></span>  <a class="code" href="classcpp3ds_1_1UdpSocket.htm#a0a12711699d84d12f7b3f24484bf5496a25c797fae3883981ad821a25cb480630">MaxDatagramSize</a> = 65507 </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  };</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <a class="code" href="classcpp3ds_1_1UdpSocket.htm#a252b60a0f1fca376945af4d115ec92b0">UdpSocket</a>();</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <a class="code" href="classcpp3ds_1_1UdpSocket.htm#a716333ec77fa1694858a198efe4ef8bc">getLocalPort</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <a class="code" href="classcpp3ds_1_1Socket.htm#a601dfefbd970d87e98783aaa86bf1a1b">Status</a> <a class="code" href="classcpp3ds_1_1UdpSocket.htm#af3ac92e27cc335d604da7ae5b8f5a46a">bind</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> port);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordtype">void</span> <a class="code" href="classcpp3ds_1_1UdpSocket.htm#a478c0327eb26ace648400d1ab5ac9bc7">unbind</a>();</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <a class="code" href="classcpp3ds_1_1Socket.htm#a601dfefbd970d87e98783aaa86bf1a1b">Status</a> <a class="code" href="classcpp3ds_1_1UdpSocket.htm#aac5de9f83bd7c3b39255661e31c72d9d">send</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* data, std::size_t size, <span class="keyword">const</span> <a class="code" href="classcpp3ds_1_1IpAddress.htm">IpAddress</a>& remoteAddress, <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> remotePort);</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <a class="code" href="classcpp3ds_1_1Socket.htm#a601dfefbd970d87e98783aaa86bf1a1b">Status</a> <a class="code" href="classcpp3ds_1_1UdpSocket.htm#a8fce34b94706598da3b7cf7ad09f1650">receive</a>(<span class="keywordtype">void</span>* data, std::size_t size, std::size_t& received, <a class="code" href="classcpp3ds_1_1IpAddress.htm">IpAddress</a>& remoteAddress, <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span>& remotePort);</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <a class="code" href="classcpp3ds_1_1Socket.htm#a601dfefbd970d87e98783aaa86bf1a1b">Status</a> <a class="code" href="classcpp3ds_1_1UdpSocket.htm#aac5de9f83bd7c3b39255661e31c72d9d">send</a>(<a class="code" href="classcpp3ds_1_1Packet.htm">Packet</a>& packet, <span class="keyword">const</span> <a class="code" href="classcpp3ds_1_1IpAddress.htm">IpAddress</a>& remoteAddress, <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> remotePort);</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <a class="code" href="classcpp3ds_1_1Socket.htm#a601dfefbd970d87e98783aaa86bf1a1b">Status</a> <a class="code" href="classcpp3ds_1_1UdpSocket.htm#a8fce34b94706598da3b7cf7ad09f1650">receive</a>(<a class="code" href="classcpp3ds_1_1Packet.htm">Packet</a>& packet, <a class="code" href="classcpp3ds_1_1IpAddress.htm">IpAddress</a>& remoteAddress, <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span>& remotePort);</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> </div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <span class="comment">// Member data</span></div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"></span> std::vector<char> m_buffer; </div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> };</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> } <span class="comment">// namespace cpp3ds</span></div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> </div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> </div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="preprocessor">#endif // CPP3DS_UDPSOCKET_HPP</span></div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> </div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> </div>
<div class="ttc" id="classcpp3ds_1_1IpAddress_htm"><div class="ttname"><a href="classcpp3ds_1_1IpAddress.htm">cpp3ds::IpAddress</a></div><div class="ttdoc">Encapsulate an IPv4 network address. </div><div class="ttdef"><b>Definition:</b> <a href="IpAddress_8hpp_source.htm#l00043">IpAddress.hpp:43</a></div></div>
<div class="ttc" id="classcpp3ds_1_1UdpSocket_htm"><div class="ttname"><a href="classcpp3ds_1_1UdpSocket.htm">cpp3ds::UdpSocket</a></div><div class="ttdoc">Specialized socket using the UDP protocol. </div><div class="ttdef"><b>Definition:</b> <a href="UdpSocket_8hpp_source.htm#l00044">UdpSocket.hpp:44</a></div></div>
<div class="ttc" id="namespacecpp3ds_htm"><div class="ttname"><a href="namespacecpp3ds.htm">cpp3ds</a></div><div class="ttdef"><b>Definition:</b> <a href="AlResource_8hpp_source.htm#l00033">AlResource.hpp:33</a></div></div>
<div class="ttc" id="classcpp3ds_1_1Packet_htm"><div class="ttname"><a href="classcpp3ds_1_1Packet.htm">cpp3ds::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.htm#l00047">Packet.hpp:47</a></div></div>
<div class="ttc" id="classcpp3ds_1_1Socket_htm"><div class="ttname"><a href="classcpp3ds_1_1Socket.htm">cpp3ds::Socket</a></div><div class="ttdoc">Base class for all the socket types. </div><div class="ttdef"><b>Definition:</b> <a href="Socket_8hpp_source.htm#l00044">Socket.hpp:44</a></div></div>
<div class="ttc" id="classcpp3ds_1_1UdpSocket_htm_af3ac92e27cc335d604da7ae5b8f5a46a"><div class="ttname"><a href="classcpp3ds_1_1UdpSocket.htm#af3ac92e27cc335d604da7ae5b8f5a46a">cpp3ds::UdpSocket::bind</a></div><div class="ttdeci">Status bind(unsigned short port)</div><div class="ttdoc">Bind the socket to a specific port. </div></div>
<div class="ttc" id="classcpp3ds_1_1UdpSocket_htm_a716333ec77fa1694858a198efe4ef8bc"><div class="ttname"><a href="classcpp3ds_1_1UdpSocket.htm#a716333ec77fa1694858a198efe4ef8bc">cpp3ds::UdpSocket::getLocalPort</a></div><div class="ttdeci">unsigned short getLocalPort() const </div><div class="ttdoc">Get the port to which the socket is bound locally. </div></div>
<div class="ttc" id="classcpp3ds_1_1UdpSocket_htm_aac5de9f83bd7c3b39255661e31c72d9d"><div class="ttname"><a href="classcpp3ds_1_1UdpSocket.htm#aac5de9f83bd7c3b39255661e31c72d9d">cpp3ds::UdpSocket::send</a></div><div class="ttdeci">Status send(const void *data, std::size_t size, const IpAddress &remoteAddress, unsigned short remotePort)</div><div class="ttdoc">Send raw data to a remote peer. </div></div>
<div class="ttc" id="classcpp3ds_1_1UdpSocket_htm_a8fce34b94706598da3b7cf7ad09f1650"><div class="ttname"><a href="classcpp3ds_1_1UdpSocket.htm#a8fce34b94706598da3b7cf7ad09f1650">cpp3ds::UdpSocket::receive</a></div><div class="ttdeci">Status receive(void *data, std::size_t size, std::size_t &received, IpAddress &remoteAddress, unsigned short &remotePort)</div><div class="ttdoc">Receive raw data from a remote peer. </div></div>
<div class="ttc" id="classcpp3ds_1_1UdpSocket_htm_a478c0327eb26ace648400d1ab5ac9bc7"><div class="ttname"><a href="classcpp3ds_1_1UdpSocket.htm#a478c0327eb26ace648400d1ab5ac9bc7">cpp3ds::UdpSocket::unbind</a></div><div class="ttdeci">void unbind()</div><div class="ttdoc">Unbind the socket from the local port to which it is bound. </div></div>
<div class="ttc" id="classcpp3ds_1_1UdpSocket_htm_a0a12711699d84d12f7b3f24484bf5496a25c797fae3883981ad821a25cb480630"><div class="ttname"><a href="classcpp3ds_1_1UdpSocket.htm#a0a12711699d84d12f7b3f24484bf5496a25c797fae3883981ad821a25cb480630">cpp3ds::UdpSocket::MaxDatagramSize</a></div><div class="ttdoc">The maximum number of bytes that can be sent in a single UDP datagram. </div><div class="ttdef"><b>Definition:</b> <a href="UdpSocket_8hpp_source.htm#l00053">UdpSocket.hpp:53</a></div></div>
<div class="ttc" id="classcpp3ds_1_1Socket_htm_a601dfefbd970d87e98783aaa86bf1a1b"><div class="ttname"><a href="classcpp3ds_1_1Socket.htm#a601dfefbd970d87e98783aaa86bf1a1b">cpp3ds::Socket::Status</a></div><div class="ttdeci">Status</div><div class="ttdoc">Status codes that may be returned by socket functions. </div><div class="ttdef"><b>Definition:</b> <a href="Socket_8hpp_source.htm#l00052">Socket.hpp:52</a></div></div>
<div class="ttc" id="classcpp3ds_1_1UdpSocket_htm_a252b60a0f1fca376945af4d115ec92b0"><div class="ttname"><a href="classcpp3ds_1_1UdpSocket.htm#a252b60a0f1fca376945af4d115ec92b0">cpp3ds::UdpSocket::UdpSocket</a></div><div class="ttdeci">UdpSocket()</div><div class="ttdoc">Default constructor. </div></div>
</div><!-- fragment --></div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
SFML Copyright © Laurent Gomila
</div>
</div>
</body>
</html>