]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/socket.h
removed relic: GetMaxLineWidth
[wxWidgets.git] / include / wx / socket.h
index 05bc0c2c46b0126acc5b9f4935a33c44fc19c263..4663b0d6ed597e5c499653f4f8fb1310068b1bb7 100644 (file)
 #include "wx/gsocket.h"
 
 // ------------------------------------------------------------------------
-// GSocket type alias
+// constants
 // ------------------------------------------------------------------------
 
-typedef enum {
+enum wxSocketNotify
+{
   wxSOCKET_INPUT = GSOCK_INPUT,
   wxSOCKET_OUTPUT = GSOCK_OUTPUT,
   wxSOCKET_CONNECTION = GSOCK_CONNECTION,
   wxSOCKET_LOST = GSOCK_LOST
-} wxSocketNotify;
+};
 
-enum {
+enum
+{
   wxSOCKET_INPUT_FLAG = GSOCK_INPUT_FLAG,
   wxSOCKET_OUTPUT_FLAG = GSOCK_OUTPUT_FLAG,
   wxSOCKET_CONNECTION_FLAG = GSOCK_CONNECTION_FLAG,
@@ -54,7 +56,8 @@ enum {
 
 typedef GSocketEventFlags wxSocketEventFlags;
 
-typedef enum {
+enum wxSocketError
+{
   wxSOCKET_NOERROR = GSOCK_NOERROR,
   wxSOCKET_INPOP = GSOCK_INVOP,
   wxSOCKET_IOERR = GSOCK_IOERR,
@@ -66,15 +69,26 @@ typedef enum {
   wxSOCKET_TIMEDOUT = GSOCK_TIMEDOUT,
   wxSOCKET_MEMERR = GSOCK_MEMERR,
   wxSOCKET_BUSY
-} wxSocketError;
+};
 
-enum {
+enum
+{
   wxSOCKET_NONE = 0,
   wxSOCKET_NOWAIT = 1,
   wxSOCKET_WAITALL = 2,
   wxSOCKET_BLOCK = 4
 };
 
+// Type of socket
+enum wxSockType
+{
+  SOCK_CLIENT,
+  SOCK_SERVER,
+  SOCK_DATAGRAM,
+  SOCK_INTERNAL,
+  SOCK_UNINIT
+};
+
 typedef int wxSockFlags;
 
 // ------------------------------------------------------------------------
@@ -83,67 +97,52 @@ typedef int wxSockFlags;
 
 class WXDLLEXPORT wxTimer;
 class WXDLLEXPORT wxSocketEvent;
+
 class WXDLLEXPORT wxSocketBase : public wxEvtHandler
 {
   DECLARE_CLASS(wxSocketBase)
 public:
 
-  enum {
+  enum
+  {
     NONE = wxSOCKET_NONE,
     NOWAIT = wxSOCKET_NOWAIT,
     WAITALL = wxSOCKET_WAITALL,
     SPEED = wxSOCKET_BLOCK
   };
 
-  // Type of request
-
-  enum wxSockType { SOCK_CLIENT, SOCK_SERVER, SOCK_INTERNAL, SOCK_UNINIT };
   typedef void (*wxSockCbk)(wxSocketBase& sock, wxSocketNotify evt, char *cdata);
 
 protected:
-  GSocket *m_socket;            // GSocket
-  int m_id;                     // Socket id (for event handler)
+  GSocket      *m_socket;           // GSocket
+  wxEvtHandler *m_evt_handler;      // event handler
+  int           m_id;               // Socket id (for event handler)
 
   // Attributes
-  wxSockFlags m_flags;                 // wxSocket flags
-  wxSockType m_type;                   // wxSocket type
+  wxSockFlags   m_flags;            // wxSocket flags
+  wxSockType    m_type;             // wxSocket type
   wxSocketEventFlags m_neededreq;   // Event mask
-  bool m_notify_state;          // Notify events to users?
-  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 ?
-  wxUint32 m_lcount;            // Last IO transaction size
-  unsigned long m_timeout;             // IO timeout value
-  wxList m_states;              // Stack of states
-
-  char *m_unread;               // Pushback buffer
-  wxUint32 m_unrd_size;                        // Pushback buffer size
-  wxUint32 m_unrd_cur;          // Pushback pointer (index into buffer)
-
-  // Async IO variables
-  enum
-  {
-    NO_DEFER = 0,
-    DEFER_READ = 1,
-    DEFER_WRITE = 2
-  } 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
-
-/*
-  char *m_read_buffer;          // Target buffer (read)
-  char *m_write_buffer;         // Target buffer (write)
-  wxUint32 m_read_nbytes;       // Buffer size (read)
-  wxUint32 m_write_nbytes;      // Buffer size (write)
-  wxTimer *m_read_timer;        // Timer (read)
-  wxTimer *m_write_timer;       // Timer (write)
-*/
-
-  wxSockCbk m_cbk;              // C callback
-  char *m_cdata;                // C callback data
+  bool          m_notify_state;     // Notify events to users?
+
+  // State
+  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?
+  wxUint32      m_lcount;           // Last IO transaction size
+  unsigned long m_timeout;          // IO timeout value
+  wxList        m_states;           // Stack of states
+  bool          m_interrupt;        // Interrupt ongoing wait operations
+
+  // Pushback buffer
+  char         *m_unread;           // Pushback buffer
+  wxUint32      m_unrd_size;        // Pushback buffer size
+  wxUint32      m_unrd_cur;         // Pushback pointer (index into buffer)
+
+  // Callback
+  wxSockCbk     m_cbk;              // C callback
+  char         *m_cdata;            // C callback data
 
 public:
   wxSocketBase();
@@ -170,7 +169,7 @@ public:
   inline wxSocketError LastError() const { return (wxSocketError)GSocket_GetError(m_socket); }
   inline wxSockType GetType() const { return m_type; }
 
-  // Some info on the socket...
+  // Addresses
   virtual bool GetPeer(wxSockAddress& addr_man) const;
   virtual bool GetLocal(wxSockAddress& addr_man) const;
 
@@ -179,15 +178,23 @@ public:
   void SetFlags(wxSockFlags flags);
   inline wxSockFlags GetFlags() const { return m_flags; };
 
-  // Wait functions
-  //   seconds = -1 means default timeout (change with SetTimeout)
-  //   seconds, milliseconds = 0 means no wait
-  //   seconds, milliseconds > 0 means specified wait
+  /* 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);
 
+  /* This function interrupts all ongoing wait operations for this
+   * socket; use it only as an escape mechanism (for example to close
+   * an app or to abort an operation). Reception of LOST events and
+   * calls to Close() automatically call this.
+   */
+  void InterruptAllWaits() { m_interrupt = TRUE; };
+
   // Save the current state of Socket
   void SaveState();
   void RestoreState();
@@ -231,10 +238,6 @@ protected:
   wxUint32 _Write(const char *buffer, wxUint32 nbytes);
   bool _Wait(long seconds, long milliseconds, wxSocketEventFlags flags);
 
-  wxUint32 DeferRead(char *buffer, wxUint32 nbytes);
-  wxUint32 DeferWrite(const char *buffer, wxUint32 nbytes);
-  void DoDefer();
-
   // Pushbacks
   void Pushback(const char *buffer, wxUint32 size);
   wxUint32 GetPushback(char *buffer, wxUint32 size, bool peek);
@@ -248,7 +251,7 @@ class WXDLLEXPORT wxSocketServer : public wxSocketBase
 public:
   // 'service' can be a name or a port-number
 
-  wxSocketServer(wxSockAddress& addr_man, wxSockFlags flags = wxSocketBase::NONE);
+  wxSocketServer(wxSockAddress& addr_man, wxSockFlags flags = wxSOCKET_NONE);
 
   wxSocketBase* Accept(bool wait = TRUE);
   bool AcceptWith(wxSocketBase& sock, bool wait = TRUE);
@@ -263,7 +266,7 @@ class WXDLLEXPORT wxSocketClient : public wxSocketBase
   DECLARE_CLASS(wxSocketClient)
 public:
 
-  wxSocketClient(wxSockFlags flags = wxSocketBase::NONE);
+  wxSocketClient(wxSockFlags flags = wxSOCKET_NONE);
   virtual ~wxSocketClient();
 
   virtual bool Connect(wxSockAddress& addr_man, bool wait = TRUE);
@@ -271,6 +274,25 @@ public:
   bool WaitOnConnect(long seconds = -1, long milliseconds = 0);
 };
 
+////////////////////////////////////////////////////////////////////////
+
+class wxDatagramSocket : public wxSocketBase
+{
+  DECLARE_CLASS(wxDatagramSocket)
+
+public:
+  wxDatagramSocket( wxSockAddress& addr, wxSockFlags flags = wxSOCKET_NONE );
+
+  wxDatagramSocket& RecvFrom( wxSockAddress& addr,
+                              char* buf,
+                              wxUint32 nBytes );
+  wxDatagramSocket& SendTo( wxSockAddress& addr,
+                            const char* buf,
+                            wxUint32 nBytes );
+};
+
+////////////////////////////////////////////////////////////////////////
+
 class WXDLLEXPORT wxSocketEvent : public wxEvent {
   DECLARE_DYNAMIC_CLASS(wxSocketEvent)
 public: