git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	\section{\class{wxTCPClient}}\label{wxtcpclient}
	2
	3	A wxTCPClient object represents the client 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{wxDDEClient}{wxddeclient}.
	7
	8	To create a client which can communicate with a suitable server,
	9	you need to derive a class from wxTCPConnection and another from wxTCPClient.
	10	The custom wxTCPConnection class will intercept communications in
	11	a `conversation' with a server, and the custom wxTCPServer is required
	12	so that a user-overridden \helpref{wxTCPClient::OnMakeConnection}{wxtcpclientonmakeconnection} member can return
	13	a wxTCPConnection of the required class, when a connection is made.
	14
	15	\wxheading{Derived from}
	16
	17	wxClientBase\\
	18	\helpref{wxObject}{wxobject}
	19
	20	\wxheading{Include files}
	21
	22	<wx/sckipc.h>
	23
	24	\wxheading{See also}
	25
	26	\helpref{wxTCPServer}{wxtcpserver}, \helpref{wxTCPConnection}{wxtcpconnection},
	27	\helpref{Interprocess communications overview}{ipcoverview}
	28
	29	\latexignore{\rtfignore{\wxheading{Members}}}
	30
	31	\membersection{wxTCPClient::wxTCPClient}\label{wxtcpclientctor}
	32
	33	\func{}{wxTCPClient}{\void}
	34
	35	Constructs a client object.
	36
	37	\membersection{wxTCPClient::MakeConnection}\label{wxtcpclientmakeconnection}
	38
	39	\func{wxConnectionBase *}{MakeConnection}{\param{const wxString\& }{host}, \param{const wxString\& }{service}, \param{const wxString\& }{topic}}
	40
	41	Tries to make a connection with a server specified by the host
	42	(a machine name under Unix), service name (must
	43	contain an integer port number under Unix), and a topic string. If the
	44	server allows a connection, a wxTCPConnection object will be returned.
	45	The type of wxTCPConnection returned can be altered by overriding
	46	the \helpref{wxTCPClient::OnMakeConnection}{wxtcpclientonmakeconnection} member to return your own
	47	derived connection object.
	48
	49	\membersection{wxTCPClient::OnMakeConnection}\label{wxtcpclientonmakeconnection}
	50
	51	\func{wxConnectionBase *}{OnMakeConnection}{\void}
	52
	53	The type of \helpref{wxTCPConnection}{wxtcpconnection} returned from a \helpref{wxTCPClient::MakeConnection}{wxtcpclientmakeconnection} call can
	54	be altered by deriving the {\bf OnMakeConnection} member to return your
	55	own derived connection object. By default, a wxTCPConnection
	56	object is returned.
	57
	58	The advantage of deriving your own connection class is that it will
	59	enable you to intercept messages initiated by the server, such
	60	as \helpref{wxTCPConnection::OnAdvise}{wxtcpconnectiononadvise}. You may also want to
	61	store application-specific data in instances of the new class.
	62
	63	\membersection{wxTCPClient::ValidHost}\label{wxtcpclientvalidhost}
	64
	65	\func{bool}{ValidHost}{\param{const wxString\& }{host}}
	66
	67	Returns true if this is a valid host name, false otherwise.
	68