Added missing arg

[wxWidgets.git] / src / msw / gsocket.cpp

diff --git a/src/msw/gsocket.cpp b/src/msw/gsocket.cpp
index ddd98cc06e1e48d28897a397e5d988f794625f7f..0bbfea6275720ad81e9bb6e086ef8a6213b1b052 100644 (file)
--- a/src/msw/gsocket.cpp
+++ b/src/msw/gsocket.cpp
@@ -1,21 +1,15 @@
 /* -------------------------------------------------------------------------
 /* -------------------------------------------------------------------------

- * Project: GSocket (Generic Socket)
- * Name:    gsocket.cpp
- * Author:  Guillermo Rodriguez Garcia <guille@iies.es>
- * Purpose: GSocket main MSW file
- * Licence: The wxWindows licence
- * CVSID:   $Id$
+ * Project:     GSocket (Generic Socket)
+ * Name:        src/msw/gsocket.cpp
+ * Copyright:   (c) Guilhem Lavaux
+ * Licence:     wxWindows Licence
+ * Author:      Guillermo Rodriguez Garcia <guille@iies.es>
+ * Purpose:     GSocket main MSW file
+ * Licence:     The wxWindows licence
+ * CVSID:       $Id$

  * -------------------------------------------------------------------------
  */
 
  * -------------------------------------------------------------------------
  */
 

-// ============================================================================
-// declarations
-// ============================================================================
-
-// ----------------------------------------------------------------------------
-// headers
-// ----------------------------------------------------------------------------
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -51,11 +45,16 @@
 
 #endif /* _MSC_VER */
 
 
 #endif /* _MSC_VER */
 

+#if defined(__CYGWIN__)
+    //CYGWIN gives annoying warning about runtime stuff if we don't do this
+#   define USE_SYS_TYPES_FD_SET
+#   include <sys/types.h>
+#endif
+

 #include <winsock.h>
 
 #ifndef __GSOCKET_STANDALONE__
 #   include "wx/platform.h"
 #include <winsock.h>
 
 #ifndef __GSOCKET_STANDALONE__
 #   include "wx/platform.h"

-#   include "wx/setup.h"

 #endif
 
 #if wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__)
 #endif
 
 #if wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__)


@@ -84,9 +83,9 @@
 #include <stddef.h>
 #include <ctype.h>
 
 #include <stddef.h>
 #include <ctype.h>
 

-/* if we use configure for MSW SOCKLEN_T will be already defined */
-#ifndef SOCKLEN_T
-#  define SOCKLEN_T int
+/* if we use configure for MSW WX_SOCKLEN_T will be already defined */
+#ifndef WX_SOCKLEN_T
+#  define WX_SOCKLEN_T int

 #endif
 
 /* Table of GUI-related functions. We must call them indirectly because
 #endif
 
 /* Table of GUI-related functions. We must call them indirectly because


@@ -171,13 +170,13 @@ GSocket::GSocket()
   m_local           = NULL;
   m_peer            = NULL;
   m_error           = GSOCK_NOERROR;
   m_local           = NULL;
   m_peer            = NULL;
   m_error           = GSOCK_NOERROR;

-  m_server          = FALSE;
-  m_stream          = TRUE;
+  m_server          = false;
+  m_stream          = true;

   m_non_blocking    = false;
   m_timeout.tv_sec  = 10 * 60;  /* 10 minutes */
   m_timeout.tv_usec = 0;
   m_non_blocking    = false;
   m_timeout.tv_sec  = 10 * 60;  /* 10 minutes */
   m_timeout.tv_usec = 0;

-  m_establishing    = FALSE;
-  m_reusable        = FALSE;
+  m_establishing    = false;
+  m_reusable        = false;

 
   assert(gs_gui_functions);
   /* Per-socket GUI-specific initialization */
 
   assert(gs_gui_functions);
   /* Per-socket GUI-specific initialization */


@@ -299,7 +298,7 @@ GAddress *GSocket::GetLocal()
 {
   GAddress *address;
   struct sockaddr addr;
 {
   GAddress *address;
   struct sockaddr addr;

-  SOCKLEN_T size = sizeof(addr);
+  WX_SOCKLEN_T size = sizeof(addr);

   GSocketError err;
 
   assert(this);
   GSocketError err;
 
   assert(this);


@@ -382,8 +381,8 @@ GSocketError GSocket::SetServer()
   }
 
   /* Initialize all fields */
   }
 
   /* Initialize all fields */

-  m_server   = TRUE;
-  m_stream   = TRUE;
+  m_server   = true;
+  m_stream   = true;

 
   /* Create the socket */
   m_fd = socket(m_local->m_realfamily, SOCK_STREAM, 0);
 
   /* Create the socket */
   m_fd = socket(m_local->m_realfamily, SOCK_STREAM, 0);


@@ -411,7 +410,7 @@ GSocketError GSocket::SetServer()
   if ((bind(m_fd, m_local->m_addr, m_local->m_len) != 0) ||
       (getsockname(m_fd,
                    m_local->m_addr,
   if ((bind(m_fd, m_local->m_addr, m_local->m_len) != 0) ||
       (getsockname(m_fd,
                    m_local->m_addr,

-                   (SOCKLEN_T *)&m_local->m_len) != 0) ||
+                   (WX_SOCKLEN_T *)&m_local->m_len) != 0) ||

       (listen(m_fd, 5) != 0))
   {
     Close();
       (listen(m_fd, 5) != 0))
   {
     Close();


@@ -438,7 +437,7 @@ GSocket *GSocket::WaitConnection()
 {
   GSocket *connection;
   struct sockaddr from;
 {
   GSocket *connection;
   struct sockaddr from;

-  SOCKLEN_T fromlen = sizeof(from);
+  WX_SOCKLEN_T fromlen = sizeof(from);

   GSocketError err;
   u_long arg = 1;
 
   GSocketError err;
   u_long arg = 1;
 


@@ -485,8 +484,8 @@ GSocket *GSocket::WaitConnection()
   }
 
   /* Initialize all fields */
   }
 
   /* Initialize all fields */

-  connection->m_server   = FALSE;
-  connection->m_stream   = TRUE;
+  connection->m_server   = false;
+  connection->m_stream   = true;

 
   /* Setup the peer address field */
   connection->m_peer = GAddress_new();
 
   /* Setup the peer address field */
   connection->m_peer = GAddress_new();


@@ -516,17 +515,17 @@ GSocket *GSocket::WaitConnection()
 *  make the appropriate setsockopt() call.
 *  Implemented as a GSocket function because clients (ie, wxSocketServer)
 *  don't have access to the GSocket struct information.
 *  make the appropriate setsockopt() call.
 *  Implemented as a GSocket function because clients (ie, wxSocketServer)
 *  don't have access to the GSocket struct information.

-*  Returns TRUE if the flag was set correctly, FALSE if an error occured
+*  Returns true if the flag was set correctly, false if an error occurred

 *  (ie, if the parameter was NULL)
 */
 *  (ie, if the parameter was NULL)
 */

-int GSocket::SetReusable()
+bool GSocket::SetReusable()

 {
     /* socket must not be null, and must not be in use/already bound */
     if (this && m_fd == INVALID_SOCKET) {
 {
     /* socket must not be null, and must not be in use/already bound */
     if (this && m_fd == INVALID_SOCKET) {

-        m_reusable = TRUE;
-        return TRUE;
+        m_reusable = true;
+        return true;

     }
     }

-    return FALSE;
+    return false;

 }
 
 /* Client specific parts */
 }
 
 /* Client specific parts */


@@ -535,7 +534,7 @@ int GSocket::SetReusable()
  *  For stream (connection oriented) sockets, GSocket_Connect() tries
  *  to establish a client connection to a server using the peer address
  *  as established with GSocket_SetPeer(). Returns GSOCK_NOERROR if the
  *  For stream (connection oriented) sockets, GSocket_Connect() tries
  *  to establish a client connection to a server using the peer address
  *  as established with GSocket_SetPeer(). Returns GSOCK_NOERROR if the

- *  connection has been succesfully established, or one of the error
+ *  connection has been successfully established, or one of the error

  *  codes listed below. Note that for nonblocking sockets, a return
  *  value of GSOCK_WOULDBLOCK doesn't mean a failure. The connection
  *  request can be completed later; you should use GSocket_Select()
  *  codes listed below. Note that for nonblocking sockets, a return
  *  value of GSOCK_WOULDBLOCK doesn't mean a failure. The connection
  *  request can be completed later; you should use GSocket_Select()


@@ -578,8 +577,8 @@ GSocketError GSocket::Connect(GSocketStream stream)
 
   /* Streamed or dgram socket? */
   m_stream   = (stream == GSOCK_STREAMED);
 
   /* Streamed or dgram socket? */
   m_stream   = (stream == GSOCK_STREAMED);

-  m_server   = FALSE;
-  m_establishing = FALSE;
+  m_server   = false;
+  m_establishing = false;

 
   /* Create the socket */
   m_fd = socket(m_peer->m_realfamily,
 
   /* Create the socket */
   m_fd = socket(m_peer->m_realfamily,


@@ -594,6 +593,18 @@ GSocketError GSocket::Connect(GSocketStream stream)
   ioctlsocket(m_fd, FIONBIO, (u_long FAR *) &arg);
   gs_gui_functions->Enable_Events(this);
 
   ioctlsocket(m_fd, FIONBIO, (u_long FAR *) &arg);
   gs_gui_functions->Enable_Events(this);
 

+  // If the reuse flag is set, use the applicable socket reuse flag
+  if (m_reusable)
+  {
+     setsockopt(m_fd, SOL_SOCKET, SO_REUSEADDR, (const char*)&arg, sizeof(u_long));
+  }
+
+  // If a local address has been set, then we need to bind to it before calling connect
+  if (m_local && m_local->m_addr)
+  {
+    bind(m_fd, m_local->m_addr, m_local->m_len);
+  }
+

   /* Connect it to the peer address, with a timeout (see below) */
   ret = connect(m_fd, m_peer->m_addr, m_peer->m_len);
 
   /* Connect it to the peer address, with a timeout (see below) */
   ret = connect(m_fd, m_peer->m_addr, m_peer->m_len);
 


@@ -627,7 +638,7 @@ GSocketError GSocket::Connect(GSocketStream stream)
      */
     if ((err == WSAEWOULDBLOCK) && (m_non_blocking))
     {
      */
     if ((err == WSAEWOULDBLOCK) && (m_non_blocking))
     {

-      m_establishing = TRUE;
+      m_establishing = true;

       m_error = GSOCK_WOULDBLOCK;
       return GSOCK_WOULDBLOCK;
     }
       m_error = GSOCK_WOULDBLOCK;
       return GSOCK_WOULDBLOCK;
     }


@@ -675,8 +686,8 @@ GSocketError GSocket::SetNonOriented()
   }
 
   /* Initialize all fields */
   }
 
   /* Initialize all fields */

-  m_stream   = FALSE;
-  m_server   = FALSE;
+  m_stream   = false;
+  m_server   = false;

 
   /* Create the socket */
   m_fd = socket(m_local->m_realfamily, SOCK_DGRAM, 0);
 
   /* Create the socket */
   m_fd = socket(m_local->m_realfamily, SOCK_DGRAM, 0);


@@ -696,7 +707,7 @@ GSocketError GSocket::SetNonOriented()
   if ((bind(m_fd, m_local->m_addr, m_local->m_len) != 0) ||
       (getsockname(m_fd,
                    m_local->m_addr,
   if ((bind(m_fd, m_local->m_addr, m_local->m_len) != 0) ||
       (getsockname(m_fd,
                    m_local->m_addr,

-                   (SOCKLEN_T *)&m_local->m_len) != 0))
+                   (WX_SOCKLEN_T *)&m_local->m_len) != 0))

   {
     Close();
     m_error = GSOCK_IOERR;
   {
     Close();
     m_error = GSOCK_IOERR;


@@ -726,7 +737,10 @@ int GSocket::Read(char *buffer, int size)
 
   /* If the socket is blocking, wait for data (with a timeout) */
   if (Input_Timeout() == GSOCK_TIMEDOUT)
 
   /* If the socket is blocking, wait for data (with a timeout) */
   if (Input_Timeout() == GSOCK_TIMEDOUT)

+  {
+    m_error = GSOCK_TIMEDOUT;

     return -1;
     return -1;

+  }

 
   /* Read the data */
   if (m_stream)
 
   /* Read the data */
   if (m_stream)


@@ -821,7 +835,7 @@ GSocketEventFlags GSocket::Select(GSocketEventFlags flags)
      */
     if ((m_detected & GSOCK_LOST_FLAG) != 0)
     {
      */
     if ((m_detected & GSOCK_LOST_FLAG) != 0)
     {

-      m_establishing = FALSE;
+      m_establishing = false;

 
       return (GSOCK_LOST_FLAG & flags);
     }
 
       return (GSOCK_LOST_FLAG & flags);
     }


@@ -834,30 +848,28 @@ GSocketEventFlags GSocket::Select(GSocketEventFlags flags)
       return (result & flags);
     }
 
       return (result & flags);
     }
 

-    /* Check for readability */
-    if (FD_ISSET(m_fd, &readfds))
+    /* Check for exceptions and errors */
+    if (FD_ISSET(m_fd, &exceptfds))

     {
     {

-      char c;
+      m_establishing = false;
+      m_detected = GSOCK_LOST_FLAG;

 
 

-      if (!m_stream || recv(m_fd, &c, 1, MSG_PEEK) > 0)
-      {
-        result |= GSOCK_INPUT_FLAG;
-      }
-      else
-      {
-        if (m_server && m_stream)
-        {
-          result |= GSOCK_CONNECTION_FLAG;
-          m_detected |= GSOCK_CONNECTION_FLAG;
-        }
-        else
-        {
-          m_detected = GSOCK_LOST_FLAG;
-          m_establishing = FALSE;
+      /* LOST event: Abort any further processing */
+      return (GSOCK_LOST_FLAG & flags);
+    }

 
 

-          /* LOST event: Abort any further processing */
-          return (GSOCK_LOST_FLAG & flags);
-        }
+    /* Check for readability */
+    if (FD_ISSET(m_fd, &readfds))
+    {
+      result |= GSOCK_INPUT_FLAG;
+
+      if (m_server && m_stream)
+      { 
+        /* This is a TCP server socket that detected a connection. 
+           While the INPUT_FLAG is also set, it doesn't matter on 
+           this kind of  sockets, as we can only Accept() from them. */
+        result |= GSOCK_CONNECTION_FLAG;
+        m_detected |= GSOCK_CONNECTION_FLAG;

       }
     }
 
       }
     }
 


@@ -867,9 +879,9 @@ GSocketEventFlags GSocket::Select(GSocketEventFlags flags)
       if (m_establishing && !m_server)
       {
         int error;
       if (m_establishing && !m_server)
       {
         int error;

-        SOCKLEN_T len = sizeof(error);
+        WX_SOCKLEN_T len = sizeof(error);

 
 

-        m_establishing = FALSE;
+        m_establishing = false;

 
         getsockopt(m_fd, SOL_SOCKET, SO_ERROR, (char*)&error, &len);
 
 
         getsockopt(m_fd, SOL_SOCKET, SO_ERROR, (char*)&error, &len);
 


@@ -892,16 +904,6 @@ GSocketEventFlags GSocket::Select(GSocketEventFlags flags)
       }
     }
 
       }
     }
 

-    /* Check for exceptions and errors (is this useful in Unices?) */
-    if (FD_ISSET(m_fd, &exceptfds))
-    {
-      m_establishing = FALSE;
-      m_detected = GSOCK_LOST_FLAG;
-
-      /* LOST event: Abort any further processing */
-      return (GSOCK_LOST_FLAG & flags);
-    }
-

     return (result & flags);
   }
   else /* USE_GUI() */
     return (result & flags);
   }
   else /* USE_GUI() */


@@ -937,7 +939,7 @@ void GSocket::SetTimeout(unsigned long millis)
 }
 
 /* GSocket_GetError:
 }
 
 /* GSocket_GetError:

- *  Returns the last error occured for this socket. Note that successful
+ *  Returns the last error occurred for this socket. Note that successful

  *  operations do not clear this back to GSOCK_NOERROR, so use it only
  *  after an error.
  */
  *  operations do not clear this back to GSOCK_NOERROR, so use it only
  *  after an error.
  */


@@ -962,7 +964,7 @@ GSocketError WXDLLIMPEXP_NET GSocket::GetError()
  *   assume that it can write since the first OUTPUT event, and no more
  *   OUTPUT events will be generated unless an error occurs.
  * GSOCK_CONNECTION:
  *   assume that it can write since the first OUTPUT event, and no more
  *   OUTPUT events will be generated unless an error occurs.
  * GSOCK_CONNECTION:

- *   Connection succesfully established, for client sockets, or incoming
+ *   Connection successfully established, for client sockets, or incoming

  *   client connection, for server sockets. Wait for this event (also watch
  *   out for GSOCK_LOST) after you issue a nonblocking GSocket_Connect() call.
  * GSOCK_LOST:
  *   client connection, for server sockets. Wait for this event (also watch
  *   out for GSOCK_LOST) after you issue a nonblocking GSocket_Connect() call.
  * GSOCK_LOST:


@@ -1114,7 +1116,7 @@ int GSocket::Recv_Stream(char *buffer, int size)
 int GSocket::Recv_Dgram(char *buffer, int size)
 {
   struct sockaddr from;
 int GSocket::Recv_Dgram(char *buffer, int size)
 {
   struct sockaddr from;

-  SOCKLEN_T fromlen = sizeof(from);
+  WX_SOCKLEN_T fromlen = sizeof(from);

   int ret;
   GSocketError err;
 
   int ret;
   GSocketError err;
 


@@ -1420,7 +1422,7 @@ GSocketError GAddress_INET_SetHostAddress(GAddress *address,
   CHECK_ADDRESS(address, INET);
 
   addr = &(((struct sockaddr_in *)address->m_addr)->sin_addr);
   CHECK_ADDRESS(address, INET);
 
   addr = &(((struct sockaddr_in *)address->m_addr)->sin_addr);

-  addr->s_addr = htonl(hostaddr);;
+  addr->s_addr = htonl(hostaddr);

 
   return GSOCK_NOERROR;
 }
 
   return GSOCK_NOERROR;
 }


@@ -1536,24 +1538,15 @@ GSocketError _GAddress_Init_UNIX(GAddress *address)
   return GSOCK_INVADDR;
 }
 
   return GSOCK_INVADDR;
 }
 

-GSocketError GAddress_UNIX_SetPath(GAddress *address, const char *path)
+GSocketError GAddress_UNIX_SetPath(GAddress *address, const char *WXUNUSED(path))

 {
 {

-#if defined(__BORLANDC__)
-  /* prevents unused variable message in Borland */
-  (void)path;
-#endif

   assert (address != NULL);
   address->m_error = GSOCK_INVADDR;
   return GSOCK_INVADDR;
 }
 
   assert (address != NULL);
   address->m_error = GSOCK_INVADDR;
   return GSOCK_INVADDR;
 }
 

-GSocketError GAddress_UNIX_GetPath(GAddress *address, char *path, size_t sbuf)
+GSocketError GAddress_UNIX_GetPath(GAddress *address, char *WXUNUSED(path), size_t WXUNUSED(sbuf))

 {
 {

-#if defined(__BORLANDC__)
-  /* prevents unused variable message in Borland */
-  (void)path;
-  (void)sbuf;
-#endif

   assert (address != NULL);
   address->m_error = GSOCK_INVADDR;
   return GSOCK_INVADDR;
   assert (address != NULL);
   address->m_error = GSOCK_INVADDR;
   return GSOCK_INVADDR;


@@ -1568,4 +1561,3 @@ GSocketError GAddress_UNIX_GetPath(GAddress *address, char *path, size_t sbuf)
 typedef void (*wxDummy)();
 
 #endif  /* wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__) */
 typedef void (*wxDummy)();
 
 #endif  /* wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__) */

-