deprecate OnScroll() which existed for compatibility only even before

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

diff --git a/include/wx/socket.h b/include/wx/socket.h
index 496f5a47de73756a3c2c21f21d201fe7b8c055b2..1b72a2cd56eb22b46cd6f850f768779616a6355d 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$


@@ -9,225 +9,377 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef _WX_NETWORK_SOCKET_H
-#define _WX_NETWORK_SOCKET_H
-
-#ifdef __GNUG__
-#pragma interface "socket.h"
-#endif
+#ifndef _WX_SOCKET_H_
+#define _WX_SOCKET_H_

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

-// wxSocket headers (generic)
+// wxSocket headers

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

-#ifdef WXPREC
-#  include "wx/wxprec.h"
-#else
-#  include "wx/event.h"
-#  include "wx/string.h"
-#endif

 
 

+#include "wx/event.h"

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

-#include "wx/gsocket.h"
+#include "wx/list.h"
+
+class wxSocketImpl;

 
 

-class WXDLLEXPORT wxTimer;
-class WXDLLEXPORT wxSocketEvent;
-class WXDLLEXPORT wxSocketBase : public wxEvtHandler
+// ------------------------------------------------------------------------
+// Types and constants
+// ------------------------------------------------------------------------
+
+// Types of different socket notifications or events.
+//
+// NB: the values here should be consecutive and start with 0 as they are
+//     used to construct the wxSOCKET_XXX_FLAG bit mask values below
+enum wxSocketNotify

 {
 {

-  DECLARE_CLASS(wxSocketBase)
-public:
+    wxSOCKET_INPUT,
+    wxSOCKET_OUTPUT,
+    wxSOCKET_CONNECTION,
+    wxSOCKET_LOST,
+    wxSOCKET_MAX_EVENT
+};
+
+enum
+{
+    wxSOCKET_INPUT_FLAG = 1 << wxSOCKET_INPUT,
+    wxSOCKET_OUTPUT_FLAG = 1 << wxSOCKET_OUTPUT,
+    wxSOCKET_CONNECTION_FLAG = 1 << wxSOCKET_CONNECTION,
+    wxSOCKET_LOST_FLAG = 1 << wxSOCKET_LOST
+};

 
 

-  enum { NONE=0, NOWAIT=1, WAITALL=2, SPEED=4 };
-  typedef int wxSockFlags;
-  // Type of request
+// this is a combination of the bit masks defined above
+typedef int wxSocketEventFlags;

 
 

-  enum wxSockType { SOCK_CLIENT, SOCK_SERVER, SOCK_INTERNAL, SOCK_UNINIT };
-  typedef void (*wxSockCbk)(wxSocketBase& sock,GSocketEvent evt,char *cdata);
+enum wxSocketError
+{
+    wxSOCKET_NOERROR = 0,
+    wxSOCKET_INVOP,
+    wxSOCKET_IOERR,
+    wxSOCKET_INVADDR,
+    wxSOCKET_INVSOCK,
+    wxSOCKET_NOHOST,
+    wxSOCKET_INVPORT,
+    wxSOCKET_WOULDBLOCK,
+    wxSOCKET_TIMEDOUT,
+    wxSOCKET_MEMERR,
+    wxSOCKET_OPTERR
+};
+
+// socket options/flags bit masks
+enum
+{
+    wxSOCKET_NONE = 0,
+    wxSOCKET_NOWAIT = 1,
+    wxSOCKET_WAITALL = 2,
+    wxSOCKET_BLOCK = 4,
+    wxSOCKET_REUSEADDR = 8,
+    wxSOCKET_BROADCAST = 16,
+    wxSOCKET_NOBIND = 32
+};

 
 

-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
-  unsigned long m_timeout;             // IO timeout value
+typedef int wxSocketFlags;

 
 

-  char *m_unread;                      // Pushback buffer
-  size_t m_unrd_size;                  // Pushback buffer size
-  size_t m_unrd_cur;                   // Pushback pointer
+// socket kind values (badly defined, don't use)
+enum wxSocketType
+{
+    wxSOCKET_UNINIT,
+    wxSOCKET_CLIENT,
+    wxSOCKET_SERVER,
+    wxSOCKET_BASE,
+    wxSOCKET_DATAGRAM
+};

 
 

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

 
 

-  bool m_connected;                    // Connected ?
-  bool m_notify_state;                 // Notify state
-  int m_id;                            // Socket id (for event handler)

 
 

-  // 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
+// --------------------------------------------------------------------------
+// wxSocketBase
+// --------------------------------------------------------------------------

 
 

-  wxList m_states;                     // Stack of states
+class WXDLLIMPEXP_NET wxSocketBase : public wxObject
+{
+  DECLARE_CLASS(wxSocketBase)

 
 public:
 
 public:

+
+  // Public interface
+  // ----------------
+
+  // ctors and dtors

   wxSocketBase();
   wxSocketBase();

+  wxSocketBase(wxSocketFlags flags, wxSocketType type);

   virtual ~wxSocketBase();
   virtual ~wxSocketBase();

-  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);
-  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); };
-  inline bool Error() const
-           { return (GSocket_GetError(m_socket) != GSOCK_NOERROR); };
-  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 GSocketError LastError() const { return GSocket_GetError(m_socket); }
-  inline wxSockType GetType() const { return m_type; }
-
-  void SetFlags(wxSockFlags _flags);
-  wxSockFlags GetFlags() const;
-  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);
-
-  // Save the current state of Socket
+  void Init();
+  bool Destroy();
+
+  // state
+  bool Ok() const { return IsOk(); }
+  bool IsOk() const { return m_impl != NULL; }
+  bool Error() const { return m_error; }
+  bool IsClosed() const { return m_closed; }
+  bool IsConnected() const { return m_connected; }
+  bool IsData() { return WaitForRead(0, 0); }
+  bool IsDisconnected() const { return !IsConnected(); }
+  wxUint32 LastCount() const { return m_lcount; }
+  wxSocketError LastError() const;

   void SaveState();
   void RestoreState();
 
   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);
-
-  // Method called when it happens something on the socket
-  void SetNotify(GSocketEventFlags flags);
-  virtual void OnRequest(GSocketEvent req_evt);
-
-  // Public internal callback
-  virtual void OldOnNotify(GSocketEvent WXUNUSED(evt));
-
-  // Some info on the socket...
-  virtual bool GetPeer(wxSockAddress& addr_man) const;
+  // addresses

   virtual bool GetLocal(wxSockAddress& addr_man) const;
   virtual bool GetLocal(wxSockAddress& addr_man) const;

-
-  // Install or uninstall callbacks
+  virtual bool GetPeer(wxSockAddress& addr_man) const;
+  virtual bool SetLocal(const wxIPV4address& local);
+
+  // base IO
+  virtual bool  Close();
+  wxSocketBase& Discard();
+  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);
+
+  // all Wait() functions wait until their condition is satisfied or the
+  // timeout expires; if seconds == -1 (default) then m_timeout value is used
+  //
+  // it is also possible to call InterruptWait() to cancel any current Wait()
+
+  // wait for anything at all to happen with this socket
+  bool Wait(long seconds = -1, long milliseconds = 0);
+
+  // wait until we can read from or write to the socket without blocking
+  // (notice that this does not mean that the operation will succeed but only
+  // that it will return immediately)
+  bool WaitForRead(long seconds = -1, long milliseconds = 0);
+  bool WaitForWrite(long seconds = -1, long milliseconds = 0);
+
+  // wait until the connection is terminated
+  bool WaitForLost(long seconds = -1, long milliseconds = 0);
+
+  void InterruptWait() { m_interrupt = true; }
+
+
+  wxSocketFlags GetFlags() const { return m_flags; }
+  void SetFlags(wxSocketFlags flags);
+  void SetTimeout(long seconds);
+  long GetTimeout() const { return m_timeout; }
+
+  bool GetOption(int level, int optname, void *optval, int *optlen);
+  bool SetOption(int level, int optname, const void *optval, int optlen);
+  wxUint32 GetLastIOSize() const { return m_lcount; }
+
+  // event handling
+  void *GetClientData() const { return m_clientData; }
+  void SetClientData(void *data) { m_clientData = data; }
+  void SetEventHandler(wxEvtHandler& handler, int id = wxID_ANY);
+  void SetNotify(wxSocketEventFlags flags);

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

-  // So you can know what the socket driver is looking for ...
-  inline GSocketEventFlags NeededReq() const { return m_neededreq; }
-
-  static GSocketEventFlags EventToNotify(GSocketEvent evt);
+  // initialize/shutdown the sockets (usually called automatically)
+  static bool IsInitialized();
+  static bool Initialize();
+  static void Shutdown();

 
 

-protected:
-  friend class wxSocketServer;
-  friend class wxSocketHandler;
-  friend class wxSocketInternal;
-
-#ifdef __SALFORDC__
-public:
-#endif
-
-  wxSocketBase(wxSockFlags flags, wxSockType type);

 
 

-#ifdef __SALFORDC__
-protected:
-#endif
+  // Implementation from now on
+  // --------------------------

 
 

-  bool _Wait(long seconds, long microseconds, int type);
+  // do not use, should be private (called from wxSocketImpl only)
+  void OnRequest(wxSocketNotify notify);

 
 

-  int DeferRead(char *buffer, size_t nbytes);
-  int DeferWrite(const char *buffer, size_t nbytes);
-  void DoDefer(GSocketEvent evt);
+  // do not use, not documented nor supported
+  bool IsNoWait() const { return ((m_flags & wxSOCKET_NOWAIT) != 0); }
+  wxSocketType GetType() const { return m_type; }

 
 

-  // Pushback library
-  size_t GetPushback(char *buffer, size_t size, bool peek);
+private:
+  friend class wxSocketClient;
+  friend class wxSocketServer;
+  friend class wxDatagramSocket;
+
+  // low level IO
+  wxUint32 DoRead(void* buffer, wxUint32 nbytes);
+  wxUint32 DoWrite(const void *buffer, wxUint32 nbytes);
+
+  // wait until the given flags are set for this socket or the given timeout
+  // (or m_timeout) expires
+  //
+  // notice that wxSOCKET_LOST_FLAG is always taken into account but the return
+  // value depends on whether it is included in flags or not: if it is, and the
+  // connection is indeed lost, true is returned, but if it isn't then the
+  // function returns false in this case
+  //
+  // false is always returned if we returned because of the timeout expiration
+  bool DoWait(long seconds, long milliseconds, wxSocketEventFlags flags);
+
+  // pushback buffer
+  void     Pushback(const void *buffer, wxUint32 size);
+  wxUint32 GetPushback(void *buffer, wxUint32 size, bool peek);
+
+private:
+  // socket
+  wxSocketImpl *m_impl;             // port-specific implementation
+  wxSocketType  m_type;             // wxSocket type
+
+  // state
+  wxSocketFlags m_flags;            // wxSocket flags
+  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?
+  bool          m_closed;           // was the other end closed?
+                                    // (notice that m_error is also set then)
+  wxUint32      m_lcount;           // last IO transaction size
+  unsigned long m_timeout;          // IO timeout value in seconds
+  wxList        m_states;           // stack of states
+  bool          m_interrupt;        // interrupt ongoing wait operations?
+  bool          m_beingDeleted;     // marked for delayed deletion?
+  wxIPV4address m_localAddress;     // bind to local address?
+
+  // pushback buffer
+  void         *m_unread;           // pushback buffer
+  wxUint32      m_unrd_size;        // pushback buffer size
+  wxUint32      m_unrd_cur;         // pushback pointer (index into buffer)
+
+  // events
+  int           m_id;               // socket id
+  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;
+
+  DECLARE_NO_COPY_CLASS(wxSocketBase)

 };
 
 };
 

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

 
 

-class WXDLLEXPORT wxSocketServer : public wxSocketBase
+// --------------------------------------------------------------------------
+// wxSocketServer
+// --------------------------------------------------------------------------
+
+class WXDLLIMPEXP_NET wxSocketServer : public wxSocketBase

 {
   DECLARE_CLASS(wxSocketServer)
 {
   DECLARE_CLASS(wxSocketServer)

+

 public:
 public:

+  wxSocketServer(const wxSockAddress& addr, wxSocketFlags flags = wxSOCKET_NONE);

 
 

-  // 'service' can be a name or a port-number
+  wxSocketBase* Accept(bool wait = true);
+  bool AcceptWith(wxSocketBase& socket, bool wait = true);

 
 

-  wxSocketServer(wxSockAddress& addr_man, wxSockFlags flags = wxSocketBase::NONE);
+  bool WaitForAccept(long seconds = -1, long milliseconds = 0);

 
 

-  wxSocketBase* Accept();
-  bool AcceptWith(wxSocketBase& sock);
+  DECLARE_NO_COPY_CLASS(wxSocketServer)

 };
 
 };
 

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

 
 

-class WXDLLEXPORT wxSocketClient : public wxSocketBase
+// --------------------------------------------------------------------------
+// wxSocketClient
+// --------------------------------------------------------------------------
+
+class WXDLLIMPEXP_NET wxSocketClient : public wxSocketBase

 {
   DECLARE_CLASS(wxSocketClient)
 {
   DECLARE_CLASS(wxSocketClient)

-public:

 
 

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

   virtual ~wxSocketClient();
 
   virtual ~wxSocketClient();
 

-  virtual bool Connect(wxSockAddress& addr_man, bool wait = TRUE);
+  virtual bool Connect(const wxSockAddress& addr, bool wait = true);
+  bool Connect(const wxSockAddress& addr, const wxSockAddress& local,
+               bool wait = true);
+
+  bool WaitOnConnect(long seconds = -1, long milliseconds = 0);
+
+  // Sets initial socket buffer sizes using the SO_SNDBUF and SO_RCVBUF options
+  // before calling connect (either one can be -1 to leave it unchanged)
+  void SetInitialSocketBuffers(int recv, int send)
+  {
+      m_initialRecvBufferSize = recv;
+      m_initialSendBufferSize = send;
+  }
+
+private:
+  virtual bool DoConnect(const wxSockAddress& addr,
+                         const wxSockAddress* local,
+                         bool wait = true);
+
+  // buffer sizes, -1 if unset and defaults should be used
+  int m_initialRecvBufferSize;
+  int m_initialSendBufferSize;

 
 

-  bool WaitOnConnect(long seconds = -1, long microseconds = 0);
+  DECLARE_NO_COPY_CLASS(wxSocketClient)
+};
+
+
+// --------------------------------------------------------------------------
+// wxDatagramSocket
+// --------------------------------------------------------------------------
+
+// WARNING: still in alpha stage

 
 

-  virtual void OnRequest(GSocketEvent flags);
+class WXDLLIMPEXP_NET wxDatagramSocket : public wxSocketBase
+{
+  DECLARE_CLASS(wxDatagramSocket)
+
+public:
+  wxDatagramSocket(const wxSockAddress& addr, wxSocketFlags flags = wxSOCKET_NONE);
+
+  wxDatagramSocket& RecvFrom( wxSockAddress& addr,
+                              void* buf,
+                              wxUint32 nBytes );
+  wxDatagramSocket& SendTo( const wxSockAddress& addr,
+                            const void* buf,
+                            wxUint32 nBytes );
+
+/* TODO:
+  bool Connect(wxSockAddress& addr);
+*/
+  DECLARE_NO_COPY_CLASS(wxDatagramSocket)

 };
 
 };
 

-class WXDLLEXPORT wxSocketEvent : public wxEvent {
-  DECLARE_DYNAMIC_CLASS(wxSocketEvent)
+
+// --------------------------------------------------------------------------
+// wxSocketEvent
+// --------------------------------------------------------------------------
+
+class WXDLLIMPEXP_NET wxSocketEvent : public wxEvent
+{

 public:
 public:

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

 
 

-  GSocketEvent SocketEvent() const { return m_skevt; }
-  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& obj_d) const;
+  virtual wxEvent *Clone() const { return new wxSocketEvent(*this); }

 
 public:
 
 public:

-  GSocketEvent m_skevt;
-  wxSocketBase *m_socket;
+  wxSocketNotify  m_event;
+  void           *m_clientData;
+
+  DECLARE_DYNAMIC_CLASS_NO_ASSIGN(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 wxSocketEventHandler(func) \
+    (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSocketEventFunction, &func)
+
+#define EVT_SOCKET(id, func) \
+    wx__DECLARE_EVT1(wxEVT_SOCKET, id, wxSocketEventHandler(func))
+
+#endif // wxUSE_SOCKETS

 
 

-#endif
-  // wxUSE_SOCKETS
+#endif // _WX_SOCKET_H_

 
 

-#endif
-  // _WX_NETWORK_SOCKET_H