X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ad81651f00edc6f489d9b6a0839d316a964fd521..f515c25a2cbf63596b03397a9d81705d3c464408:/src/common/sckipc.cpp

diff --git a/src/common/sckipc.cpp b/src/common/sckipc.cpp
index b9e286ffbf..3fea37e1ec 100644
--- a/src/common/sckipc.cpp
+++ b/src/common/sckipc.cpp
@@ -1,14 +1,26 @@
 /////////////////////////////////////////////////////////////////////////////
 // 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
 // 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
@@ -20,29 +32,34 @@
 #pragma hdrstop
 #endif
 
-#if wxUSE_SOCKETS
-
 #ifndef WX_PRECOMP
+#include "wx/defs.h"
 #endif
 
+#if wxUSE_SOCKETS && wxUSE_IPC && wxUSE_STREAMS
+
 #include <stdlib.h>
 #include <stdio.h>
 
 #include "wx/socket.h"
 #include "wx/sckipc.h"
+#include "wx/module.h"
+#include "wx/event.h"
+#include "wx/log.h"
 
 #ifdef __BORLANDC__
 #pragma hdrstop
 #endif
 
-IMPLEMENT_DYNAMIC_CLASS(wxTCPServer, wxServerBase)
-IMPLEMENT_DYNAMIC_CLASS(wxTCPClient, wxClientBase)
-IMPLEMENT_DYNAMIC_CLASS(wxTCPConnection, wxConnectionBase)
+// --------------------------------------------------------------------------
+// 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,
@@ -57,19 +74,46 @@ enum {
 };
 #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)
+
+// --------------------------------------------------------------------------
+// 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()
 {
 }
 
@@ -88,86 +132,117 @@ wxConnectionBase *wxTCPClient::MakeConnection (const wxString& host,
                                                const wxString& server_name,
                                                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);
+  wxDataInputStream *data_is = new wxDataInputStream(*stream);
+  wxDataOutputStream *data_os = new wxDataOutputStream(*stream);
+
+  wxIPV4address addr;
   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;
+  if (client->Connect(addr))
+  {
+    unsigned char msg;
   
-  data_os.Write8(IPC_CONNECT);
-  data_os.WriteString(topic);
+    // 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))) {
-        delete connection;
-        return NULL;
+    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
+        }
       }
-      connection->m_topic = topic;
-      client->Callback(Client_OnRequest);
-      client->CallbackData((char *)connection);
-      client->Notify(TRUE);
-      return connection;
-    } else {
-      delete client;
-      return NULL;
     }
-  } 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)
 {
+  // Destroy previous server, if any
+  if (m_server)
+  {
+    m_server->SetClientData(NULL);
+    m_server->Destroy();
+    m_server = NULL;
+  }
+
+  // wxIPV4address defaults to INADDR_ANY:0
   wxIPV4address addr;
-  wxSocketServer *server;
+  addr.Service(serverName);
 
-  addr.Service(server_name);
+  // Create a socket listening on the specified port
+  m_server = new wxSocketServer(addr, SCKIPC_FLAGS);
 
-  // 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();
+  }
 }
 
 wxConnectionBase *wxTCPServer::OnAcceptConnection( const wxString& WXUNUSED(topic) )
@@ -175,14 +250,16 @@ wxConnectionBase *wxTCPServer::OnAcceptConnection( const wxString& WXUNUSED(topi
   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))
@@ -191,10 +268,15 @@ 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))
@@ -207,12 +289,13 @@ bool wxTCPConnection::Disconnect ()
 {
   // 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 (const wxChar *data, int size, wxIPCFormat format)
+bool wxTCPConnection::Execute(const wxChar *data, int size, wxIPCFormat format)
 {
   if (!m_sock->IsConnected())
     return FALSE;
@@ -220,12 +303,12 @@ bool wxTCPConnection::Execute (const wxChar *data, int size, wxIPCFormat format)
   // 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;
 }
@@ -245,7 +328,8 @@ char *wxTCPConnection::Request (const wxString& item, int *size, wxIPCFormat for
   ret = m_codeci->Read8();
   if (ret == IPC_FAIL)
     return NULL;
-  else {
+  else
+  {
     size_t s;
     char *data = NULL;
 
@@ -267,12 +351,12 @@ bool wxTCPConnection::Poke (const wxString& item, wxChar *data, int size, wxIPCF
   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;
 }
@@ -323,30 +407,47 @@ bool wxTCPConnection::Advise (const wxString& item,
   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; 
   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;
   }
@@ -357,8 +458,10 @@ void Client_OnRequest(wxSocketBase& sock, wxSocketNotify evt,
   sockstrm = connection->m_sockstrm;
   msg = codeci->Read8();
 
-  switch (msg) {
-  case IPC_EXECUTE: {
+  switch (msg)
+  {
+  case IPC_EXECUTE:
+  {
     char *data;
     size_t size; 
     wxIPCFormat format;
@@ -373,7 +476,8 @@ void Client_OnRequest(wxSocketBase& sock, wxSocketNotify evt,
     delete [] data;
     break;
   }
-  case IPC_ADVISE: {
+  case IPC_ADVISE:
+  {
     char *data;
     size_t size;
     wxIPCFormat format;
@@ -389,7 +493,8 @@ void Client_OnRequest(wxSocketBase& sock, wxSocketNotify evt,
     delete [] data;
     break;
   }
-  case IPC_ADVISE_START: {
+  case IPC_ADVISE_START:
+  {
     item = codeci->ReadString();
 
     bool ok = connection->OnStartAdvise (topic_name, item);
@@ -400,7 +505,8 @@ void Client_OnRequest(wxSocketBase& sock, wxSocketNotify evt,
 
     break;
   }
-  case IPC_ADVISE_STOP: {
+  case IPC_ADVISE_STOP:
+  {
     item = codeci->ReadString();
 
     bool ok = connection->OnStopAdvise (topic_name, item);
@@ -411,7 +517,8 @@ void Client_OnRequest(wxSocketBase& sock, wxSocketNotify evt,
 
     break;
   }
-  case IPC_POKE: {
+  case IPC_POKE:
+  {
     wxIPCFormat format;
     size_t size;
     wxChar *data;
@@ -428,7 +535,8 @@ void Client_OnRequest(wxSocketBase& sock, wxSocketNotify evt,
 
     break;
   }
-  case IPC_REQUEST: {
+  case IPC_REQUEST:
+  {
     wxIPCFormat format;
 
     item = codeci->ReadString();
@@ -437,20 +545,25 @@ void Client_OnRequest(wxSocketBase& sock, wxSocketNotify evt,
     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;
   }
@@ -460,61 +573,90 @@ void Client_OnRequest(wxSocketBase& sock, wxSocketNotify evt,
   }
 }
 
-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