added wxIsDebuggerRunning() (which is going to replace the mess in log.cpp)

[wxWidgets.git] / include / wx / socket.h

diff --git a/include/wx/socket.h b/include/wx/socket.h
index f8f5575aca8d56b5659b57edf8ec982a0dcb74f3..df328666653d39842e4b142fc1935c50b79e8797 100644 (file)
--- a/include/wx/socket.h
+++ b/include/wx/socket.h
@@ -12,8 +12,8 @@
 #ifndef _WX_NETWORK_SOCKET_H
 #define _WX_NETWORK_SOCKET_H
 
 #ifndef _WX_NETWORK_SOCKET_H
 #define _WX_NETWORK_SOCKET_H
 

-#ifdef __GNUG__
-#pragma interface "socket.h"
+#if defined(__GNUG__) && !defined(__APPLE__)
+  #pragma interface "socket.h"

 #endif
 
 #include "wx/defs.h"
 #endif
 
 #include "wx/defs.h"


@@ -25,14 +25,15 @@
 // ---------------------------------------------------------------------------
 
 #ifdef WXPREC
 // ---------------------------------------------------------------------------
 
 #ifdef WXPREC

-#  include "wx/wxprec.h"
+  #include "wx/wxprec.h"

 #else
 #else

-#  include "wx/event.h"
-#  include "wx/string.h"
+  #include "wx/event.h"
+  #include "wx/string.h"

 #endif
 
 #include "wx/sckaddr.h"
 #include "wx/gsocket.h"
 #endif
 
 #include "wx/sckaddr.h"
 #include "wx/gsocket.h"

+#include "wx/list.h"

 
 // ------------------------------------------------------------------------
 // Types and constants
 
 // ------------------------------------------------------------------------
 // Types and constants


@@ -58,8 +59,9 @@ typedef GSocketEventFlags wxSocketEventFlags;
 
 enum wxSocketError
 {
 
 enum wxSocketError
 {

+  // from GSocket

   wxSOCKET_NOERROR = GSOCK_NOERROR,
   wxSOCKET_NOERROR = GSOCK_NOERROR,

-  wxSOCKET_INPOP = GSOCK_INVOP,
+  wxSOCKET_INVOP = GSOCK_INVOP,

   wxSOCKET_IOERR = GSOCK_IOERR,
   wxSOCKET_INVADDR = GSOCK_INVADDR,
   wxSOCKET_INVSOCK = GSOCK_INVSOCK,
   wxSOCKET_IOERR = GSOCK_IOERR,
   wxSOCKET_INVADDR = GSOCK_INVADDR,
   wxSOCKET_INVSOCK = GSOCK_INVSOCK,


@@ -67,7 +69,10 @@ enum wxSocketError
   wxSOCKET_INVPORT = GSOCK_INVPORT,
   wxSOCKET_WOULDBLOCK = GSOCK_WOULDBLOCK,
   wxSOCKET_TIMEDOUT = GSOCK_TIMEDOUT,
   wxSOCKET_INVPORT = GSOCK_INVPORT,
   wxSOCKET_WOULDBLOCK = GSOCK_WOULDBLOCK,
   wxSOCKET_TIMEDOUT = GSOCK_TIMEDOUT,

-  wxSOCKET_MEMERR = GSOCK_MEMERR
+  wxSOCKET_MEMERR = GSOCK_MEMERR,
+
+  // wxSocket-specific (not yet implemented)
+  wxSOCKET_DUMMY

 };
 
 enum
 };
 
 enum


@@ -78,7 +83,6 @@ enum
   wxSOCKET_BLOCK = 4
 };
 
   wxSOCKET_BLOCK = 4
 };
 

-// Type of socket

 enum wxSocketType
 {
   wxSOCKET_UNINIT,
 enum wxSocketType
 {
   wxSOCKET_UNINIT,


@@ -91,15 +95,12 @@ enum wxSocketType
 typedef int wxSocketFlags;
 
 
 typedef int wxSocketFlags;
 
 

-// old names
-

 #if WXWIN_COMPATIBILITY
 #if WXWIN_COMPATIBILITY

-
-typedef wxSocketType wxSockType;
-typedef wxSocketFlags wxSockFlags;
-
+  typedef wxSocketType wxSockType;
+  typedef wxSocketFlags wxSockFlags;

 #endif // WXWIN_COMPATIBILITY
 
 #endif // WXWIN_COMPATIBILITY
 

+

 // --------------------------------------------------------------------------
 // wxSocketBase
 // --------------------------------------------------------------------------
 // --------------------------------------------------------------------------
 // wxSocketBase
 // --------------------------------------------------------------------------


@@ -127,9 +128,9 @@ public:
     SOCK_INTERNAL = wxSOCKET_BASE,
     SOCK_DATAGRAM = wxSOCKET_DATAGRAM
   };
     SOCK_INTERNAL = wxSOCKET_BASE,
     SOCK_DATAGRAM = wxSOCKET_DATAGRAM
   };

-#endif // WXWIN_COMPATIBILITY

 
   typedef void (*wxSockCbk)(wxSocketBase& sock, wxSocketNotify evt, char *cdata);
 
   typedef void (*wxSockCbk)(wxSocketBase& sock, wxSocketNotify evt, char *cdata);

+#endif // WXWIN_COMPATIBILITY

 
 public:
 
 
 public:
 


@@ -161,56 +162,68 @@ public:
   // base IO
   virtual bool  Close();
   wxSocketBase& Discard();
   // base IO
   virtual bool  Close();
   wxSocketBase& Discard();

-  wxSocketBase& Peek(char* buffer, wxUint32 nbytes);
-  wxSocketBase& Read(char* buffer, wxUint32 nbytes);
-  wxSocketBase& ReadMsg(char *buffer, wxUint32 nbytes);
-  wxSocketBase& Unread(const char *buffer, wxUint32 nbytes);
-  wxSocketBase& Write(const char *buffer, wxUint32 nbytes);
-  wxSocketBase& WriteMsg(const char *buffer, wxUint32 nbytes);
-
-  void InterruptAllWaits() { m_interrupt = TRUE; };
+  wxSocketBase& Peek(void* buffer, wxUint32 nbytes);
+  wxSocketBase& Read(void* buffer, wxUint32 nbytes);
+  wxSocketBase& ReadMsg(void *buffer, wxUint32 nbytes);
+  wxSocketBase& Unread(const void *buffer, wxUint32 nbytes);
+  wxSocketBase& Write(const void *buffer, wxUint32 nbytes);
+  wxSocketBase& WriteMsg(const void *buffer, wxUint32 nbytes);
+
+  void InterruptWait() { m_interrupt = TRUE; };

   bool Wait(long seconds = -1, long milliseconds = 0);
   bool WaitForRead(long seconds = -1, long milliseconds = 0);
   bool WaitForWrite(long seconds = -1, long milliseconds = 0);
   bool WaitForLost(long seconds = -1, long milliseconds = 0);
 
   bool Wait(long seconds = -1, long milliseconds = 0);
   bool WaitForRead(long seconds = -1, long milliseconds = 0);
   bool WaitForWrite(long seconds = -1, long milliseconds = 0);
   bool WaitForLost(long seconds = -1, long milliseconds = 0);
 

-  inline wxSocketFlags GetFlags() const { return m_flags; };
+  inline wxSocketFlags GetFlags() const { return m_flags; }

   void SetFlags(wxSocketFlags flags);
   void SetTimeout(long seconds);
 
   // event handling
   void SetFlags(wxSocketFlags flags);
   void SetTimeout(long seconds);
 
   // event handling

+  void *GetClientData() const { return m_clientData; }
+  void SetClientData(void *data) { m_clientData = data; }

   void SetEventHandler(wxEvtHandler& handler, int id = -1);
   void SetNotify(wxSocketEventFlags flags);
   void Notify(bool notify);
 
   void SetEventHandler(wxEvtHandler& handler, int id = -1);
   void SetNotify(wxSocketEventFlags flags);
   void Notify(bool notify);
 

-  // callbacks - deprecated, avoid if possible
+  // initialize/shutdown the sockets (usually called automatically)
+  static bool IsInitialized();
+  static bool Initialize();
+  static void Shutdown();
+
+  // callbacks are deprecated, use events instead
+#if WXWIN_COMPATIBILITY

   wxSockCbk Callback(wxSockCbk cbk_);
   char *CallbackData(char *data);
   wxSockCbk Callback(wxSockCbk cbk_);
   char *CallbackData(char *data);

+#endif // WXWIN_COMPATIBILITY

 
 
   // Implementation from now on
   // --------------------------
 
 
 
   // Implementation from now on
   // --------------------------
 

-  // do not use, this should be private
-  void OnRequest(wxSocketNotify req_evt);
+  // do not use, should be private (called from GSocket)
+  void OnRequest(wxSocketNotify notify);

 
   // do not use, not documented nor supported
 
   // do not use, not documented nor supported

-  inline bool IsNoWait() const { return ((m_flags & wxSOCKET_NOWAIT) != 0); };
+  inline bool IsNoWait() const { return ((m_flags & wxSOCKET_NOWAIT) != 0); }

   inline wxSocketType GetType() const { return m_type; }
 
   inline wxSocketType GetType() const { return m_type; }
 

-protected:
+private:
+  friend class wxSocketClient;
+  friend class wxSocketServer;
+  friend class wxDatagramSocket;

 
   // low level IO
 
   // low level IO

-  wxUint32 _Read(char* buffer, wxUint32 nbytes);
-  wxUint32 _Write(const char *buffer, wxUint32 nbytes);
-  bool _Wait(long seconds, long milliseconds, wxSocketEventFlags flags);
+  wxUint32 _Read(void* buffer, wxUint32 nbytes);
+  wxUint32 _Write(const void *buffer, wxUint32 nbytes);
+  bool     _Wait(long seconds, long milliseconds, wxSocketEventFlags flags);

 
   // pushback buffer
 
   // pushback buffer

-  void Pushback(const char *buffer, wxUint32 size);
-  wxUint32 GetPushback(char *buffer, wxUint32 size, bool peek);
-
-protected:
+  void     Pushback(const void *buffer, wxUint32 size);
+  wxUint32 GetPushback(void *buffer, wxUint32 size, bool peek);

 
 

+private:
+  // socket

   GSocket      *m_socket;           // GSocket
   wxSocketType  m_type;             // wxSocket type
 
   GSocket      *m_socket;           // GSocket
   wxSocketType  m_type;             // wxSocket type
 


@@ -221,6 +234,7 @@ protected:
   bool          m_reading;          // busy reading?
   bool          m_writing;          // busy writing?
   bool          m_error;            // did last IO call fail?
   bool          m_reading;          // busy reading?
   bool          m_writing;          // busy writing?
   bool          m_error;            // did last IO call fail?

+  wxSocketError m_lasterror;        // last error (not cleared on success)

   wxUint32      m_lcount;           // last IO transaction size
   unsigned long m_timeout;          // IO timeout value
   wxList        m_states;           // stack of states
   wxUint32      m_lcount;           // last IO transaction size
   unsigned long m_timeout;          // IO timeout value
   wxList        m_states;           // stack of states


@@ -228,18 +242,27 @@ protected:
   bool          m_beingDeleted;     // marked for delayed deletion?
 
   // pushback buffer
   bool          m_beingDeleted;     // marked for delayed deletion?
 
   // pushback buffer

-  char         *m_unread;           // pushback buffer
+  void         *m_unread;           // pushback buffer

   wxUint32      m_unrd_size;        // pushback buffer size
   wxUint32      m_unrd_cur;         // pushback pointer (index into buffer)
 
   // events
   wxUint32      m_unrd_size;        // pushback buffer size
   wxUint32      m_unrd_cur;         // pushback pointer (index into buffer)
 
   // events

-  wxEvtHandler *m_handler;          // event handler

   int           m_id;               // socket id
   int           m_id;               // socket id

-  bool          m_notify_state;     // notify events to users?
-  wxSocketEventFlags
-                m_neededreq;        // event mask
+  wxEvtHandler *m_handler;          // event handler
+  void         *m_clientData;       // client data for events
+  bool          m_notify;           // notify events to users?
+  wxSocketEventFlags  m_eventmask;  // which events to notify?
+
+  // the initialization count, GSocket is initialized if > 0
+  static size_t m_countInit;
+
+  // callbacks are deprecated, use events instead
+#if WXWIN_COMPATIBILITY

   wxSockCbk     m_cbk;              // callback
   char         *m_cdata;            // callback data
   wxSockCbk     m_cbk;              // callback
   char         *m_cdata;            // callback data

+#endif // WXWIN_COMPATIBILITY
+
+    DECLARE_NO_COPY_CLASS(wxSocketBase)

 };
 
 
 };
 
 


@@ -258,6 +281,8 @@ public:
   bool AcceptWith(wxSocketBase& socket, bool wait = TRUE);
 
   bool WaitForAccept(long seconds = -1, long milliseconds = 0);
   bool AcceptWith(wxSocketBase& socket, bool wait = TRUE);
 
   bool WaitForAccept(long seconds = -1, long milliseconds = 0);

+
+  DECLARE_NO_COPY_CLASS(wxSocketServer)

 };
 
 
 };
 
 


@@ -276,6 +301,8 @@ public:
   virtual bool Connect(wxSockAddress& addr, bool wait = TRUE);
 
   bool WaitOnConnect(long seconds = -1, long milliseconds = 0);
   virtual bool Connect(wxSockAddress& addr, bool wait = TRUE);
 
   bool WaitOnConnect(long seconds = -1, long milliseconds = 0);

+
+  DECLARE_NO_COPY_CLASS(wxSocketClient)

 };
 
 
 };
 
 


@@ -285,7 +312,7 @@ public:
 
 // WARNING: still in alpha stage
 
 
 // WARNING: still in alpha stage
 

-class wxDatagramSocket : public wxSocketBase
+class WXDLLEXPORT wxDatagramSocket : public wxSocketBase

 {
   DECLARE_CLASS(wxDatagramSocket)
 
 {
   DECLARE_CLASS(wxDatagramSocket)
 


@@ -293,11 +320,16 @@ public:
   wxDatagramSocket(wxSockAddress& addr, wxSocketFlags flags = wxSOCKET_NONE);
 
   wxDatagramSocket& RecvFrom( wxSockAddress& addr,
   wxDatagramSocket(wxSockAddress& addr, wxSocketFlags flags = wxSOCKET_NONE);
 
   wxDatagramSocket& RecvFrom( wxSockAddress& addr,

-                              char* buf,
+                              void* buf,

                               wxUint32 nBytes );
   wxDatagramSocket& SendTo( wxSockAddress& addr,
                               wxUint32 nBytes );
   wxDatagramSocket& SendTo( wxSockAddress& addr,

-                            const char* buf,
+                            const void* buf,

                             wxUint32 nBytes );
                             wxUint32 nBytes );

+
+/* TODO:
+  bool Connect(wxSockAddress& addr);
+*/
+  DECLARE_NO_COPY_CLASS(wxDatagramSocket)

 };
 
 
 };
 
 


@@ -307,27 +339,40 @@ public:
 
 class WXDLLEXPORT wxSocketEvent : public wxEvent
 {
 
 class WXDLLEXPORT wxSocketEvent : public wxEvent
 {

-  DECLARE_DYNAMIC_CLASS(wxSocketEvent)
-

 public:
 public:

-  wxSocketEvent(int id = 0);
+  wxSocketEvent(int id = 0)
+      : wxEvent(id, wxEVT_SOCKET)
+      {
+      }

 
 

-  wxSocketNotify SocketEvent() const { return m_event; }
-  wxSocketBase *Socket() const       { return m_socket; }
+  wxSocketNotify  GetSocketEvent() const { return m_event; }
+  wxSocketBase   *GetSocket() const      { return (wxSocketBase *) GetEventObject(); }
+  void           *GetClientData() const  { return m_clientData; }

 
 

-  void CopyObject(wxObject& object_dest) const;
+  // backwards compatibility
+#if WXWIN_COMPATIBILITY_2
+  wxSocketNotify  SocketEvent() const    { return m_event; }
+  wxSocketBase   *Socket() const         { return (wxSocketBase *) GetEventObject(); }
+#endif // WXWIN_COMPATIBILITY_2
+
+  virtual wxEvent *Clone() const { return new wxSocketEvent(*this); }

 
 public:
   wxSocketNotify  m_event;
 
 public:
   wxSocketNotify  m_event;

-  wxSocketBase   *m_socket;
+  void           *m_clientData;
+
+  DECLARE_DYNAMIC_CLASS(wxSocketEvent)

 };
 
 
 typedef void (wxEvtHandler::*wxSocketEventFunction)(wxSocketEvent&);
 
 };
 
 
 typedef void (wxEvtHandler::*wxSocketEventFunction)(wxSocketEvent&);
 

-#define EVT_SOCKET(id, func) { wxEVT_SOCKET, id, -1, \
-  (wxObjectEventFunction) (wxEventFunction) (wxSocketEventFunction) & func, \
-  (wxObject *) NULL  },
+#define EVT_SOCKET(id, func) \
+    DECLARE_EVENT_TABLE_ENTRY( wxEVT_SOCKET, id, -1, \
+                              (wxObjectEventFunction) \
+                              (wxEventFunction) \
+                              (wxSocketEventFunction) & func, \
+                              (wxObject *) NULL ),

 
 
 #endif
 
 
 #endif