]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/tcpservr.tex
added wxMessageQueue class for inter-thread communications
[wxWidgets.git] / docs / latex / wx / tcpservr.tex
CommitLineData
e2a6f233
JS
1\section{\class{wxTCPServer}}\label{wxtcpserver}
2
3A wxTCPServer object represents the server part of a client-server conversation.
4It emulates a DDE-style protocol, but uses TCP/IP which is available on most platforms.
5
6A DDE-based implementation for Windows is available using \helpref{wxDDEServer}{wxddeserver}.
7
8\wxheading{Derived from}
9
10wxServerBase\\
11\helpref{wxObject}{wxobject}
12
954b8ae6
JS
13\wxheading{Include files}
14
15<wx/sckipc.h>
16
a7af285d
VZ
17\wxheading{Library}
18
19\helpref{wxNet}{librarieslist}
20
e2a6f233
JS
21\wxheading{See also}
22
23\helpref{wxTCPClient}{wxtcpclient}, \helpref{wxTCPConnection}{wxtcpconnection}, \helpref{IPC overview}{ipcoverview}
24
25\latexignore{\rtfignore{\wxheading{Members}}}
26
f510b7b2 27\membersection{wxTCPServer::wxTCPServer}\label{wxtcpserverctor}
e2a6f233
JS
28
29\func{}{wxTCPServer}{\void}
30
31Constructs a server object.
32
f510b7b2 33\membersection{wxTCPServer::Create}\label{wxtcpservercreate}
e2a6f233
JS
34
35\func{bool}{Create}{\param{const wxString\& }{service}}
36
37Registers the server using the given service name. Under Unix, the
38string must contain an integer id which is used as an Internet port
cc81d32f 39number. false is returned if the call failed (for example, the port
e2a6f233
JS
40number is already in use).
41
42\membersection{wxTCPServer::OnAcceptConnection}\label{wxtcpserveronacceptconnection}
43
44\func{virtual wxConnectionBase *}{OnAcceptConnection}{\param{const wxString\& }{topic}}
45
46When a client calls {\bf MakeConnection}, the server receives the
47message and this member is called. The application should derive a
48member to intercept this message and return a connection object of
49either the standard wxTCPConnection type, or of a user-derived type. If the
50topic is ``STDIO'', the application may wish to refuse the connection.
51Under Unix, when a server is created the OnAcceptConnection message is
52always sent for standard input and output.
53