]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/socket.h
support SDK < 10.6, fixes #14902
[wxWidgets.git] / include / wx / socket.h
index a8797de0549ee68c00dd57131416bf84d0adc07f..93b39325da264f0a3775170df780a1fd95e6e77c 100644 (file)
@@ -1,7 +1,7 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////
-// Name:        socket.h
+// Name:        wx/socket.h
 // Purpose:     Socket handling classes
 // 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$
 // 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"
-
-class WXDLLEXPORT wxSocketEvent;
-class WXDLLEXPORT wxSocketBase : public wxEvtHandler
-{
-  DECLARE_CLASS(wxSocketBase)
-public:
+#include "wx/list.h"
 
 
-  enum { NONE=0, NOWAIT=1, WAITALL=2, SPEED=4 };
-  typedef int wxSockFlags;
-  // Type of request
+class wxSocketImpl;
 
 
-  enum wxSockType { SOCK_CLIENT, SOCK_SERVER, SOCK_INTERNAL, SOCK_UNINIT };
-  typedef void (*wxSockCbk)(wxSocketBase& sock,GSocketEvent evt,char *cdata);
+// ------------------------------------------------------------------------
+// Types and constants
+// ------------------------------------------------------------------------
 
 
-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
-
-  char *m_unread;                      // Pushback buffer
-  size_t m_unrd_size;                  // Pushback buffer size
-  size_t m_unrd_cur;                   // Pushback pointer
+// 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
+{
+    wxSOCKET_INPUT,
+    wxSOCKET_OUTPUT,
+    wxSOCKET_CONNECTION,
+    wxSOCKET_LOST
+};
 
 
-  wxSockCbk m_cbk;                     // C callback
-  char *m_cdata;                       // C callback data
+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
+};
 
 
-  bool m_connected;                    // Connected ?
-  bool m_notify_state;                 // Notify state
-  int m_id;                            // Socket id (for event handler)
+// this is a combination of the bit masks defined above
+typedef int wxSocketEventFlags;
 
 
-  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
+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
+};
 
 
-  wxList m_states;                     // Stack of states
+// socket options/flags bit masks
+enum
+{
+    wxSOCKET_NONE           = 0x0000,
+    wxSOCKET_NOWAIT_READ    = 0x0001,
+    wxSOCKET_NOWAIT_WRITE   = 0x0002,
+    wxSOCKET_NOWAIT         = wxSOCKET_NOWAIT_READ | wxSOCKET_NOWAIT_WRITE,
+    wxSOCKET_WAITALL_READ   = 0x0004,
+    wxSOCKET_WAITALL_WRITE  = 0x0008,
+    wxSOCKET_WAITALL        = wxSOCKET_WAITALL_READ | wxSOCKET_WAITALL_WRITE,
+    wxSOCKET_BLOCK          = 0x0010,
+    wxSOCKET_REUSEADDR      = 0x0020,
+    wxSOCKET_BROADCAST      = 0x0040,
+    wxSOCKET_NOBIND         = 0x0080
+};
 
 
-public:
-  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 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;
-  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 GSocketEventFlags NeededReq() const { return m_neededreq; }
-
-  static GSocketEventFlags EventToNotify(GSocketEvent evt);
-
-protected:
-  friend class wxSocketServer;
-  friend class wxSocketHandler;
-  friend class wxSocketInternal;
-
-#ifdef __SALFORDC__
-public:
-#endif
+typedef int wxSocketFlags;
 
 
-  wxSocketBase(wxSockFlags flags, wxSockType type);
+// socket kind values (badly defined, don't use)
+enum wxSocketType
+{
+    wxSOCKET_UNINIT,
+    wxSOCKET_CLIENT,
+    wxSOCKET_SERVER,
+    wxSOCKET_BASE,
+    wxSOCKET_DATAGRAM
+};
 
 
-#ifdef __SALFORDC__
-protected:
-#endif
 
 
-  bool _Wait(long seconds, long microseconds, int type);
+// event
+class WXDLLIMPEXP_FWD_NET wxSocketEvent;
+wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_NET, wxEVT_SOCKET, wxSocketEvent);
 
 
-  int DeferRead(char *buffer, size_t nbytes);
-  int DeferWrite(const char *buffer, size_t nbytes);
-  void DoDefer(GSocketEvent evt);
+// --------------------------------------------------------------------------
+// wxSocketBase
+// --------------------------------------------------------------------------
 
 
-  // Pushback library
-  size_t GetPushback(char *buffer, size_t size, bool peek);
+class WXDLLIMPEXP_NET wxSocketBase : public wxObject
+{
+public:
+    // Public interface
+    // ----------------
+
+    // ctors and dtors
+    wxSocketBase();
+    wxSocketBase(wxSocketFlags flags, wxSocketType type);
+    virtual ~wxSocketBase();
+    void Init();
+    bool Destroy();
+
+    // state
+    bool Ok() const { return IsOk(); }
+    bool IsOk() const { return m_impl != NULL; }
+    bool Error() const { return LastError() != wxSOCKET_NOERROR; }
+    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; }
+    wxUint32 LastReadCount() const { return m_lcount_read; }
+    wxUint32 LastWriteCount() const { return m_lcount_write; }
+    wxSocketError LastError() const;
+    void SaveState();
+    void RestoreState();
+
+    // addresses
+    virtual bool GetLocal(wxSockAddress& addr_man) const;
+    virtual bool GetPeer(wxSockAddress& addr_man) const;
+    virtual bool SetLocal(const wxIPV4address& local);
+
+    // base IO
+    virtual bool  Close();
+    void ShutdownOutput();
+    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);
+    virtual 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; }
+    wxUint32 GetLastIOReadSize() const { return m_lcount_read; }
+    wxUint32 GetLastIOWriteSize() const { return m_lcount_write; }
+
+    // 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);
+
+    // initialize/shutdown the sockets (done automatically so there is no need
+    // to call these functions usually)
+    //
+    // should always be called from the main thread only so one of the cases
+    // where they should indeed be called explicitly is when the first wxSocket
+    // object in the application is created in a different thread
+    static bool Initialize();
+    static void Shutdown();
+
+    // check if wxSocket had been already initialized
+    //
+    // notice that this function should be only called from the main thread as
+    // otherwise it is inherently unsafe because Initialize/Shutdown() may be
+    // called concurrently with it in the main thread
+    static bool IsInitialized();
+
+    // Implementation from now on
+    // --------------------------
+
+    // do not use, should be private (called from wxSocketImpl only)
+    void OnRequest(wxSocketNotify notify);
+
+    // do not use, not documented nor supported
+    bool IsNoWait() const { return ((m_flags & wxSOCKET_NOWAIT) != 0); }
+    wxSocketType GetType() const { return m_type; }
+
+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 and the
+    // function returns -1 if the connection was lost; otherwise it returns
+    // true if any of the events specified by flags argument happened or false
+    // if the timeout expired
+    int DoWait(long timeout, wxSocketEventFlags flags);
+
+    // a helper calling DoWait() using the same convention as the public
+    // WaitForXXX() functions use, i.e. use our timeout if seconds == -1 or the
+    // specified timeout otherwise
+    int DoWait(long seconds, long milliseconds, wxSocketEventFlags flags);
+
+    // another helper calling DoWait() using our m_timeout
+    int DoWaitWithTimeout(wxSocketEventFlags flags)
+    {
+        return DoWait(m_timeout*1000, flags);
+    }
+
+    // pushback buffer
+    void     Pushback(const void *buffer, wxUint32 size);
+    wxUint32 GetPushback(void *buffer, wxUint32 size, bool peek);
+
+    // store the given error as the LastError()
+    void SetError(wxSocketError error);
+
+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_closed;           // was the other end closed?
+    wxUint32      m_lcount;           // last IO transaction size
+    wxUint32      m_lcount_read;      // last IO transaction size of Read() direction.
+    wxUint32      m_lcount_write;     // last IO transaction size of Write() direction.
+    unsigned long m_timeout;          // IO timeout value in seconds
+                                      // (TODO: remove, wxSocketImpl has it too)
+    wxList        m_states;           // stack of states (TODO: remove!)
+    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?
+    wxSocketEventFlags  m_eventsgot;  // collects events received in OnRequest()
+
+
+    friend class wxSocketReadGuard;
+    friend class wxSocketWriteGuard;
+
+    wxDECLARE_NO_COPY_CLASS(wxSocketBase);
+    DECLARE_CLASS(wxSocketBase)
 };
 
 };
 
-////////////////////////////////////////////////////////////////////////
 
 
-class WXDLLEXPORT wxSocketServer : public wxSocketBase
+// --------------------------------------------------------------------------
+// wxSocketServer
+// --------------------------------------------------------------------------
+
+class WXDLLIMPEXP_NET wxSocketServer : public wxSocketBase
 {
 {
-  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);
+    wxDECLARE_NO_COPY_CLASS(wxSocketServer);
+    DECLARE_CLASS(wxSocketServer)
 };
 
 };
 
-////////////////////////////////////////////////////////////////////////
 
 
-class WXDLLEXPORT wxSocketClient : public wxSocketBase
+// --------------------------------------------------------------------------
+// wxSocketClient
+// --------------------------------------------------------------------------
+
+class WXDLLIMPEXP_NET wxSocketClient : public wxSocketBase
 {
 {
-  DECLARE_CLASS(wxSocketClient)
 public:
 public:
+    wxSocketClient(wxSocketFlags flags = wxSOCKET_NONE);
+
+    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;
+
+    wxDECLARE_NO_COPY_CLASS(wxSocketClient);
+    DECLARE_CLASS(wxSocketClient)
+};
 
 
-  wxSocketClient(wxSockFlags flags = wxSocketBase::NONE);
-  virtual ~wxSocketClient();
 
 
-  virtual bool Connect(wxSockAddress& addr_man, bool wait = TRUE);
+// --------------------------------------------------------------------------
+// wxDatagramSocket
+// --------------------------------------------------------------------------
 
 
-  bool WaitOnConnect(long seconds = -1, long microseconds = 0);
+// WARNING: still in alpha stage
 
 
-  virtual void OnRequest(GSocketEvent flags);
+class WXDLLIMPEXP_NET wxDatagramSocket : public wxSocketBase
+{
+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);
+     */
+
+private:
+    wxDECLARE_NO_COPY_CLASS(wxDatagramSocket);
+    DECLARE_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); }
+    virtual wxEventCategory GetEventCategory() const { return wxEVT_CATEGORY_SOCKET; }
 
 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) \
+    wxEVENT_HANDLER_CAST(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