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
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
|
<!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 class="current"><a href="annotated.htm"><span>Classes</span></a></li>
<li><a href="files.htm"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.htm"><span>Class List</span></a></li>
<li><a href="classes.htm"><span>Class Index</span></a></li>
<li><a href="hierarchy.htm"><span>Class Hierarchy</span></a></li>
<li><a href="functions.htm"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><b>sf</b>::<a class="el" href="classsf_1_1SocketUDP.htm">SocketUDP</a>
</div>
</div>
<div class="contents">
<h1>sf::SocketUDP Class Reference</h1><!-- doxytag: class="sf::SocketUDP" --><a class="el" href="classsf_1_1SocketUDP.htm" title="SocketUDP wraps a socket using UDP protocol to send data fastly (but with less safety)...">SocketUDP</a> wraps a socket using UDP protocol to send data fastly (but with less safety).
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="SocketUDP_8hpp-source.htm">SocketUDP.hpp</a>></code>
<p>
<p>
<a href="classsf_1_1SocketUDP-members.htm">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SocketUDP.htm#844e648922eccd86d4815d19472bb901">SocketUDP</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#844e648922eccd86d4815d19472bb901"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SocketUDP.htm#128ebfff7472dfdd330b46b719e06fd6">SetBlocking</a> (bool Blocking)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the blocking state of the socket. <a href="#128ebfff7472dfdd330b46b719e06fd6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SocketUDP.htm#4a7e364fd39aa7338f0822d849323a5d">Bind</a> (unsigned short Port)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Bind the socket to a specific port. <a href="#4a7e364fd39aa7338f0822d849323a5d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SocketUDP.htm#6f6b448b8ab63913dad5d6906645081c">Unbind</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unbind the socket from its previous port, if any. <a href="#6f6b448b8ab63913dad5d6906645081c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">Socket::Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SocketUDP.htm#bce9f533dd86c0fd8fbe26b7efce3bc2">Send</a> (const char *Data, std::size_t Size, const <a class="el" href="classsf_1_1IPAddress.htm">IPAddress</a> &Address, unsigned short Port)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send an array of bytes. <a href="#bce9f533dd86c0fd8fbe26b7efce3bc2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">Socket::Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SocketUDP.htm#c6928928fa1d6242db1f8d4176369996">Receive</a> (char *Data, std::size_t MaxSize, std::size_t &SizeReceived, <a class="el" href="classsf_1_1IPAddress.htm">IPAddress</a> &Address, unsigned short &Port)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive an array of bytes. <a href="#c6928928fa1d6242db1f8d4176369996"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">Socket::Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SocketUDP.htm#fef698f2544ac0364d422e1e1ba7a5b6">Send</a> (<a class="el" href="classsf_1_1Packet.htm">Packet</a> &PacketToSend, const <a class="el" href="classsf_1_1IPAddress.htm">IPAddress</a> &Address, unsigned short Port)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet of data. <a href="#fef698f2544ac0364d422e1e1ba7a5b6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">Socket::Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SocketUDP.htm#463bbd635513f2653f072c2f220d2495">Receive</a> (<a class="el" href="classsf_1_1Packet.htm">Packet</a> &PacketToReceive, <a class="el" href="classsf_1_1IPAddress.htm">IPAddress</a> &Address, unsigned short &Port)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a packet. <a href="#463bbd635513f2653f072c2f220d2495"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SocketUDP.htm#c9abf54c9ced16b55ddef46973cd1a58">Close</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the socket. <a href="#c9abf54c9ced16b55ddef46973cd1a58"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SocketUDP.htm#ffecb97b84b51dea691934f9195abc1f">IsValid</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the socket is in a valid state ; this function can be called any time to check if the socket is OK. <a href="#ffecb97b84b51dea691934f9195abc1f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned short </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SocketUDP.htm#14f2c68a57a163a5d142acd0c4b022dd">GetPort</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the port the socket is currently bound to. <a href="#14f2c68a57a163a5d142acd0c4b022dd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SocketUDP.htm#5e6df73d3b4acf5890bd48229b2d2fa0">operator==</a> (const <a class="el" href="classsf_1_1SocketUDP.htm">SocketUDP</a> &Other) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Comparison operator ==. <a href="#5e6df73d3b4acf5890bd48229b2d2fa0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SocketUDP.htm#2cb8111d79d32e456f047132e61acd24">operator!=</a> (const <a class="el" href="classsf_1_1SocketUDP.htm">SocketUDP</a> &Other) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Comparison operator !=. <a href="#2cb8111d79d32e456f047132e61acd24"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SocketUDP.htm#fc35043831c10528cc3e97b959438b95">operator<</a> (const <a class="el" href="classsf_1_1SocketUDP.htm">SocketUDP</a> &Other) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Comparison operator <. <a href="#fc35043831c10528cc3e97b959438b95"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f750d7515f80120fe802531753208caf"></a><!-- doxytag: member="sf::SocketUDP::Selector< SocketUDP >" ref="f750d7515f80120fe802531753208caf" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>Selector< SocketUDP ></b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classsf_1_1SocketUDP.htm" title="SocketUDP wraps a socket using UDP protocol to send data fastly (but with less safety)...">SocketUDP</a> wraps a socket using UDP protocol to send data fastly (but with less safety).
<p>Definition at line <a class="el" href="SocketUDP_8hpp-source.htm#l00045">45</a> of file <a class="el" href="SocketUDP_8hpp-source.htm">SocketUDP.hpp</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="844e648922eccd86d4815d19472bb901"></a><!-- doxytag: member="sf::SocketUDP::SocketUDP" ref="844e648922eccd86d4815d19472bb901" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sf::SocketUDP::SocketUDP </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default constructor.
<p>
<p>Definition at line <a class="el" href="SocketUDP_8cpp-source.htm#l00041">41</a> of file <a class="el" href="SocketUDP_8cpp-source.htm">SocketUDP.cpp</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="4a7e364fd39aa7338f0822d849323a5d"></a><!-- doxytag: member="sf::SocketUDP::Bind" ref="4a7e364fd39aa7338f0822d849323a5d" args="(unsigned short Port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool sf::SocketUDP::Bind </td>
<td>(</td>
<td class="paramtype">unsigned short </td>
<td class="paramname"> <em>Port</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Bind the socket to a specific port.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Port</em> </td><td>: Port to bind the socket to</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if operation has been successful </dd></dl>
<p>Definition at line <a class="el" href="SocketUDP_8cpp-source.htm#l00064">64</a> of file <a class="el" href="SocketUDP_8cpp-source.htm">SocketUDP.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="c9abf54c9ced16b55ddef46973cd1a58"></a><!-- doxytag: member="sf::SocketUDP::Close" ref="c9abf54c9ced16b55ddef46973cd1a58" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool sf::SocketUDP::Close </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Close the socket.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if operation has been successful </dd></dl>
<p>Definition at line <a class="el" href="SocketUDP_8cpp-source.htm#l00316">316</a> of file <a class="el" href="SocketUDP_8cpp-source.htm">SocketUDP.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="14f2c68a57a163a5d142acd0c4b022dd"></a><!-- doxytag: member="sf::SocketUDP::GetPort" ref="14f2c68a57a163a5d142acd0c4b022dd" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned short sf::SocketUDP::GetPort </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the port the socket is currently bound to.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Current port (0 means the socket is not bound) </dd></dl>
<p>Definition at line <a class="el" href="SocketUDP_8cpp-source.htm#l00349">349</a> of file <a class="el" href="SocketUDP_8cpp-source.htm">SocketUDP.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="ffecb97b84b51dea691934f9195abc1f"></a><!-- doxytag: member="sf::SocketUDP::IsValid" ref="ffecb97b84b51dea691934f9195abc1f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool sf::SocketUDP::IsValid </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the socket is in a valid state ; this function can be called any time to check if the socket is OK.
<p>
Check if the socket is in a valid state ; this function can be called any time to check if the socket is OK.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the socket is valid </dd></dl>
<p>Definition at line <a class="el" href="SocketUDP_8cpp-source.htm#l00340">340</a> of file <a class="el" href="SocketUDP_8cpp-source.htm">SocketUDP.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="2cb8111d79d32e456f047132e61acd24"></a><!-- doxytag: member="sf::SocketUDP::operator!=" ref="2cb8111d79d32e456f047132e61acd24" args="(const SocketUDP &Other) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool sf::SocketUDP::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1SocketUDP.htm">SocketUDP</a> & </td>
<td class="paramname"> <em>Other</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Comparison operator !=.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Other</em> </td><td>: Socket to compare</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if *this != Other </dd></dl>
<p>Definition at line <a class="el" href="SocketUDP_8cpp-source.htm#l00367">367</a> of file <a class="el" href="SocketUDP_8cpp-source.htm">SocketUDP.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="fc35043831c10528cc3e97b959438b95"></a><!-- doxytag: member="sf::SocketUDP::operator<" ref="fc35043831c10528cc3e97b959438b95" args="(const SocketUDP &Other) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool sf::SocketUDP::operator< </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1SocketUDP.htm">SocketUDP</a> & </td>
<td class="paramname"> <em>Other</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Comparison operator <.
<p>
Provided for compatibility with standard containers, as comparing two sockets doesn't make much sense...<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Other</em> </td><td>: Socket to compare</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if *this < Other</dd></dl>
Provided for compatibility with standard containers, as comparing two sockets doesn't make much sense...
<p>Definition at line <a class="el" href="SocketUDP_8cpp-source.htm#l00378">378</a> of file <a class="el" href="SocketUDP_8cpp-source.htm">SocketUDP.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="5e6df73d3b4acf5890bd48229b2d2fa0"></a><!-- doxytag: member="sf::SocketUDP::operator==" ref="5e6df73d3b4acf5890bd48229b2d2fa0" args="(const SocketUDP &Other) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool sf::SocketUDP::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1SocketUDP.htm">SocketUDP</a> & </td>
<td class="paramname"> <em>Other</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Comparison operator ==.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Other</em> </td><td>: Socket to compare</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if *this == Other </dd></dl>
<p>Definition at line <a class="el" href="SocketUDP_8cpp-source.htm#l00358">358</a> of file <a class="el" href="SocketUDP_8cpp-source.htm">SocketUDP.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="463bbd635513f2653f072c2f220d2495"></a><!-- doxytag: member="sf::SocketUDP::Receive" ref="463bbd635513f2653f072c2f220d2495" args="(Packet &PacketToReceive, IPAddress &Address, unsigned short &Port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Socket::Status sf::SocketUDP::Receive </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td>
<td class="paramname"> <em>PacketToReceive</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classsf_1_1IPAddress.htm">IPAddress</a> & </td>
<td class="paramname"> <em>Address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned short & </td>
<td class="paramname"> <em>Port</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Receive a packet.
<p>
This function will block if the socket is blocking<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>PacketToReceive</em> </td><td>: <a class="el" href="classsf_1_1Packet.htm" title="Packet wraps data to send / to receive through the network.">Packet</a> to fill with received data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Address</em> </td><td>: Address of the computer which sent the packet </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Port</em> </td><td>: Port on which the remote computer sent the data</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Status code</dd></dl>
This function will block if the socket is blocking
<p>Definition at line <a class="el" href="SocketUDP_8cpp-source.htm#l00245">245</a> of file <a class="el" href="SocketUDP_8cpp-source.htm">SocketUDP.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="c6928928fa1d6242db1f8d4176369996"></a><!-- doxytag: member="sf::SocketUDP::Receive" ref="c6928928fa1d6242db1f8d4176369996" args="(char *Data, std::size_t MaxSize, std::size_t &SizeReceived, IPAddress &Address, unsigned short &Port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Socket::Status sf::SocketUDP::Receive </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>Data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::size_t </td>
<td class="paramname"> <em>MaxSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::size_t & </td>
<td class="paramname"> <em>SizeReceived</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classsf_1_1IPAddress.htm">IPAddress</a> & </td>
<td class="paramname"> <em>Address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned short & </td>
<td class="paramname"> <em>Port</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Receive an array of bytes.
<p>
This function will block if the socket is blocking<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Data</em> </td><td>: Pointer to a byte array to fill (make sure it is big enough) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>MaxSize</em> </td><td>: Maximum number of bytes to read </td></tr>
<tr><td valign="top"></td><td valign="top"><em>SizeReceived</em> </td><td>: Number of bytes received </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Address</em> </td><td>: Address of the computer which sent the data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Port</em> </td><td>: Port on which the remote computer sent the data</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Status code</dd></dl>
This function will block if the socket is blocking
<p>Definition at line <a class="el" href="SocketUDP_8cpp-source.htm#l00162">162</a> of file <a class="el" href="SocketUDP_8cpp-source.htm">SocketUDP.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="fef698f2544ac0364d422e1e1ba7a5b6"></a><!-- doxytag: member="sf::SocketUDP::Send" ref="fef698f2544ac0364d422e1e1ba7a5b6" args="(Packet &PacketToSend, const IPAddress &Address, unsigned short Port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Socket::Status sf::SocketUDP::Send </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td>
<td class="paramname"> <em>PacketToSend</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classsf_1_1IPAddress.htm">IPAddress</a> & </td>
<td class="paramname"> <em>Address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned short </td>
<td class="paramname"> <em>Port</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Send a packet of data.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>PacketToSend</em> </td><td>: <a class="el" href="classsf_1_1Packet.htm" title="Packet wraps data to send / to receive through the network.">Packet</a> to send </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Address</em> </td><td>: Address of the computer to send the packet to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Port</em> </td><td>: Port to send the data to</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Status code </dd></dl>
<p>Definition at line <a class="el" href="SocketUDP_8cpp-source.htm#l00219">219</a> of file <a class="el" href="SocketUDP_8cpp-source.htm">SocketUDP.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="bce9f533dd86c0fd8fbe26b7efce3bc2"></a><!-- doxytag: member="sf::SocketUDP::Send" ref="bce9f533dd86c0fd8fbe26b7efce3bc2" args="(const char *Data, std::size_t Size, const IPAddress &Address, unsigned short Port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Socket::Status sf::SocketUDP::Send </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::size_t </td>
<td class="paramname"> <em>Size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classsf_1_1IPAddress.htm">IPAddress</a> & </td>
<td class="paramname"> <em>Address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned short </td>
<td class="paramname"> <em>Port</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Send an array of bytes.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Data</em> </td><td>: Pointer to the bytes to send </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Size</em> </td><td>: Number of bytes to send </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Address</em> </td><td>: Address of the computer to send the packet to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Port</em> </td><td>: Port to send the data to</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Status code </dd></dl>
<p>Definition at line <a class="el" href="SocketUDP_8cpp-source.htm#l00118">118</a> of file <a class="el" href="SocketUDP_8cpp-source.htm">SocketUDP.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="128ebfff7472dfdd330b46b719e06fd6"></a><!-- doxytag: member="sf::SocketUDP::SetBlocking" ref="128ebfff7472dfdd330b46b719e06fd6" args="(bool Blocking)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::SocketUDP::SetBlocking </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>Blocking</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Change the blocking state of the socket.
<p>
The default behaviour of a socket is blocking<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Blocking</em> </td><td>: Pass true to set the socket as blocking, or false for non-blocking </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="SocketUDP_8cpp-source.htm#l00050">50</a> of file <a class="el" href="SocketUDP_8cpp-source.htm">SocketUDP.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="6f6b448b8ab63913dad5d6906645081c"></a><!-- doxytag: member="sf::SocketUDP::Unbind" ref="6f6b448b8ab63913dad5d6906645081c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool sf::SocketUDP::Unbind </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Unbind the socket from its previous port, if any.
<p>
Unbind the socket to its previous port.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if operation has been successful </dd></dl>
<p>Definition at line <a class="el" href="SocketUDP_8cpp-source.htm#l00101">101</a> of file <a class="el" href="SocketUDP_8cpp-source.htm">SocketUDP.cpp</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="SocketUDP_8hpp-source.htm">SocketUDP.hpp</a><li><a class="el" href="SocketUDP_8cpp-source.htm">SocketUDP.cpp</a></ul>
</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>
|
