]> git.saurik.com Git - wxWidgets.git/blobdiff - samples/sockets/server.cpp
Make a couple virtuals protected so they can be overridden.
[wxWidgets.git] / samples / sockets / server.cpp
index ca2a8972850253c80fa8096b1a513ad419863c3c..04b4ce33f28d6bfe534c3205678a5fd5e92aae84 100644 (file)
@@ -2,10 +2,10 @@
 // Name:        server.cpp
 // Purpose:     Server for wxSocket demo
 // Author:      Guillermo Rodriguez Garcia <guille@iies.es>
-// Modified by:
 // Created:     1999/09/19
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Guillermo Rodriguez Garcia
+//              (c) 2009 Vadim Zeitlin
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // headers
 // --------------------------------------------------------------------------
 
-#ifdef __GNUG__
-#  pragma implementation "server.cpp"
-#  pragma interface "server.cpp"
-#endif
-
 // For compilers that support precompilation, includes "wx/wx.h".
 #include "wx/wxprec.h"
 
 #  pragma hdrstop
 #endif
 
-// for all others, include the necessary headers 
+// for all others, include the necessary headers
 #ifndef WX_PRECOMP
 #  include "wx/wx.h"
 #endif
 
+#include "wx/busyinfo.h"
 #include "wx/socket.h"
 
+// this example is currently written to use only IP or only IPv6 sockets, it
+// should be extended to allow using either in the future
+#if wxUSE_IPV6
+    typedef wxIPV6address IPaddress;
+#else
+    typedef wxIPV4address IPaddress;
+#endif
+
 // --------------------------------------------------------------------------
 // resources
 // --------------------------------------------------------------------------
 
 // the application icon
-#if defined(__WXGTK__) || defined(__WXMOTIF__)
-#  include "mondrian.xpm"
+#ifndef wxHAS_IMAGES_IN_RESOURCES
+    #include "../sample.xpm"
 #endif
 
 // --------------------------------------------------------------------------
@@ -64,6 +68,8 @@ public:
   ~MyFrame();
 
   // event handlers (these functions should _not_ be virtual)
+  void OnUDPTest(wxCommandEvent& event);
+  void OnWaitForAccept(wxCommandEvent& event);
   void OnQuit(wxCommandEvent& event);
   void OnAbout(wxCommandEvent& event);
   void OnServerEvent(wxSocketEvent& event);
@@ -78,17 +84,34 @@ public:
 
 private:
   wxSocketServer *m_server;
-  wxPanel        *m_panel;
   wxTextCtrl     *m_text;
   wxMenu         *m_menuFile;
   wxMenuBar      *m_menuBar;
   bool            m_busy;
   int             m_numClients;
 
-  // any class wishing to process wxWindows events must use this macro
+  // any class wishing to process wxWidgets events must use this macro
   DECLARE_EVENT_TABLE()
 };
 
+// simple helper class to log start and end of each test
+class TestLogger
+{
+public:
+    TestLogger(const wxString& name) : m_name(name)
+    {
+        wxLogMessage("=== %s begins ===", m_name);
+    }
+
+    ~TestLogger()
+    {
+        wxLogMessage("=== %s ends ===", m_name);
+    }
+
+private:
+    const wxString m_name;
+};
+
 // --------------------------------------------------------------------------
 // constants
 // --------------------------------------------------------------------------
@@ -97,21 +120,25 @@ private:
 enum
 {
   // menu items
-  SERVER_QUIT = 1000,
-  SERVER_ABOUT,
+  SERVER_UDPTEST = 10,
+  SERVER_WAITFORACCEPT,
+  SERVER_QUIT = wxID_EXIT,
+  SERVER_ABOUT = wxID_ABOUT,
 
   // id for sockets
-  SERVER_ID,
+  SERVER_ID = 100,
   SOCKET_ID
 };
 
 // --------------------------------------------------------------------------
-// event tables and other macros for wxWindows
+// event tables and other macros for wxWidgets
 // --------------------------------------------------------------------------
 
 BEGIN_EVENT_TABLE(MyFrame, wxFrame)
   EVT_MENU(SERVER_QUIT,  MyFrame::OnQuit)
   EVT_MENU(SERVER_ABOUT, MyFrame::OnAbout)
+  EVT_MENU(SERVER_UDPTEST, MyFrame::OnUDPTest)
+  EVT_MENU(SERVER_WAITFORACCEPT, MyFrame::OnWaitForAccept)
   EVT_SOCKET(SERVER_ID,  MyFrame::OnServerEvent)
   EVT_SOCKET(SOCKET_ID,  MyFrame::OnSocketEvent)
 END_EVENT_TABLE()
@@ -119,10 +146,6 @@ END_EVENT_TABLE()
 IMPLEMENT_APP(MyApp)
 
 
-// To append sockets for delayed deletion [XXX: this should be removed]
-extern WXDLLEXPORT wxList wxPendingDelete;
-
-
 // ==========================================================================
 // implementation
 // ==========================================================================
@@ -133,15 +156,17 @@ extern WXDLLEXPORT wxList wxPendingDelete;
 
 bool MyApp::OnInit()
 {
+  if ( !wxApp::OnInit() )
+      return false;
+
   // Create the main application window
   MyFrame *frame = new MyFrame();
 
-  // Show it and tell the application that it's our main window
-  frame->Show(TRUE);
-  SetTopWindow(frame);
+  // Show it
+  frame->Show(true);
 
-  // success
-  return TRUE;
+  // Success
+  return true;
 }
 
 // --------------------------------------------------------------------------
@@ -149,56 +174,80 @@ bool MyApp::OnInit()
 // --------------------------------------------------------------------------
 
 // frame constructor
-MyFrame::MyFrame() : wxFrame((wxFrame *)NULL, -1,
-                             _T("wxSocket demo: Server"),
+
+MyFrame::MyFrame() : wxFrame((wxFrame *)NULL, wxID_ANY,
+                             _("wxSocket demo: Server"),
                              wxDefaultPosition, wxSize(300, 200))
 {
   // Give the frame an icon
-  SetIcon(wxICON(mondrian));
+  SetIcon(wxICON(sample));
 
   // Make menus
   m_menuFile = new wxMenu();
-  m_menuFile->Append(SERVER_ABOUT, _T("&About...\tCtrl-A"), _T("Show about dialog"));
+  m_menuFile->Append(SERVER_WAITFORACCEPT, "&Wait for connection\tCtrl-W");
+  m_menuFile->Append(SERVER_UDPTEST, "&UDP test\tCtrl-U");
   m_menuFile->AppendSeparator();
-  m_menuFile->Append(SERVER_QUIT, _T("E&xit\tAlt-X"), _T("Quit server"));
+  m_menuFile->Append(SERVER_ABOUT, _("&About\tCtrl-A"), _("Show about dialog"));
+  m_menuFile->AppendSeparator();
+  m_menuFile->Append(SERVER_QUIT, _("E&xit\tAlt-X"), _("Quit server"));
 
   // Append menus to the menubar
   m_menuBar = new wxMenuBar();
-  m_menuBar->Append(m_menuFile, _T("&File"));
+  m_menuBar->Append(m_menuFile, _("&File"));
   SetMenuBar(m_menuBar);
 
+#if wxUSE_STATUSBAR
   // Status bar
   CreateStatusBar(2);
+#endif // wxUSE_STATUSBAR
 
-  // Make a panel with a textctrl in it
-  m_panel = new wxPanel(this, -1);
-  m_text  = new wxTextCtrl(m_panel, -1,
-                           _T("Welcome to wxSocket demo: Server\n"),
-                           wxPoint(0, 0), m_panel->GetClientSize(),
+  // Make a textctrl for logging
+  m_text  = new wxTextCtrl(this, wxID_ANY,
+                           _("Welcome to wxSocket demo: Server\n"),
+                           wxDefaultPosition, wxDefaultSize,
                            wxTE_MULTILINE | wxTE_READONLY);
+  delete wxLog::SetActiveTarget(new wxLogTextCtrl(m_text));
 
-  // Create the socket - defaults to localhost:0
-  wxIPV4address addr;
+  // Create the address - defaults to localhost:0 initially
+  IPaddress addr;
   addr.Service(3000);
 
+  wxLogMessage("Creating server at %s:%u", addr.IPAddress(), addr.Service());
+
+  // Create the socket
   m_server = new wxSocketServer(addr);
-  m_server->SetEventHandler(*this, SERVER_ID);
-  m_server->SetNotify(wxSOCKET_CONNECTION_FLAG);
-  m_server->Notify(TRUE);
 
-  // We use Ok() here to see if the server is really listening
-  if (m_server->Ok())
-    m_text->AppendText(_T("Server listening.\n\n"));
+  // We use IsOk() here to see if the server is really listening
+  if (! m_server->IsOk())
+  {
+    wxLogMessage("Could not listen at the specified port !");
+    return;
+  }
+
+  IPaddress addrReal;
+  if ( !m_server->GetLocal(addrReal) )
+  {
+    wxLogMessage("ERROR: couldn't get the address we bound to");
+  }
   else
-    m_text->AppendText(_T("Could not listen at the specified port !\n\n"));
+  {
+    wxLogMessage("Server listening at %s:%u",
+                 addrReal.IPAddress(), addrReal.Service());
+  }
+
+  // Setup the event handler and subscribe to connection events
+  m_server->SetEventHandler(*this, SERVER_ID);
+  m_server->SetNotify(wxSOCKET_CONNECTION_FLAG);
+  m_server->Notify(true);
 
-  m_busy = FALSE;
+  m_busy = false;
   m_numClients = 0;
   UpdateStatusBar();
 }
 
 MyFrame::~MyFrame()
 {
+  // No delayed deletion here, as the frame is dying anyway
   delete m_server;
 }
 
@@ -206,24 +255,67 @@ MyFrame::~MyFrame()
 
 void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event))
 {
-  // TRUE is to force the frame to close
-  Close(TRUE);
+  // true is to force the frame to close
+  Close(true);
 }
 
 void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
 {
-  wxMessageBox(_T("wxSocket demo: Server\n")
-               _T("(c) 1999 Guillermo Rodriguez Garcia\n"),
-               _T("About Server"),
+  wxMessageBox(_("wxSocket demo: Server\n(c) 1999 Guillermo Rodriguez Garcia\n"),
+               _("About Server"),
                wxOK | wxICON_INFORMATION, this);
 }
 
-void MyFrame::Test1(wxSocketBase *sock)
+void MyFrame::OnUDPTest(wxCommandEvent& WXUNUSED(event))
 {
-  unsigned char len;
-  char *buf;
+    TestLogger logtest("UDP test");
 
-  m_text->AppendText(_T("Test 1 begins\n"));
+    IPaddress addr;
+    addr.Service(3000);
+    wxDatagramSocket sock(addr);
+
+    char buf[1024];
+    size_t n = sock.RecvFrom(addr, buf, sizeof(buf)).LastCount();
+    if ( !n )
+    {
+        wxLogMessage("ERROR: failed to receive data");
+        return;
+    }
+
+    wxLogMessage("Received \"%s\" from %s:%u.",
+                 wxString::From8BitData(buf, n),
+                 addr.IPAddress(), addr.Service());
+
+    for ( size_t i = 0; i < n; i++ )
+    {
+        char& c = buf[i];
+        if ( (c >= 'A' && c <= 'M') || (c >= 'a' && c <= 'm') )
+            c += 13;
+        else if ( (c >= 'N' && c <= 'Z') || (c >= 'n' && c <= 'z') )
+            c -= 13;
+    }
+
+    if ( sock.SendTo(addr, buf, n).LastCount() != n )
+    {
+        wxLogMessage("ERROR: failed to send data");
+        return;
+    }
+}
+
+void MyFrame::OnWaitForAccept(wxCommandEvent& WXUNUSED(event))
+{
+    TestLogger logtest("WaitForAccept() test");
+
+    wxBusyInfo("Waiting for connection for 10 seconds...", this);
+    if ( m_server->WaitForAccept(10) )
+        wxLogMessage("Accepted client connection.");
+    else
+        wxLogMessage("Connection error or timeout expired.");
+}
+
+void MyFrame::Test1(wxSocketBase *sock)
+{
+  TestLogger logtest("Test 1");
 
   // Receive data from socket and send it back. We will first
   // get a byte with the buffer size, so we can specify the
@@ -233,96 +325,107 @@ void MyFrame::Test1(wxSocketBase *sock)
 
   sock->SetFlags(wxSOCKET_WAITALL);
 
-  sock->Read((char *)&len, 1);
+  // Read the size
+  unsigned char len;
+  sock->Read(&len, 1);
+  wxCharBuffer buf(len);
+
+  // Read the data
+  sock->Read(buf.data(), len);
+  wxLogMessage("Got the data, sending it back");
 
-  buf = new char[len];
-  sock->Read(buf, len);
+  // Write it back
   sock->Write(buf, len);
-  delete[] buf;
-
-  m_text->AppendText(_T("Test 1 ends\n"));
 }
 
 void MyFrame::Test2(wxSocketBase *sock)
 {
-#define MAX_MSG_SIZE 10000
+  char buf[4096];
 
-  wxString s;
-  char *buf = new char[MAX_MSG_SIZE];
-  wxUint32 len;
-
-  m_text->AppendText(_T("Test 2 begins\n"));
+  TestLogger logtest("Test 2");
 
   // We don't need to set flags because ReadMsg and WriteMsg
   // are not affected by them anyway.
 
-  len = sock->ReadMsg(buf, MAX_MSG_SIZE).LastCount();
+  // Read the message
+  wxUint32 len = sock->ReadMsg(buf, sizeof(buf)).LastCount();
+  if ( !len )
+  {
+      wxLogError("Failed to read message.");
+      return;
+  }
 
-  s.Printf(_T("Client says: %s\n"), buf);
-  m_text->AppendText(s);
+  wxLogMessage("Got \"%s\" from client.", wxString::FromUTF8(buf, len));
+  wxLogMessage("Sending the data back");
 
+  // Write it back
   sock->WriteMsg(buf, len);
-  delete[] buf;
-
-  m_text->AppendText(_T("Test 2 ends\n"));
-
-#undef MAX_MSG_SIZE
 }
 
 void MyFrame::Test3(wxSocketBase *sock)
 {
-  unsigned char len;
-  char *buf;
-
-  m_text->AppendText(_T("Test 3 begins\n"));
+  TestLogger logtest("Test 3");
 
-  // This test is similar to the first one, but the len is   
+  // This test is similar to the first one, but the len is
   // expressed in kbytes - this tests large data transfers.
 
   sock->SetFlags(wxSOCKET_WAITALL);
 
-  sock->Read((char *)&len, 1);
-  buf = new char[len * 1024];
-  sock->Read(buf, len * 1024);
-  sock->Write(buf, len * 1024);
-  delete[] buf;
+  // Read the size
+  unsigned char len;
+  sock->Read(&len, 1);
+  wxCharBuffer buf(len*1024);
+
+  // Read the data
+  sock->Read(buf.data(), len * 1024);
+  wxLogMessage("Got the data, sending it back");
 
-  m_text->AppendText(_T("Test 3 ends\n"));
+  // Write it back
+  sock->Write(buf, len * 1024);
 }
 
 void MyFrame::OnServerEvent(wxSocketEvent& event)
 {
-  wxString s = _T("OnServerEvent: ");
+  wxString s = _("OnServerEvent: ");
   wxSocketBase *sock;
 
-  switch(event.SocketEvent())
+  switch(event.GetSocketEvent())
   {
-    case wxSOCKET_CONNECTION : s.Append(_T("wxSOCKET_CONNECTION\n")); break;
-    default                  : s.Append(_T("Unexpected event !\n")); break;
+    case wxSOCKET_CONNECTION : s.Append(_("wxSOCKET_CONNECTION\n")); break;
+    default                  : s.Append(_("Unexpected event !\n")); break;
   }
 
   m_text->AppendText(s);
 
   // Accept new connection if there is one in the pending
-  // connections queue, else exit. We use Accept(FALSE) for
+  // connections queue, else exit. We use Accept(false) for
   // non-blocking accept (although if we got here, there
   // should ALWAYS be a pending connection).
 
-  sock = m_server->Accept(FALSE);
+  sock = m_server->Accept(false);
 
   if (sock)
   {
-    m_text->AppendText(_T("New client connection accepted\n"));
+    IPaddress addr;
+    if ( !sock->GetPeer(addr) )
+    {
+      wxLogMessage("New connection from unknown client accepted.");
+    }
+    else
+    {
+      wxLogMessage("New client connection from %s:%u accepted",
+                   addr.IPAddress(), addr.Service());
+    }
   }
   else
   {
-    m_text->AppendText(_T("Error: couldn't accept a new connection"));
+    wxLogMessage("Error: couldn't accept a new connection");
     return;
   }
 
   sock->SetEventHandler(*this, SOCKET_ID);
   sock->SetNotify(wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG);
-  sock->Notify(TRUE);
+  sock->Notify(true);
 
   m_numClients++;
   UpdateStatusBar();
@@ -330,21 +433,21 @@ void MyFrame::OnServerEvent(wxSocketEvent& event)
 
 void MyFrame::OnSocketEvent(wxSocketEvent& event)
 {
-  wxSocketBase *sock = event.Socket();
-  wxString s = _T("OnSocketEvent: ");
+  wxString s = _("OnSocketEvent: ");
+  wxSocketBase *sock = event.GetSocket();
 
-  // We first print a msg
-  switch(event.SocketEvent())
+  // First, print a message
+  switch(event.GetSocketEvent())
   {
-    case wxSOCKET_INPUT: s.Append(_T("wxSOCKET_INPUT\n")); break;
-    case wxSOCKET_LOST:  s.Append(_T("wxSOCKET_LOST\n")); break;
-    default:             s.Append(_T("unexpected event !\n"));
+    case wxSOCKET_INPUT : s.Append(_("wxSOCKET_INPUT\n")); break;
+    case wxSOCKET_LOST  : s.Append(_("wxSOCKET_LOST\n")); break;
+    default             : s.Append(_("Unexpected event !\n")); break;
   }
 
   m_text->AppendText(s);
 
   // Now we process the event
-  switch(event.SocketEvent())
+  switch(event.GetSocketEvent())
   {
     case wxSOCKET_INPUT:
     {
@@ -354,14 +457,15 @@ void MyFrame::OnSocketEvent(wxSocketEvent& event)
 
       // Which test are we going to run?
       unsigned char c;
-      sock->Read((char *)&c ,1);
+      sock->Read(&c, 1);
 
       switch (c)
       {
         case 0xBE: Test1(sock); break;
         case 0xCE: Test2(sock); break;
         case 0xDE: Test3(sock); break;
-        default: s.Append(_T("Unknown test id received from client\n"));
+        default:
+          wxLogMessage("Unknown test id received from client");
       }
 
       // Enable input events again.
@@ -372,12 +476,17 @@ void MyFrame::OnSocketEvent(wxSocketEvent& event)
     {
       m_numClients--;
 
-      // We cannot delete the socket right now because we can
-      // be in the middle of a test or something. So we append
-      // it to the list of objects to be deleted.
-
-      m_text->AppendText(_T("Deleting socket.\n"));
-      wxPendingDelete.Append(sock);
+      // Destroy() should be used instead of delete wherever possible,
+      // due to the fact that wxSocket uses 'delayed events' (see the
+      // documentation for wxPostEvent) and we don't want an event to
+      // arrive to the event handler (the frame, here) after the socket
+      // has been deleted. Also, we might be doing some other thing with
+      // the socket at the same time; for example, we might be in the
+      // middle of a test or something. Destroy() takes care of all
+      // this for us.
+
+      wxLogMessage("Deleting socket.");
+      sock->Destroy();
       break;
     }
     default: ;
@@ -390,7 +499,9 @@ void MyFrame::OnSocketEvent(wxSocketEvent& event)
 
 void MyFrame::UpdateStatusBar()
 {
+#if wxUSE_STATUSBAR
   wxString s;
-  s.Printf(_T("%d clients connected"), m_numClients);
+  s.Printf(_("%d clients connected"), m_numClients);
   SetStatusText(s, 1);
+#endif // wxUSE_STATUSBAR
 }