projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| e2a6f233 JS |
1 | \section{\class{wxTCPServer}}\label{wxtcpserver} |
| 2 | ||
| 3 | A wxTCPServer object represents the server part of a client-server conversation. | |
| 4 | It emulates a DDE-style protocol, but uses TCP/IP which is available on most platforms. | |
| 5 | ||
| 6 | A DDE-based implementation for Windows is available using \helpref{wxDDEServer}{wxddeserver}. | |
| 7 | ||
| 8 | \wxheading{Derived from} | |
| 9 | ||
| 10 | wxServerBase\\ | |
| 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 | ||
| f510b7b2 | 23 | \membersection{wxTCPServer::wxTCPServer}\label{wxtcpserverctor} |
| e2a6f233 JS |
24 | |
| 25 | \func{}{wxTCPServer}{\void} | |
| 26 | ||
| 27 | Constructs a server object. | |
| 28 | ||
| f510b7b2 | 29 | \membersection{wxTCPServer::Create}\label{wxtcpservercreate} |
| e2a6f233 JS |
30 | |
| 31 | \func{bool}{Create}{\param{const wxString\& }{service}} | |
| 32 | ||
| 33 | Registers the server using the given service name. Under Unix, the | |
| 34 | string must contain an integer id which is used as an Internet port | |
| cc81d32f | 35 | number. false is returned if the call failed (for example, the port |
| e2a6f233 JS |
36 | number is already in use). |
| 37 | ||
| 38 | \membersection{wxTCPServer::OnAcceptConnection}\label{wxtcpserveronacceptconnection} | |
| 39 | ||
| 40 | \func{virtual wxConnectionBase *}{OnAcceptConnection}{\param{const wxString\& }{topic}} | |
| 41 | ||
| 42 | When a client calls {\bf MakeConnection}, the server receives the | |
| 43 | message and this member is called. The application should derive a | |
| 44 | member to intercept this message and return a connection object of | |
| 45 | either the standard wxTCPConnection type, or of a user-derived type. If the | |
| 46 | topic is ``STDIO'', the application may wish to refuse the connection. | |
| 47 | Under Unix, when a server is created the OnAcceptConnection message is | |
| 48 | always sent for standard input and output. | |
| 49 |