]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/tcpservr.tex
corrected the completely wrong example (bug 545427)
[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
e2a6f233
JS
17\wxheading{See also}
18
19\helpref{wxTCPClient}{wxtcpclient}, \helpref{wxTCPConnection}{wxtcpconnection}, \helpref{IPC overview}{ipcoverview}
20
21\latexignore{\rtfignore{\wxheading{Members}}}
22
23\membersection{wxTCPServer::wxTCPServer}
24
25\func{}{wxTCPServer}{\void}
26
27Constructs a server object.
28
29\membersection{wxTCPServer::Create}
30
31\func{bool}{Create}{\param{const wxString\& }{service}}
32
33Registers the server using the given service name. Under Unix, the
34string must contain an integer id which is used as an Internet port
35number. FALSE is returned if the call failed (for example, the port
36number is already in use).
37
38\membersection{wxTCPServer::OnAcceptConnection}\label{wxtcpserveronacceptconnection}
39
40\func{virtual wxConnectionBase *}{OnAcceptConnection}{\param{const wxString\& }{topic}}
41
42When a client calls {\bf MakeConnection}, the server receives the
43message and this member is called. The application should derive a
44member to intercept this message and return a connection object of
45either the standard wxTCPConnection type, or of a user-derived type. If the
46topic is ``STDIO'', the application may wish to refuse the connection.
47Under Unix, when a server is created the OnAcceptConnection message is
48always sent for standard input and output.
49