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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>wxWidgets: wxSocketClient Class Reference</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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="page_container">
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0" style="width: 100%;">
<tbody>
<tr>
<td id="projectlogo">
<a href="http://www.wxwidgets.org/" target="_new">
<img alt="wxWidgets" src="logo.png"/>
</a>
</td>
<td style="padding-left: 0.5em; text-align: right;">
<span id="projectnumber">Version: 3.0.2</span>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.8.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Categories</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classwx_socket_client-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">wxSocketClient Class Reference<div class="ingroups"><a class="el" href="group__group__class__net.html">Networking</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <wx/socket.h></code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for wxSocketClient:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classwx_socket_client__inherit__graph.png" border="0" usemap="#wx_socket_client_inherit__map" alt="Inheritance graph"/></div>
<map name="wx_socket_client_inherit__map" id="wx_socket_client_inherit__map">
<area shape="rect" id="node7" href="classwx_protocol.html" title="Represents a protocol for use with wxURL." alt="" coords="37,238,123,266"/><area shape="rect" id="node2" href="classwx_socket_base.html" title="wxSocketBase is the base class for all socket-related objects, and it defines all basic IO functional..." alt="" coords="27,83,133,111"/><area shape="rect" id="node4" href="classwx_object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="43,6,117,34"/><area shape="rect" id="node9" href="classwx_f_t_p.html" title="wxFTP can be used to establish a connection to an FTP server and perform all the usual operations..." alt="" coords="5,315,67,343"/><area shape="rect" id="node11" href="classwx_h_t_t_p.html" title="wxHTTP can be used to establish a connection to an HTTP server." alt="" coords="91,315,160,343"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="todo"><dt><b><a class="el" href="todo.html#_todo000048">Todo:</a></b></dt><dd>describe me.</dd></dl>
<h2></h2>
<div><span class="lib">Library:</span>  <span class="lib_text"><a class="el" href="page_libs.html#page_libs_wxnet">wxNet</a></span></div><div><span class="category">Category:</span>  <span class="category_text"><a class="el" href="group__group__class__net.html">Networking</a></span></div> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1eaa0a775aa619d4d04d48bd84a8212c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_client.html#a1eaa0a775aa619d4d04d48bd84a8212c">wxSocketClient</a> (wxSocketFlags flags=<a class="el" href="socket_8h.html#a1fb9092bcdeada2d206bdc74afbbe122aeb1d7a7c69cad4340559486c04d2336c">wxSOCKET_NONE</a>)</td></tr>
<tr class="memdesc:a1eaa0a775aa619d4d04d48bd84a8212c"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a1eaa0a775aa619d4d04d48bd84a8212c"></a><br/></td></tr>
<tr class="separator:a1eaa0a775aa619d4d04d48bd84a8212c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6e55d27056f3bf22b16b25d2fadb01ad"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_client.html#a6e55d27056f3bf22b16b25d2fadb01ad">~wxSocketClient</a> ()</td></tr>
<tr class="memdesc:a6e55d27056f3bf22b16b25d2fadb01ad"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a6e55d27056f3bf22b16b25d2fadb01ad"></a><br/></td></tr>
<tr class="separator:a6e55d27056f3bf22b16b25d2fadb01ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a581cdb757cce6020c8caac1ddd74a599"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_client.html#a581cdb757cce6020c8caac1ddd74a599">Connect</a> (const <a class="el" href="classwx_sock_address.html">wxSockAddress</a> &address, bool wait=true)</td></tr>
<tr class="memdesc:a581cdb757cce6020c8caac1ddd74a599"><td class="mdescLeft"> </td><td class="mdescRight">Connects to a server using the specified address. <a href="#a581cdb757cce6020c8caac1ddd74a599"></a><br/></td></tr>
<tr class="separator:a581cdb757cce6020c8caac1ddd74a599"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2167813338c94621a9ee0180524974a5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_client.html#a2167813338c94621a9ee0180524974a5">Connect</a> (const <a class="el" href="classwx_sock_address.html">wxSockAddress</a> &address, const <a class="el" href="classwx_sock_address.html">wxSockAddress</a> &local, bool wait=true)</td></tr>
<tr class="memdesc:a2167813338c94621a9ee0180524974a5"><td class="mdescLeft"> </td><td class="mdescRight">Connects to a server using the specified address. <a href="#a2167813338c94621a9ee0180524974a5"></a><br/></td></tr>
<tr class="separator:a2167813338c94621a9ee0180524974a5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a83c92e8c27a72c3610c9eb0b60e92d74"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_client.html#a83c92e8c27a72c3610c9eb0b60e92d74">WaitOnConnect</a> (long seconds=-1, long milliseconds=0)</td></tr>
<tr class="memdesc:a83c92e8c27a72c3610c9eb0b60e92d74"><td class="mdescLeft"> </td><td class="mdescRight">Wait until a connection request completes, or until the specified timeout elapses. <a href="#a83c92e8c27a72c3610c9eb0b60e92d74"></a><br/></td></tr>
<tr class="separator:a83c92e8c27a72c3610c9eb0b60e92d74"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classwx_socket_base"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classwx_socket_base')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classwx_socket_base.html">wxSocketBase</a></td></tr>
<tr class="memitem:a1a70bf5e24ccf3a6171ba07c06f8dac9 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a1a70bf5e24ccf3a6171ba07c06f8dac9">Error</a> () const </td></tr>
<tr class="memdesc:a1a70bf5e24ccf3a6171ba07c06f8dac9 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Returns <span class="literal">true</span> if an error occurred in the last IO operation. <a href="#a1a70bf5e24ccf3a6171ba07c06f8dac9"></a><br/></td></tr>
<tr class="separator:a1a70bf5e24ccf3a6171ba07c06f8dac9 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1751b32af0172a30f544068100ba90d2 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a1751b32af0172a30f544068100ba90d2">GetLocal</a> (<a class="el" href="classwx_sock_address.html">wxSockAddress</a> &addr) const </td></tr>
<tr class="memdesc:a1751b32af0172a30f544068100ba90d2 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Return the local address of the socket. <a href="#a1751b32af0172a30f544068100ba90d2"></a><br/></td></tr>
<tr class="separator:a1751b32af0172a30f544068100ba90d2 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae825b5309067c212640189d6ad7e993 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#aae825b5309067c212640189d6ad7e993">GetPeer</a> (<a class="el" href="classwx_sock_address.html">wxSockAddress</a> &addr) const </td></tr>
<tr class="memdesc:aae825b5309067c212640189d6ad7e993 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Return the peer address field of the socket. <a href="#aae825b5309067c212640189d6ad7e993"></a><br/></td></tr>
<tr class="separator:aae825b5309067c212640189d6ad7e993 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb940bb2853901b4ea0b2840964f8e5b inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#adb940bb2853901b4ea0b2840964f8e5b">GetTimeout</a> () const </td></tr>
<tr class="memdesc:adb940bb2853901b4ea0b2840964f8e5b inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Return the socket timeout in seconds. <a href="#adb940bb2853901b4ea0b2840964f8e5b"></a><br/></td></tr>
<tr class="separator:adb940bb2853901b4ea0b2840964f8e5b inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2d171f3eac0dbc9211f0032188d381ac inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a2d171f3eac0dbc9211f0032188d381ac">IsConnected</a> () const </td></tr>
<tr class="memdesc:a2d171f3eac0dbc9211f0032188d381ac inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Returns <span class="literal">true</span> if the socket is connected. <a href="#a2d171f3eac0dbc9211f0032188d381ac"></a><br/></td></tr>
<tr class="separator:a2d171f3eac0dbc9211f0032188d381ac inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6703a3dd7c15fcb2eff7c7baf0b886f5 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a6703a3dd7c15fcb2eff7c7baf0b886f5">IsData</a> ()</td></tr>
<tr class="memdesc:a6703a3dd7c15fcb2eff7c7baf0b886f5 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Check if the socket can be currently read or written. <a href="#a6703a3dd7c15fcb2eff7c7baf0b886f5"></a><br/></td></tr>
<tr class="separator:a6703a3dd7c15fcb2eff7c7baf0b886f5 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac5118b15195664969b7d914a045936f6 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#ac5118b15195664969b7d914a045936f6">IsDisconnected</a> () const </td></tr>
<tr class="memdesc:ac5118b15195664969b7d914a045936f6 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Returns <span class="literal">true</span> if the socket is not connected. <a href="#ac5118b15195664969b7d914a045936f6"></a><br/></td></tr>
<tr class="separator:ac5118b15195664969b7d914a045936f6 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a86799181fb499a72a42651704a3bbda3 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a86799181fb499a72a42651704a3bbda3">IsOk</a> () const </td></tr>
<tr class="memdesc:a86799181fb499a72a42651704a3bbda3 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Returns <span class="literal">true</span> if the socket is initialized and ready and <span class="literal">false</span> in other cases. <a href="#a86799181fb499a72a42651704a3bbda3"></a><br/></td></tr>
<tr class="separator:a86799181fb499a72a42651704a3bbda3 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b0cfbb970153b563c7134c1e8ba8319 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#afdb12e5345c3fae4b537e813df9f02a3">wxUint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a5b0cfbb970153b563c7134c1e8ba8319">LastCount</a> () const </td></tr>
<tr class="memdesc:a5b0cfbb970153b563c7134c1e8ba8319 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of bytes read or written by the last IO call. <a href="#a5b0cfbb970153b563c7134c1e8ba8319"></a><br/></td></tr>
<tr class="separator:a5b0cfbb970153b563c7134c1e8ba8319 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0cfe7a2aaf5749041076b38249404b20 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#afdb12e5345c3fae4b537e813df9f02a3">wxUint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a0cfe7a2aaf5749041076b38249404b20">LastReadCount</a> () const </td></tr>
<tr class="memdesc:a0cfe7a2aaf5749041076b38249404b20 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of bytes read by the last <a class="el" href="classwx_socket_base.html#aa75b3c2dd051a012cfbd0596d95f80c2" title="Read up to the given number of bytes from the socket.">Read()</a> or <a class="el" href="classwx_socket_base.html#a7c16b20282272c68acfe04107d430bf6" title="Receive a message sent by WriteMsg().">ReadMsg()</a> call (receive direction only). <a href="#a0cfe7a2aaf5749041076b38249404b20"></a><br/></td></tr>
<tr class="separator:a0cfe7a2aaf5749041076b38249404b20 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0af60002ca2775490ad8bcd937591829 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#afdb12e5345c3fae4b537e813df9f02a3">wxUint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a0af60002ca2775490ad8bcd937591829">LastWriteCount</a> () const </td></tr>
<tr class="memdesc:a0af60002ca2775490ad8bcd937591829 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of bytes written by the last <a class="el" href="classwx_socket_base.html#a7676f1821d2e17db95de2438346355cd" title="Write up to the given number of bytes to the socket.">Write()</a> or <a class="el" href="classwx_socket_base.html#a91abca66c1d5bf4237aa87b0e796464b" title="Sends a buffer which can be read using ReadMsg().">WriteMsg()</a> call (transmit direction only). <a href="#a0af60002ca2775490ad8bcd937591829"></a><br/></td></tr>
<tr class="separator:a0af60002ca2775490ad8bcd937591829 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b3fa4395c33fd4f99956a5585e49b2e inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="socket_8h.html#aec4f3fb4ed18dd9b1fe503750ec4e0f6">wxSocketError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a4b3fa4395c33fd4f99956a5585e49b2e">LastError</a> () const </td></tr>
<tr class="memdesc:a4b3fa4395c33fd4f99956a5585e49b2e inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Returns the last wxSocket error. <a href="#a4b3fa4395c33fd4f99956a5585e49b2e"></a><br/></td></tr>
<tr class="separator:a4b3fa4395c33fd4f99956a5585e49b2e inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a386797430bfc9f568be388e7abf6c782 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a386797430bfc9f568be388e7abf6c782">RestoreState</a> ()</td></tr>
<tr class="memdesc:a386797430bfc9f568be388e7abf6c782 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Restore the previous state of the socket, as saved with <a class="el" href="classwx_socket_base.html#af227621ab1ee04542063fe91ea281e49" title="Save the current state of the socket in a stack.">SaveState()</a>. <a href="#a386797430bfc9f568be388e7abf6c782"></a><br/></td></tr>
<tr class="separator:a386797430bfc9f568be388e7abf6c782 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af227621ab1ee04542063fe91ea281e49 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#af227621ab1ee04542063fe91ea281e49">SaveState</a> ()</td></tr>
<tr class="memdesc:af227621ab1ee04542063fe91ea281e49 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Save the current state of the socket in a stack. <a href="#af227621ab1ee04542063fe91ea281e49"></a><br/></td></tr>
<tr class="separator:af227621ab1ee04542063fe91ea281e49 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a054754d97e15427949ffa30af8ce9945 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a054754d97e15427949ffa30af8ce9945">Close</a> ()</td></tr>
<tr class="memdesc:a054754d97e15427949ffa30af8ce9945 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Shut down the socket, disabling further transmission and reception of data and disable events for the socket and frees the associated system resources. <a href="#a054754d97e15427949ffa30af8ce9945"></a><br/></td></tr>
<tr class="separator:a054754d97e15427949ffa30af8ce9945 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a90d2aea95b10c68eee2656860d90e23e inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a90d2aea95b10c68eee2656860d90e23e">ShutdownOutput</a> ()</td></tr>
<tr class="memdesc:a90d2aea95b10c68eee2656860d90e23e inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Shuts down the writing end of the socket. <a href="#a90d2aea95b10c68eee2656860d90e23e"></a><br/></td></tr>
<tr class="separator:a90d2aea95b10c68eee2656860d90e23e inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5cfc8b791cff6723dd499509d99d02be inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwx_socket_base.html">wxSocketBase</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a5cfc8b791cff6723dd499509d99d02be">Discard</a> ()</td></tr>
<tr class="memdesc:a5cfc8b791cff6723dd499509d99d02be inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Delete all bytes in the incoming queue. <a href="#a5cfc8b791cff6723dd499509d99d02be"></a><br/></td></tr>
<tr class="separator:a5cfc8b791cff6723dd499509d99d02be inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1eecc8010fa40587623778cf9902e661 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">wxSocketFlags </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a1eecc8010fa40587623778cf9902e661">GetFlags</a> () const </td></tr>
<tr class="memdesc:a1eecc8010fa40587623778cf9902e661 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Returns current IO flags, as set with <a class="el" href="classwx_socket_base.html#aa11d1db40c87c8e06e3f9849a08abafc" title="Use SetFlags to customize IO operation for this socket.">SetFlags()</a> <a href="#a1eecc8010fa40587623778cf9902e661"></a><br/></td></tr>
<tr class="separator:a1eecc8010fa40587623778cf9902e661 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a89897c3ea99e6e3d8d5daf8e26596bc3 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a89897c3ea99e6e3d8d5daf8e26596bc3">InterruptWait</a> ()</td></tr>
<tr class="memdesc:a89897c3ea99e6e3d8d5daf8e26596bc3 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Use this function to interrupt any wait operation currently in progress. <a href="#a89897c3ea99e6e3d8d5daf8e26596bc3"></a><br/></td></tr>
<tr class="separator:a89897c3ea99e6e3d8d5daf8e26596bc3 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a944eb846a3849dd34f7825cfdce3bcd1 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwx_socket_base.html">wxSocketBase</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a944eb846a3849dd34f7825cfdce3bcd1">Peek</a> (void *buffer, <a class="el" href="defs_8h.html#afdb12e5345c3fae4b537e813df9f02a3">wxUint32</a> nbytes)</td></tr>
<tr class="memdesc:a944eb846a3849dd34f7825cfdce3bcd1 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Peek into the socket by copying the next bytes which would be read by <a class="el" href="classwx_socket_base.html#aa75b3c2dd051a012cfbd0596d95f80c2" title="Read up to the given number of bytes from the socket.">Read()</a> into the provided buffer. <a href="#a944eb846a3849dd34f7825cfdce3bcd1"></a><br/></td></tr>
<tr class="separator:a944eb846a3849dd34f7825cfdce3bcd1 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa75b3c2dd051a012cfbd0596d95f80c2 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwx_socket_base.html">wxSocketBase</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#aa75b3c2dd051a012cfbd0596d95f80c2">Read</a> (void *buffer, <a class="el" href="defs_8h.html#afdb12e5345c3fae4b537e813df9f02a3">wxUint32</a> nbytes)</td></tr>
<tr class="memdesc:aa75b3c2dd051a012cfbd0596d95f80c2 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Read up to the given number of bytes from the socket. <a href="#aa75b3c2dd051a012cfbd0596d95f80c2"></a><br/></td></tr>
<tr class="separator:aa75b3c2dd051a012cfbd0596d95f80c2 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7c16b20282272c68acfe04107d430bf6 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwx_socket_base.html">wxSocketBase</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a7c16b20282272c68acfe04107d430bf6">ReadMsg</a> (void *buffer, <a class="el" href="defs_8h.html#afdb12e5345c3fae4b537e813df9f02a3">wxUint32</a> nbytes)</td></tr>
<tr class="memdesc:a7c16b20282272c68acfe04107d430bf6 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Receive a message sent by <a class="el" href="classwx_socket_base.html#a91abca66c1d5bf4237aa87b0e796464b" title="Sends a buffer which can be read using ReadMsg().">WriteMsg()</a>. <a href="#a7c16b20282272c68acfe04107d430bf6"></a><br/></td></tr>
<tr class="separator:a7c16b20282272c68acfe04107d430bf6 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa11d1db40c87c8e06e3f9849a08abafc inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#aa11d1db40c87c8e06e3f9849a08abafc">SetFlags</a> (wxSocketFlags flags)</td></tr>
<tr class="memdesc:aa11d1db40c87c8e06e3f9849a08abafc inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Use SetFlags to customize IO operation for this socket. <a href="#aa11d1db40c87c8e06e3f9849a08abafc"></a><br/></td></tr>
<tr class="separator:aa11d1db40c87c8e06e3f9849a08abafc inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18b26d4201f86daf64c881433c68a1b3 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a18b26d4201f86daf64c881433c68a1b3">SetLocal</a> (const <a class="el" href="classwx_i_p_v4address.html">wxIPV4address</a> &local)</td></tr>
<tr class="memdesc:a18b26d4201f86daf64c881433c68a1b3 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Set the local address and port to use. <a href="#a18b26d4201f86daf64c881433c68a1b3"></a><br/></td></tr>
<tr class="separator:a18b26d4201f86daf64c881433c68a1b3 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac24247e3f866154825c14de46a911e50 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#ac24247e3f866154825c14de46a911e50">SetTimeout</a> (long seconds)</td></tr>
<tr class="memdesc:ac24247e3f866154825c14de46a911e50 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Set the default socket timeout in seconds. <a href="#ac24247e3f866154825c14de46a911e50"></a><br/></td></tr>
<tr class="separator:ac24247e3f866154825c14de46a911e50 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8fd912526830f7b079ac28677424d40a inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwx_socket_base.html">wxSocketBase</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a8fd912526830f7b079ac28677424d40a">Unread</a> (const void *buffer, <a class="el" href="defs_8h.html#afdb12e5345c3fae4b537e813df9f02a3">wxUint32</a> nbytes)</td></tr>
<tr class="memdesc:a8fd912526830f7b079ac28677424d40a inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Put the specified data into the input queue. <a href="#a8fd912526830f7b079ac28677424d40a"></a><br/></td></tr>
<tr class="separator:a8fd912526830f7b079ac28677424d40a inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae46d0dea0ec25af581ba3119cca4bd7e inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#ae46d0dea0ec25af581ba3119cca4bd7e">Wait</a> (long seconds=-1, long millisecond=0)</td></tr>
<tr class="memdesc:ae46d0dea0ec25af581ba3119cca4bd7e inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Wait for any socket event. <a href="#ae46d0dea0ec25af581ba3119cca4bd7e"></a><br/></td></tr>
<tr class="separator:ae46d0dea0ec25af581ba3119cca4bd7e inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a80e8a0feaed33843aa7972c02909106c inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a80e8a0feaed33843aa7972c02909106c">WaitForLost</a> (long seconds=-1, long millisecond=0)</td></tr>
<tr class="memdesc:a80e8a0feaed33843aa7972c02909106c inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Wait until the connection is lost. <a href="#a80e8a0feaed33843aa7972c02909106c"></a><br/></td></tr>
<tr class="separator:a80e8a0feaed33843aa7972c02909106c inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aab8fdd558f149d70ed265dad0f12e9f8 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#aab8fdd558f149d70ed265dad0f12e9f8">WaitForRead</a> (long seconds=-1, long millisecond=0)</td></tr>
<tr class="memdesc:aab8fdd558f149d70ed265dad0f12e9f8 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Wait until the socket is readable. <a href="#aab8fdd558f149d70ed265dad0f12e9f8"></a><br/></td></tr>
<tr class="separator:aab8fdd558f149d70ed265dad0f12e9f8 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abda804254aa40c9f8ae363dbc5ebc1f2 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#abda804254aa40c9f8ae363dbc5ebc1f2">WaitForWrite</a> (long seconds=-1, long millisecond=0)</td></tr>
<tr class="memdesc:abda804254aa40c9f8ae363dbc5ebc1f2 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Wait until the socket becomes writable. <a href="#abda804254aa40c9f8ae363dbc5ebc1f2"></a><br/></td></tr>
<tr class="separator:abda804254aa40c9f8ae363dbc5ebc1f2 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7676f1821d2e17db95de2438346355cd inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwx_socket_base.html">wxSocketBase</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a7676f1821d2e17db95de2438346355cd">Write</a> (const void *buffer, <a class="el" href="defs_8h.html#afdb12e5345c3fae4b537e813df9f02a3">wxUint32</a> nbytes)</td></tr>
<tr class="memdesc:a7676f1821d2e17db95de2438346355cd inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Write up to the given number of bytes to the socket. <a href="#a7676f1821d2e17db95de2438346355cd"></a><br/></td></tr>
<tr class="separator:a7676f1821d2e17db95de2438346355cd inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a91abca66c1d5bf4237aa87b0e796464b inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwx_socket_base.html">wxSocketBase</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a91abca66c1d5bf4237aa87b0e796464b">WriteMsg</a> (const void *buffer, <a class="el" href="defs_8h.html#afdb12e5345c3fae4b537e813df9f02a3">wxUint32</a> nbytes)</td></tr>
<tr class="memdesc:a91abca66c1d5bf4237aa87b0e796464b inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Sends a buffer which can be read using <a class="el" href="classwx_socket_base.html#a7c16b20282272c68acfe04107d430bf6" title="Receive a message sent by WriteMsg().">ReadMsg()</a>. <a href="#a91abca66c1d5bf4237aa87b0e796464b"></a><br/></td></tr>
<tr class="separator:a91abca66c1d5bf4237aa87b0e796464b inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9dd69ce31cb441c2c47e374256fabcc4 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a9dd69ce31cb441c2c47e374256fabcc4">GetClientData</a> () const </td></tr>
<tr class="memdesc:a9dd69ce31cb441c2c47e374256fabcc4 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer of the client data for this socket, as set with <a class="el" href="classwx_socket_base.html#a5695e6dc7db8e4119caf3c81dcbc7306" title="Sets user-supplied client data for this socket.">SetClientData()</a> <a href="#a9dd69ce31cb441c2c47e374256fabcc4"></a><br/></td></tr>
<tr class="separator:a9dd69ce31cb441c2c47e374256fabcc4 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acfaca539bd0fe0e9c0b1018c77e6701c inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#acfaca539bd0fe0e9c0b1018c77e6701c">Notify</a> (bool notify)</td></tr>
<tr class="memdesc:acfaca539bd0fe0e9c0b1018c77e6701c inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">According to the <em>notify</em> value, this function enables or disables socket events. <a href="#acfaca539bd0fe0e9c0b1018c77e6701c"></a><br/></td></tr>
<tr class="separator:acfaca539bd0fe0e9c0b1018c77e6701c inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5695e6dc7db8e4119caf3c81dcbc7306 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a5695e6dc7db8e4119caf3c81dcbc7306">SetClientData</a> (void *data)</td></tr>
<tr class="memdesc:a5695e6dc7db8e4119caf3c81dcbc7306 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Sets user-supplied client data for this socket. <a href="#a5695e6dc7db8e4119caf3c81dcbc7306"></a><br/></td></tr>
<tr class="separator:a5695e6dc7db8e4119caf3c81dcbc7306 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a09819e56d36638fb6b45bf3dd7ea8742 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a09819e56d36638fb6b45bf3dd7ea8742">SetEventHandler</a> (<a class="el" href="classwx_evt_handler.html">wxEvtHandler</a> &handler, int id=-1)</td></tr>
<tr class="memdesc:a09819e56d36638fb6b45bf3dd7ea8742 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Sets an event handler to be called when a socket event occurs. <a href="#a09819e56d36638fb6b45bf3dd7ea8742"></a><br/></td></tr>
<tr class="separator:a09819e56d36638fb6b45bf3dd7ea8742 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4a3883a253c29e0f0027d279c647dbe0 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a4a3883a253c29e0f0027d279c647dbe0">SetNotify</a> (<a class="el" href="socket_8h.html#a2ec8996eecae7da1c5fa77c88a45a353">wxSocketEventFlags</a> flags)</td></tr>
<tr class="memdesc:a4a3883a253c29e0f0027d279c647dbe0 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Specifies which socket events are to be sent to the event handler. <a href="#a4a3883a253c29e0f0027d279c647dbe0"></a><br/></td></tr>
<tr class="separator:a4a3883a253c29e0f0027d279c647dbe0 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3d403e292ada2a6e01b5f9d2908aefbe inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="socket_8h.html#aa6e1c1635ef97512c7a0d0c0c7a5db31">wxSOCKET_T</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a3d403e292ada2a6e01b5f9d2908aefbe">GetSocket</a> () const </td></tr>
<tr class="memdesc:a3d403e292ada2a6e01b5f9d2908aefbe inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Returns the native socket descriptor. <a href="#a3d403e292ada2a6e01b5f9d2908aefbe"></a><br/></td></tr>
<tr class="separator:a3d403e292ada2a6e01b5f9d2908aefbe inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3bf32997db6732a5b053d8d52b1173f0 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a3bf32997db6732a5b053d8d52b1173f0">wxSocketBase</a> ()</td></tr>
<tr class="memdesc:a3bf32997db6732a5b053d8d52b1173f0 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a3bf32997db6732a5b053d8d52b1173f0"></a><br/></td></tr>
<tr class="separator:a3bf32997db6732a5b053d8d52b1173f0 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a636e72242dd5550e84456c277ca31222 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a636e72242dd5550e84456c277ca31222">~wxSocketBase</a> ()</td></tr>
<tr class="memdesc:a636e72242dd5550e84456c277ca31222 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a636e72242dd5550e84456c277ca31222"></a><br/></td></tr>
<tr class="separator:a636e72242dd5550e84456c277ca31222 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab0b0926cfdfdd00b8b5c5f7f57cea861 inherit pub_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#ab0b0926cfdfdd00b8b5c5f7f57cea861">Destroy</a> ()</td></tr>
<tr class="memdesc:ab0b0926cfdfdd00b8b5c5f7f57cea861 inherit pub_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the socket safely. <a href="#ab0b0926cfdfdd00b8b5c5f7f57cea861"></a><br/></td></tr>
<tr class="separator:ab0b0926cfdfdd00b8b5c5f7f57cea861 inherit pub_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classwx_object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classwx_object')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classwx_object.html">wxObject</a></td></tr>
<tr class="memitem:acaa378363a28af421ab56ad7b46eadf0 inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#acaa378363a28af421ab56ad7b46eadf0">wxObject</a> ()</td></tr>
<tr class="memdesc:acaa378363a28af421ab56ad7b46eadf0 inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Default ctor; initializes to <span class="literal">NULL</span> the internal reference data. <a href="#acaa378363a28af421ab56ad7b46eadf0"></a><br/></td></tr>
<tr class="separator:acaa378363a28af421ab56ad7b46eadf0 inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4721b4dc9b7aff0f30904ba2ea3954cf inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a4721b4dc9b7aff0f30904ba2ea3954cf">wxObject</a> (const <a class="el" href="classwx_object.html">wxObject</a> &other)</td></tr>
<tr class="memdesc:a4721b4dc9b7aff0f30904ba2ea3954cf inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Copy ctor. <a href="#a4721b4dc9b7aff0f30904ba2ea3954cf"></a><br/></td></tr>
<tr class="separator:a4721b4dc9b7aff0f30904ba2ea3954cf inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a51aa8bfbab47ca2f051bcf84b3f35b inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a2a51aa8bfbab47ca2f051bcf84b3f35b">~wxObject</a> ()</td></tr>
<tr class="memdesc:a2a51aa8bfbab47ca2f051bcf84b3f35b inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a2a51aa8bfbab47ca2f051bcf84b3f35b"></a><br/></td></tr>
<tr class="separator:a2a51aa8bfbab47ca2f051bcf84b3f35b inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab3a0c6f723cbaddb47be4e8dd98cc8e2 inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classwx_class_info.html">wxClassInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#ab3a0c6f723cbaddb47be4e8dd98cc8e2">GetClassInfo</a> () const </td></tr>
<tr class="memdesc:ab3a0c6f723cbaddb47be4e8dd98cc8e2 inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">This virtual function is redefined for every class that requires run-time type information, when using the <a class="el" href="group__group__funcmacro__rtti.html#ga20465fc7e022e29a5dacfad46e152e75" title="Used inside a class declaration to declare that the class should be made known to the class hierarchy...">wxDECLARE_CLASS</a> macro (or similar). <a href="#ab3a0c6f723cbaddb47be4e8dd98cc8e2"></a><br/></td></tr>
<tr class="separator:ab3a0c6f723cbaddb47be4e8dd98cc8e2 inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aabdb4fc957226544a8408167844e4f42 inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwx_object_ref_data.html">wxObjectRefData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#aabdb4fc957226544a8408167844e4f42">GetRefData</a> () const </td></tr>
<tr class="memdesc:aabdb4fc957226544a8408167844e4f42 inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="classwx_object.html#a9e31954530a0abd54982effc443ed2b8" title="Pointer to an object which is the object's reference-counted data.">wxObject::m_refData</a> pointer, i.e. the data referenced by this object. <a href="#aabdb4fc957226544a8408167844e4f42"></a><br/></td></tr>
<tr class="separator:aabdb4fc957226544a8408167844e4f42 inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af40d580385cf4f8112fae7713404b01e inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#af40d580385cf4f8112fae7713404b01e">IsKindOf</a> (const <a class="el" href="classwx_class_info.html">wxClassInfo</a> *info) const </td></tr>
<tr class="memdesc:af40d580385cf4f8112fae7713404b01e inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether this class is a subclass of (or the same class as) the given class. <a href="#af40d580385cf4f8112fae7713404b01e"></a><br/></td></tr>
<tr class="separator:af40d580385cf4f8112fae7713404b01e inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a80a1a3fda7b14396a9ddd3d7a46a88bd inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a80a1a3fda7b14396a9ddd3d7a46a88bd">IsSameAs</a> (const <a class="el" href="classwx_object.html">wxObject</a> &obj) const </td></tr>
<tr class="memdesc:a80a1a3fda7b14396a9ddd3d7a46a88bd inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Returns <span class="literal">true</span> if this object has the same data pointer as <em>obj</em>. <a href="#a80a1a3fda7b14396a9ddd3d7a46a88bd"></a><br/></td></tr>
<tr class="separator:a80a1a3fda7b14396a9ddd3d7a46a88bd inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f6f1aa51fe9fc2b1415ca4211a90e9e inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a2f6f1aa51fe9fc2b1415ca4211a90e9e">Ref</a> (const <a class="el" href="classwx_object.html">wxObject</a> &clone)</td></tr>
<tr class="memdesc:a2f6f1aa51fe9fc2b1415ca4211a90e9e inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Makes this object refer to the data in <em>clone</em>. <a href="#a2f6f1aa51fe9fc2b1415ca4211a90e9e"></a><br/></td></tr>
<tr class="separator:a2f6f1aa51fe9fc2b1415ca4211a90e9e inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afab780710f2adc1bb33310e27590140b inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#afab780710f2adc1bb33310e27590140b">SetRefData</a> (<a class="el" href="classwx_object_ref_data.html">wxObjectRefData</a> *data)</td></tr>
<tr class="memdesc:afab780710f2adc1bb33310e27590140b inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Sets the <a class="el" href="classwx_object.html#a9e31954530a0abd54982effc443ed2b8" title="Pointer to an object which is the object's reference-counted data.">wxObject::m_refData</a> pointer. <a href="#afab780710f2adc1bb33310e27590140b"></a><br/></td></tr>
<tr class="separator:afab780710f2adc1bb33310e27590140b inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af51efc6b1ae632fc7f0cd7ebbce9fa36 inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#af51efc6b1ae632fc7f0cd7ebbce9fa36">UnRef</a> ()</td></tr>
<tr class="memdesc:af51efc6b1ae632fc7f0cd7ebbce9fa36 inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Decrements the reference count in the associated data, and if it is zero, deletes the data. <a href="#af51efc6b1ae632fc7f0cd7ebbce9fa36"></a><br/></td></tr>
<tr class="separator:af51efc6b1ae632fc7f0cd7ebbce9fa36 inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a74b40e42d19a4b9e9bec0b57d62a5725 inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a74b40e42d19a4b9e9bec0b57d62a5725">UnShare</a> ()</td></tr>
<tr class="memdesc:a74b40e42d19a4b9e9bec0b57d62a5725 inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">This is the same of <a class="el" href="classwx_object.html#a60204063f3cc3aa2fa1c7ff5bda9eb13" title="Ensure that this object's data is not shared with any other object.">AllocExclusive()</a> but this method is public. <a href="#a74b40e42d19a4b9e9bec0b57d62a5725"></a><br/></td></tr>
<tr class="separator:a74b40e42d19a4b9e9bec0b57d62a5725 inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a07b8f34f5afc5743195c5fed052f55d3 inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a07b8f34f5afc5743195c5fed052f55d3">operator delete</a> (void *buf)</td></tr>
<tr class="memdesc:a07b8f34f5afc5743195c5fed052f55d3 inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">The <em>delete</em> operator is defined for debugging versions of the library only, when the identifier <code><b>WXDEBUG</b></code> is defined. <a href="#a07b8f34f5afc5743195c5fed052f55d3"></a><br/></td></tr>
<tr class="separator:a07b8f34f5afc5743195c5fed052f55d3 inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a96fa423a1dbc212c8227a5d83825971f inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a96fa423a1dbc212c8227a5d83825971f">operator new</a> (size_t size, const <a class="el" href="classwx_string.html">wxString</a> &filename=NULL, int lineNum=0)</td></tr>
<tr class="memdesc:a96fa423a1dbc212c8227a5d83825971f inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">The <em>new</em> operator is defined for debugging versions of the library only, when the identifier <code><b>WXDEBUG</b></code> is defined. <a href="#a96fa423a1dbc212c8227a5d83825971f"></a><br/></td></tr>
<tr class="separator:a96fa423a1dbc212c8227a5d83825971f inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_classwx_socket_base"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classwx_socket_base')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classwx_socket_base.html">wxSocketBase</a></td></tr>
<tr class="memitem:a4c4c4cc8e1fcd824ef621b0f3d17b29f inherit pub_static_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#a4c4c4cc8e1fcd824ef621b0f3d17b29f">Initialize</a> ()</td></tr>
<tr class="memdesc:a4c4c4cc8e1fcd824ef621b0f3d17b29f inherit pub_static_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Perform the initialization needed in order to use the sockets. <a href="#a4c4c4cc8e1fcd824ef621b0f3d17b29f"></a><br/></td></tr>
<tr class="separator:a4c4c4cc8e1fcd824ef621b0f3d17b29f inherit pub_static_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acfa7398ce7fac6e8db20caeb3a09b10e inherit pub_static_methods_classwx_socket_base"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_socket_base.html#acfa7398ce7fac6e8db20caeb3a09b10e">Shutdown</a> ()</td></tr>
<tr class="memdesc:acfa7398ce7fac6e8db20caeb3a09b10e inherit pub_static_methods_classwx_socket_base"><td class="mdescLeft"> </td><td class="mdescRight">Shut down the sockets. <a href="#acfa7398ce7fac6e8db20caeb3a09b10e"></a><br/></td></tr>
<tr class="separator:acfa7398ce7fac6e8db20caeb3a09b10e inherit pub_static_methods_classwx_socket_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_methods_classwx_object"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classwx_object')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classwx_object.html">wxObject</a></td></tr>
<tr class="memitem:a60204063f3cc3aa2fa1c7ff5bda9eb13 inherit pro_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a60204063f3cc3aa2fa1c7ff5bda9eb13">AllocExclusive</a> ()</td></tr>
<tr class="memdesc:a60204063f3cc3aa2fa1c7ff5bda9eb13 inherit pro_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Ensure that this object's data is not shared with any other object. <a href="#a60204063f3cc3aa2fa1c7ff5bda9eb13"></a><br/></td></tr>
<tr class="separator:a60204063f3cc3aa2fa1c7ff5bda9eb13 inherit pro_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a95c6a5e4e1e03ff23c7b9efe4cff0c1a inherit pro_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classwx_object_ref_data.html">wxObjectRefData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a95c6a5e4e1e03ff23c7b9efe4cff0c1a">CreateRefData</a> () const </td></tr>
<tr class="memdesc:a95c6a5e4e1e03ff23c7b9efe4cff0c1a inherit pro_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. <a href="#a95c6a5e4e1e03ff23c7b9efe4cff0c1a"></a><br/></td></tr>
<tr class="separator:a95c6a5e4e1e03ff23c7b9efe4cff0c1a inherit pro_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d39f1d3650fe0982c9a1abe7f9fe7b7 inherit pro_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classwx_object_ref_data.html">wxObjectRefData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a1d39f1d3650fe0982c9a1abe7f9fe7b7">CloneRefData</a> (const <a class="el" href="classwx_object_ref_data.html">wxObjectRefData</a> *data) const </td></tr>
<tr class="memdesc:a1d39f1d3650fe0982c9a1abe7f9fe7b7 inherit pro_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying <em>data</em>. <a href="#a1d39f1d3650fe0982c9a1abe7f9fe7b7"></a><br/></td></tr>
<tr class="separator:a1d39f1d3650fe0982c9a1abe7f9fe7b7 inherit pro_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_attribs_classwx_object"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classwx_object')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classwx_object.html">wxObject</a></td></tr>
<tr class="memitem:a9e31954530a0abd54982effc443ed2b8 inherit pro_attribs_classwx_object"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwx_object_ref_data.html">wxObjectRefData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a9e31954530a0abd54982effc443ed2b8">m_refData</a></td></tr>
<tr class="memdesc:a9e31954530a0abd54982effc443ed2b8 inherit pro_attribs_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to an object which is the object's reference-counted data. <a href="#a9e31954530a0abd54982effc443ed2b8"></a><br/></td></tr>
<tr class="separator:a9e31954530a0abd54982effc443ed2b8 inherit pro_attribs_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a1eaa0a775aa619d4d04d48bd84a8212c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxSocketClient::wxSocketClient </td>
<td>(</td>
<td class="paramtype">wxSocketFlags </td>
<td class="paramname"><em>flags</em> = <code><a class="el" href="socket_8h.html#a1fb9092bcdeada2d206bdc74afbbe122aeb1d7a7c69cad4340559486c04d2336c">wxSOCKET_NONE</a></code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">flags</td><td>Socket flags (See <a class="el" href="classwx_socket_base.html#aa11d1db40c87c8e06e3f9849a08abafc" title="Use SetFlags to customize IO operation for this socket.">wxSocketBase::SetFlags()</a>) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6e55d27056f3bf22b16b25d2fadb01ad"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual wxSocketClient::~wxSocketClient </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<p>Please see <a class="el" href="classwx_socket_base.html#ab0b0926cfdfdd00b8b5c5f7f57cea861" title="Destroys the socket safely.">wxSocketBase::Destroy()</a>. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a581cdb757cce6020c8caac1ddd74a599"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool wxSocketClient::Connect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_sock_address.html">wxSockAddress</a> & </td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>wait</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Connects to a server using the specified address. </p>
<p>If <em>wait</em> is <span class="literal">true</span>, <a class="el" href="classwx_socket_client.html#a581cdb757cce6020c8caac1ddd74a599" title="Connects to a server using the specified address.">Connect()</a> will wait until the connection completes.</p>
<dl class="section warning"><dt>Warning</dt><dd>This method will block the GUI.</dd></dl>
<p>If <em>wait</em> is <span class="literal">false</span>, <a class="el" href="classwx_socket_client.html#a581cdb757cce6020c8caac1ddd74a599" title="Connects to a server using the specified address.">Connect()</a> will try to establish the connection and return immediately, without blocking the GUI. When used this way, even if <a class="el" href="classwx_socket_client.html#a581cdb757cce6020c8caac1ddd74a599" title="Connects to a server using the specified address.">Connect()</a> returns <span class="literal">false</span>, the connection request can be completed later. To detect this, use <a class="el" href="classwx_socket_client.html#a83c92e8c27a72c3610c9eb0b60e92d74" title="Wait until a connection request completes, or until the specified timeout elapses.">WaitOnConnect()</a>, or catch <b>wxSOCKET_CONNECTION</b> events (for successful establishment) and <b>wxSOCKET_LOST</b> events (for connection failure).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">address</td><td>Address of the server. </td></tr>
<tr><td class="paramname">wait</td><td>If <span class="literal">true</span>, waits for the connection to complete.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><span class="literal">true</span> if the connection is established and no error occurs. If <em>wait</em> was true, and <a class="el" href="classwx_socket_client.html#a581cdb757cce6020c8caac1ddd74a599" title="Connects to a server using the specified address.">Connect()</a> returns <span class="literal">false</span>, an error occurred and the connection failed. If <em>wait</em> was <span class="literal">false</span>, and <a class="el" href="classwx_socket_client.html#a581cdb757cce6020c8caac1ddd74a599" title="Connects to a server using the specified address.">Connect()</a> returns <span class="literal">false</span>, you should still be prepared to handle the completion of this connection request, either with <a class="el" href="classwx_socket_client.html#a83c92e8c27a72c3610c9eb0b60e92d74" title="Wait until a connection request completes, or until the specified timeout elapses.">WaitOnConnect()</a> or by watching wxSOCKET_CONNECTION and wxSOCKET_LOST events.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classwx_socket_client.html#a83c92e8c27a72c3610c9eb0b60e92d74" title="Wait until a connection request completes, or until the specified timeout elapses.">WaitOnConnect()</a>, <a class="el" href="classwx_socket_base.html#a4a3883a253c29e0f0027d279c647dbe0" title="Specifies which socket events are to be sent to the event handler.">wxSocketBase::SetNotify()</a>, <a class="el" href="classwx_socket_base.html#acfaca539bd0fe0e9c0b1018c77e6701c" title="According to the notify value, this function enables or disables socket events.">wxSocketBase::Notify()</a> </dd></dl>
<p>Reimplemented in <a class="el" href="classwx_h_t_t_p.html#a9697a75df07e36219114dbb02b5211b8">wxHTTP</a>.</p>
</div>
</div>
<a class="anchor" id="a2167813338c94621a9ee0180524974a5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxSocketClient::Connect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_sock_address.html">wxSockAddress</a> & </td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classwx_sock_address.html">wxSockAddress</a> & </td>
<td class="paramname"><em>local</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>wait</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Connects to a server using the specified address. </p>
<p>If <em>wait</em> is <span class="literal">true</span>, <a class="el" href="classwx_socket_client.html#a581cdb757cce6020c8caac1ddd74a599" title="Connects to a server using the specified address.">Connect()</a> will wait until the connection completes. <b>Warning:</b> This will block the GUI.</p>
<p>If <em>wait</em> is <span class="literal">false</span>, <a class="el" href="classwx_socket_client.html#a581cdb757cce6020c8caac1ddd74a599" title="Connects to a server using the specified address.">Connect()</a> will try to establish the connection and return immediately, without blocking the GUI. When used this way, even if <a class="el" href="classwx_socket_client.html#a581cdb757cce6020c8caac1ddd74a599" title="Connects to a server using the specified address.">Connect()</a> returns <span class="literal">false</span>, the connection request can be completed later. To detect this, use <a class="el" href="classwx_socket_client.html#a83c92e8c27a72c3610c9eb0b60e92d74" title="Wait until a connection request completes, or until the specified timeout elapses.">WaitOnConnect()</a>, or catch <b>wxSOCKET_CONNECTION</b> events (for successful establishment) and <b>wxSOCKET_LOST</b> events (for connection failure).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">address</td><td>Address of the server. </td></tr>
<tr><td class="paramname">local</td><td>Bind to the specified local address and port before connecting. The local address and port can also be set using <a class="el" href="classwx_socket_base.html#a18b26d4201f86daf64c881433c68a1b3" title="Set the local address and port to use.">SetLocal()</a>, and then using the 2-parameter <a class="el" href="classwx_socket_client.html#a581cdb757cce6020c8caac1ddd74a599" title="Connects to a server using the specified address.">Connect()</a> method. </td></tr>
<tr><td class="paramname">wait</td><td>If <span class="literal">true</span>, waits for the connection to complete.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><span class="literal">true</span> if the connection is established and no error occurs. If <em>wait</em> was true, and <a class="el" href="classwx_socket_client.html#a581cdb757cce6020c8caac1ddd74a599" title="Connects to a server using the specified address.">Connect()</a> returns <span class="literal">false</span>, an error occurred and the connection failed. If <em>wait</em> was <span class="literal">false</span>, and <a class="el" href="classwx_socket_client.html#a581cdb757cce6020c8caac1ddd74a599" title="Connects to a server using the specified address.">Connect()</a> returns <span class="literal">false</span>, you should still be prepared to handle the completion of this connection request, either with <a class="el" href="classwx_socket_client.html#a83c92e8c27a72c3610c9eb0b60e92d74" title="Wait until a connection request completes, or until the specified timeout elapses.">WaitOnConnect()</a> or by watching wxSOCKET_CONNECTION and wxSOCKET_LOST events.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classwx_socket_client.html#a83c92e8c27a72c3610c9eb0b60e92d74" title="Wait until a connection request completes, or until the specified timeout elapses.">WaitOnConnect()</a>, <a class="el" href="classwx_socket_base.html#a4a3883a253c29e0f0027d279c647dbe0" title="Specifies which socket events are to be sent to the event handler.">wxSocketBase::SetNotify()</a>, <a class="el" href="classwx_socket_base.html#acfaca539bd0fe0e9c0b1018c77e6701c" title="According to the notify value, this function enables or disables socket events.">wxSocketBase::Notify()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a83c92e8c27a72c3610c9eb0b60e92d74"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxSocketClient::WaitOnConnect </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>seconds</em> = <code>-1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>milliseconds</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wait until a connection request completes, or until the specified timeout elapses. </p>
<p>Use this function after issuing a call to <a class="el" href="classwx_socket_client.html#a581cdb757cce6020c8caac1ddd74a599" title="Connects to a server using the specified address.">Connect()</a> with <em>wait</em> set to <span class="literal">false</span>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">seconds</td><td>Number of seconds to wait. If -1, it will wait for the default timeout, as set with <a class="el" href="classwx_socket_base.html#ac24247e3f866154825c14de46a911e50" title="Set the default socket timeout in seconds.">wxSocketBase::SetTimeout()</a>. </td></tr>
<tr><td class="paramname">milliseconds</td><td>Number of milliseconds to wait.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classwx_socket_client.html#a83c92e8c27a72c3610c9eb0b60e92d74" title="Wait until a connection request completes, or until the specified timeout elapses.">WaitOnConnect()</a> returns <span class="literal">true</span> if the connection request completes. This does not necessarily mean that the connection was successfully established; it might also happen that the connection was refused by the peer. Use <a class="el" href="classwx_socket_base.html#a2d171f3eac0dbc9211f0032188d381ac" title="Returns true if the socket is connected.">wxSocketBase::IsConnected()</a> to distinguish between these two situations. <br/>
<br/>
If the timeout elapses, <a class="el" href="classwx_socket_client.html#a83c92e8c27a72c3610c9eb0b60e92d74" title="Wait until a connection request completes, or until the specified timeout elapses.">WaitOnConnect()</a> returns <span class="literal">false</span>. <br/>
<br/>
These semantics allow code like this: <div class="fragment"><div class="line"><span class="comment">// Issue the connection request</span></div>
<div class="line">client->Connect(addr, <span class="keyword">false</span>);</div>
<div class="line"></div>
<div class="line"><span class="comment">// Wait until the request completes or until we decide to give up</span></div>
<div class="line"><span class="keywordtype">bool</span> waitmore = <span class="keyword">true</span>;</div>
<div class="line"><span class="keywordflow">while</span> ( !client->WaitOnConnect(seconds, millis) && waitmore )</div>
<div class="line">{</div>
<div class="line"> <span class="comment">// possibly give some feedback to the user,</span></div>
<div class="line"> <span class="comment">// and update waitmore as needed.</span></div>
<div class="line">}</div>
<div class="line"><span class="keywordtype">bool</span> success = client->IsConnected();</div>
</div><!-- fragment --> </dd></dl>
</div>
</div>
</div><!-- contents -->
<address class="footer">
<small>
Generated on Thu Nov 27 2014 13:46:58 for wxWidgets by <a href="http://www.doxygen.org/index.html" target="_new">Doxygen</a> 1.8.2
</small>
</address>
<script src="wxwidgets.js" type="text/javascript"></script>
</div><!-- #page_container -->
</body>
</html>
|
