File: wx210.htm

package info (click to toggle)
wxwin2-doc 2.01-1
  • links: PTS
  • area: main
  • in suites: potato
  • size: 6,540 kB
  • ctags: 5,968
  • sloc: cpp: 15,157; makefile: 434; sh: 6
file content (67 lines) | stat: -rw-r--r-- 2,776 bytes parent folder | download
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
<HTML>
<head><title>wxSocketClient</title></head>

<BODY BGCOLOR=#FFFFFF>
<A NAME="wxsocketclient"></A><CENTER>
<A HREF="wx.htm"><img align=center src="contents.gif" BORDER=0 ALT="Contents"></A> <A HREF="wx22.htm#classref"><img align=center src="up.gif" BORDER=0 ALT="Up"></A> <A HREF="wx209.htm#wxsocketbase"><img align=center src="back.gif" BORDER=0 ALT="Previous"></A> <A HREF="wx211.htm#wxsocketevent"><img align=center src="forward.gif" BORDER=0 ALT="Next"></A> </CENTER><HR>

<H2>wxSocketClient</H2>
<P>
<B><FONT COLOR="#FF0000">Derived from</FONT></B><P>
<A HREF="wx209.htm#wxsocketbase">wxSocketBase</A><P>
<B><FONT COLOR="#FF0000">Include files</FONT></B><P>
&lt;wx/socket.h&gt;<P>
<A HREF="#topic827">wxSocketClient::wxSocketClient</A><BR>
<A HREF="#topic828">wxSocketClient::~wxSocketClient</A><BR>
<A HREF="#wxsocketclientconnect">wxSocketClient::Connect</A><BR>
<A HREF="#wxsocketclientwaitonconnect">wxSocketClient::WaitOnConnect</A><BR>
<P>

<HR>
<A NAME="topic827"></A>
<H3>wxSocketClient::wxSocketClient</H3>
<P>
<B></B> <B>wxSocketClient</B>(<B>wxSockFlags</B><I> flags = wxSocketBase::NONE</I>)<P>
Constructs a new wxSocketClient.<P>
<B>Warning !</B> The new socket client needs to be registered to a socket handler (See <A HREF="wx212.htm#wxsockethandler">wxSocketHandler</A>).<P>
<B><FONT COLOR="#FF0000">Parameters</FONT></B><P>
<I>flags</I><UL><UL>
Socket flags (See <A HREF="wx209.htm#wxsocketbasesetflags">wxSocketBase::SetFlags</A>)</UL></UL>
<P>

<HR>
<A NAME="topic828"></A>
<H3>wxSocketClient::~wxSocketClient</H3>
<P>
<B></B> <B>~wxSocketClient</B>()<P>
Destroys a wxSocketClient object.<P>

<HR>
<A NAME="wxsocketclientconnect"></A>
<H3>wxSocketClient::Connect</H3>
<P>
<B>bool</B> <B>Connect</B>(<B>wxSockAddress&amp;</B><I> address</I>, <B>bool</B><I> wait = TRUE</I>)<P>
Connects to a server using the specified address. If <I>wait</I> is TRUE, Connect
will wait for the socket ready to send or receive data.<P>
<B><FONT COLOR="#FF0000">Parameters</FONT></B><P>
<I>address</I><UL><UL>
Address of the server.</UL></UL>
<P>
<I>wait</I><UL><UL>
If true, waits for the connection to be ready.</UL></UL>
<P>
<B><FONT COLOR="#FF0000">Return value</FONT></B><P>
Returns TRUE if the connection is established and no error occurs.<P>
<B><FONT COLOR="#FF0000">See also</FONT></B><P>
<A HREF="wx210.htm#wxsocketclientwaitonconnect">wxSocketClient::WaitOnConnect</A><P>

<HR>
<A NAME="wxsocketclientwaitonconnect"></A>
<H3>wxSocketClient::WaitOnConnect</H3>
<P>
<B>bool</B> <B>WaitOnConnect</B>(<B>long</B><I> seconds = -1</I>, <B>long</B><I> microseconds = 0</I>)<P>
Wait for a "connect" event.<P>
<B><FONT COLOR="#FF0000">See also</FONT></B><P>
<A HREF="wx209.htm#wxsocketbasewait">wxSocketBase::Wait</A> for a detailed description.<P>

</BODY></HTML>