# wxTCPConnection Class Reference
[Networking]

`#include <wx/sckipc.h>`

Inheritance diagram for wxTCPConnection:
[legend]

## Detailed Description

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.

##

Library: wxNet

Category: Networking

See also:
  wxTCPClient, wxTCPServer, Interprocess Communication

## Public Member Functions
virtual bool | Disconnect ()
| Called by the client or server application to disconnect from the other program; it causes the OnDisconnect() message to be sent to the corresponding connection object in the other program.
virtual bool | OnAdvise (const wxString &topic, const wxString &item, const void *data, size_t 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.
virtual bool | OnDisconnect ()
| Message sent to the client or server application when the other application notifies it to delete the connection.
virtual bool | OnExecute (const wxString &topic, const void *data, size_t size, wxIPCFormat format)
| Message sent to the server application when the client notifies it to execute the given data.
virtual bool | OnPoke (const wxString &topic, const wxString &item, const void *data, size_t size, wxIPCFormat format)
| Message sent to the server application when the client notifies it to accept the given data.
virtual const void * | OnRequest (const wxString &topic, const wxString &item, size_t *size, wxIPCFormat format)
| Message sent to the server application when the client calls Request().
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.
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.
virtual const void * | Request (const wxString &item, size_t *size=0, wxIPCFormat format=wxIPC_TEXT)
| Called by the client application to request data from the server.
virtual bool | StartAdvise (const wxString &item)
| Called by the client application to ask if an advise loop can be started with the server.
virtual bool | StopAdvise (const wxString &item)
| Called by the client application to ask if an advise loop can be stopped.
| wxTCPConnection ()
| Constructs a connection object.
| wxTCPConnection (void *buffer, size_t size)
| Constructs a connection object.
bool | Advise (const wxString &item, const void *data, size_t size, wxIPCFormat format=wxIPC_PRIVATE)
| Called by the server application to advise the client of a change in the data associated with the given item.
bool | Advise (const wxString &item, const char *data)
| Called by the server application to advise the client of a change in the data associated with the given item.
bool | Advise (const wxString &item, const wchar_t *data)
| Called by the server application to advise the client of a change in the data associated with the given item.
bool | Advise (const wxString &item, const wxString data)
| Called by the server application to advise the client of a change in the data associated with the given item.
bool | Execute (const void *data, size_t size, wxIPCFormat format=wxIPC_PRIVATE)
| Called by the client application to execute a command on the server.
bool | Execute (const char *data)
| Called by the client application to execute a command on the server.
bool | Execute (const wchar_t *data)
| Called by the client application to execute a command on the server.
bool | Execute (const wxString data)
| Called by the client application to execute a command on the server.
bool | Poke (const wxString &item, const void *data, size_t size, wxIPCFormat format=wxIPC_PRIVATE)
| Called by the client application to poke data into the server.
bool | Poke (const wxString &item, const char *data)
| Called by the client application to poke data into the server.
bool | Poke (const wxString &item, const wchar_t *data)
| Called by the client application to poke data into the server.
bool | Poke (const wxString &item, const wxString data)
| Called by the client application to poke data into the server.

List of all members.

## Constructor & Destructor Documentation

wxTCPConnection::wxTCPConnection | ( |  | ) |

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 buffer and size of the buffer for the connection object to use in transactions.

wxTCPConnection::wxTCPConnection | ( | void * | buffer,
|  | size_t | 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 buffer and size of the buffer for the connection object to use in transactions.

## Member Function Documentation

bool wxTCPConnection::Advise | ( | const wxString & | item,
|  | const wxString | data |
| ) |  |  |

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 OnAdvise() member to be called.

Returns true if successful.

bool wxTCPConnection::Advise | ( | const wxString & | item,
|  | const wchar_t * | data |
| ) |  |  |

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 OnAdvise() member to be called.

Returns true if successful.

bool wxTCPConnection::Advise | ( | const wxString & | item,
|  | const char * | data |
| ) |  |  |

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 OnAdvise() member to be called.

Returns true if successful.

bool wxTCPConnection::Advise | ( | const wxString & | item,
|  | const void * | data,
|  | size_t | size,
|  | wxIPCFormat | format = `wxIPC_PRIVATE` |
| ) |  |  |

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 OnAdvise() member to be called.

Returns true if successful.

virtual bool wxTCPConnection::Disconnect | ( |  | ) | `[virtual]`

Called by the client or server application to disconnect from the other program; it causes the 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.

bool wxTCPConnection::Execute | ( | const wxString | data | ) |

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 Poke() in that respect). Causes the server connection's OnExecute() member to be called.

Returns true if successful.

bool wxTCPConnection::Execute | ( | const wchar_t * | data | ) |

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 Poke() in that respect). Causes the server connection's OnExecute() member to be called.

Returns true if successful.

bool wxTCPConnection::Execute | ( | const char * | data | ) |

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 Poke() in that respect). Causes the server connection's OnExecute() member to be called.

Returns true if successful.

bool wxTCPConnection::Execute | ( | const void * | data,
|  | size_t | size,
|  | wxIPCFormat | format = `wxIPC_PRIVATE` |
| ) |  |  |

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 Poke() in that respect). Causes the server connection's OnExecute() member to be called.

Returns true if successful.

virtual bool wxTCPConnection::OnAdvise | ( | const wxString & | topic,
|  | const wxString & | item,
|  | const void * | data,
|  | size_t | size,
|  | wxIPCFormat | format |
| ) |  |  | `[virtual]`

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

virtual bool wxTCPConnection::OnDisconnect | ( |  | ) | `[virtual]`

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.

virtual bool wxTCPConnection::OnExecute | ( | const wxString & | topic,
|  | const void * | data,
|  | size_t | size,
|  | wxIPCFormat | format |
| ) |  |  | `[virtual]`

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.

virtual bool wxTCPConnection::OnPoke | ( | const wxString & | topic,
|  | const wxString & | item,
|  | const void * | data,
|  | size_t | size,
|  | wxIPCFormat | format |
| ) |  |  | `[virtual]`

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

virtual const void* wxTCPConnection::OnRequest | ( | const wxString & | topic,
|  | const wxString & | item,
|  | size_t * | size,
|  | wxIPCFormat | format |
| ) |  |  | `[virtual]`

Message sent to the server application when the client calls Request().

The server should respond by returning a character string from OnRequest, or NULL to indicate no data.

virtual bool wxTCPConnection::OnStartAdvise | ( | const wxString & | topic,
|  | const wxString & | item |
| ) |  |  | `[virtual]`

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.

virtual bool wxTCPConnection::OnStopAdvise | ( | const wxString & | topic,
|  | const wxString & | item |
| ) |  |  | `[virtual]`

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.

bool wxTCPConnection::Poke | ( | const wxString & | item,
|  | const wxString | data |
| ) |  |  |

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 OnPoke() member to be called. Returns true if successful.

bool wxTCPConnection::Poke | ( | const wxString & | item,
|  | const wchar_t * | data |
| ) |  |  |

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 OnPoke() member to be called. Returns true if successful.

bool wxTCPConnection::Poke | ( | const wxString & | item,
|  | const char * | data |
| ) |  |  |

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 OnPoke() member to be called. Returns true if successful.

bool wxTCPConnection::Poke | ( | const wxString & | item,
|  | const void * | data,
|  | size_t | size,
|  | wxIPCFormat | format = `wxIPC_PRIVATE` |
| ) |  |  |

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 OnPoke() member to be called. Returns true if successful.

virtual const void* wxTCPConnection::Request | ( | const wxString & | item,
|  | size_t * | size = `0`,
|  | wxIPCFormat | format = `wxIPC_TEXT` |
| ) |  |  | `[virtual]`

Called by the client application to request data from the server.

Causes the server connection's OnRequest() member to be called.

Returns a character string (actually a pointer to the connection's buffer) if successful, NULL otherwise.

virtual bool wxTCPConnection::StartAdvise | ( | const wxString & | item | ) | `[virtual]`

Called by the client application to ask if an advise loop can be started with the server.

Causes the server connection's OnStartAdvise() member to be called. Returns true if the server okays it, false otherwise.

virtual bool wxTCPConnection::StopAdvise | ( | const wxString & | item | ) | `[virtual]`

Called by the client application to ask if an advise loop can be stopped.

Causes the server connection's OnStopAdvise() member to be called. Returns true if the server okays it, false otherwise.

|  | [ top ]