.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxTCPClient 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxTCPClient \- 
.SH DESCRIPTION

  


   A wxTCPClient object represents the client part of a client-server
   conversation. It emulates a DDE-style protocol, but uses TCP/IP which is
   available on most platforms.
  
  


   A DDE-based implementation for Windows is available using
   wxDDEClient
   .
  
  


   To create a client which can communicate with a suitable server, you need to
   derive a class from wxTCPConnection and another from wxTCPClient. The custom
   wxTCPConnection class will intercept communications in a `conversation' with
   a server, and the custom wxTCPServer is required so that a user-overridden
   wxTCPClient::OnMakeConnection
   member can return a wxTCPConnection of the required class, when a connection
   is made.
  
 
.SH "PARENTS"

  wxClientBase
  wxObject
 
.SH "INCLUDE FILES"
wx/sckipc.h
.SH MEMBERS

  
.SS  wxTCPClient ()

     


      Constructs a client object.
     
    
   
  
.SS wxConnectionBase * MakeConnection (const wxString& hostconst wxString& serviceconst wxString& topic)

     


      Tries to make a connection with a server specified by the host (a machine
      name under Unix), service name (must contain an integer port number under
      Unix), and a topic string. If the server allows a connection, a
      wxTCPConnection object will be returned. The type of wxTCPConnection
      returned can be altered by overriding the
      wxTCPClient::OnMakeConnection
      member to return your own derived connection object.
     
    
   
  
.SS wxConnectionBase * OnMakeConnection ()

     


      The type of
      wxTCPConnection
      returned from a
      wxTCPClient::MakeConnection
      call can be altered by deriving the
      
       OnMakeConnection
      
      member to return your own derived connection object. By default, a
      wxTCPConnection object is returned.
     
     


      The advantage of deriving your own connection class is that it will enable
      you to intercept messages initiated by the server, such as
      wxTCPConnection::OnAdvise
      . You may also want to store application-specific data in instances of the
      new class.
     
    
   
  
.SS bool ValidHost (const wxString& host)

     


      Returns true if this is a valid host name, false otherwise.
     
    
 
.SH "SEE ALSO"

  wxClientBase
  wxObject
 
  wxTCPServer
  wxTCPConnection
   
  Interprocess communications overview
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.