]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/gsocket.c
applied patch 890642: wxRE_ADVANCED flag and docs
[wxWidgets.git] / src / msw / gsocket.c
index 2274a39fe84fb04a3a55bf42fde1a354f53d5ae2..9eb8d695138a1d2882960db67ce807148f5f73cf 100644 (file)
@@ -3,6 +3,7 @@
  * Name:    gsocket.c
  * Author:  Guillermo Rodriguez Garcia <guille@iies.es>
  * Purpose: GSocket main MSW file
+ * Licence: The wxWindows licence
  * CVSID:   $Id$
  * -------------------------------------------------------------------------
  */
  * PLEASE don't put C++ comments here - this is a C source file.
  */
 
+#ifdef _MSC_VER
+   /* RPCNOTIFICATION_ROUTINE in rasasync.h (included from winsock.h),
+    * warning: conditional expression is constant.
+    */
+#  pragma warning(disable:4115)
+   /* FD_SET,
+    * warning: named type definition in parentheses.
+    */
+#  pragma warning(disable:4127)
+   /* GAddress_UNIX_GetPath,
+    * warning: unreferenced formal parameter.
+    */
+#  pragma warning(disable:4100)
+#endif /* _MSC_VER */
+
+#include <winsock.h>
+
 #ifndef __GSOCKET_STANDALONE__
-#include "wx/setup.h"
+#   include "wx/platform.h"
+#   include "wx/setup.h"
 #endif
 
 #if wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__)
 
 #ifndef __GSOCKET_STANDALONE__
-
-#include "wx/msw/gsockmsw.h"
-#include "wx/gsocket.h"
-
+#  include "wx/msw/gsockmsw.h"
+#  include "wx/gsocket.h"
 #else
-
-#include "gsockmsw.h"
-#include "gsocket.h"
-
+#  include "gsockmsw.h"
+#  include "gsocket.h"
 #endif /* __GSOCKET_STANDALONE__ */
 
+#ifndef __WXWINCE__
 #include <assert.h>
+#else
+#define assert(x)
+#ifndef isdigit
+#define isdigit(x) (x > 47 && x < 58)
+#endif
+#include "wx/msw/wince/net.h"
+#endif
+
 #include <string.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <stddef.h>
 #include <ctype.h>
-#include <winsock.h>
 
 /* if we use configure for MSW SOCKLEN_T will be already defined */
 #ifndef SOCKLEN_T
-#define SOCKLEN_T  int
+#  define SOCKLEN_T int
 #endif
 
-#ifdef _MSC_VER
-    /* using FD_SET results in this warning */
-    #pragma warning(disable:4127) /* conditional expression is constant */
-#endif /* Visual C++ */
+/* Table of GUI-related functions. We must call them indirectly because
+ * of wxBase and GUI separation: */
+
+static struct GSocketGUIFunctionsTable *gs_gui_functions;
+
+#define USE_GUI() (gs_gui_functions != NULL)
+
+/* Define macros to simplify indirection: */
+#define _GSocket_GUI_Init() \
+    if (gs_gui_functions) gs_gui_functions->GUI_Init()
+#define _GSocket_GUI_Cleanup() \
+    if (gs_gui_functions) gs_gui_functions->GUI_Cleanup()
+#define _GSocket_GUI_Init_Socket(socket) \
+    (gs_gui_functions ? gs_gui_functions->GUI_Init_Socket(socket) : 1)
+#define _GSocket_GUI_Destroy_Socket(socket) \
+    if (gs_gui_functions) gs_gui_functions->GUI_Destroy_Socket(socket)
+#define _GSocket_Enable_Events(socket) \
+    if (gs_gui_functions) gs_gui_functions->Enable_Events(socket)
+#define _GSocket_Disable_Events(socket) \
+    if (gs_gui_functions) gs_gui_functions->Disable_Events(socket)
+#define _GSocket_Install_Callback(socket, event) \
+    if (gs_gui_functions) gs_gui_functions->Install_Callback(socket, event)
+#define _GSocket_Uninstall_Callback(socket, event) \
+    if (gs_gui_functions) gs_gui_functions->Uninstall_Callback(socket, event)
+
+/* Global initialisers */
+
+void GSocket_SetGUIFunctions(struct GSocketGUIFunctionsTable *guifunc)
+{
+  gs_gui_functions = guifunc;
+}
+         
+int GSocket_Init(void)
+{
+  WSADATA wsaData;
+  
+  if (gs_gui_functions)
+  {
+      if ( !gs_gui_functions->GUI_Init() )
+        return 0;
+  }
 
+  /* Initialize WinSocket */
+  return (WSAStartup((1 << 8) | 1, &wsaData) == 0);
+}
+
+void GSocket_Cleanup(void)
+{
+  if (gs_gui_functions)
+  {
+      gs_gui_functions->GUI_Cleanup();
+  }
+  
+  /* Cleanup WinSocket */
+  WSACleanup();
+}
 
 /* Constructors / Destructors for GSocket */
 
 GSocket *GSocket_new(void)
 {
-  int i;
+  int i, success;
   GSocket *socket;
 
   if ((socket = (GSocket *) malloc(sizeof(GSocket))) == NULL)
@@ -63,32 +137,41 @@ GSocket *GSocket_new(void)
   {
     socket->m_cbacks[i]     = NULL;
   }
-  socket->m_local           = NULL;     
-  socket->m_peer            = NULL;     
+  socket->m_detected        = 0;
+  socket->m_local           = NULL;
+  socket->m_peer            = NULL;
   socket->m_error           = GSOCK_NOERROR;
-  socket->m_server          = FALSE;            
+  socket->m_server          = FALSE;
   socket->m_stream          = TRUE;
   socket->m_non_blocking    = FALSE;
   socket->m_timeout.tv_sec  = 10 * 60;  /* 10 minutes */
   socket->m_timeout.tv_usec = 0;
-  socket->m_detected        = 0;
+  socket->m_establishing    = FALSE;
 
   /* Per-socket GUI-specific initialization */
-  if (!_GSocket_GUI_Init(socket))
+  success = _GSocket_GUI_Init_Socket(socket);
+  if (!success)
   {
     free(socket);
-    return NULL;
+    socket = NULL;
   }
 
   return socket;
 }
 
+void GSocket_close(GSocket *socket)
+{
+    _GSocket_Disable_Events(socket);
+    closesocket(socket->m_fd);
+    socket->m_fd = INVALID_SOCKET;
+}
+
 void GSocket_destroy(GSocket *socket)
 {
   assert(socket != NULL);
 
   /* Per-socket GUI-specific cleanup */
-  _GSocket_GUI_Destroy(socket);
+  _GSocket_GUI_Destroy_Socket(socket);
 
   /* Check that the socket is really shutdowned */
   if (socket->m_fd != INVALID_SOCKET)
@@ -119,8 +202,7 @@ void GSocket_Shutdown(GSocket *socket)
   if (socket->m_fd != INVALID_SOCKET)
   {
     shutdown(socket->m_fd, 2);
-    closesocket(socket->m_fd);
-    socket->m_fd = INVALID_SOCKET;
+    GSocket_close(socket);
   }
 
   /* Disable GUI callbacks */
@@ -128,7 +210,6 @@ void GSocket_Shutdown(GSocket *socket)
     socket->m_cbacks[evt] = NULL;
 
   socket->m_detected = GSOCK_LOST_FLAG;
-  _GSocket_Disable_Events(socket);
 }
 
 /* Address handling */
@@ -252,11 +333,11 @@ GAddress *GSocket_GetPeer(GSocket *socket)
  *  Sets up this socket as a server. The local address must have been
  *  set with GSocket_SetLocal() before GSocket_SetServer() is called.
  *  Returns GSOCK_NOERROR on success, one of the following otherwise:
- * 
+ *
  *  Error codes:
  *    GSOCK_INVSOCK - the socket is in use.
  *    GSOCK_INVADDR - the local address has not been set.
- *    GSOCK_IOERR   - low-level error. 
+ *    GSOCK_IOERR   - low-level error.
  */
 GSocketError GSocket_SetServer(GSocket *sck)
 {
@@ -295,6 +376,11 @@ GSocketError GSocket_SetServer(GSocket *sck)
   ioctlsocket(sck->m_fd, FIONBIO, (u_long FAR *) &arg);
   _GSocket_Enable_Events(sck);
 
+  /* allow a socket to re-bind if the socket is in the TIME_WAIT
+     state after being previously closed.
+   */
+  setsockopt(sck->m_fd, SOL_SOCKET, SO_REUSEADDR, (const char*)&arg, sizeof(u_long));
+
   /* Bind to the local address,
    * retrieve the actual address bound,
    * and listen up to 5 connections.
@@ -305,8 +391,7 @@ GSocketError GSocket_SetServer(GSocket *sck)
                    (SOCKLEN_T *)&sck->m_local->m_len) != 0) ||
       (listen(sck->m_fd, 5) != 0))
   {
-    closesocket(sck->m_fd);
-    sck->m_fd = INVALID_SOCKET;
+    GSocket_close(sck);
     sck->m_error = GSOCK_IOERR;
     return GSOCK_IOERR;
   }
@@ -324,7 +409,7 @@ GSocketError GSocket_SetServer(GSocket *sck)
  *    GSOCK_TIMEDOUT   - timeout, no incoming connections.
  *    GSOCK_WOULDBLOCK - the call would block and the socket is nonblocking.
  *    GSOCK_MEMERR     - couldn't allocate memory.
- *    GSOCK_IOERR      - low-level error. 
+ *    GSOCK_IOERR      - low-level error.
  */
 GSocket *GSocket_WaitConnection(GSocket *sck)
 {
@@ -427,7 +512,7 @@ GSocket *GSocket_WaitConnection(GSocket *sck)
  *    GSOCK_TIMEDOUT   - timeout, the connection failed.
  *    GSOCK_WOULDBLOCK - connection in progress (nonblocking sockets only)
  *    GSOCK_MEMERR     - couldn't allocate memory.
- *    GSOCK_IOERR      - low-level error. 
+ *    GSOCK_IOERR      - low-level error.
  */
 GSocketError GSocket_Connect(GSocket *sck, GSocketStream stream)
 {
@@ -455,6 +540,7 @@ GSocketError GSocket_Connect(GSocket *sck, GSocketStream stream)
   sck->m_stream   = (stream == GSOCK_STREAMED);
   sck->m_oriented = TRUE;
   sck->m_server   = FALSE;
+  sck->m_establishing = FALSE;
 
   /* Create the socket */
   sck->m_fd = socket(sck->m_peer->m_realfamily,
@@ -487,12 +573,11 @@ GSocketError GSocket_Connect(GSocket *sck, GSocketStream stream)
 
       if (err != GSOCK_NOERROR)
       {
-        closesocket(sck->m_fd);
-        sck->m_fd = INVALID_SOCKET;
+        GSocket_close(sck);
         /* sck->m_error is set in _GSocket_Connect_Timeout */
       }
 
-      return err;
+      return (GSocketError) err;
     }
 
     /* If connect failed with EWOULDBLOCK and the GSocket object
@@ -503,6 +588,7 @@ GSocketError GSocket_Connect(GSocket *sck, GSocketStream stream)
      */
     if ((err == WSAEWOULDBLOCK) && (sck->m_non_blocking))
     {
+      sck->m_establishing = TRUE;
       sck->m_error = GSOCK_WOULDBLOCK;
       return GSOCK_WOULDBLOCK;
     }
@@ -510,8 +596,7 @@ GSocketError GSocket_Connect(GSocket *sck, GSocketStream stream)
     /* If connect failed with an error other than EWOULDBLOCK,
      * then the call to GSocket_Connect() has failed.
      */
-    closesocket(sck->m_fd);
-    sck->m_fd = INVALID_SOCKET;
+    GSocket_close(sck);
     sck->m_error = GSOCK_IOERR;
     return GSOCK_IOERR;
   }
@@ -530,7 +615,7 @@ GSocketError GSocket_Connect(GSocket *sck, GSocketStream stream)
  *  Error codes:
  *    GSOCK_INVSOCK - the socket is in use.
  *    GSOCK_INVADDR - the local address has not been set.
- *    GSOCK_IOERR   - low-level error. 
+ *    GSOCK_IOERR   - low-level error.
  */
 GSocketError GSocket_SetNonOriented(GSocket *sck)
 {
@@ -575,8 +660,7 @@ GSocketError GSocket_SetNonOriented(GSocket *sck)
                    sck->m_local->m_addr,
                    (SOCKLEN_T *)&sck->m_local->m_len) != 0))
   {
-    closesocket(sck->m_fd);
-    sck->m_fd    = INVALID_SOCKET;
+    GSocket_close(sck);
     sck->m_error = GSOCK_IOERR;
     return GSOCK_IOERR;
   }
@@ -674,9 +758,119 @@ int GSocket_Write(GSocket *socket, const char *buffer, int size)
  */
 GSocketEventFlags GSocket_Select(GSocket *socket, GSocketEventFlags flags)
 {
-  assert(socket != NULL);
+  if (!USE_GUI())
+  {
+    GSocketEventFlags result = 0;
+    fd_set readfds;
+    fd_set writefds;
+    fd_set exceptfds;
+    
+    assert(socket != NULL);
+
+    FD_ZERO(&readfds);
+    FD_ZERO(&writefds);
+    FD_ZERO(&exceptfds);
+    FD_SET(socket->m_fd, &readfds);
+       if (flags & GSOCK_OUTPUT_FLAG)
+      FD_SET(socket->m_fd, &writefds);
+    FD_SET(socket->m_fd, &exceptfds);
+
+    /* Check 'sticky' CONNECTION flag first */
+    result |= (GSOCK_CONNECTION_FLAG & socket->m_detected);
+
+    /* If we have already detected a LOST event, then don't try
+     * to do any further processing.
+     */
+    if ((socket->m_detected & GSOCK_LOST_FLAG) != 0)
+    {
+      socket->m_establishing = FALSE;
+
+      return (GSOCK_LOST_FLAG & flags);
+    }
 
-  return flags & socket->m_detected;
+    /* Try select now */
+    if (select(socket->m_fd + 1, &readfds, &writefds, &exceptfds,
+           &socket->m_timeout) <= 0)
+    {
+      /* What to do here? */
+      return (result & flags);
+    }
+
+    /* Check for readability */
+    if (FD_ISSET(socket->m_fd, &readfds))
+    {
+      char c;
+
+      if (!socket->m_stream || recv(socket->m_fd, &c, 1, MSG_PEEK) > 0)
+      {
+        result |= GSOCK_INPUT_FLAG;
+      }
+      else
+      {
+        if (socket->m_server && socket->m_stream)
+        {
+          result |= GSOCK_CONNECTION_FLAG;
+          socket->m_detected |= GSOCK_CONNECTION_FLAG;
+        }
+        else
+        {
+          socket->m_detected = GSOCK_LOST_FLAG;
+          socket->m_establishing = FALSE;
+      
+          /* LOST event: Abort any further processing */
+          return (GSOCK_LOST_FLAG & flags);
+        }
+      }
+    }
+
+    /* Check for writability */
+    if (FD_ISSET(socket->m_fd, &writefds))
+    {
+      if (socket->m_establishing && !socket->m_server)
+      {
+        int error;
+        SOCKLEN_T len = sizeof(error);
+
+        socket->m_establishing = FALSE;
+
+        getsockopt(socket->m_fd, SOL_SOCKET, SO_ERROR, (void*)&error, &len);
+
+        if (error)
+        {
+          socket->m_detected = GSOCK_LOST_FLAG;
+
+          /* LOST event: Abort any further processing */
+          return (GSOCK_LOST_FLAG & flags);
+        }
+        else
+        {
+          result |= GSOCK_CONNECTION_FLAG;
+          socket->m_detected |= GSOCK_CONNECTION_FLAG;
+        }
+      }
+      else
+      {
+        result |= GSOCK_OUTPUT_FLAG;
+      }
+    }
+
+    /* Check for exceptions and errors (is this useful in Unices?) */
+    if (FD_ISSET(socket->m_fd, &exceptfds))
+    {
+      socket->m_establishing = FALSE;
+      socket->m_detected = GSOCK_LOST_FLAG;
+
+      /* LOST event: Abort any further processing */
+      return (GSOCK_LOST_FLAG & flags);
+    }
+
+    return (result & flags);
+  }
+  else /* USE_GUI() */
+  {
+    assert(socket != NULL);
+    return flags & socket->m_detected;
+  }
 }
 
 /* Attributes */
@@ -685,7 +879,7 @@ GSocketEventFlags GSocket_Select(GSocket *socket, GSocketEventFlags flags)
  *  Sets the socket to non-blocking mode. All IO calls will return
  *  immediately.
  */
-void GSocket_SetNonBlocking(GSocket *socket, bool non_block)
+void GSocket_SetNonBlocking(GSocket *socket, int non_block)
 {
   assert(socket != NULL);
 
@@ -723,7 +917,7 @@ GSocketError GSocket_GetError(GSocket *socket)
  *   operation, there is still data available, the callback function will
  *   be called again.
  * GSOCK_OUTPUT:
- *   The socket is available for writing. That is, the next write call 
+ *   The socket is available for writing. That is, the next write call
  *   won't block. This event is generated only once, when the connection is
  *   first established, and then only if a call failed with GSOCK_WOULDBLOCK,
  *   when the output buffer empties again. This means that the app should
@@ -932,22 +1126,38 @@ int _GSocket_Send_Dgram(GSocket *socket, const char *buffer, int size)
  * -------------------------------------------------------------------------
  */
 
-/* CHECK_ADDRESS verifies that the current family is either GSOCK_NOFAMILY
- * or GSOCK_*family*, and if it is GSOCK_NOFAMILY, it initalizes address
- * to be a GSOCK_*family*. In other cases, it returns GSOCK_INVADDR.
+/* CHECK_ADDRESS verifies that the current address family is either
+ * GSOCK_NOFAMILY or GSOCK_*family*, and if it is GSOCK_NOFAMILY, it
+ * initalizes it to be a GSOCK_*family*. In other cases, it returns
+ * an appropiate error code.
+ *
+ * CHECK_ADDRESS_RETVAL does the same but returning 'retval' on error.
  */
-#define CHECK_ADDRESS(address, family, retval)                      \
+#define CHECK_ADDRESS(address, family)                              \
 {                                                                   \
   if (address->m_family == GSOCK_NOFAMILY)                          \
     if (_GAddress_Init_##family(address) != GSOCK_NOERROR)          \
       return address->m_error;                                      \
   if (address->m_family != GSOCK_##family)                          \
+  {                                                                 \
+    address->m_error = GSOCK_INVADDR;                               \
+    return GSOCK_INVADDR;                                           \
+  }                                                                 \
+}
+
+#define CHECK_ADDRESS_RETVAL(address, family, retval)               \
+{                                                                   \
+  if (address->m_family == GSOCK_NOFAMILY)                          \
+    if (_GAddress_Init_##family(address) != GSOCK_NOERROR)          \
+      return retval;                                                \
+  if (address->m_family != GSOCK_##family)                          \
   {                                                                 \
     address->m_error = GSOCK_INVADDR;                               \
     return retval;                                                  \
   }                                                                 \
 }
 
+
 GAddress *GAddress_new(void)
 {
   GAddress *address;
@@ -991,6 +1201,9 @@ void GAddress_destroy(GAddress *address)
 {
   assert(address != NULL);
 
+  if (address->m_addr)
+    free(address->m_addr);
+
   free(address);
 }
 
@@ -1100,7 +1313,7 @@ GSocketError GAddress_INET_SetHostName(GAddress *address, const char *hostname)
 
   assert(address != NULL);
 
-  CHECK_ADDRESS(address, INET, GSOCK_INVADDR);
+  CHECK_ADDRESS(address, INET);
 
   addr = &(((struct sockaddr_in *)address->m_addr)->sin_addr);
 
@@ -1136,7 +1349,7 @@ GSocketError GAddress_INET_SetHostAddress(GAddress *address,
 
   assert(address != NULL);
 
-  CHECK_ADDRESS(address, INET, GSOCK_INVADDR);
+  CHECK_ADDRESS(address, INET);
 
   addr = &(((struct sockaddr_in *)address->m_addr)->sin_addr);
   addr->s_addr = hostaddr;
@@ -1151,7 +1364,7 @@ GSocketError GAddress_INET_SetPortName(GAddress *address, const char *port,
   struct sockaddr_in *addr;
 
   assert(address != NULL);
-  CHECK_ADDRESS(address, INET, GSOCK_INVADDR);
+  CHECK_ADDRESS(address, INET);
 
   if (!port)
   {
@@ -1187,7 +1400,7 @@ GSocketError GAddress_INET_SetPort(GAddress *address, unsigned short port)
   struct sockaddr_in *addr;
 
   assert(address != NULL);
-  CHECK_ADDRESS(address, INET, GSOCK_INVADDR);
+  CHECK_ADDRESS(address, INET);
 
   addr = (struct sockaddr_in *)address->m_addr;
   addr->sin_port = htons(port);
@@ -1202,7 +1415,7 @@ GSocketError GAddress_INET_GetHostName(GAddress *address, char *hostname, size_t
   struct sockaddr_in *addr;
 
   assert(address != NULL);
-  CHECK_ADDRESS(address, INET, GSOCK_INVADDR);
+  CHECK_ADDRESS(address, INET);
 
   addr = (struct sockaddr_in *)address->m_addr;
   addr_buf = (char *)&(addr->sin_addr);
@@ -1224,7 +1437,7 @@ unsigned long GAddress_INET_GetHostAddress(GAddress *address)
   struct sockaddr_in *addr;
 
   assert(address != NULL);
-  CHECK_ADDRESS(address, INET, 0);
+  CHECK_ADDRESS_RETVAL(address, INET, 0);
 
   addr = (struct sockaddr_in *)address->m_addr;
 
@@ -1236,7 +1449,7 @@ unsigned short GAddress_INET_GetPort(GAddress *address)
   struct sockaddr_in *addr;
 
   assert(address != NULL);
-  CHECK_ADDRESS(address, INET, 0);
+  CHECK_ADDRESS_RETVAL(address, INET, 0);
 
   addr = (struct sockaddr_in *)address->m_addr;
   return ntohs(addr->sin_port);
@@ -1248,10 +1461,6 @@ unsigned short GAddress_INET_GetPort(GAddress *address)
  * -------------------------------------------------------------------------
  */
 
-#ifdef _MSC_VER
-    #pragma warning(disable:4100) /* unreferenced formal parameter */
-#endif /* Visual C++ */
-
 GSocketError _GAddress_Init_UNIX(GAddress *address)
 {
   assert (address != NULL);
@@ -1261,6 +1470,10 @@ GSocketError _GAddress_Init_UNIX(GAddress *address)
 
 GSocketError GAddress_UNIX_SetPath(GAddress *address, const char *path)
 {
+#if defined(__BORLANDC__)
+  /* prevents unused variable message in Borland */
+  (void)path;
+#endif
   assert (address != NULL);
   address->m_error = GSOCK_INVADDR;
   return GSOCK_INVADDR;
@@ -1268,6 +1481,11 @@ GSocketError GAddress_UNIX_SetPath(GAddress *address, const char *path)
 
 GSocketError GAddress_UNIX_GetPath(GAddress *address, char *path, size_t 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;
@@ -1275,10 +1493,11 @@ GSocketError GAddress_UNIX_GetPath(GAddress *address, char *path, size_t sbuf)
 
 #else /* !wxUSE_SOCKETS */
 
-/* 
+/*
  * Translation unit shouldn't be empty, so include this typedef to make the
  * compiler (VC++ 6.0, for example) happy
  */
-typedef (*wxDummy)();
+typedef void (*wxDummy)();
 
 #endif  /* wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__) */
+