Implemented wxHelpContext for wxGTK.

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

diff --git a/include/wx/socket.h b/include/wx/socket.h
index 3d2fd861b1cbb354354232194191f13aaa799543..0b955b128da4372217e6c833f45f1257f527732c 100644 (file)
--- a/include/wx/socket.h
+++ b/include/wx/socket.h
@@ -13,7 +13,7 @@
 #define _WX_NETWORK_SOCKET_H
 
 #ifdef __GNUG__
 #define _WX_NETWORK_SOCKET_H
 
 #ifdef __GNUG__

-#pragma interface "socket.h"
+  #pragma interface "socket.h"

 #endif
 
 #include "wx/defs.h"
 #endif
 
 #include "wx/defs.h"


@@ -25,10 +25,10 @@
 // ---------------------------------------------------------------------------
 
 #ifdef WXPREC
 // ---------------------------------------------------------------------------
 
 #ifdef WXPREC

-#  include "wx/wxprec.h"
+  #include "wx/wxprec.h"

 #else
 #else

-#  include "wx/event.h"
-#  include "wx/string.h"
+  #include "wx/event.h"
+  #include "wx/string.h"

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


@@ -58,8 +58,9 @@ typedef GSocketEventFlags wxSocketEventFlags;
 
 enum wxSocketError
 {
 
 enum wxSocketError
 {

+  // from GSocket

   wxSOCKET_NOERROR = GSOCK_NOERROR,
   wxSOCKET_NOERROR = GSOCK_NOERROR,

-  wxSOCKET_INPOP = GSOCK_INVOP,
+  wxSOCKET_INVOP = GSOCK_INVOP,

   wxSOCKET_IOERR = GSOCK_IOERR,
   wxSOCKET_INVADDR = GSOCK_INVADDR,
   wxSOCKET_INVSOCK = GSOCK_INVSOCK,
   wxSOCKET_IOERR = GSOCK_IOERR,
   wxSOCKET_INVADDR = GSOCK_INVADDR,
   wxSOCKET_INVSOCK = GSOCK_INVSOCK,


@@ -67,7 +68,10 @@ enum wxSocketError
   wxSOCKET_INVPORT = GSOCK_INVPORT,
   wxSOCKET_WOULDBLOCK = GSOCK_WOULDBLOCK,
   wxSOCKET_TIMEDOUT = GSOCK_TIMEDOUT,
   wxSOCKET_INVPORT = GSOCK_INVPORT,
   wxSOCKET_WOULDBLOCK = GSOCK_WOULDBLOCK,
   wxSOCKET_TIMEDOUT = GSOCK_TIMEDOUT,

-  wxSOCKET_MEMERR = GSOCK_MEMERR
+  wxSOCKET_MEMERR = GSOCK_MEMERR,
+
+  // wxSocket-specific (not yet implemented)
+  wxSOCKET_DUMMY

 };
 
 enum
 };
 
 enum


@@ -78,7 +82,6 @@ enum
   wxSOCKET_BLOCK = 4
 };
 
   wxSOCKET_BLOCK = 4
 };
 

-// Type of socket

 enum wxSocketType
 {
   wxSOCKET_UNINIT,
 enum wxSocketType
 {
   wxSOCKET_UNINIT,


@@ -91,15 +94,12 @@ enum wxSocketType
 typedef int wxSocketFlags;
 
 
 typedef int wxSocketFlags;
 
 

-// old names
-

 #if WXWIN_COMPATIBILITY
 #if WXWIN_COMPATIBILITY

-
-typedef wxSocketType wxSockType;
-typedef wxSocketFlags wxSockFlags;
-
+  typedef wxSocketType wxSockType;
+  typedef wxSocketFlags wxSockFlags;

 #endif // WXWIN_COMPATIBILITY
 
 #endif // WXWIN_COMPATIBILITY
 

+

 // --------------------------------------------------------------------------
 // wxSocketBase
 // --------------------------------------------------------------------------
 // --------------------------------------------------------------------------
 // wxSocketBase
 // --------------------------------------------------------------------------


@@ -127,9 +127,9 @@ public:
     SOCK_INTERNAL = wxSOCKET_BASE,
     SOCK_DATAGRAM = wxSOCKET_DATAGRAM
   };
     SOCK_INTERNAL = wxSOCKET_BASE,
     SOCK_DATAGRAM = wxSOCKET_DATAGRAM
   };

-#endif // WXWIN_COMPATIBILITY

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

+#endif // WXWIN_COMPATIBILITY

 
 public:
 
 
 public:
 


@@ -168,7 +168,7 @@ 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 InterruptAllWaits() { m_interrupt = TRUE; };
+  void InterruptWait() { m_interrupt = TRUE; };

   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 Wait(long seconds = -1, long milliseconds = 0);
   bool WaitForRead(long seconds = -1, long milliseconds = 0);
   bool WaitForWrite(long seconds = -1, long milliseconds = 0);


@@ -185,19 +185,21 @@ public:
   void SetNotify(wxSocketEventFlags flags);
   void Notify(bool notify);
 
   void SetNotify(wxSocketEventFlags flags);
   void Notify(bool notify);
 

-  // callbacks - deprecated, avoid if possible
+  // callbacks are deprecated, use events instead
+#if WXWIN_COMPATIBILITY

   wxSockCbk Callback(wxSockCbk cbk_);
   char *CallbackData(char *data);
   wxSockCbk Callback(wxSockCbk cbk_);
   char *CallbackData(char *data);

+#endif // WXWIN_COMPATIBILITY

 
 
   // Implementation from now on
   // --------------------------
 
 
 
   // Implementation from now on
   // --------------------------
 

-  // do not use, this should be private
-  void OnRequest(wxSocketNotify req_evt);
+  // do not use, should be private (called from GSocket)
+  void OnRequest(wxSocketNotify notify);

 
   // do not use, not documented nor supported
 
   // do not use, not documented nor supported

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

   inline wxSocketType GetType() const { return m_type; }
 
 private:
   inline wxSocketType GetType() const { return m_type; }
 
 private:


@@ -208,13 +210,14 @@ private:
   // low level IO
   wxUint32 _Read(void* buffer, wxUint32 nbytes);
   wxUint32 _Write(const void *buffer, wxUint32 nbytes);
   // low level IO
   wxUint32 _Read(void* buffer, wxUint32 nbytes);
   wxUint32 _Write(const void *buffer, wxUint32 nbytes);

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

 
   // pushback buffer
 
   // pushback buffer

-  void Pushback(const void *buffer, wxUint32 size);
+  void     Pushback(const void *buffer, wxUint32 size);

   wxUint32 GetPushback(void *buffer, wxUint32 size, bool peek);
 
 private:
   wxUint32 GetPushback(void *buffer, wxUint32 size, bool peek);
 
 private:

+  // socket

   GSocket      *m_socket;           // GSocket
   wxSocketType  m_type;             // wxSocket type
 
   GSocket      *m_socket;           // GSocket
   wxSocketType  m_type;             // wxSocket type
 


@@ -225,6 +228,7 @@ 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)

   wxUint32      m_lcount;           // last IO transaction size
   unsigned long m_timeout;          // IO timeout value
   wxList        m_states;           // stack of states
   wxUint32      m_lcount;           // last IO transaction size
   unsigned long m_timeout;          // IO timeout value
   wxList        m_states;           // stack of states


@@ -240,12 +244,14 @@ private:
   int           m_id;               // socket id
   wxEvtHandler *m_handler;          // event handler
   void         *m_clientData;       // client data for events
   int           m_id;               // socket id
   wxEvtHandler *m_handler;          // event handler
   void         *m_clientData;       // client data for events

-  bool          m_notify_state;     // notify events to users?
-  wxSocketEventFlags  m_neededreq;  // event mask
+  bool          m_notify;           // notify events to users?
+  wxSocketEventFlags  m_eventmask;  // which events to notify?

 
 

-  // callbacks - deprecated, avoid if possible
+  // callbacks are deprecated, use events instead
+#if WXWIN_COMPATIBILITY

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

+#endif // WXWIN_COMPATIBILITY

 };
 
 
 };
 
 


@@ -304,6 +310,10 @@ public:
   wxDatagramSocket& SendTo( wxSockAddress& addr,
                             const void* buf,
                             wxUint32 nBytes );
   wxDatagramSocket& SendTo( wxSockAddress& addr,
                             const void* buf,
                             wxUint32 nBytes );

+
+/* TODO:
+  bool Connect(wxSockAddress& addr);
+*/

 };
 
 
 };
 
 


@@ -323,8 +333,10 @@ public:
   void           *GetClientData() const  { return m_clientData; }
 
   // backwards compatibility
   void           *GetClientData() const  { return m_clientData; }
 
   // backwards compatibility

+#if WXWIN_COMPATIBILITY_2

   wxSocketNotify  SocketEvent() const    { return m_event; }
   wxSocketBase   *Socket() const         { return (wxSocketBase *) GetEventObject(); }
   wxSocketNotify  SocketEvent() const    { return m_event; }
   wxSocketBase   *Socket() const         { return (wxSocketBase *) GetEventObject(); }

+#endif // WXWIN_COMPATIBILITY_2

 
   void CopyObject(wxObject& object_dest) const;
 
 
   void CopyObject(wxObject& object_dest) const;