corrected to allow drag and drop for mingw32/gcc295

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

diff --git a/include/wx/socket.h b/include/wx/socket.h
index ec578d12d981059cbb9d399200a2446dd9d17ba4..d74c44d2964f0538a391f4c6d4dc1d02d7279775 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$


@@ -48,7 +48,7 @@ enum {
   wxSOCKET_INPUT_FLAG = GSOCK_INPUT_FLAG,
   wxSOCKET_OUTPUT_FLAG = GSOCK_OUTPUT_FLAG,
   wxSOCKET_CONNECTION_FLAG = GSOCK_CONNECTION_FLAG,
   wxSOCKET_INPUT_FLAG = GSOCK_INPUT_FLAG,
   wxSOCKET_OUTPUT_FLAG = GSOCK_OUTPUT_FLAG,
   wxSOCKET_CONNECTION_FLAG = GSOCK_CONNECTION_FLAG,

-  wxSOCKET_LOST_FLAG = GSOCK_LOST_FLAG,
+  wxSOCKET_LOST_FLAG = GSOCK_LOST_FLAG

 };
 
 typedef GSocketEventFlags wxSocketEventFlags;
 };
 
 typedef GSocketEventFlags wxSocketEventFlags;


@@ -62,7 +62,7 @@ typedef enum {
   wxSOCKET_NOHOST = GSOCK_NOHOST,
   wxSOCKET_INVPORT = GSOCK_INVPORT,
   wxSOCKET_WOULDBLOCK = GSOCK_WOULDBLOCK,
   wxSOCKET_NOHOST = GSOCK_NOHOST,
   wxSOCKET_INVPORT = GSOCK_INVPORT,
   wxSOCKET_WOULDBLOCK = GSOCK_WOULDBLOCK,

-  wxSOCKET_TIMEOUT = GSOCK_TIMEOUT,
+  wxSOCKET_TIMEDOUT = GSOCK_TIMEDOUT,

   wxSOCKET_MEMERR = GSOCK_MEMERR
 } wxSocketError;
 
   wxSOCKET_MEMERR = GSOCK_MEMERR
 } wxSocketError;
 


@@ -82,36 +82,38 @@ public:
   // Type of request
 
   enum wxSockType { SOCK_CLIENT, SOCK_SERVER, SOCK_INTERNAL, SOCK_UNINIT };
   // Type of request
 
   enum wxSockType { SOCK_CLIENT, SOCK_SERVER, SOCK_INTERNAL, SOCK_UNINIT };

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

 
 protected:
   GSocket *m_socket;                   // wxSocket socket
   wxSockFlags m_flags;                 // wxSocket flags
   wxSockType m_type;                   // wxSocket type
 
 protected:
   GSocket *m_socket;                   // wxSocket socket
   wxSockFlags m_flags;                 // wxSocket flags
   wxSockType m_type;                   // wxSocket type

-  GSocketEventFlags m_neededreq;       // Specify which requet signals we need
-  size_t m_lcount;                     // Last IO request size
+  wxSocketEventFlags m_neededreq;   // Which events we are interested in
+  wxUint32 m_lcount;                   // Last IO request size

   unsigned long m_timeout;             // IO timeout value
   unsigned long m_timeout;             // IO timeout value

+                     
+  char *m_unread;               // Pushback buffer
+  wxUint32 m_unrd_size;                        // Pushback buffer size
+  wxUint32 m_unrd_cur;                 // Pushback pointer

 
 

-  char *m_unread;                      // Pushback buffer
-  size_t m_unrd_size;                  // Pushback buffer size
-  size_t m_unrd_cur;                   // Pushback pointer
+  wxSockCbk m_cbk;              // C callback
+  char *m_cdata;                // C callback data

 
 

-  wxSockCbk m_cbk;                     // C callback
-  char *m_cdata;                       // C callback data
-
-  bool m_connected;                    // Connected ?
+  bool m_connected;             // Connected ?
+  bool m_establishing;          // Pending connections ?

   bool m_notify_state;                 // Notify state
   bool m_notify_state;                 // Notify state

-  int m_id;                            // Socket id (for event handler)
+  int m_id;                     // Socket id (for event handler)

 
   // Defering variables
   enum {
     DEFER_READ, DEFER_WRITE, NO_DEFER
 
   // Defering variables
   enum {
     DEFER_READ, DEFER_WRITE, NO_DEFER

-  } m_defering;                         // Defering state
-  char *m_defer_buffer;                 // Defering target buffer
-  size_t m_defer_nbytes;                // Defering buffer size
-  wxTimer *m_defer_timer;              // Timer for defering mode
+  } m_defering;                 // Defering state
+  char *m_defer_buffer;         // Defering target buffer
+  wxUint32 m_defer_nbytes;      // Defering buffer size
+  wxTimer *m_defer_timer;       // Timer for defering mode

 
 

-  wxList m_states;                     // Stack of states
+  bool m_error;                 // Did an error occur in last IO call ?
+  wxList m_states;              // Stack of states

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


@@ -119,76 +121,72 @@ 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& Unread(const char *buffer, size_t nbytes);
-  wxSocketBase& ReadMsg(char *buffer, size_t nbytes);
-  wxSocketBase& WriteMsg(const char *buffer, size_t nbytes);
+  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);

   void Discard();
 
   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);
-

   // Status
   inline bool Ok() const { return (m_socket != NULL); };
   // Status
   inline bool Ok() const { return (m_socket != NULL); };

-  inline bool Error() const
-           { return (GSocket_GetError(m_socket) != GSOCK_NOERROR); };
+  inline bool Error() const { return m_error; };

   inline bool IsConnected() const { return m_connected; };
   inline bool IsDisconnected() const { return !IsConnected(); };
   inline bool IsNoWait() const { return ((m_flags & NOWAIT) != 0); };
   bool IsData() const;
   inline bool IsConnected() const { return m_connected; };
   inline bool IsDisconnected() const { return !IsConnected(); };
   inline bool IsNoWait() const { return ((m_flags & NOWAIT) != 0); };
   bool IsData() const;

-  inline size_t LastCount() const { return m_lcount; }
+  inline wxUint32 LastCount() const { return m_lcount; }

   inline wxSocketError LastError() const { return (wxSocketError)GSocket_GetError(m_socket); }
   inline wxSockType GetType() const { return m_type; }
 
   inline wxSocketError LastError() const { return (wxSocketError)GSocket_GetError(m_socket); }
   inline wxSockType GetType() const { return m_type; }
 

+  // Some info on the socket...
+  virtual bool GetPeer(wxSockAddress& addr_man) const;
+  virtual bool GetLocal(wxSockAddress& addr_man) const;
+
+  // Set attributes and flags

   void SetFlags(wxSockFlags _flags);
   wxSockFlags GetFlags() const;
   void SetFlags(wxSockFlags _flags);
   wxSockFlags GetFlags() const;

-  inline void SetTimeout(unsigned long sec) { m_timeout = sec; }
+  void SetTimeout(long seconds);

 
 

-  // 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);
+  // 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);

 
   // 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
+  // Tell wxSocket which events to notify

   void SetNotify(wxSocketEventFlags flags);
   void SetNotify(wxSocketEventFlags flags);

-  virtual void OnRequest(wxSocketNotify req_evt);
+  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);

 
   // Public internal callback
   virtual void OldOnNotify(wxSocketNotify WXUNUSED(evt));
 
 
   // Public internal callback
   virtual void OldOnNotify(wxSocketNotify 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
-  void Notify(bool notify);
-
-  // So you can know what the socket driver is looking for ...
-  inline wxSocketEventFlags NeededReq() const { return m_neededreq; }
-
-  static wxSocketEventFlags EventToNotify(wxSocketNotify evt);
+  // Do NOT use these functions; they should be protected!
+  void CreatePushbackAfter(const char *buffer, wxUint32 size);
+  void CreatePushbackBefore(const char *buffer, wxUint32 size);
+  void OnRequest(wxSocketNotify req_evt);

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

+  friend class wxSocketClient;

   friend class wxSocketHandler;
   friend class wxSocketHandler;

-  friend class wxSocketInternal;

 
 #ifdef __SALFORDC__
 public:
 
 #ifdef __SALFORDC__
 public:


@@ -200,14 +198,14 @@ public:
 protected:
 #endif
 
 protected:
 #endif
 

-  bool _Wait(long seconds, long microseconds, int type);
+  bool _Wait(long seconds, long milliseconds, wxSocketEventFlags flags);

 
 

-  int DeferRead(char *buffer, size_t nbytes);
-  int DeferWrite(const char *buffer, size_t nbytes);
-  void DoDefer(GSocketEvent evt);
+  int DeferRead(char *buffer, wxUint32 nbytes);
+  int DeferWrite(const char *buffer, wxUint32 nbytes);
+  void DoDefer();

 
   // Pushback library
 
   // Pushback library

-  size_t GetPushback(char *buffer, size_t size, bool peek);
+  wxUint32 GetPushback(char *buffer, wxUint32 size, bool peek);

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


@@ -216,13 +214,14 @@ class WXDLLEXPORT wxSocketServer : public wxSocketBase
 {
   DECLARE_CLASS(wxSocketServer)
 public:
 {
   DECLARE_CLASS(wxSocketServer)
 public:

-

   // 'service' can be a name or a port-number
 
   wxSocketServer(wxSockAddress& addr_man, wxSockFlags flags = wxSocketBase::NONE);
 
   // 'service' can be a name or a port-number
 
   wxSocketServer(wxSockAddress& addr_man, wxSockFlags flags = wxSocketBase::NONE);
 

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

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


@@ -237,9 +236,7 @@ public:
 
   virtual bool Connect(wxSockAddress& addr_man, bool wait = TRUE);
 
 
   virtual bool Connect(wxSockAddress& addr_man, bool wait = TRUE);
 

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

 };
 
 class WXDLLEXPORT wxSocketEvent : public wxEvent {
 };
 
 class WXDLLEXPORT wxSocketEvent : public wxEvent {


@@ -247,13 +244,13 @@ class WXDLLEXPORT wxSocketEvent : public wxEvent {
 public:
   wxSocketEvent(int id = 0);
 
 public:
   wxSocketEvent(int id = 0);
 

-  wxSocketNotify SocketEvent() const { return (wxSocketNotify)m_skevt; }
+  wxSocketNotify SocketEvent() const { return m_skevt; }

   wxSocketBase *Socket() const { return m_socket; }
 
   void CopyObject(wxObject& obj_d) const;
 
 public:
   wxSocketBase *Socket() const { return m_socket; }
 
   void CopyObject(wxObject& obj_d) const;
 
 public:

-  GSocketEvent m_skevt;
+  wxSocketNotify m_skevt;

   wxSocketBase *m_socket;
 };
 
   wxSocketBase *m_socket;
 };