## wxTCPConnection

A wxTCPClient object represents the connection between a client and a server. 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 wxDDEConnection.

A wxTCPConnection object can be created by making a connection using a wxTCPClient object, or by the acceptance of a connection by a wxTCPServer object. The bulk of a conversation is controlled by calling members in a wxTCPConnection object or by overriding its members.

An application should normally derive a new connection class from wxTCPConnection, in order to override the communication event handlers to do something interesting.

Derived from

wxConnectionBase
wxObject

Include files

<wx/sckipc.h>

Types

wxIPCFormat is defined as follows:

    enum wxIPCFormat
    {
      wxIPC_INVALID =          0,
      wxIPC_TEXT =             1,  /* CF_TEXT */
      wxIPC_BITMAP =           2,  /* CF_BITMAP */
      wxIPC_METAFILE =         3,  /* CF_METAFILEPICT */
      wxIPC_SYLK =             4,
      wxIPC_DIF =              5,
      wxIPC_TIFF =             6,
      wxIPC_OEMTEXT =          7,  /* CF_OEMTEXT */
      wxIPC_DIB =              8,  /* CF_DIB */
      wxIPC_PALETTE =          9,
      wxIPC_PENDATA =          10,
      wxIPC_RIFF =             11,
      wxIPC_WAVE =             12,
      wxIPC_UNICODETEXT =      13,
      wxIPC_ENHMETAFILE =      14,
      wxIPC_FILENAME =         15, /* CF_HDROP */
      wxIPC_LOCALE =           16,
      wxIPC_PRIVATE =          20
    };

See also

wxTCPClient, wxTCPServer, Interprocess communications overview

Members

wxTCPConnection::wxTCPConnection
wxTCPConnection::Advise
wxTCPConnection::Execute
wxTCPConnection::Disconnect
wxTCPConnection::OnAdvise
wxTCPConnection::OnDisconnect
wxTCPConnection::OnExecute
wxTCPConnection::OnPoke
wxTCPConnection::OnRequest
wxTCPConnection::OnStartAdvise
wxTCPConnection::OnStopAdvise
wxTCPConnection::Poke
wxTCPConnection::Request
wxTCPConnection::StartAdvise
wxTCPConnection::StopAdvise

### wxTCPConnection::wxTCPConnection

wxTCPConnection()

wxTCPConnection(char* buffer, int size)

Constructs a connection object. If no user-defined connection object is to be derived from wxTCPConnection, then the constructor should not be called directly, since the default connection object will be provided on requesting (or accepting) a connection. However, if the user defines his or her own derived connection object, the wxTCPServer::OnAcceptConnection and/or wxTCPClient::OnMakeConnection members should be replaced by functions which construct the new connection object. If the arguments of the wxTCPConnection constructor are void, then a default buffer is associated with the connection. Otherwise, the programmer must provide a a buffer and size of the buffer for the connection object to use in transactions.

### wxTCPConnection::Advise

bool Advise(const wxString& item, char* data, int size = -1, wxIPCFormat format = wxCF_TEXT)

Called by the server application to advise the client of a change in the data associated with the given item. Causes the client connection's wxTCPConnection::OnAdvise member to be called. Returns TRUE if successful.

### wxTCPConnection::Execute

bool Execute(char* data, int size = -1, wxIPCFormat format = wxCF_TEXT)

Called by the client application to execute a command on the server. Can also be used to transfer arbitrary data to the server (similar to wxTCPConnection::Poke in that respect). Causes the server connection's wxTCPConnection::OnExecute member to be called. Returns TRUE if successful.

### wxTCPConnection::Disconnect

bool Disconnect()

Called by the client or server application to disconnect from the other program; it causes the wxTCPConnection::OnDisconnect message to be sent to the corresponding connection object in the other program. The default behaviour of OnDisconnect is to delete the connection, but the calling application must explicitly delete its side of the connection having called Disconnect. Returns TRUE if successful.

### wxTCPConnection::OnAdvise

virtual bool OnAdvise(const wxString& topic, const wxString& item, char* data, int size, wxIPCFormat format)

Message sent to the client application when the server notifies it of a change in the data associated with the given item.

### wxTCPConnection::OnDisconnect

virtual bool OnDisconnect()

Message sent to the client or server application when the other application notifies it to delete the connection. Default behaviour is to delete the connection object.

### wxTCPConnection::OnExecute

virtual bool OnExecute(const wxString& topic, char* data, int size, wxIPCFormat format)

Message sent to the server application when the client notifies it to execute the given data. Note that there is no item associated with this message.

### wxTCPConnection::OnPoke

virtual bool OnPoke(const wxString& topic, const wxString& item, char* data, int size, wxIPCFormat format)

Message sent to the server application when the client notifies it to accept the given data.

### wxTCPConnection::OnRequest

virtual char* OnRequest(const wxString& topic, const wxString& item, int *size, wxIPCFormat format)

Message sent to the server application when the client calls wxTCPConnection::Request. The server should respond by returning a character string from OnRequest, or NULL to indicate no data.

### wxTCPConnection::OnStartAdvise

virtual bool OnStartAdvise(const wxString& topic, const wxString& item)

Message sent to the server application by the client, when the client wishes to start an 'advise loop' for the given topic and item. The server can refuse to participate by returning FALSE.

### wxTCPConnection::OnStopAdvise

virtual bool OnStopAdvise(const wxString& topic, const wxString& item)

Message sent to the server application by the client, when the client wishes to stop an 'advise loop' for the given topic and item. The server can refuse to stop the advise loop by returning FALSE, although this doesn't have much meaning in practice.

### wxTCPConnection::Poke

bool Poke(const wxString& item, char* data, int size = -1, wxIPCFormat format = wxCF_TEXT)

Called by the client application to poke data into the server. Can be used to transfer arbitrary data to the server. Causes the server connection's wxTCPConnection::OnPoke member to be called. Returns TRUE if successful.

### wxTCPConnection::Request

char* Request(const wxString& item, int *size, wxIPCFormat format = wxIPC_TEXT)

Called by the client application to request data from the server. Causes the server connection's wxTCPConnection::OnRequest member to be called. Returns a character string (actually a pointer to the connection's buffer) if successful, NULL otherwise.

### wxTCPConnection::StartAdvise

bool StartAdvise(const wxString& item)

Called by the client application to ask if an advise loop can be started with the server. Causes the server connection's wxTCPConnection::OnStartAdvise member to be called. Returns TRUE if the server okays it, FALSE otherwise.

### wxTCPConnection::StopAdvise

bool StopAdvise(const wxString& item)

Called by the client application to ask if an advise loop can be stopped. Causes the server connection's wxTCPConnection::OnStopAdvise member to be called. Returns TRUE if the server okays it, FALSE otherwise.