/////////////////////////////////////////////////////////////////////////////
// Name: sckipc.cpp
// Purpose: Interprocess communication implementation (wxSocket version)
-// Author: Julian Smart, Guilhem Lavaux
+// Author: Julian Smart
// Modified by: Guilhem Lavaux (big rewrite) May 1997, 1998
+// Guillermo Rodriguez (updated for wxSocket v2) Jan 2000
+// (callbacks deprecated) Mar 2000
+// Vadim Zeitlin (added support for Unix sockets) Apr 2002
// Created: 1993
// RCS-ID: $Id$
-// Copyright: (c) Julian Smart 1993, Guilhem Lavaux 1997, 1998
+// Copyright: (c) Julian Smart 1993
+// (c) Guilhem Lavaux 1997, 1998
+// (c) 2000 Guillermo Rodriguez <guille@iies.es>
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
+// ==========================================================================
+// declarations
+// ==========================================================================
+
+// --------------------------------------------------------------------------
+// headers
+// --------------------------------------------------------------------------
+
#ifdef __GNUG__
#pragma implementation "sckipc.h"
#endif
#pragma hdrstop
#endif
-#if wxUSE_SOCKETS
-
#ifndef WX_PRECOMP
+#include "wx/log.h"
#endif
+#if wxUSE_SOCKETS && wxUSE_IPC && wxUSE_STREAMS
+
#include <stdlib.h>
#include <stdio.h>
+#include <errno.h>
#include "wx/socket.h"
#include "wx/sckipc.h"
+#include "wx/module.h"
+#include "wx/event.h"
-#ifdef __BORLANDC__
-#pragma hdrstop
-#endif
-
-#if !USE_SHARED_LIBRARY
-IMPLEMENT_DYNAMIC_CLASS(wxTCPServer, wxServerBase)
-IMPLEMENT_DYNAMIC_CLASS(wxTCPClient, wxClientBase)
-IMPLEMENT_DYNAMIC_CLASS(wxTCPConnection, wxConnectionBase)
-#endif
+// --------------------------------------------------------------------------
+// macros and constants
+// --------------------------------------------------------------------------
// It seems to be already defined somewhere in the Xt includes.
#ifndef __XT__
// Message codes
-enum {
+enum
+{
IPC_EXECUTE = 1,
IPC_REQUEST,
IPC_POKE,
};
#endif
-void Server_OnRequest(wxSocketServer& server,
- wxSocketNotify evt,
- char *cdata);
-void Client_OnRequest(wxSocketBase& sock,
- wxSocketNotify evt,
- char *cdata);
+// All sockets will be created with the following flags
+#define SCKIPC_FLAGS (wxSOCKET_WAITALL)
+
+// headers needed for umask()
+#ifdef __UNIX_LIKE__
+ #include <sys/types.h>
+ #include <sys/stat.h>
+#endif // __UNIX_LIKE__
+
+// ----------------------------------------------------------------------------
+// private functions
+// ----------------------------------------------------------------------------
+
+// get the address object for the given server name, the caller must delete it
+static wxSockAddress *
+GetAddressFromName(const wxString& serverName, const wxString& host = _T(""))
+{
+ // we always use INET sockets under non-Unix systems
+#if defined(__UNIX__) && !defined(__WXMAC__)
+ // under Unix, if the server name looks like a path, create a AF_UNIX
+ // socket instead of AF_INET one
+ if ( serverName.Find(_T('/')) != wxNOT_FOUND )
+ {
+ wxUNIXaddress *addr = new wxUNIXaddress;
+ addr->Filename(serverName);
+
+ return addr;
+ }
+#endif // Unix/!Unix
+ {
+ wxIPV4address *addr = new wxIPV4address;
+ addr->Service(serverName);
+ if ( !host.empty() )
+ {
+ addr->Hostname(host);
+ }
+
+ return addr;
+ }
+}
+
+// --------------------------------------------------------------------------
+// wxTCPEventHandler stuff (private class)
+// --------------------------------------------------------------------------
+
+class wxTCPEventHandler : public wxEvtHandler
+{
+public:
+ wxTCPEventHandler() : wxEvtHandler() {};
+
+ void Client_OnRequest(wxSocketEvent& event);
+ void Server_OnRequest(wxSocketEvent& event);
+
+ DECLARE_EVENT_TABLE()
+};
+
+enum
+{
+ _CLIENT_ONREQUEST_ID = 1000,
+ _SERVER_ONREQUEST_ID
+};
+
+static wxTCPEventHandler *gs_handler = NULL;
-// ---------------------------------------------------------------------------
+// ==========================================================================
+// implementation
+// ==========================================================================
+
+IMPLEMENT_DYNAMIC_CLASS(wxTCPServer, wxServerBase)
+IMPLEMENT_DYNAMIC_CLASS(wxTCPClient, wxClientBase)
+IMPLEMENT_CLASS(wxTCPConnection, wxConnectionBase)
+
+// --------------------------------------------------------------------------
// wxTCPClient
-// ---------------------------------------------------------------------------
+// --------------------------------------------------------------------------
-wxTCPClient::wxTCPClient ()
- : wxClientBase()
+wxTCPClient::wxTCPClient () : wxClientBase()
{
}
}
wxConnectionBase *wxTCPClient::MakeConnection (const wxString& host,
- const wxString& server_name,
+ const wxString& serverName,
const wxString& topic)
{
- wxIPV4address addr;
- wxSocketClient *client = new wxSocketClient();
+ wxSocketClient *client = new wxSocketClient(SCKIPC_FLAGS);
wxSocketStream *stream = new wxSocketStream(*client);
- wxDataInputStream data_is(*stream);
- wxDataOutputStream data_os(*stream);
-
- client->SetNotify(wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG);
- addr.Service(server_name);
- addr.Hostname(host);
-
- if (!client->Connect(addr)) {
- delete client;
- return NULL;
- }
- client->Notify(FALSE);
-
- // Send topic name, and enquire whether this has succeeded
- unsigned char msg;
-
- data_os.Write8(IPC_CONNECT);
- data_os.WriteString(topic);
-
- msg = data_is.Read8();
-
- // OK! Confirmation.
- if (msg == IPC_CONNECT) {
- wxTCPConnection *connection = (wxTCPConnection *)OnMakeConnection ();
- if (connection) {
- if (!connection->IsKindOf(CLASSINFO(wxTCPConnection))) {
- delete connection;
- return NULL;
- }
- connection->m_topic = topic;
- client->Callback(Client_OnRequest);
- client->CallbackData((char *)connection);
- client->Notify(TRUE);
- return connection;
- } else {
- delete client;
+ wxDataInputStream *data_is = new wxDataInputStream(*stream);
+ wxDataOutputStream *data_os = new wxDataOutputStream(*stream);
+
+ wxSockAddress *addr = GetAddressFromName(serverName, host);
+ if ( !addr )
return NULL;
+
+ bool ok = client->Connect(*addr);
+ delete addr;
+
+ if ( ok )
+ {
+ unsigned char msg;
+
+ // Send topic name, and enquire whether this has succeeded
+ data_os->Write8(IPC_CONNECT);
+ data_os->WriteString(topic);
+
+ msg = data_is->Read8();
+
+ // OK! Confirmation.
+ if (msg == IPC_CONNECT)
+ {
+ wxTCPConnection *connection = (wxTCPConnection *)OnMakeConnection ();
+
+ if (connection)
+ {
+ if (connection->IsKindOf(CLASSINFO(wxTCPConnection)))
+ {
+ connection->m_topic = topic;
+ connection->m_sock = client;
+ connection->m_sockstrm = stream;
+ connection->m_codeci = data_is;
+ connection->m_codeco = data_os;
+ client->SetEventHandler(*gs_handler, _CLIENT_ONREQUEST_ID);
+ client->SetClientData(connection);
+ client->SetNotify(wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG);
+ client->Notify(TRUE);
+ return connection;
+ }
+ else
+ {
+ delete connection;
+ // and fall through to delete everything else
+ }
+ }
}
- } else {
- delete client;
- return NULL;
}
+
+ // Something went wrong, delete everything
+ delete data_is;
+ delete data_os;
+ delete stream;
+ client->Destroy();
+
return NULL;
}
wxConnectionBase *wxTCPClient::OnMakeConnection()
{
- return new wxTCPConnection;
+ return new wxTCPConnection();
}
-// ---------------------------------------------------------------------------
+// --------------------------------------------------------------------------
// wxTCPServer
-// ---------------------------------------------------------------------------
+// --------------------------------------------------------------------------
-wxTCPServer::wxTCPServer ()
- : wxServerBase()
+wxTCPServer::wxTCPServer () : wxServerBase()
{
+ m_server = NULL;
}
-bool wxTCPServer::Create(const wxString& server_name)
+bool wxTCPServer::Create(const wxString& serverName)
{
- wxIPV4address addr;
- wxSocketServer *server;
+ // Destroy previous server, if any
+ if (m_server)
+ {
+ m_server->SetClientData(NULL);
+ m_server->Destroy();
+ m_server = NULL;
+ }
+
+ wxSockAddress *addr = GetAddressFromName(serverName);
+ if ( !addr )
+ return FALSE;
+
+#ifdef __UNIX_LIKE__
+ mode_t umaskOld;
+ if ( addr->Type() == wxSockAddress::UNIX )
+ {
+ // ensure that the file doesn't exist as otherwise calling socket() would
+ // fail
+ int rc = remove(serverName);
+ if ( rc < 0 && errno != ENOENT )
+ {
+ delete addr;
+
+ return FALSE;
+ }
+
+ // also set the umask to prevent the others from reading our file
+ umaskOld = umask(077);
+ }
+ else
+ {
+ // unused anyhow but shut down the compiler warnings
+ umaskOld = 0;
+ }
+#endif // __UNIX_LIKE__
+
+ // Create a socket listening on the specified port
+ m_server = new wxSocketServer(*addr, SCKIPC_FLAGS);
+
+#ifdef __UNIX_LIKE__
+ if ( addr->Type() == wxSockAddress::UNIX )
+ {
+ // restore the umask
+ umask(umaskOld);
- addr.Service(server_name);
+ // save the file name to remove it later
+ m_filename = serverName;
+ }
+#endif // __UNIX_LIKE__
+
+ delete addr;
- // Create a socket listening on specified port
- server = new wxSocketServer(addr);
- server->Callback((wxSocketBase::wxSockCbk)Server_OnRequest);
- server->SetNotify(wxSOCKET_CONNECTION_FLAG);
+ if (!m_server->Ok())
+ {
+ m_server->Destroy();
+ m_server = NULL;
- server->CallbackData((char *)this);
+ return FALSE;
+ }
+
+ m_server->SetEventHandler(*gs_handler, _SERVER_ONREQUEST_ID);
+ m_server->SetClientData(this);
+ m_server->SetNotify(wxSOCKET_CONNECTION_FLAG);
+ m_server->Notify(TRUE);
return TRUE;
}
wxTCPServer::~wxTCPServer()
{
+ if (m_server)
+ {
+ m_server->SetClientData(NULL);
+ m_server->Destroy();
+ }
+
+#ifdef __UNIX_LIKE__
+ if ( !m_filename.empty() )
+ {
+ if ( remove(m_filename) != 0 )
+ {
+ wxLogDebug(_T("Stale AF_UNIX file '%s' left."), m_filename.c_str());
+ }
+ }
+#endif // __UNIX_LIKE__
}
wxConnectionBase *wxTCPServer::OnAcceptConnection( const wxString& WXUNUSED(topic) )
return new wxTCPConnection();
}
-// ---------------------------------------------------------------------------
+// --------------------------------------------------------------------------
// wxTCPConnection
-// ---------------------------------------------------------------------------
+// --------------------------------------------------------------------------
-wxTCPConnection::wxTCPConnection ()
- : wxConnectionBase(),
- m_sock(NULL), m_sockstrm(NULL), m_codeci(NULL), m_codeco(NULL)
+wxTCPConnection::wxTCPConnection () : wxConnectionBase()
{
+ m_sock = NULL;
+ m_sockstrm = NULL;
+ m_codeci = NULL;
+ m_codeco = NULL;
}
wxTCPConnection::wxTCPConnection(char * WXUNUSED(buffer), int WXUNUSED(size))
wxTCPConnection::~wxTCPConnection ()
{
- wxDELETE(m_sock);
wxDELETE(m_codeci);
wxDELETE(m_codeco);
wxDELETE(m_sockstrm);
+
+ if (m_sock)
+ {
+ m_sock->SetClientData(NULL);
+ m_sock->Destroy();
+ }
}
void wxTCPConnection::Compress(bool WXUNUSED(on))
{
// Send the the disconnect message to the peer.
m_codeco->Write8(IPC_DISCONNECT);
+ m_sock->Notify(FALSE);
m_sock->Close();
return TRUE;
}
-bool wxTCPConnection::Execute (wxChar *data, int size, wxIPCFormat format)
+bool wxTCPConnection::Execute(const wxChar *data, int size, wxIPCFormat format)
{
if (!m_sock->IsConnected())
return FALSE;
// Prepare EXECUTE message
m_codeco->Write8(IPC_EXECUTE);
m_codeco->Write8(format);
+
if (size < 0)
- m_codeco->WriteString(data);
- else {
- m_codeco->Write32(size);
- m_sockstrm->Write(data, size);
- }
+ size = wxStrlen(data) + 1; // includes final NUL
+
+ m_codeco->Write32(size);
+ m_sockstrm->Write(data, size);
return TRUE;
}
ret = m_codeci->Read8();
if (ret == IPC_FAIL)
return NULL;
- else {
+ else
+ {
size_t s;
char *data = NULL;
m_codeco->Write8(IPC_POKE);
m_codeco->WriteString(item);
m_codeco->Write8(format);
+
if (size < 0)
- m_codeco->WriteString(data);
- else {
- m_codeco->Write32(size);
- m_sockstrm->Write(data, size);
- }
+ size = wxStrlen(data) + 1; // includes final NUL
+
+ m_codeco->Write32(size);
+ m_sockstrm->Write(data, size);
return TRUE;
}
m_codeco->Write8(IPC_ADVISE);
m_codeco->WriteString(item);
m_codeco->Write8(format);
+
if (size < 0)
- m_codeco->WriteString(data);
- else {
- m_codeco->Write32(size);
- m_sockstrm->Write(data, size);
- }
+ size = wxStrlen(data) + 1; // includes final NUL
+
+ m_codeco->Write32(size);
+ m_sockstrm->Write(data, size);
return TRUE;
}
-void Client_OnRequest(wxSocketBase& sock, wxSocketNotify evt,
- char *cdata)
+// --------------------------------------------------------------------------
+// wxTCPEventHandler (private class)
+// --------------------------------------------------------------------------
+
+BEGIN_EVENT_TABLE(wxTCPEventHandler, wxEvtHandler)
+ EVT_SOCKET(_CLIENT_ONREQUEST_ID, wxTCPEventHandler::Client_OnRequest)
+ EVT_SOCKET(_SERVER_ONREQUEST_ID, wxTCPEventHandler::Server_OnRequest)
+END_EVENT_TABLE()
+
+void wxTCPEventHandler::Client_OnRequest(wxSocketEvent &event)
{
+ wxSocketBase *sock = event.GetSocket();
+ wxSocketNotify evt = event.GetSocketEvent();
+ wxTCPConnection *connection = (wxTCPConnection *)(sock->GetClientData());
+
+ // This socket is being deleted; skip this event
+ if (!connection)
+ return;
+
int msg = 0;
- wxTCPConnection *connection = (wxTCPConnection *)cdata;
wxDataInputStream *codeci;
- wxDataOutputStream *codeco;
+ wxDataOutputStream *codeco;
wxSocketStream *sockstrm;
wxString topic_name = connection->m_topic;
wxString item;
- // The socket handler signals us that we lost the connection: destroy all.
- if (evt == wxSOCKET_LOST) {
- sock.Close();
+ // We lost the connection: destroy everything
+ if (evt == wxSOCKET_LOST)
+ {
+ sock->Notify(FALSE);
+ sock->Close();
connection->OnDisconnect();
return;
}
sockstrm = connection->m_sockstrm;
msg = codeci->Read8();
- switch (msg) {
- case IPC_EXECUTE: {
+ switch (msg)
+ {
+ case IPC_EXECUTE:
+ {
char *data;
- size_t size;
+ size_t size;
wxIPCFormat format;
-
+
format = (wxIPCFormat)codeci->Read8();
size = codeci->Read32();
data = new char[size];
delete [] data;
break;
}
- case IPC_ADVISE: {
+ case IPC_ADVISE:
+ {
char *data;
size_t size;
wxIPCFormat format;
size = codeci->Read32();
data = new char[size];
sockstrm->Read(data, size);
-
+
connection->OnAdvise (topic_name, item, data, size, format);
delete [] data;
break;
}
- case IPC_ADVISE_START: {
+ case IPC_ADVISE_START:
+ {
item = codeci->ReadString();
bool ok = connection->OnStartAdvise (topic_name, item);
break;
}
- case IPC_ADVISE_STOP: {
+ case IPC_ADVISE_STOP:
+ {
item = codeci->ReadString();
bool ok = connection->OnStopAdvise (topic_name, item);
break;
}
- case IPC_POKE: {
+ case IPC_POKE:
+ {
wxIPCFormat format;
size_t size;
wxChar *data;
size = codeci->Read32();
data = new wxChar[size];
sockstrm->Read(data, size);
-
+
connection->OnPoke (topic_name, item, data, size, format);
delete [] data;
break;
}
- case IPC_REQUEST: {
+ case IPC_REQUEST:
+ {
wxIPCFormat format;
item = codeci->ReadString();
int user_size = -1;
char *user_data = connection->OnRequest (topic_name, item, &user_size, format);
- if (user_data) {
+ if (user_data)
+ {
codeco->Write8(IPC_REQUEST_REPLY);
- if (user_size != -1) {
- codeco->Write32(user_size);
- sockstrm->Write(user_data, user_size);
- } else
- codeco->WriteString(user_data);
- } else
+
+ if (user_size == -1)
+ user_size = strlen(user_data) + 1; // includes final NUL
+
+ codeco->Write32(user_size);
+ sockstrm->Write(user_data, user_size);
+ }
+ else
codeco->Write8(IPC_FAIL);
break;
}
- case IPC_DISCONNECT: {
- sock.Close();
+ case IPC_DISCONNECT:
+ {
+ sock->Notify(FALSE);
+ sock->Close();
connection->OnDisconnect();
break;
}
}
}
-void Server_OnRequest(wxSocketServer& server,
- wxSocketNotify evt, char *cdata)
+void wxTCPEventHandler::Server_OnRequest(wxSocketEvent &event)
{
- wxTCPServer *ipcserv = (wxTCPServer *)cdata;
- wxSocketStream *stream;
- wxDataInputStream *codeci;
- wxDataOutputStream *codeco;
+ wxSocketServer *server = (wxSocketServer *) event.GetSocket();
+ wxTCPServer *ipcserv = (wxTCPServer *) server->GetClientData();
- if (evt != wxSOCKET_CONNECTION)
+ // This socket is being deleted; skip this event
+ if (!ipcserv)
return;
- /* Accept the connection, getting a new socket */
- wxSocketBase *sock = server.Accept();
- sock->Notify(FALSE);
- sock->SetNotify(wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG);
-
- stream = new wxSocketStream(*sock);
- codeci = new wxDataInputStream(*stream);
- codeco = new wxDataOutputStream(*stream);
+ if (event.GetSocketEvent() != wxSOCKET_CONNECTION)
+ return;
+ // Accept the connection, getting a new socket
+ wxSocketBase *sock = server->Accept();
if (!sock->Ok())
+ {
+ sock->Destroy();
return;
+ }
+
+ wxSocketStream *stream = new wxSocketStream(*sock);
+ wxDataInputStream *codeci = new wxDataInputStream(*stream);
+ wxDataOutputStream *codeco = new wxDataOutputStream(*stream);
int msg;
msg = codeci->Read8();
- if (msg == IPC_CONNECT) {
+ if (msg == IPC_CONNECT)
+ {
wxString topic_name;
topic_name = codeci->ReadString();
- /* Register new socket with the notifier */
wxTCPConnection *new_connection =
(wxTCPConnection *)ipcserv->OnAcceptConnection (topic_name);
- if (new_connection) {
- if (!new_connection->IsKindOf(CLASSINFO(wxTCPConnection))) {
- delete new_connection;
- codeco->Write8(IPC_FAIL);
+
+ if (new_connection)
+ {
+ if (new_connection->IsKindOf(CLASSINFO(wxTCPConnection)))
+ {
+ // Acknowledge success
+ codeco->Write8(IPC_CONNECT);
+ new_connection->m_topic = topic_name;
+ new_connection->m_sock = sock;
+ new_connection->m_sockstrm = stream;
+ new_connection->m_codeci = codeci;
+ new_connection->m_codeco = codeco;
+ sock->SetEventHandler(*gs_handler, _CLIENT_ONREQUEST_ID);
+ sock->SetClientData(new_connection);
+ sock->SetNotify(wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG);
+ sock->Notify(TRUE);
return;
}
- // Acknowledge success
- codeco->Write8(IPC_CONNECT);
-
- new_connection->m_topic = topic_name;
- new_connection->m_sockstrm = stream;
- new_connection->m_codeci = codeci;
- new_connection->m_codeco = codeco;
- sock->Callback(Client_OnRequest);
- sock->CallbackData((char *)new_connection);
- sock->Notify(TRUE);
- } else {
- // Send failure message
- codeco->Write8(IPC_FAIL);
+ else
+ {
+ delete new_connection;
+ // and fall through to delete everything else
+ }
}
}
+
+ // Something went wrong, send failure message and delete everything
+ codeco->Write8(IPC_FAIL);
+
+ delete codeco;
+ delete codeci;
+ delete stream;
+ sock->Destroy();
}
+// --------------------------------------------------------------------------
+// wxTCPEventHandlerModule (private class)
+// --------------------------------------------------------------------------
+
+class WXDLLEXPORT wxTCPEventHandlerModule: public wxModule
+{
+ DECLARE_DYNAMIC_CLASS(wxTCPEventHandlerModule)
+
+public:
+ bool OnInit() { gs_handler = new wxTCPEventHandler(); return TRUE; }
+ void OnExit() { wxDELETE(gs_handler); }
+};
+
+IMPLEMENT_DYNAMIC_CLASS(wxTCPEventHandlerModule, wxModule)
+
+
#endif
- // wxUSE_SOCKETS
+ // wxUSE_SOCKETS && wxUSE_IPC
projects / wxWidgets.git / blobdiff