Enable intercepting ENTER in wxSpinCtrl under wxMac by using wxTE_PROCESS_ENTER

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

diff --git a/include/wx/socket.h b/include/wx/socket.h
index 2cd5df584ad4538ba4d10eaa214470458ab26efd..165aa97890aa3d0f5c5aa253c76dcc439505c9e8 100644 (file)
--- a/include/wx/socket.h
+++ b/include/wx/socket.h
@@ -12,10 +12,6 @@
 #ifndef _WX_SOCKET_H_
 #define _WX_SOCKET_H_
 
 #ifndef _WX_SOCKET_H_
 #define _WX_SOCKET_H_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-  #pragma interface "socket.h"
-#endif
-

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


@@ -75,7 +71,9 @@ enum
   wxSOCKET_NOWAIT = 1,
   wxSOCKET_WAITALL = 2,
   wxSOCKET_BLOCK = 4,
   wxSOCKET_NOWAIT = 1,
   wxSOCKET_WAITALL = 2,
   wxSOCKET_BLOCK = 4,

-  wxSOCKET_REUSEADDR = 8
+  wxSOCKET_REUSEADDR = 8,
+  wxSOCKET_BROADCAST = 16,
+  wxSOCKET_NOBIND = 32

 };
 
 enum wxSocketType
 };
 
 enum wxSocketType


@@ -112,19 +110,22 @@ public:
   bool Destroy();
 
   // state
   bool Destroy();
 
   // state

-  inline bool Ok() const { return (m_socket != NULL); };
-  inline bool Error() const { return m_error; };
-  inline bool IsConnected() const { return m_connected; };
-  inline bool IsData() { return WaitForRead(0, 0); };
-  inline bool IsDisconnected() const { return !IsConnected(); };
-  inline wxUint32 LastCount() const { return m_lcount; }
-  inline wxSocketError LastError() const { return (wxSocketError)m_socket->GetError(); }
+  bool Ok() const { return IsOk(); }
+  bool IsOk() const { return (m_socket != 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 { return (wxSocketError)m_socket->GetError(); }

   void SaveState();
   void RestoreState();
 
   // addresses
   virtual bool GetLocal(wxSockAddress& addr_man) const;
   virtual bool GetPeer(wxSockAddress& addr_man) 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();
 
   // base IO
   virtual bool  Close();


@@ -136,19 +137,33 @@ public:
   wxSocketBase& Write(const void *buffer, wxUint32 nbytes);
   wxSocketBase& WriteMsg(const void *buffer, wxUint32 nbytes);
 
   wxSocketBase& Write(const void *buffer, wxUint32 nbytes);
   wxSocketBase& WriteMsg(const void *buffer, wxUint32 nbytes);
 

-  void InterruptWait() { m_interrupt = true; };
+  // 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);
   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);
   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);
 
   bool WaitForLost(long seconds = -1, long milliseconds = 0);
 

-  inline wxSocketFlags GetFlags() const { return m_flags; }
+  void InterruptWait() { m_interrupt = true; }
+
+
+  wxSocketFlags GetFlags() const { return m_flags; }

   void SetFlags(wxSocketFlags flags);
   void SetTimeout(long seconds);
 
   bool GetOption(int level, int optname, void *optval, int *optlen);
   bool SetOption(int level, int optname, const void *optval, int optlen);
   void SetFlags(wxSocketFlags flags);
   void SetTimeout(long seconds);
 
   bool GetOption(int level, int optname, void *optval, int *optlen);
   bool SetOption(int level, int optname, const void *optval, int optlen);

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

 
   // event handling
   void *GetClientData() const { return m_clientData; }
 
   // event handling
   void *GetClientData() const { return m_clientData; }


@@ -170,8 +185,8 @@ public:
   void OnRequest(wxSocketNotify notify);
 
   // do not use, not documented nor supported
   void OnRequest(wxSocketNotify notify);
 
   // do not use, not documented nor supported

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

 
 private:
   friend class wxSocketClient;
 
 private:
   friend class wxSocketClient;


@@ -179,9 +194,19 @@ private:
   friend class wxDatagramSocket;
 
   // low level IO
   friend class wxDatagramSocket;
 
   // low level IO

-  wxUint32 _Read(void* buffer, wxUint32 nbytes);
-  wxUint32 _Write(const void *buffer, wxUint32 nbytes);
-  bool     _Wait(long seconds, long milliseconds, wxSocketEventFlags flags);
+  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 GSOCK_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);
 
   // pushback buffer
   void     Pushback(const void *buffer, wxUint32 size);


@@ -199,12 +224,14 @@ private:
   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)
+  bool          m_closed;           // was the other end closed?
+                                    // (notice that m_error is also set then)

   wxUint32      m_lcount;           // last IO transaction size
   wxUint32      m_lcount;           // last IO transaction size

-  unsigned long m_timeout;          // IO timeout value
+  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?
   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
 
   // pushback buffer
   void         *m_unread;           // pushback buffer


@@ -221,7 +248,7 @@ private:
   // the initialization count, GSocket is initialized if > 0
   static size_t m_countInit;
 
   // the initialization count, GSocket is initialized if > 0
   static size_t m_countInit;
 

-    DECLARE_NO_COPY_CLASS(wxSocketBase)
+  DECLARE_NO_COPY_CLASS(wxSocketBase)

 };
 
 
 };
 
 


@@ -234,7 +261,7 @@ class WXDLLIMPEXP_NET wxSocketServer : public wxSocketBase
   DECLARE_CLASS(wxSocketServer)
 
 public:
   DECLARE_CLASS(wxSocketServer)
 
 public:

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

 
   wxSocketBase* Accept(bool wait = true);
   bool AcceptWith(wxSocketBase& socket, bool wait = true);
 
   wxSocketBase* Accept(bool wait = true);
   bool AcceptWith(wxSocketBase& socket, bool wait = true);


@@ -257,10 +284,29 @@ public:
   wxSocketClient(wxSocketFlags flags = wxSOCKET_NONE);
   virtual ~wxSocketClient();
 
   wxSocketClient(wxSocketFlags flags = wxSOCKET_NONE);
   virtual ~wxSocketClient();
 

-  virtual bool Connect(wxSockAddress& addr, 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);
 
 
   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;
+

   DECLARE_NO_COPY_CLASS(wxSocketClient)
 };
 
   DECLARE_NO_COPY_CLASS(wxSocketClient)
 };
 


@@ -276,12 +322,12 @@ class WXDLLIMPEXP_NET wxDatagramSocket : public wxSocketBase
   DECLARE_CLASS(wxDatagramSocket)
 
 public:
   DECLARE_CLASS(wxDatagramSocket)
 
 public:

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

 
   wxDatagramSocket& RecvFrom( wxSockAddress& addr,
                               void* buf,
                               wxUint32 nBytes );
 
   wxDatagramSocket& RecvFrom( wxSockAddress& addr,
                               void* buf,
                               wxUint32 nBytes );

-  wxDatagramSocket& SendTo( wxSockAddress& addr,
+  wxDatagramSocket& SendTo( const wxSockAddress& addr,

                             const void* buf,
                             wxUint32 nBytes );
 
                             const void* buf,
                             wxUint32 nBytes );
 


@@ -321,7 +367,7 @@ public:
 typedef void (wxEvtHandler::*wxSocketEventFunction)(wxSocketEvent&);
 
 #define wxSocketEventHandler(func) \
 typedef void (wxEvtHandler::*wxSocketEventFunction)(wxSocketEvent&);
 
 #define wxSocketEventHandler(func) \

-    (wxObjectEventFunction)wxStaticCastEvent(wxSocketEventFunction, &func)
+    (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSocketEventFunction, &func)

 
 #define EVT_SOCKET(id, func) \
     wx__DECLARE_EVT1(wxEVT_SOCKET, id, wxSocketEventHandler(func))
 
 #define EVT_SOCKET(id, func) \
     wx__DECLARE_EVT1(wxEVT_SOCKET, id, wxSocketEventHandler(func))