include/wx/socket.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        socket.h
   3 // Purpose:     Socket handling classes
   4 // Author:      Guilhem Lavaux
   5 // Modified by:
   6 // Created:     April 1997
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Guilhem Lavaux
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_NETWORK_SOCKET_H
  13 #define _WX_NETWORK_SOCKET_H
  14
  15 #ifdef __GNUG__
  16 #pragma interface "socket.h"
  17 #endif
  18
  19 #include "wx/defs.h"
  20
  21 #if wxUSE_SOCKETS
  22
  23 // ---------------------------------------------------------------------------
  24 // wxSocket headers (generic)
  25 // ---------------------------------------------------------------------------
  26 #ifdef WXPREC
  27 #  include "wx/wxprec.h"
  28 #else
  29 #  include "wx/event.h"
  30 #  include "wx/string.h"
  31 #endif
  32
  33 #include "wx/sckaddr.h"
  34 #include "wx/gsocket.h"
  35
  36 // ------------------------------------------------------------------------
  37 // GSocket type alias
  38 // ------------------------------------------------------------------------
  39
  40 typedef enum {
  41   wxSOCKET_INPUT = GSOCK_INPUT,
  42   wxSOCKET_OUTPUT = GSOCK_OUTPUT,
  43   wxSOCKET_CONNECTION = GSOCK_CONNECTION,
  44   wxSOCKET_LOST = GSOCK_LOST
  45 } wxSocketNotify;
  46
  47 enum {
  48   wxSOCKET_INPUT_FLAG = GSOCK_INPUT_FLAG,
  49   wxSOCKET_OUTPUT_FLAG = GSOCK_OUTPUT_FLAG,
  50   wxSOCKET_CONNECTION_FLAG = GSOCK_CONNECTION_FLAG,
  51   wxSOCKET_LOST_FLAG = GSOCK_LOST_FLAG,
  52 };
  53
  54 typedef GSocketEventFlags wxSocketEventFlags;
  55
  56 typedef enum {
  57   wxSOCKET_NOERROR = GSOCK_NOERROR,
  58   wxSOCKET_INPOP = GSOCK_INVOP,
  59   wxSOCKET_IOERR = GSOCK_IOERR,
  60   wxSOCKET_INVADDR = GSOCK_INVADDR,
  61   wxSOCKET_INVSOCK = GSOCK_INVSOCK,
  62   wxSOCKET_NOHOST = GSOCK_NOHOST,
  63   wxSOCKET_INVPORT = GSOCK_INVPORT,
  64   wxSOCKET_WOULDBLOCK = GSOCK_WOULDBLOCK,
  65   wxSOCKET_TIMEDOUT = GSOCK_TIMEDOUT,
  66   wxSOCKET_MEMERR = GSOCK_MEMERR
  67 } wxSocketError;
  68
  69 // ------------------------------------------------------------------------
  70 // wxSocket base
  71 // ------------------------------------------------------------------------
  72
  73 class WXDLLEXPORT wxTimer;
  74 class WXDLLEXPORT wxSocketEvent;
  75 class WXDLLEXPORT wxSocketBase : public wxEvtHandler
  76 {
  77   DECLARE_CLASS(wxSocketBase)
  78 public:
  79
  80   enum { NONE=0, NOWAIT=1, WAITALL=2, SPEED=4 };
  81   typedef int wxSockFlags;
  82   // Type of request
  83
  84   enum wxSockType { SOCK_CLIENT, SOCK_SERVER, SOCK_INTERNAL, SOCK_UNINIT };
  85   typedef void (*wxSockCbk)(wxSocketBase& sock,wxSocketNotify evt,char *cdata);
  86
  87 protected:
  88   GSocket *m_socket;                    // wxSocket socket
  89   wxSockFlags m_flags;                  // wxSocket flags
  90   wxSockType m_type;                    // wxSocket type
  91   wxSocketEventFlags m_neededreq;       // Specify which requet signals we need
  92   wxUint32 m_lcount;                    // Last IO request size
  93   unsigned long m_timeout;              // IO timeout value
  94
  95   char *m_unread;                       // Pushback buffer
  96   wxUint32 m_unrd_size;                 // Pushback buffer size
  97   wxUint32 m_unrd_cur;                  // Pushback pointer
  98
  99   wxSockCbk m_cbk;                      // C callback
 100   char *m_cdata;                        // C callback data
 101
 102   bool m_connected;                     // Connected ?
 103   bool m_notify_state;                  // Notify state
 104   int m_id;                             // Socket id (for event handler)
 105
 106   // Defering variables
 107   enum {
 108     DEFER_READ, DEFER_WRITE, NO_DEFER
 109   } m_defering;                         // Defering state
 110   char *m_defer_buffer;                 // Defering target buffer
 111   wxUint32 m_defer_nbytes;                // Defering buffer size
 112   wxTimer *m_defer_timer;               // Timer for defering mode
 113
 114   wxList m_states;                      // Stack of states
 115
 116 public:
 117   wxSocketBase();
 118   virtual ~wxSocketBase();
 119   virtual bool Close();
 120
 121   // Base IO
 122   wxSocketBase& Peek(char* buffer, wxUint32 nbytes);
 123   wxSocketBase& Read(char* buffer, wxUint32 nbytes);
 124   wxSocketBase& Write(const char *buffer, wxUint32 nbytes);
 125   wxSocketBase& Unread(const char *buffer, wxUint32 nbytes);
 126   wxSocketBase& ReadMsg(char *buffer, wxUint32 nbytes);
 127   wxSocketBase& WriteMsg(const char *buffer, wxUint32 nbytes);
 128   void Discard();
 129
 130   // Try not to use this two methods (they sould be protected)
 131   void CreatePushbackAfter(const char *buffer, wxUint32 size);
 132   void CreatePushbackBefore(const char *buffer, wxUint32 size);
 133
 134   // Status
 135   inline bool Ok() const { return (m_socket != NULL); };
 136   inline bool Error() const
 137            { return (GSocket_GetError(m_socket) != GSOCK_NOERROR); };
 138   inline bool IsConnected() const { return m_connected; };
 139   inline bool IsDisconnected() const { return !IsConnected(); };
 140   inline bool IsNoWait() const { return ((m_flags & NOWAIT) != 0); };
 141   bool IsData() const;
 142   inline wxUint32 LastCount() const { return m_lcount; }
 143   inline wxSocketError LastError() const { return (wxSocketError)GSocket_GetError(m_socket); }
 144   inline wxSockType GetType() const { return m_type; }
 145
 146   void SetFlags(wxSockFlags _flags);
 147   wxSockFlags GetFlags() const;
 148   void SetTimeout(unsigned long sec);
 149
 150   // seconds = -1 means infinite wait
 151   // seconds = 0 means no wait
 152   // seconds > 0 means specified wait
 153   bool Wait(long seconds = -1, long milliseconds = 0);
 154   bool WaitForRead(long seconds = -1, long milliseconds = 0);
 155   bool WaitForWrite(long seconds = -1, long milliseconds = 0);
 156   bool WaitForLost(long seconds = -1, long milliseconds = 0);
 157
 158   // Save the current state of Socket
 159   void SaveState();
 160   void RestoreState();
 161
 162   // Setup external callback
 163   wxSockCbk Callback(wxSockCbk cbk_);
 164   char *CallbackData(char *data);
 165
 166   // Setup event handler
 167   void SetEventHandler(wxEvtHandler& evt_hdlr, int id = -1);
 168
 169   // Method called when it happens something on the socket
 170   void SetNotify(wxSocketEventFlags flags);
 171   virtual void OnRequest(wxSocketNotify req_evt);
 172
 173   // Public internal callback
 174   virtual void OldOnNotify(wxSocketNotify WXUNUSED(evt));
 175
 176   // Some info on the socket...
 177   virtual bool GetPeer(wxSockAddress& addr_man) const;
 178   virtual bool GetLocal(wxSockAddress& addr_man) const;
 179
 180   // Install or uninstall callbacks
 181   void Notify(bool notify);
 182
 183   // So you can know what the socket driver is looking for ...
 184   inline wxSocketEventFlags NeededReq() const { return m_neededreq; }
 185
 186   static wxSocketEventFlags EventToNotify(wxSocketNotify evt);
 187
 188 protected:
 189   friend class wxSocketServer;
 190   friend class wxSocketHandler;
 191   friend class wxSocketInternal;
 192
 193 #ifdef __SALFORDC__
 194 public:
 195 #endif
 196
 197   wxSocketBase(wxSockFlags flags, wxSockType type);
 198
 199 #ifdef __SALFORDC__
 200 protected:
 201 #endif
 202
 203   bool _Wait(long seconds, long milliseconds, int type);
 204
 205   int DeferRead(char *buffer, wxUint32 nbytes);
 206   int DeferWrite(const char *buffer, wxUint32 nbytes);
 207   void DoDefer(wxSocketNotify evt);
 208
 209   // Pushback library
 210   wxUint32 GetPushback(char *buffer, wxUint32 size, bool peek);
 211 };
 212
 213 ////////////////////////////////////////////////////////////////////////
 214
 215 class WXDLLEXPORT wxSocketServer : public wxSocketBase
 216 {
 217   DECLARE_CLASS(wxSocketServer)
 218 public:
 219
 220   // 'service' can be a name or a port-number
 221
 222   wxSocketServer(wxSockAddress& addr_man, wxSockFlags flags = wxSocketBase::NONE);
 223
 224   wxSocketBase* Accept();
 225   bool AcceptWith(wxSocketBase& sock);
 226 };
 227
 228 ////////////////////////////////////////////////////////////////////////
 229
 230 class WXDLLEXPORT wxSocketClient : public wxSocketBase
 231 {
 232   DECLARE_CLASS(wxSocketClient)
 233 public:
 234
 235   wxSocketClient(wxSockFlags flags = wxSocketBase::NONE);
 236   virtual ~wxSocketClient();
 237
 238   virtual bool Connect(wxSockAddress& addr_man, bool wait = TRUE);
 239
 240   bool WaitOnConnect(long seconds = -1, long milliseconds = 0);
 241
 242   virtual void OnRequest(wxSocketNotify flags);
 243 };
 244
 245 class WXDLLEXPORT wxSocketEvent : public wxEvent {
 246   DECLARE_DYNAMIC_CLASS(wxSocketEvent)
 247 public:
 248   wxSocketEvent(int id = 0);
 249
 250   wxSocketNotify SocketEvent() const { return m_skevt; }
 251   wxSocketBase *Socket() const { return m_socket; }
 252
 253   void CopyObject(wxObject& obj_d) const;
 254
 255 public:
 256   wxSocketNotify m_skevt;
 257   wxSocketBase *m_socket;
 258 };
 259
 260 typedef void (wxEvtHandler::*wxSocketEventFunction)(wxSocketEvent&);
 261
 262 #define EVT_SOCKET(id, func) { wxEVT_SOCKET, id, -1, \
 263   (wxObjectEventFunction) (wxEventFunction) (wxSocketEventFunction) & func, \
 264   (wxObject *) NULL  },
 265
 266 #endif
 267   // wxUSE_SOCKETS
 268
 269 #endif
 270   // _WX_NETWORK_SOCKET_H