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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>SFML - Simple and Fast Multimedia Library</title>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="tabs.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="logo">
<img src="./logo.jpg" width="770" height="200" title="SFML home" alt="SFML logo" />
</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.htm"><span>Main Page</span></a></li>
<li><a href="namespaces.htm"><span>Namespaces</span></a></li>
<li><a href="annotated.htm"><span>Classes</span></a></li>
<li class="current"><a href="files.htm"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.htm"><span>File List</span></a></li>
</ul>
</div>
<h1>SocketTCP.cpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
<a name="l00002"></a>00002 <span class="comment">//</span>
<a name="l00003"></a>00003 <span class="comment">// SFML - Simple and Fast Multimedia Library</span>
<a name="l00004"></a>00004 <span class="comment">// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)</span>
<a name="l00005"></a>00005 <span class="comment">//</span>
<a name="l00006"></a>00006 <span class="comment">// This software is provided 'as-is', without any express or implied warranty.</span>
<a name="l00007"></a>00007 <span class="comment">// In no event will the authors be held liable for any damages arising from the use of this software.</span>
<a name="l00008"></a>00008 <span class="comment">//</span>
<a name="l00009"></a>00009 <span class="comment">// Permission is granted to anyone to use this software for any purpose,</span>
<a name="l00010"></a>00010 <span class="comment">// including commercial applications, and to alter it and redistribute it freely,</span>
<a name="l00011"></a>00011 <span class="comment">// subject to the following restrictions:</span>
<a name="l00012"></a>00012 <span class="comment">//</span>
<a name="l00013"></a>00013 <span class="comment">// 1. The origin of this software must not be misrepresented;</span>
<a name="l00014"></a>00014 <span class="comment">// you must not claim that you wrote the original software.</span>
<a name="l00015"></a>00015 <span class="comment">// If you use this software in a product, an acknowledgment</span>
<a name="l00016"></a>00016 <span class="comment">// in the product documentation would be appreciated but is not required.</span>
<a name="l00017"></a>00017 <span class="comment">//</span>
<a name="l00018"></a>00018 <span class="comment">// 2. Altered source versions must be plainly marked as such,</span>
<a name="l00019"></a>00019 <span class="comment">// and must not be misrepresented as being the original software.</span>
<a name="l00020"></a>00020 <span class="comment">//</span>
<a name="l00021"></a>00021 <span class="comment">// 3. This notice may not be removed or altered from any source distribution.</span>
<a name="l00022"></a>00022 <span class="comment">//</span>
<a name="l00024"></a>00024 <span class="comment"></span>
<a name="l00026"></a>00026 <span class="comment">// Headers</span>
<a name="l00028"></a>00028 <span class="comment"></span><span class="preprocessor">#include <SFML/Network/SocketTCP.hpp></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <SFML/Network/IPAddress.hpp></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <SFML/Network/Packet.hpp></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <SFML/Network/SocketHelper.hpp></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <algorithm></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include <iostream></span>
<a name="l00034"></a>00034 <span class="preprocessor">#include <string.h></span>
<a name="l00035"></a>00035
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="preprocessor">#ifdef _MSC_VER</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor"> #pragma warning(disable : 4127) // "conditional expression is constant" generated by the FD_SET macro</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span>
<a name="l00041"></a>00041
<a name="l00042"></a>00042 <span class="keyword">namespace </span>sf
<a name="l00043"></a>00043 {
<a name="l00047"></a><a class="code" href="classsf_1_1SocketTCP.htm#098157a901a6f355b499085a3fb97afa">00047</a> <a class="code" href="classsf_1_1SocketTCP.htm#098157a901a6f355b499085a3fb97afa" title="Default constructor.">SocketTCP::SocketTCP</a>()
<a name="l00048"></a>00048 {
<a name="l00049"></a>00049 Create(<a class="code" href="classsf_1_1SocketHelper.htm#99e426a217cc8847264f837632b4e458" title="Return the value of the invalid socket.">SocketHelper::InvalidSocket</a>());
<a name="l00050"></a>00050 }
<a name="l00051"></a>00051
<a name="l00052"></a>00052
<a name="l00056"></a><a class="code" href="classsf_1_1SocketTCP.htm#a80f7711b15fe33a5c7005acedae43c9">00056</a> <span class="keywordtype">void</span> <a class="code" href="classsf_1_1SocketTCP.htm#a80f7711b15fe33a5c7005acedae43c9" title="Change the blocking state of the socket.">SocketTCP::SetBlocking</a>(<span class="keywordtype">bool</span> Blocking)
<a name="l00057"></a>00057 {
<a name="l00058"></a>00058 <span class="comment">// Make sure our socket is valid</span>
<a name="l00059"></a>00059 <span class="keywordflow">if</span> (!<a class="code" href="classsf_1_1SocketTCP.htm#098d613057a72d9e5cfa76a77b5f7124" title="Check if the socket is in a valid state ; this function can be called any time to...">IsValid</a>())
<a name="l00060"></a>00060 Create();
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <a class="code" href="classsf_1_1SocketTCP.htm#a80f7711b15fe33a5c7005acedae43c9" title="Change the blocking state of the socket.">SocketHelper::SetBlocking</a>(mySocket, Blocking);
<a name="l00063"></a>00063 myIsBlocking = Blocking;
<a name="l00064"></a>00064 }
<a name="l00065"></a>00065
<a name="l00066"></a>00066
<a name="l00070"></a><a class="code" href="classsf_1_1SocketTCP.htm#dd590d0119fa8edbe8da1574b6c8f07f">00070</a> Socket::Status <a class="code" href="classsf_1_1SocketTCP.htm#dd590d0119fa8edbe8da1574b6c8f07f" title="Connect to another computer on a specified port.">SocketTCP::Connect</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> Port, <span class="keyword">const</span> <a class="code" href="classsf_1_1IPAddress.htm" title="IPAddress provides easy manipulation of IP v4 addresses.">IPAddress</a>& HostAddress, <span class="keywordtype">float</span> Timeout)
<a name="l00071"></a>00071 {
<a name="l00072"></a>00072 <span class="comment">// Make sure our socket is valid</span>
<a name="l00073"></a>00073 <span class="keywordflow">if</span> (!<a class="code" href="classsf_1_1SocketTCP.htm#098d613057a72d9e5cfa76a77b5f7124" title="Check if the socket is in a valid state ; this function can be called any time to...">IsValid</a>())
<a name="l00074"></a>00074 Create();
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="comment">// Build the host address</span>
<a name="l00077"></a>00077 sockaddr_in SockAddr;
<a name="l00078"></a>00078 memset(SockAddr.sin_zero, 0, <span class="keyword">sizeof</span>(SockAddr.sin_zero));
<a name="l00079"></a>00079 SockAddr.sin_addr.s_addr = inet_addr(HostAddress.<a class="code" href="classsf_1_1IPAddress.htm#76eadca85be545b5c1c68a4d0dc1c643" title="Get a string representation of the address.">ToString</a>().c_str());
<a name="l00080"></a>00080 SockAddr.sin_family = AF_INET;
<a name="l00081"></a>00081 SockAddr.sin_port = htons(Port);
<a name="l00082"></a>00082
<a name="l00083"></a>00083 <span class="keywordflow">if</span> (Timeout <= 0)
<a name="l00084"></a>00084 {
<a name="l00085"></a>00085 <span class="comment">// ----- We're not using a timeout : just try to connect -----</span>
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <span class="keywordflow">if</span> (connect(mySocket, reinterpret_cast<sockaddr*>(&SockAddr), <span class="keyword">sizeof</span>(SockAddr)) == -1)
<a name="l00088"></a>00088 {
<a name="l00089"></a>00089 <span class="comment">// Failed to connect</span>
<a name="l00090"></a>00090 <span class="keywordflow">return</span> <a class="code" href="classsf_1_1SocketHelper.htm#7e634801c53a5a1b2ee16757e2d96a83" title="Get the last socket error status.">SocketHelper::GetErrorStatus</a>();
<a name="l00091"></a>00091 }
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="comment">// Connection succeeded</span>
<a name="l00094"></a>00094 <span class="keywordflow">return</span> Socket::Done;
<a name="l00095"></a>00095 }
<a name="l00096"></a>00096 <span class="keywordflow">else</span>
<a name="l00097"></a>00097 {
<a name="l00098"></a>00098 <span class="comment">// ----- We're using a timeout : we'll need a few tricks to make it work -----</span>
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <span class="comment">// Save the previous blocking state</span>
<a name="l00101"></a>00101 <span class="keywordtype">bool</span> IsBlocking = myIsBlocking;
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="comment">// Switch to non-blocking to enable our connection timeout</span>
<a name="l00104"></a>00104 <span class="keywordflow">if</span> (IsBlocking)
<a name="l00105"></a>00105 <a class="code" href="classsf_1_1SocketTCP.htm#a80f7711b15fe33a5c7005acedae43c9" title="Change the blocking state of the socket.">SetBlocking</a>(<span class="keyword">false</span>);
<a name="l00106"></a>00106
<a name="l00107"></a>00107 <span class="comment">// Try to connect to host</span>
<a name="l00108"></a>00108 <span class="keywordflow">if</span> (connect(mySocket, reinterpret_cast<sockaddr*>(&SockAddr), <span class="keyword">sizeof</span>(SockAddr)) >= 0)
<a name="l00109"></a>00109 {
<a name="l00110"></a>00110 <span class="comment">// We got instantly connected! (it may no happen a lot...)</span>
<a name="l00111"></a>00111 <span class="keywordflow">return</span> Socket::Done;
<a name="l00112"></a>00112 }
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="comment">// Get the error status</span>
<a name="l00115"></a>00115 Socket::Status Status = <a class="code" href="classsf_1_1SocketHelper.htm#7e634801c53a5a1b2ee16757e2d96a83" title="Get the last socket error status.">SocketHelper::GetErrorStatus</a>();
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="comment">// If we were in non-blocking mode, return immediatly</span>
<a name="l00118"></a>00118 <span class="keywordflow">if</span> (!IsBlocking)
<a name="l00119"></a>00119 <span class="keywordflow">return</span> Status;
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="comment">// Otherwise, wait until something happens to our socket (success, timeout or error)</span>
<a name="l00122"></a>00122 <span class="keywordflow">if</span> (Status == Socket::NotReady)
<a name="l00123"></a>00123 {
<a name="l00124"></a>00124 <span class="comment">// Setup the selector</span>
<a name="l00125"></a>00125 fd_set <a class="code" href="classsf_1_1Selector.htm" title="Selector allow reading from multiple sockets without blocking.">Selector</a>;
<a name="l00126"></a>00126 FD_ZERO(&Selector);
<a name="l00127"></a>00127 FD_SET(mySocket, &Selector);
<a name="l00128"></a>00128
<a name="l00129"></a>00129 <span class="comment">// Setup the timeout</span>
<a name="l00130"></a>00130 timeval Time;
<a name="l00131"></a>00131 Time.tv_sec = <span class="keyword">static_cast<</span><span class="keywordtype">long</span><span class="keyword">></span>(Timeout);
<a name="l00132"></a>00132 Time.tv_usec = (<span class="keyword">static_cast<</span><span class="keywordtype">long</span><span class="keyword">></span>(Timeout * 1000) % 1000) * 1000;
<a name="l00133"></a>00133
<a name="l00134"></a>00134 <span class="comment">// Wait for something to write on our socket (which means that the connection request has returned)</span>
<a name="l00135"></a>00135 <span class="keywordflow">if</span> (select(static_cast<int>(mySocket + 1), NULL, &Selector, NULL, &Time) > 0)
<a name="l00136"></a>00136 {
<a name="l00137"></a>00137 <span class="comment">// At this point the connection may have been either accepted or refused.</span>
<a name="l00138"></a>00138 <span class="comment">// To know whether it's a success or a failure, we try to retrieve the name of the connected peer</span>
<a name="l00139"></a>00139 SocketHelper::LengthType Size = <span class="keyword">sizeof</span>(SockAddr);
<a name="l00140"></a>00140 <span class="keywordflow">if</span> (getpeername(mySocket, reinterpret_cast<sockaddr*>(&SockAddr), &Size) != -1)
<a name="l00141"></a>00141 {
<a name="l00142"></a>00142 <span class="comment">// Connection accepted</span>
<a name="l00143"></a>00143 Status = Socket::Done;
<a name="l00144"></a>00144 }
<a name="l00145"></a>00145 <span class="keywordflow">else</span>
<a name="l00146"></a>00146 {
<a name="l00147"></a>00147 <span class="comment">// Connection failed</span>
<a name="l00148"></a>00148 Status = <a class="code" href="classsf_1_1SocketHelper.htm#7e634801c53a5a1b2ee16757e2d96a83" title="Get the last socket error status.">SocketHelper::GetErrorStatus</a>();
<a name="l00149"></a>00149 }
<a name="l00150"></a>00150 }
<a name="l00151"></a>00151 <span class="keywordflow">else</span>
<a name="l00152"></a>00152 {
<a name="l00153"></a>00153 <span class="comment">// Failed to connect before timeout is over</span>
<a name="l00154"></a>00154 Status = <a class="code" href="classsf_1_1SocketHelper.htm#7e634801c53a5a1b2ee16757e2d96a83" title="Get the last socket error status.">SocketHelper::GetErrorStatus</a>();
<a name="l00155"></a>00155 }
<a name="l00156"></a>00156 }
<a name="l00157"></a>00157
<a name="l00158"></a>00158 <span class="comment">// Switch back to blocking mode</span>
<a name="l00159"></a>00159 <a class="code" href="classsf_1_1SocketTCP.htm#a80f7711b15fe33a5c7005acedae43c9" title="Change the blocking state of the socket.">SetBlocking</a>(<span class="keyword">true</span>);
<a name="l00160"></a>00160
<a name="l00161"></a>00161 <span class="keywordflow">return</span> Status;
<a name="l00162"></a>00162 }
<a name="l00163"></a>00163 }
<a name="l00164"></a>00164
<a name="l00165"></a>00165
<a name="l00169"></a><a class="code" href="classsf_1_1SocketTCP.htm#3153062e1fb2a7afe9e0ed80f9204b39">00169</a> <span class="keywordtype">bool</span> <a class="code" href="classsf_1_1SocketTCP.htm#3153062e1fb2a7afe9e0ed80f9204b39" title="Listen to a specified port for incoming data or connections.">SocketTCP::Listen</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> Port)
<a name="l00170"></a>00170 {
<a name="l00171"></a>00171 <span class="comment">// Make sure our socket is valid</span>
<a name="l00172"></a>00172 <span class="keywordflow">if</span> (!<a class="code" href="classsf_1_1SocketTCP.htm#098d613057a72d9e5cfa76a77b5f7124" title="Check if the socket is in a valid state ; this function can be called any time to...">IsValid</a>())
<a name="l00173"></a>00173 Create();
<a name="l00174"></a>00174
<a name="l00175"></a>00175 <span class="comment">// Build the address</span>
<a name="l00176"></a>00176 sockaddr_in SockAddr;
<a name="l00177"></a>00177 memset(SockAddr.sin_zero, 0, <span class="keyword">sizeof</span>(SockAddr.sin_zero));
<a name="l00178"></a>00178 SockAddr.sin_addr.s_addr = htonl(INADDR_ANY);
<a name="l00179"></a>00179 SockAddr.sin_family = AF_INET;
<a name="l00180"></a>00180 SockAddr.sin_port = htons(Port);
<a name="l00181"></a>00181
<a name="l00182"></a>00182 <span class="comment">// Bind the socket to the specified port</span>
<a name="l00183"></a>00183 <span class="keywordflow">if</span> (bind(mySocket, reinterpret_cast<sockaddr*>(&SockAddr), <span class="keyword">sizeof</span>(SockAddr)) == -1)
<a name="l00184"></a>00184 {
<a name="l00185"></a>00185 <span class="comment">// Not likely to happen, but...</span>
<a name="l00186"></a>00186 std::cerr << <span class="stringliteral">"Failed to bind socket to port "</span> << Port << std::endl;
<a name="l00187"></a>00187 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00188"></a>00188 }
<a name="l00189"></a>00189
<a name="l00190"></a>00190 <span class="comment">// Listen to the bound port</span>
<a name="l00191"></a>00191 <span class="keywordflow">if</span> (listen(mySocket, 0) == -1)
<a name="l00192"></a>00192 {
<a name="l00193"></a>00193 <span class="comment">// Oops, socket is deaf</span>
<a name="l00194"></a>00194 std::cerr << <span class="stringliteral">"Failed to listen to port "</span> << Port << std::endl;
<a name="l00195"></a>00195 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00196"></a>00196 }
<a name="l00197"></a>00197
<a name="l00198"></a>00198 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00199"></a>00199 }
<a name="l00200"></a>00200
<a name="l00201"></a>00201
<a name="l00206"></a><a class="code" href="classsf_1_1SocketTCP.htm#70beb8cda69c4e9212fd5987f0d04107">00206</a> Socket::Status <a class="code" href="classsf_1_1SocketTCP.htm#70beb8cda69c4e9212fd5987f0d04107" title="Wait for a connection (must be listening to a port).">SocketTCP::Accept</a>(<a class="code" href="classsf_1_1SocketTCP.htm" title="SocketTCP wraps a socket using TCP protocol to send data safely (but a bit slower)...">SocketTCP</a>& Connected, <a class="code" href="classsf_1_1IPAddress.htm" title="IPAddress provides easy manipulation of IP v4 addresses.">IPAddress</a>* Address)
<a name="l00207"></a>00207 {
<a name="l00208"></a>00208 <span class="comment">// Address that will be filled with client informations</span>
<a name="l00209"></a>00209 sockaddr_in ClientAddress;
<a name="l00210"></a>00210 SocketHelper::LengthType Length = <span class="keyword">sizeof</span>(ClientAddress);
<a name="l00211"></a>00211
<a name="l00212"></a>00212 <span class="comment">// Accept a new connection</span>
<a name="l00213"></a>00213 Connected = accept(mySocket, reinterpret_cast<sockaddr*>(&ClientAddress), &Length);
<a name="l00214"></a>00214
<a name="l00215"></a>00215 <span class="comment">// Check errors</span>
<a name="l00216"></a>00216 <span class="keywordflow">if</span> (!Connected.<a class="code" href="classsf_1_1SocketTCP.htm#098d613057a72d9e5cfa76a77b5f7124" title="Check if the socket is in a valid state ; this function can be called any time to...">IsValid</a>())
<a name="l00217"></a>00217 {
<a name="l00218"></a>00218 <span class="keywordflow">if</span> (Address)
<a name="l00219"></a>00219 *Address = <a class="code" href="classsf_1_1IPAddress.htm" title="IPAddress provides easy manipulation of IP v4 addresses.">IPAddress</a>();
<a name="l00220"></a>00220
<a name="l00221"></a>00221 <span class="keywordflow">return</span> <a class="code" href="classsf_1_1SocketHelper.htm#7e634801c53a5a1b2ee16757e2d96a83" title="Get the last socket error status.">SocketHelper::GetErrorStatus</a>();
<a name="l00222"></a>00222 }
<a name="l00223"></a>00223
<a name="l00224"></a>00224 <span class="comment">// Fill address if requested</span>
<a name="l00225"></a>00225 <span class="keywordflow">if</span> (Address)
<a name="l00226"></a>00226 *Address = <a class="code" href="classsf_1_1IPAddress.htm" title="IPAddress provides easy manipulation of IP v4 addresses.">IPAddress</a>(inet_ntoa(ClientAddress.sin_addr));
<a name="l00227"></a>00227
<a name="l00228"></a>00228 <span class="keywordflow">return</span> Socket::Done;
<a name="l00229"></a>00229 }
<a name="l00230"></a>00230
<a name="l00231"></a>00231
<a name="l00235"></a><a class="code" href="classsf_1_1SocketTCP.htm#4debed568966f75e3e63a70f08e67c21">00235</a> Socket::Status <a class="code" href="classsf_1_1SocketTCP.htm#4debed568966f75e3e63a70f08e67c21" title="Send an array of bytes to the host (must be connected first).">SocketTCP::Send</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* Data, std::size_t Size)
<a name="l00236"></a>00236 {
<a name="l00237"></a>00237 <span class="comment">// First check that socket is valid</span>
<a name="l00238"></a>00238 <span class="keywordflow">if</span> (!<a class="code" href="classsf_1_1SocketTCP.htm#098d613057a72d9e5cfa76a77b5f7124" title="Check if the socket is in a valid state ; this function can be called any time to...">IsValid</a>())
<a name="l00239"></a>00239 <span class="keywordflow">return</span> Socket::Error;
<a name="l00240"></a>00240
<a name="l00241"></a>00241 <span class="comment">// Check parameters</span>
<a name="l00242"></a>00242 <span class="keywordflow">if</span> (Data && Size)
<a name="l00243"></a>00243 {
<a name="l00244"></a>00244 <span class="comment">// Loop until every byte has been sent</span>
<a name="l00245"></a>00245 <span class="keywordtype">int</span> Sent = 0;
<a name="l00246"></a>00246 <span class="keywordtype">int</span> SizeToSend = <span class="keyword">static_cast<</span><span class="keywordtype">int</span><span class="keyword">></span>(Size);
<a name="l00247"></a>00247 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> Length = 0; Length < SizeToSend; Length += Sent)
<a name="l00248"></a>00248 {
<a name="l00249"></a>00249 <span class="comment">// Send a chunk of data</span>
<a name="l00250"></a>00250 Sent = send(mySocket, Data + Length, SizeToSend - Length, 0);
<a name="l00251"></a>00251
<a name="l00252"></a>00252 <span class="comment">// Check if an error occured</span>
<a name="l00253"></a>00253 <span class="keywordflow">if</span> (Sent <= 0)
<a name="l00254"></a>00254 <span class="keywordflow">return</span> <a class="code" href="classsf_1_1SocketHelper.htm#7e634801c53a5a1b2ee16757e2d96a83" title="Get the last socket error status.">SocketHelper::GetErrorStatus</a>();
<a name="l00255"></a>00255 }
<a name="l00256"></a>00256
<a name="l00257"></a>00257 <span class="keywordflow">return</span> Socket::Done;
<a name="l00258"></a>00258 }
<a name="l00259"></a>00259 <span class="keywordflow">else</span>
<a name="l00260"></a>00260 {
<a name="l00261"></a>00261 <span class="comment">// Error...</span>
<a name="l00262"></a>00262 std::cerr << <span class="stringliteral">"Cannot send data over the network (invalid parameters)"</span> << std::endl;
<a name="l00263"></a>00263 <span class="keywordflow">return</span> Socket::Error;
<a name="l00264"></a>00264 }
<a name="l00265"></a>00265 }
<a name="l00266"></a>00266
<a name="l00267"></a>00267
<a name="l00272"></a><a class="code" href="classsf_1_1SocketTCP.htm#47027b00ab5589017a5c235f2deb3ab0">00272</a> Socket::Status <a class="code" href="classsf_1_1SocketTCP.htm#47027b00ab5589017a5c235f2deb3ab0" title="Receive an array of bytes from the host (must be connected first).">SocketTCP::Receive</a>(<span class="keywordtype">char</span>* Data, std::size_t MaxSize, std::size_t& SizeReceived)
<a name="l00273"></a>00273 {
<a name="l00274"></a>00274 <span class="comment">// First clear the size received</span>
<a name="l00275"></a>00275 SizeReceived = 0;
<a name="l00276"></a>00276
<a name="l00277"></a>00277 <span class="comment">// Check that socket is valid</span>
<a name="l00278"></a>00278 <span class="keywordflow">if</span> (!<a class="code" href="classsf_1_1SocketTCP.htm#098d613057a72d9e5cfa76a77b5f7124" title="Check if the socket is in a valid state ; this function can be called any time to...">IsValid</a>())
<a name="l00279"></a>00279 <span class="keywordflow">return</span> Socket::Error;
<a name="l00280"></a>00280
<a name="l00281"></a>00281 <span class="comment">// Check parameters</span>
<a name="l00282"></a>00282 <span class="keywordflow">if</span> (Data && MaxSize)
<a name="l00283"></a>00283 {
<a name="l00284"></a>00284 <span class="comment">// Receive a chunk of bytes</span>
<a name="l00285"></a>00285 <span class="keywordtype">int</span> Received = recv(mySocket, Data, static_cast<int>(MaxSize), 0);
<a name="l00286"></a>00286
<a name="l00287"></a>00287 <span class="comment">// Check the number of bytes received</span>
<a name="l00288"></a>00288 <span class="keywordflow">if</span> (Received > 0)
<a name="l00289"></a>00289 {
<a name="l00290"></a>00290 SizeReceived = <span class="keyword">static_cast<</span>std::size_t<span class="keyword">></span>(Received);
<a name="l00291"></a>00291 <span class="keywordflow">return</span> Socket::Done;
<a name="l00292"></a>00292 }
<a name="l00293"></a>00293 <span class="keywordflow">else</span> <span class="keywordflow">if</span> (Received == 0)
<a name="l00294"></a>00294 {
<a name="l00295"></a>00295 <span class="keywordflow">return</span> Socket::Disconnected;
<a name="l00296"></a>00296 }
<a name="l00297"></a>00297 <span class="keywordflow">else</span>
<a name="l00298"></a>00298 {
<a name="l00299"></a>00299 <span class="keywordflow">return</span> <a class="code" href="classsf_1_1SocketHelper.htm#7e634801c53a5a1b2ee16757e2d96a83" title="Get the last socket error status.">SocketHelper::GetErrorStatus</a>();
<a name="l00300"></a>00300 }
<a name="l00301"></a>00301 }
<a name="l00302"></a>00302 <span class="keywordflow">else</span>
<a name="l00303"></a>00303 {
<a name="l00304"></a>00304 <span class="comment">// Error...</span>
<a name="l00305"></a>00305 std::cerr << <span class="stringliteral">"Cannot receive data from the network (invalid parameters)"</span> << std::endl;
<a name="l00306"></a>00306 <span class="keywordflow">return</span> Socket::Error;
<a name="l00307"></a>00307 }
<a name="l00308"></a>00308 }
<a name="l00309"></a>00309
<a name="l00310"></a>00310
<a name="l00314"></a><a class="code" href="classsf_1_1SocketTCP.htm#a1825883276970b3d2f9b1d61763e5c7">00314</a> Socket::Status <a class="code" href="classsf_1_1SocketTCP.htm#4debed568966f75e3e63a70f08e67c21" title="Send an array of bytes to the host (must be connected first).">SocketTCP::Send</a>(<a class="code" href="classsf_1_1Packet.htm" title="Packet wraps data to send / to receive through the network.">Packet</a>& PacketToSend)
<a name="l00315"></a>00315 {
<a name="l00316"></a>00316 <span class="comment">// Get the data to send from the packet</span>
<a name="l00317"></a>00317 std::size_t DataSize = 0;
<a name="l00318"></a>00318 <span class="keyword">const</span> <span class="keywordtype">char</span>* Data = PacketToSend.<a class="code" href="classsf_1_1Packet.htm#f7572423964fc3baf9ca9fe1e5a28993" title="Called before the packet is sent to the network.">OnSend</a>(DataSize);
<a name="l00319"></a>00319
<a name="l00320"></a>00320 <span class="comment">// Send the packet size</span>
<a name="l00321"></a>00321 Uint32 PacketSize = htonl(static_cast<unsigned long>(DataSize));
<a name="l00322"></a>00322 <a class="code" href="classsf_1_1SocketTCP.htm#4debed568966f75e3e63a70f08e67c21" title="Send an array of bytes to the host (must be connected first).">Send</a>(reinterpret_cast<const char*>(&PacketSize), <span class="keyword">sizeof</span>(PacketSize));
<a name="l00323"></a>00323
<a name="l00324"></a>00324 <span class="comment">// Send the packet data</span>
<a name="l00325"></a>00325 <span class="keywordflow">if</span> (PacketSize > 0)
<a name="l00326"></a>00326 {
<a name="l00327"></a>00327 <span class="keywordflow">return</span> <a class="code" href="classsf_1_1SocketTCP.htm#4debed568966f75e3e63a70f08e67c21" title="Send an array of bytes to the host (must be connected first).">Send</a>(Data, DataSize);
<a name="l00328"></a>00328 }
<a name="l00329"></a>00329 <span class="keywordflow">else</span>
<a name="l00330"></a>00330 {
<a name="l00331"></a>00331 <span class="keywordflow">return</span> Socket::Done;
<a name="l00332"></a>00332 }
<a name="l00333"></a>00333 }
<a name="l00334"></a>00334
<a name="l00335"></a>00335
<a name="l00340"></a><a class="code" href="classsf_1_1SocketTCP.htm#4389aa92523e0a6b3f2d6517cbde74fa">00340</a> Socket::Status <a class="code" href="classsf_1_1SocketTCP.htm#47027b00ab5589017a5c235f2deb3ab0" title="Receive an array of bytes from the host (must be connected first).">SocketTCP::Receive</a>(<a class="code" href="classsf_1_1Packet.htm" title="Packet wraps data to send / to receive through the network.">Packet</a>& PacketToReceive)
<a name="l00341"></a>00341 {
<a name="l00342"></a>00342 <span class="comment">// We start by getting the size of the incoming packet</span>
<a name="l00343"></a>00343 Uint32 PacketSize = 0;
<a name="l00344"></a>00344 std::size_t Received = 0;
<a name="l00345"></a>00345 <span class="keywordflow">if</span> (myPendingPacketSize < 0)
<a name="l00346"></a>00346 {
<a name="l00347"></a>00347 <span class="comment">// Loop until we've received the entire size of the packet</span>
<a name="l00348"></a>00348 <span class="comment">// (even a 4 bytes variable may be received in more than one call)</span>
<a name="l00349"></a>00349 <span class="keywordflow">while</span> (myPendingHeaderSize < <span class="keyword">sizeof</span>(myPendingHeader))
<a name="l00350"></a>00350 {
<a name="l00351"></a>00351 <span class="keywordtype">char</span>* Data = <span class="keyword">reinterpret_cast<</span><span class="keywordtype">char</span>*<span class="keyword">></span>(&myPendingHeader) + myPendingHeaderSize;
<a name="l00352"></a>00352 Socket::Status Status = <a class="code" href="classsf_1_1SocketTCP.htm#47027b00ab5589017a5c235f2deb3ab0" title="Receive an array of bytes from the host (must be connected first).">Receive</a>(Data, <span class="keyword">sizeof</span>(myPendingHeader) - myPendingHeaderSize, Received);
<a name="l00353"></a>00353 myPendingHeaderSize += Received;
<a name="l00354"></a>00354
<a name="l00355"></a>00355 <span class="keywordflow">if</span> (Status != Socket::Done)
<a name="l00356"></a>00356 <span class="keywordflow">return</span> Status;
<a name="l00357"></a>00357 }
<a name="l00358"></a>00358
<a name="l00359"></a>00359 PacketSize = ntohl(myPendingHeader);
<a name="l00360"></a>00360 myPendingHeaderSize = 0;
<a name="l00361"></a>00361 }
<a name="l00362"></a>00362 <span class="keywordflow">else</span>
<a name="l00363"></a>00363 {
<a name="l00364"></a>00364 <span class="comment">// There is a pending packet : we already know its size</span>
<a name="l00365"></a>00365 PacketSize = myPendingPacketSize;
<a name="l00366"></a>00366 }
<a name="l00367"></a>00367
<a name="l00368"></a>00368 <span class="comment">// Then loop until we receive all the packet data</span>
<a name="l00369"></a>00369 <span class="keywordtype">char</span> Buffer[1024];
<a name="l00370"></a>00370 <span class="keywordflow">while</span> (myPendingPacket.size() < PacketSize)
<a name="l00371"></a>00371 {
<a name="l00372"></a>00372 <span class="comment">// Receive a chunk of data</span>
<a name="l00373"></a>00373 std::size_t SizeToGet = std::min(static_cast<std::size_t>(PacketSize - myPendingPacket.size()), <span class="keyword">sizeof</span>(Buffer));
<a name="l00374"></a>00374 Socket::Status Status = <a class="code" href="classsf_1_1SocketTCP.htm#47027b00ab5589017a5c235f2deb3ab0" title="Receive an array of bytes from the host (must be connected first).">Receive</a>(Buffer, SizeToGet, Received);
<a name="l00375"></a>00375 <span class="keywordflow">if</span> (Status != Socket::Done)
<a name="l00376"></a>00376 {
<a name="l00377"></a>00377 <span class="comment">// We must save the size of the pending packet until we can receive its content</span>
<a name="l00378"></a>00378 <span class="keywordflow">if</span> (Status == Socket::NotReady)
<a name="l00379"></a>00379 myPendingPacketSize = PacketSize;
<a name="l00380"></a>00380 <span class="keywordflow">return</span> Status;
<a name="l00381"></a>00381 }
<a name="l00382"></a>00382
<a name="l00383"></a>00383 <span class="comment">// Append it into the packet</span>
<a name="l00384"></a>00384 <span class="keywordflow">if</span> (Received > 0)
<a name="l00385"></a>00385 {
<a name="l00386"></a>00386 myPendingPacket.resize(myPendingPacket.size() + Received);
<a name="l00387"></a>00387 <span class="keywordtype">char</span>* Begin = &myPendingPacket[0] + myPendingPacket.size() - Received;
<a name="l00388"></a>00388 memcpy(Begin, Buffer, Received);
<a name="l00389"></a>00389 }
<a name="l00390"></a>00390 }
<a name="l00391"></a>00391
<a name="l00392"></a>00392 <span class="comment">// We have received all the datas : we can copy it to the user packet, and clear our internal packet</span>
<a name="l00393"></a>00393 PacketToReceive.<a class="code" href="classsf_1_1Packet.htm#3a7a30fb7a39e59df0cbd773756f60da" title="Clear the packet data.">Clear</a>();
<a name="l00394"></a>00394 <span class="keywordflow">if</span> (!myPendingPacket.empty())
<a name="l00395"></a>00395 PacketToReceive.<a class="code" href="classsf_1_1Packet.htm#9a480468cc7745863b7c93e0ae449cbd" title="Called after the packet has been received from the network.">OnReceive</a>(&myPendingPacket[0], myPendingPacket.size());
<a name="l00396"></a>00396 myPendingPacket.clear();
<a name="l00397"></a>00397 myPendingPacketSize = -1;
<a name="l00398"></a>00398
<a name="l00399"></a>00399 <span class="keywordflow">return</span> Socket::Done;
<a name="l00400"></a>00400 }
<a name="l00401"></a>00401
<a name="l00402"></a>00402
<a name="l00406"></a><a class="code" href="classsf_1_1SocketTCP.htm#70a5111cbddd1edbfa6cbd6017c6d044">00406</a> <span class="keywordtype">bool</span> <a class="code" href="classsf_1_1SocketTCP.htm#70a5111cbddd1edbfa6cbd6017c6d044" title="Close the socket.">SocketTCP::Close</a>()
<a name="l00407"></a>00407 {
<a name="l00408"></a>00408 <span class="keywordflow">if</span> (<a class="code" href="classsf_1_1SocketTCP.htm#098d613057a72d9e5cfa76a77b5f7124" title="Check if the socket is in a valid state ; this function can be called any time to...">IsValid</a>())
<a name="l00409"></a>00409 {
<a name="l00410"></a>00410 <span class="keywordflow">if</span> (!<a class="code" href="classsf_1_1SocketHelper.htm#ec266cafe3270d1f2e210909b9b6d232" title="Close / destroy a socket.">SocketHelper::Close</a>(mySocket))
<a name="l00411"></a>00411 {
<a name="l00412"></a>00412 std::cerr << <span class="stringliteral">"Failed to close socket"</span> << std::endl;
<a name="l00413"></a>00413 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00414"></a>00414 }
<a name="l00415"></a>00415
<a name="l00416"></a>00416 mySocket = <a class="code" href="classsf_1_1SocketHelper.htm#99e426a217cc8847264f837632b4e458" title="Return the value of the invalid socket.">SocketHelper::InvalidSocket</a>();
<a name="l00417"></a>00417 }
<a name="l00418"></a>00418
<a name="l00419"></a>00419 myIsBlocking = <span class="keyword">true</span>;
<a name="l00420"></a>00420
<a name="l00421"></a>00421 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00422"></a>00422 }
<a name="l00423"></a>00423
<a name="l00424"></a>00424
<a name="l00429"></a><a class="code" href="classsf_1_1SocketTCP.htm#098d613057a72d9e5cfa76a77b5f7124">00429</a> <span class="keywordtype">bool</span> <a class="code" href="classsf_1_1SocketTCP.htm#098d613057a72d9e5cfa76a77b5f7124" title="Check if the socket is in a valid state ; this function can be called any time to...">SocketTCP::IsValid</a>()<span class="keyword"> const</span>
<a name="l00430"></a>00430 <span class="keyword"></span>{
<a name="l00431"></a>00431 <span class="keywordflow">return</span> mySocket != <a class="code" href="classsf_1_1SocketHelper.htm#99e426a217cc8847264f837632b4e458" title="Return the value of the invalid socket.">SocketHelper::InvalidSocket</a>();
<a name="l00432"></a>00432 }
<a name="l00433"></a>00433
<a name="l00434"></a>00434
<a name="l00438"></a><a class="code" href="classsf_1_1SocketTCP.htm#ae32dcf5042a50544848140ec1f94ed1">00438</a> <span class="keywordtype">bool</span> <a class="code" href="classsf_1_1SocketTCP.htm#ae32dcf5042a50544848140ec1f94ed1" title="Comparison operator ==.">SocketTCP::operator ==</a>(<span class="keyword">const</span> <a class="code" href="classsf_1_1SocketTCP.htm" title="SocketTCP wraps a socket using TCP protocol to send data safely (but a bit slower)...">SocketTCP</a>& Other)<span class="keyword"> const</span>
<a name="l00439"></a>00439 <span class="keyword"></span>{
<a name="l00440"></a>00440 <span class="keywordflow">return</span> mySocket == Other.<a class="code" href="classsf_1_1SocketTCP.htm#4caa2174292afe7d64daece591126979" title="Socket descriptor.">mySocket</a>;
<a name="l00441"></a>00441 }
<a name="l00442"></a>00442
<a name="l00443"></a>00443
<a name="l00447"></a><a class="code" href="classsf_1_1SocketTCP.htm#4d4dd9e422c485b8a8b390d1f210e84e">00447</a> <span class="keywordtype">bool</span> <a class="code" href="classsf_1_1SocketTCP.htm#4d4dd9e422c485b8a8b390d1f210e84e" title="Comparison operator !=.">SocketTCP::operator !=</a>(<span class="keyword">const</span> <a class="code" href="classsf_1_1SocketTCP.htm" title="SocketTCP wraps a socket using TCP protocol to send data safely (but a bit slower)...">SocketTCP</a>& Other)<span class="keyword"> const</span>
<a name="l00448"></a>00448 <span class="keyword"></span>{
<a name="l00449"></a>00449 <span class="keywordflow">return</span> mySocket != Other.<a class="code" href="classsf_1_1SocketTCP.htm#4caa2174292afe7d64daece591126979" title="Socket descriptor.">mySocket</a>;
<a name="l00450"></a>00450 }
<a name="l00451"></a>00451
<a name="l00452"></a>00452
<a name="l00458"></a><a class="code" href="classsf_1_1SocketTCP.htm#dbcfa2c662f98a92beb509d3e5ebb1ce">00458</a> <span class="keywordtype">bool</span> <a class="code" href="classsf_1_1SocketTCP.htm#dbcfa2c662f98a92beb509d3e5ebb1ce" title="Comparison operator &lt;.">SocketTCP::operator <</a>(<span class="keyword">const</span> <a class="code" href="classsf_1_1SocketTCP.htm" title="SocketTCP wraps a socket using TCP protocol to send data safely (but a bit slower)...">SocketTCP</a>& Other)<span class="keyword"> const</span>
<a name="l00459"></a>00459 <span class="keyword"></span>{
<a name="l00460"></a>00460 <span class="keywordflow">return</span> mySocket < Other.<a class="code" href="classsf_1_1SocketTCP.htm#4caa2174292afe7d64daece591126979" title="Socket descriptor.">mySocket</a>;
<a name="l00461"></a>00461 }
<a name="l00462"></a>00462
<a name="l00463"></a>00463
<a name="l00468"></a>00468 <a class="code" href="classsf_1_1SocketTCP.htm#098157a901a6f355b499085a3fb97afa" title="Default constructor.">SocketTCP::SocketTCP</a>(SocketHelper::SocketType Descriptor)
<a name="l00469"></a>00469 {
<a name="l00470"></a>00470 Create(Descriptor);
<a name="l00471"></a>00471 }
<a name="l00472"></a>00472
<a name="l00473"></a>00473
<a name="l00477"></a>00477 <span class="keywordtype">void</span> SocketTCP::Create(SocketHelper::SocketType Descriptor)
<a name="l00478"></a>00478 {
<a name="l00479"></a>00479 <span class="comment">// Use the given socket descriptor, or get a new one</span>
<a name="l00480"></a>00480 mySocket = Descriptor ? Descriptor : socket(PF_INET, SOCK_STREAM, 0);
<a name="l00481"></a>00481 myIsBlocking = <span class="keyword">true</span>;
<a name="l00482"></a>00482
<a name="l00483"></a>00483 <span class="comment">// Reset the pending packet</span>
<a name="l00484"></a>00484 myPendingHeaderSize = 0;
<a name="l00485"></a>00485 myPendingPacket.clear();
<a name="l00486"></a>00486 myPendingPacketSize = -1;
<a name="l00487"></a>00487
<a name="l00488"></a>00488 <span class="comment">// Setup default options</span>
<a name="l00489"></a>00489 <span class="keywordflow">if</span> (<a class="code" href="classsf_1_1SocketTCP.htm#098d613057a72d9e5cfa76a77b5f7124" title="Check if the socket is in a valid state ; this function can be called any time to...">IsValid</a>())
<a name="l00490"></a>00490 {
<a name="l00491"></a>00491 <span class="comment">// To avoid the "Address already in use" error message when trying to bind to the same port</span>
<a name="l00492"></a>00492 <span class="keywordtype">int</span> Yes = 1;
<a name="l00493"></a>00493 <span class="keywordflow">if</span> (setsockopt(mySocket, SOL_SOCKET, SO_REUSEADDR, reinterpret_cast<char*>(&Yes), <span class="keyword">sizeof</span>(Yes)) == -1)
<a name="l00494"></a>00494 {
<a name="l00495"></a>00495 std::cerr << <span class="stringliteral">"Failed to set socket option \"SO_REUSEADDR\" ; "</span>
<a name="l00496"></a>00496 << <span class="stringliteral">"binding to a same port may fail if too fast"</span> << std::endl;
<a name="l00497"></a>00497 }
<a name="l00498"></a>00498
<a name="l00499"></a>00499 <span class="comment">// Disable the Nagle algorithm (ie. removes buffering of TCP packets)</span>
<a name="l00500"></a>00500 <span class="keywordflow">if</span> (setsockopt(mySocket, IPPROTO_TCP, TCP_NODELAY, reinterpret_cast<char*>(&Yes), <span class="keyword">sizeof</span>(Yes)) == -1)
<a name="l00501"></a>00501 {
<a name="l00502"></a>00502 std::cerr << <span class="stringliteral">"Failed to set socket option \"TCP_NODELAY\" ; "</span>
<a name="l00503"></a>00503 << <span class="stringliteral">"all your TCP packets will be buffered"</span> << std::endl;
<a name="l00504"></a>00504 }
<a name="l00505"></a>00505
<a name="l00506"></a>00506 <span class="comment">// Set blocking by default (should always be the case anyway)</span>
<a name="l00507"></a>00507 <a class="code" href="classsf_1_1SocketTCP.htm#a80f7711b15fe33a5c7005acedae43c9" title="Change the blocking state of the socket.">SetBlocking</a>(<span class="keyword">true</span>);
<a name="l00508"></a>00508 }
<a name="l00509"></a>00509 }
<a name="l00510"></a>00510
<a name="l00511"></a>00511 } <span class="comment">// namespace sf</span>
</pre></div></div>
<p id="footer">
:: Copyright © 2007-2008 Laurent Gomila, all rights reserved ::
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.5.2</a> ::
</p>
</body>
</html>
|
