Committing in .

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

diff --git a/include/wx/socket.h b/include/wx/socket.h
index 9037f92c7ba59a65e7036b90f673e77dfbf0132c..4663b0d6ed597e5c499653f4f8fb1310068b1bb7 100644 (file)
--- a/include/wx/socket.h
+++ b/include/wx/socket.h
@@ -1,7 +1,7 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        socket.h
 // Purpose:     Socket handling classes
 /////////////////////////////////////////////////////////////////////////////
 // Name:        socket.h
 // Purpose:     Socket handling classes

-// Author:      Guilhem Lavaux
+// Authors:     Guilhem Lavaux, Guillermo Rodriguez Garcia

 // Modified by:
 // Created:     April 1997
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     April 1997
 // RCS-ID:      $Id$


@@ -16,130 +16,133 @@
 #pragma interface "socket.h"
 #endif
 
 #pragma interface "socket.h"
 #endif
 

+#include "wx/defs.h"
+
+#if wxUSE_SOCKETS
+

 // ---------------------------------------------------------------------------
 // ---------------------------------------------------------------------------

-// Windows(tm) specific
+// wxSocket headers (generic)

 // ---------------------------------------------------------------------------
 // ---------------------------------------------------------------------------

-#if defined(__WINDOWS__) && defined(WXSOCK_INTERNAL)
-#include <winsock.h>
-#include <wx/msw/private.h>

 
 

-struct wxSockInternal {
-  UINT my_msg;
-};
+#ifdef WXPREC
+#  include "wx/wxprec.h"
+#else
+#  include "wx/event.h"
+#  include "wx/string.h"
+#endif
+
+#include "wx/sckaddr.h"
+#include "wx/gsocket.h"

 
 

-struct wxSockHandlerInternal {
-  HWND sockWin;
-  UINT firstAvailableMsg;
+// ------------------------------------------------------------------------
+// constants
+// ------------------------------------------------------------------------
+
+enum wxSocketNotify
+{
+  wxSOCKET_INPUT = GSOCK_INPUT,
+  wxSOCKET_OUTPUT = GSOCK_OUTPUT,
+  wxSOCKET_CONNECTION = GSOCK_CONNECTION,
+  wxSOCKET_LOST = GSOCK_LOST

 };
 };

-#endif // defined(__WINDOWS__) && defined(WXSOCK_INTERNAL)

 
 

-// ---------------------------------------------------------------------------
-// Unix specific
-// ---------------------------------------------------------------------------
-#if defined(__UNIX__) && defined(WXSOCK_INTERNAL)
-#include <sys/types.h>
-#include <sys/socket.h>
-#include <netinet/in.h>
+enum
+{
+  wxSOCKET_INPUT_FLAG = GSOCK_INPUT_FLAG,
+  wxSOCKET_OUTPUT_FLAG = GSOCK_OUTPUT_FLAG,
+  wxSOCKET_CONNECTION_FLAG = GSOCK_CONNECTION_FLAG,
+  wxSOCKET_LOST_FLAG = GSOCK_LOST_FLAG
+};

 
 

-// ---------------------------------------------------------------------------
-// Athena specific
-// ---------------------------------------------------------------------------
-#if defined(__WXXT__) || defined(__WXMOTIF__)
-#include <X11/Intrinsic.h>
+typedef GSocketEventFlags wxSocketEventFlags;

 
 

-struct wxSockInternal {
-  XtInputId sock_inputid, sock_outputid, sock_exceptid;
+enum wxSocketError
+{
+  wxSOCKET_NOERROR = GSOCK_NOERROR,
+  wxSOCKET_INPOP = GSOCK_INVOP,
+  wxSOCKET_IOERR = GSOCK_IOERR,
+  wxSOCKET_INVADDR = GSOCK_INVADDR,
+  wxSOCKET_INVSOCK = GSOCK_INVSOCK,
+  wxSOCKET_NOHOST = GSOCK_NOHOST,
+  wxSOCKET_INVPORT = GSOCK_INVPORT,
+  wxSOCKET_WOULDBLOCK = GSOCK_WOULDBLOCK,
+  wxSOCKET_TIMEDOUT = GSOCK_TIMEDOUT,
+  wxSOCKET_MEMERR = GSOCK_MEMERR,
+  wxSOCKET_BUSY

 };
 };

-#endif

 
 

-// ---------------------------------------------------------------------------
-// GTK specific
-// ---------------------------------------------------------------------------
-#if defined(__WXGTK__)
-#include <gdk/gdk.h>
+enum
+{
+  wxSOCKET_NONE = 0,
+  wxSOCKET_NOWAIT = 1,
+  wxSOCKET_WAITALL = 2,
+  wxSOCKET_BLOCK = 4
+};

 
 

-struct wxSockInternal {
-  gint sock_inputid, sock_outputid, sock_exceptid;
+// Type of socket
+enum wxSockType
+{
+  SOCK_CLIENT,
+  SOCK_SERVER,
+  SOCK_DATAGRAM,
+  SOCK_INTERNAL,
+  SOCK_UNINIT

 };
 };

-#endif

 
 

-#endif // defined(__UNIX__) && defined(WXSOCK_INTERNAL)
+typedef int wxSockFlags;

 
 

-// ---------------------------------------------------------------------------
-// wxSocket headers (generic)
-// ---------------------------------------------------------------------------
-#ifdef WXPREC
-#include <wx/wxprec.h>
-#else
-#include <wx/wx.h>
-#endif
-#include "wx/sckaddr.h"
+// ------------------------------------------------------------------------
+// wxSocket base
+// ------------------------------------------------------------------------

 
 

+class WXDLLEXPORT wxTimer;

 class WXDLLEXPORT wxSocketEvent;
 class WXDLLEXPORT wxSocketEvent;

-class WXDLLEXPORT wxSocketHandler;
+

 class WXDLLEXPORT wxSocketBase : public wxEvtHandler
 {
   DECLARE_CLASS(wxSocketBase)
 class WXDLLEXPORT wxSocketBase : public wxEvtHandler
 {
   DECLARE_CLASS(wxSocketBase)

-#ifdef __WXMAC__
-  friend void wxMacSocketOnRequestProc(void *refcon , short event) ;
-#endif
-#if defined(__WXGTK__) && defined(WXSOCK_INTERNAL)
-  friend void wxPrereadSocket(wxSocketBase *sock);
-#endif

 public:
 
 public:
 

-  enum wxSockFlags { NONE=0, NOWAIT=1, WAITALL=2, SPEED=4 };
-  // Type of request
-  enum { REQ_READ=0x1, REQ_PEEK=0x2, REQ_WRITE=0x4, REQ_LOST=0x8,
-         REQ_ACCEPT=0x10, REQ_CONNECT=0x20};
-  enum { EVT_READ=0, EVT_PEEK=1, EVT_WRITE=2, EVT_LOST=3, EVT_ACCEPT=4,
-         EVT_CONNECT=5 };
+  enum
+  {
+    NONE = wxSOCKET_NONE,
+    NOWAIT = wxSOCKET_NOWAIT,
+    WAITALL = wxSOCKET_WAITALL,
+    SPEED = wxSOCKET_BLOCK
+  };

 
 

-  typedef int wxRequestNotify;
-  typedef int wxRequestEvent;
-  typedef void (*wxSockCbk)(wxSocketBase& sock,wxRequestEvent evt,char *cdata);
+  typedef void (*wxSockCbk)(wxSocketBase& sock, wxSocketNotify evt, char *cdata);

 
 protected:
 
 protected:

-  wxList req_list[EVT_WRITE+1];
-
-  // Internal use for SaveState() and RestoreState()
-  class wxSockState : public wxObject {
-  public:
-    bool cbk_on;
-    wxSockCbk cbk;
-    char *cdata;
-    bool notif;
-    wxRequestNotify cbk_set;
-    wxSockFlags flags;
-  };
-  typedef struct {
-    char sig[4];
-    char len[4];
-  } SockMsg;
-  enum wxSockType { SOCK_CLIENT, SOCK_SERVER, SOCK_INTERNAL, SOCK_UNINIT }; 
-
-  wxSockFlags m_flags;
-  wxSockType m_type;                   // wxSocket type
-  bool m_connected, m_connecting;      // State of the socket
-  int m_fd;                            // Socket file descriptors
-  int m_waitflags;                     // Wait flags
-  wxList m_states;                     // States list
-  wxSockCbk m_cbk;                     // C callback
-  char *m_cdata;                       // C callback data
-  int m_id;                            // Socket id (for event handler)
-  wxSocketHandler *m_handler;          // the current socket handler
-  wxRequestNotify m_neededreq;         // Specify which requet signals we need
-  bool m_cbkon;
-  char *m_unread;                      // The unread buf
-  size_t m_unrd_size;                  // The size of the unread buf
-  bool m_processing;                   // To prevent some endless loop
-  unsigned long m_timeout;
-  int m_wantbuf;
-  size_t m_lcount;                     // Last IO request size
-  int m_error;                         // Last IO error
-  bool m_notifyme;
-
-  struct wxSockInternal *m_internal;   // System specific variables
+  GSocket      *m_socket;           // GSocket
+  wxEvtHandler *m_evt_handler;      // event handler
+  int           m_id;               // Socket id (for event handler)
+
+  // Attributes
+  wxSockFlags   m_flags;            // wxSocket flags
+  wxSockType    m_type;             // wxSocket type
+  wxSocketEventFlags m_neededreq;   // Event mask
+  bool          m_notify_state;     // Notify events to users?
+
+  // State
+  bool          m_connected;        // Connected?
+  bool          m_establishing;     // Establishing connection?
+  bool          m_reading;          // Busy reading?
+  bool          m_writing;          // Busy writing?
+  bool          m_error;            // Did last IO call fail?
+  wxUint32      m_lcount;           // Last IO transaction size
+  unsigned long m_timeout;          // IO timeout value
+  wxList        m_states;           // Stack of states
+  bool          m_interrupt;        // Interrupt ongoing wait operations
+
+  // Pushback buffer
+  char         *m_unread;           // Pushback buffer
+  wxUint32      m_unrd_size;        // Pushback buffer size
+  wxUint32      m_unrd_cur;         // Pushback pointer (index into buffer)
+
+  // Callback
+  wxSockCbk     m_cbk;              // C callback
+  char         *m_cdata;            // C callback data

 
 public:
   wxSocketBase();
 
 public:
   wxSocketBase();


@@ -147,71 +150,77 @@ public:
   virtual bool Close();
 
   // Base IO
   virtual bool Close();
 
   // Base IO

-  wxSocketBase& Peek(char* buffer, size_t nbytes);
-  wxSocketBase& Read(char* buffer, size_t nbytes);
-  wxSocketBase& Write(const char *buffer, size_t nbytes);
-  wxSocketBase& WriteMsg(const char *buffer, size_t nbytes);
-  wxSocketBase& ReadMsg(char* buffer, size_t nbytes);
-  wxSocketBase& Unread(const char *buffer, size_t nbytes);
-  void Discard();
-
-  // Try not to use this two methods (they sould be protected)
-  void CreatePushbackAfter(const char *buffer, size_t size);
-  void CreatePushbackBefore(const char *buffer, size_t size);
+  wxSocketBase& Peek(char* buffer, wxUint32 nbytes);
+  wxSocketBase& Read(char* buffer, wxUint32 nbytes);
+  wxSocketBase& Write(const char *buffer, wxUint32 nbytes);
+  wxSocketBase& Unread(const char *buffer, wxUint32 nbytes);
+  wxSocketBase& ReadMsg(char *buffer, wxUint32 nbytes);
+  wxSocketBase& WriteMsg(const char *buffer, wxUint32 nbytes);
+  wxSocketBase& Discard();

 
   // Status
 
   // Status

-  inline bool Ok() const { return (m_fd < 0 ? 0 : 1); };
-  inline bool Error() const { return (m_error != 0); };
+  inline bool Ok() const { return (m_socket != NULL); };
+  inline bool Error() const { return m_error; };

   inline bool IsConnected() const { return m_connected; };
   inline bool IsDisconnected() const { return !IsConnected(); };
   inline bool IsConnected() const { return m_connected; };
   inline bool IsDisconnected() const { return !IsConnected(); };

-  inline bool IsNoWait() const { return m_flags & NOWAIT; };
-  bool IsData() const;
-  inline size_t LastCount() const { return m_lcount; }
-  inline int LastError() const { return m_error; }
-  
-  void SetFlags(wxSockFlags _flags);
-  inline void SetTimeout(unsigned long sec) { m_timeout = sec; }
-
-  // seconds = -1 means infinite wait
-  // seconds = 0 means no wait
-  // seconds > 0 means specified wait
-  bool Wait(long seconds = -1, long microseconds = 0);
-  bool WaitForRead(long seconds = -1, long microseconds = 0);
-  bool WaitForWrite(long seconds = -1, long microseconds = 0);
-  bool WaitForLost(long seconds = -1, long microseconds = 0);
-  
+  inline bool IsNoWait() const { return ((m_flags & NOWAIT) != 0); };
+  inline bool IsData() { return WaitForRead(0, 0); };
+  inline wxUint32 LastCount() const { return m_lcount; }
+  inline wxSocketError LastError() const { return (wxSocketError)GSocket_GetError(m_socket); }
+  inline wxSockType GetType() const { return m_type; }
+
+  // Addresses
+  virtual bool GetPeer(wxSockAddress& addr_man) const;
+  virtual bool GetLocal(wxSockAddress& addr_man) const;
+
+  // Set attributes and flags
+  void SetTimeout(long seconds);
+  void SetFlags(wxSockFlags flags);
+  inline wxSockFlags GetFlags() const { return m_flags; };
+
+  /* Wait functions
+   *   seconds = -1 means default timeout (change with SetTimeout)
+   *   seconds, milliseconds = 0 means no wait
+   *   seconds, milliseconds > 0 means specified wait
+   */
+  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);
+
+  /* This function interrupts all ongoing wait operations for this
+   * socket; use it only as an escape mechanism (for example to close
+   * an app or to abort an operation). Reception of LOST events and
+   * calls to Close() automatically call this.
+   */
+  void InterruptAllWaits() { m_interrupt = TRUE; };
+

   // Save the current state of Socket
   void SaveState();
   void RestoreState();
 
   // Save the current state of Socket
   void SaveState();
   void RestoreState();
 

-  // Setup external callback
-  wxSockCbk Callback(wxSockCbk cbk_);
-  char *CallbackData(char *data);
-

   // Setup event handler
   void SetEventHandler(wxEvtHandler& evt_hdlr, int id = -1);
   // Setup event handler
   void SetEventHandler(wxEvtHandler& evt_hdlr, int id = -1);

-  
-  // Method called when it happens something on the socket
-  void SetNotify(wxRequestNotify flags);
-  virtual void OnRequest(wxRequestEvent req_evt);
-
-  // Public internal callback
-  virtual void OldOnNotify(wxRequestEvent WXUNUSED(evt));
-
-  // Some info on the socket...
-  virtual bool GetPeer(wxSockAddress& addr_man) const;
-  virtual bool GetLocal(wxSockAddress& addr_man) const;

 
 

-  // Install or uninstall callbacks
+  // Tell wxSocket which events to notify
+  void SetNotify(wxSocketEventFlags flags);

   void Notify(bool notify);
   void Notify(bool notify);

+  static wxSocketEventFlags EventToNotify(wxSocketNotify evt);
+  inline wxSocketEventFlags NeededReq() const { return m_neededreq; }
+
+  // External callback
+  wxSockCbk Callback(wxSockCbk cbk_);
+  char *CallbackData(char *data);

 
 

-  // So you can know what the socket driver is looking for ...
-  inline wxRequestNotify NeededReq() const { return m_neededreq; }
+  // Public internal callback
+  virtual void OldOnNotify(wxSocketNotify WXUNUSED(evt));

 
 

-  static wxRequestNotify EventToNotify(wxRequestEvent evt);
+  // Do NOT use this function; it should be protected!
+  void OnRequest(wxSocketNotify req_evt);

 
 protected:
   friend class wxSocketServer;
 
 protected:
   friend class wxSocketServer;

+  friend class wxSocketClient;

   friend class wxSocketHandler;
 
 #ifdef __SALFORDC__
   friend class wxSocketHandler;
 
 #ifdef __SALFORDC__


@@ -223,26 +232,15 @@ public:
 #ifdef __SALFORDC__
 protected:
 #endif
 #ifdef __SALFORDC__
 protected:
 #endif

-  
-  bool _Wait(long seconds, long microseconds, int type);
-  
-  // Set "my" handler
-  inline virtual void SetHandler(wxSocketHandler *handler)
-         { m_handler = handler; }
-
-  // Activate or disactivate callback
-  void SetupCallbacks();
-  void DestroyCallbacks();
-
-  // Pushback library
-  size_t GetPushback(char *buffer, size_t size, bool peek);
-
-  // To prevent many read or write on the same socket at the same time
-  //   ==> cause strange things :-)
-  void WantSpeedBuffer(char *buffer, size_t size, wxRequestEvent req);
-  void WantBuffer(char *buffer, size_t size, wxRequestEvent req);
-
-  virtual bool DoRequests(wxRequestEvent req);
+
+  // Low level IO
+  wxUint32 _Read(char* buffer, wxUint32 nbytes);
+  wxUint32 _Write(const char *buffer, wxUint32 nbytes);
+  bool _Wait(long seconds, long milliseconds, wxSocketEventFlags flags);
+
+  // Pushbacks
+  void Pushback(const char *buffer, wxUint32 size);
+  wxUint32 GetPushback(char *buffer, wxUint32 size, bool peek);

 };
 
 ////////////////////////////////////////////////////////////////////////
 };
 
 ////////////////////////////////////////////////////////////////////////


@@ -251,14 +249,14 @@ class WXDLLEXPORT wxSocketServer : public wxSocketBase
 {
   DECLARE_CLASS(wxSocketServer)
 public:
 {
   DECLARE_CLASS(wxSocketServer)
 public:

-

   // 'service' can be a name or a port-number
 
   // 'service' can be a name or a port-number
 

-  wxSocketServer(wxSockAddress& addr_man, wxSockFlags flags = wxSocketBase::NONE);
+  wxSocketServer(wxSockAddress& addr_man, wxSockFlags flags = wxSOCKET_NONE);

 
 

-  wxSocketBase* Accept();
-  bool AcceptWith(wxSocketBase& sock);
-  virtual void OnRequest(wxRequestEvent flags);
+  wxSocketBase* Accept(bool wait = TRUE);
+  bool AcceptWith(wxSocketBase& sock, bool wait = TRUE);
+
+  bool WaitForAccept(long seconds = -1, long milliseconds = 0);

 };
 
 ////////////////////////////////////////////////////////////////////////
 };
 
 ////////////////////////////////////////////////////////////////////////


@@ -268,85 +266,56 @@ class WXDLLEXPORT wxSocketClient : public wxSocketBase
   DECLARE_CLASS(wxSocketClient)
 public:
 
   DECLARE_CLASS(wxSocketClient)
 public:
 

-  wxSocketClient(wxSockFlags flags = wxSocketBase::NONE);
+  wxSocketClient(wxSockFlags flags = wxSOCKET_NONE);

   virtual ~wxSocketClient();
 
   virtual bool Connect(wxSockAddress& addr_man, bool wait = TRUE);
 
   virtual ~wxSocketClient();
 
   virtual bool Connect(wxSockAddress& addr_man, bool wait = TRUE);
 

-  bool WaitOnConnect(long seconds = -1, long microseconds = 0);
-
-  virtual void OnRequest(wxRequestEvent flags);
+  bool WaitOnConnect(long seconds = -1, long milliseconds = 0);

 };
 
 ////////////////////////////////////////////////////////////////////////
 
 };
 
 ////////////////////////////////////////////////////////////////////////
 

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

 {
 {

-  DECLARE_CLASS(wxSocketHandler)
-protected:
-#if defined(__WINDOWS__)
-  wxList *smsg_list;
-  struct wxSockHandlerInternal *internal;
-#endif
-  wxList *socks;
+  DECLARE_CLASS(wxDatagramSocket)

 
 public:
 
 public:

-  enum SockStatus { SOCK_NONE, SOCK_DATA, SOCK_CONNECT, SOCK_DISCONNECT,
-                   SOCK_ERROR };
-  static wxSocketHandler *master;
-
-  wxSocketHandler();
-  virtual ~wxSocketHandler();
-  
-  void Register(wxSocketBase* sock);
-  void UnRegister(wxSocketBase* sock);
-  
-  unsigned long Count() const;
-  
-  // seconds = -1 means indefinite wait
-  // seconds = 0 means no wait
-  // seconds > 0 means specified wait
-  
-  int Wait(long seconds = -1, long microseconds = 0);
-  void YieldSock();
-  
-  wxSocketServer *CreateServer
-                       (wxSockAddress& addr,
-                       wxSocketBase::wxSockFlags flags = wxSocketBase::NONE);
-  wxSocketClient *CreateClient
-                       (wxSocketBase::wxSockFlags flags = wxSocketBase::NONE);
-
-  // Create or reuse a socket handler
-  static wxSocketHandler& Master() { return *master; }
-
-#if defined(WXSOCK_INTERNAL) && defined(__WINDOWS__)
-
-  friend LRESULT APIENTRY _EXPORT wxSocketHandlerWndProc(HWND hWnd,
-                        UINT message, WPARAM wParam, LPARAM lParam);
-
-  UINT NewMessage(wxSocketBase *sock);
-  void DestroyMessage(UINT msg);
-
-  HWND GetHWND() const;
-#endif
+  wxDatagramSocket( wxSockAddress& addr, wxSockFlags flags = wxSOCKET_NONE );
+
+  wxDatagramSocket& RecvFrom( wxSockAddress& addr,
+                              char* buf,
+                              wxUint32 nBytes );
+  wxDatagramSocket& SendTo( wxSockAddress& addr,
+                            const char* buf,
+                            wxUint32 nBytes );

 };
 
 };
 

+////////////////////////////////////////////////////////////////////////
+

 class WXDLLEXPORT wxSocketEvent : public wxEvent {
   DECLARE_DYNAMIC_CLASS(wxSocketEvent)
 public:
   wxSocketEvent(int id = 0);
 
 class WXDLLEXPORT wxSocketEvent : public wxEvent {
   DECLARE_DYNAMIC_CLASS(wxSocketEvent)
 public:
   wxSocketEvent(int id = 0);
 

-  wxSocketBase::wxRequestEvent SocketEvent() const { return m_skevt; }
+  wxSocketNotify SocketEvent() const { return m_skevt; }
+  wxSocketBase *Socket() const { return m_socket; }
+
+  void CopyObject(wxObject& obj_d) const;
+

 public:
 public:

-  wxSocketBase::wxRequestEvent m_skevt;
+  wxSocketNotify m_skevt;
+  wxSocketBase *m_socket;

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

-#define wxEVT_SOCKET wxEVT_FIRST+301
-
-#define EVT_SOCKET(id, func) { wxEVT_SOCKET, id, 0, \
+#define EVT_SOCKET(id, func) { wxEVT_SOCKET, id, -1, \

   (wxObjectEventFunction) (wxEventFunction) (wxSocketEventFunction) & func, \
   (wxObject *) NULL  },
 
 #endif
   (wxObjectEventFunction) (wxEventFunction) (wxSocketEventFunction) & func, \
   (wxObject *) NULL  },
 
 #endif

+  // wxUSE_SOCKETS
+
+#endif
+  // _WX_NETWORK_SOCKET_H