include/wx/socket.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        socket.h
   3 // Purpose:     Socket handling classes
   4 // Authors:     Guilhem Lavaux, Guillermo Rodriguez Garcia
   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_SOCKET_H_
  13 #define _WX_SOCKET_H_
  14
  15 #include "wx/defs.h"
  16
  17 #if wxUSE_SOCKETS
  18
  19 // ---------------------------------------------------------------------------
  20 // wxSocket headers
  21 // ---------------------------------------------------------------------------
  22
  23 #include "wx/event.h"
  24 #include "wx/sckaddr.h"
  25 #include "wx/gsocket.h"
  26 #include "wx/list.h"
  27
  28 // ------------------------------------------------------------------------
  29 // Types and constants
  30 // ------------------------------------------------------------------------
  31
  32 enum wxSocketNotify
  33 {
  34   wxSOCKET_INPUT = GSOCK_INPUT,
  35   wxSOCKET_OUTPUT = GSOCK_OUTPUT,
  36   wxSOCKET_CONNECTION = GSOCK_CONNECTION,
  37   wxSOCKET_LOST = GSOCK_LOST
  38 };
  39
  40 enum
  41 {
  42   wxSOCKET_INPUT_FLAG = GSOCK_INPUT_FLAG,
  43   wxSOCKET_OUTPUT_FLAG = GSOCK_OUTPUT_FLAG,
  44   wxSOCKET_CONNECTION_FLAG = GSOCK_CONNECTION_FLAG,
  45   wxSOCKET_LOST_FLAG = GSOCK_LOST_FLAG
  46 };
  47
  48 typedef GSocketEventFlags wxSocketEventFlags;
  49
  50 enum wxSocketError
  51 {
  52   // from GSocket
  53   wxSOCKET_NOERROR = GSOCK_NOERROR,
  54   wxSOCKET_INVOP = GSOCK_INVOP,
  55   wxSOCKET_IOERR = GSOCK_IOERR,
  56   wxSOCKET_INVADDR = GSOCK_INVADDR,
  57   wxSOCKET_INVSOCK = GSOCK_INVSOCK,
  58   wxSOCKET_NOHOST = GSOCK_NOHOST,
  59   wxSOCKET_INVPORT = GSOCK_INVPORT,
  60   wxSOCKET_WOULDBLOCK = GSOCK_WOULDBLOCK,
  61   wxSOCKET_TIMEDOUT = GSOCK_TIMEDOUT,
  62   wxSOCKET_MEMERR = GSOCK_MEMERR,
  63
  64   // wxSocket-specific (not yet implemented)
  65   wxSOCKET_DUMMY
  66 };
  67
  68 enum
  69 {
  70   wxSOCKET_NONE = 0,
  71   wxSOCKET_NOWAIT = 1,
  72   wxSOCKET_WAITALL = 2,
  73   wxSOCKET_BLOCK = 4,
  74   wxSOCKET_REUSEADDR = 8,
  75   wxSOCKET_BROADCAST = 16,
  76   wxSOCKET_NOBIND = 32
  77 };
  78
  79 enum wxSocketType
  80 {
  81   wxSOCKET_UNINIT,
  82   wxSOCKET_CLIENT,
  83   wxSOCKET_SERVER,
  84   wxSOCKET_BASE,
  85   wxSOCKET_DATAGRAM
  86 };
  87
  88 typedef int wxSocketFlags;
  89
  90
  91
  92 // --------------------------------------------------------------------------
  93 // wxSocketBase
  94 // --------------------------------------------------------------------------
  95
  96 class WXDLLIMPEXP_NET wxSocketBase : public wxObject
  97 {
  98   DECLARE_CLASS(wxSocketBase)
  99
 100 public:
 101
 102   // Public interface
 103   // ----------------
 104
 105   // ctors and dtors
 106   wxSocketBase();
 107   wxSocketBase(wxSocketFlags flags, wxSocketType type);
 108   virtual ~wxSocketBase();
 109   void Init();
 110   bool Destroy();
 111
 112   // state
 113   bool Ok() const { return IsOk(); }
 114   bool IsOk() const { return (m_socket != NULL); }
 115   bool Error() const { return m_error; }
 116   bool IsConnected() const { return m_connected; }
 117   bool IsData() { return WaitForRead(0, 0); }
 118   bool IsDisconnected() const { return !IsConnected(); }
 119   wxUint32 LastCount() const { return m_lcount; }
 120   wxSocketError LastError() const { return (wxSocketError)m_socket->GetError(); }
 121   void SaveState();
 122   void RestoreState();
 123
 124   // addresses
 125   virtual bool GetLocal(wxSockAddress& addr_man) const;
 126   virtual bool GetPeer(wxSockAddress& addr_man) const;
 127   virtual bool SetLocal(const wxIPV4address& local);
 128
 129   // base IO
 130   virtual bool  Close();
 131   wxSocketBase& Discard();
 132   wxSocketBase& Peek(void* buffer, wxUint32 nbytes);
 133   wxSocketBase& Read(void* buffer, wxUint32 nbytes);
 134   wxSocketBase& ReadMsg(void *buffer, wxUint32 nbytes);
 135   wxSocketBase& Unread(const void *buffer, wxUint32 nbytes);
 136   wxSocketBase& Write(const void *buffer, wxUint32 nbytes);
 137   wxSocketBase& WriteMsg(const void *buffer, wxUint32 nbytes);
 138
 139   void InterruptWait() { m_interrupt = true; }
 140   bool Wait(long seconds = -1, long milliseconds = 0);
 141   bool WaitForRead(long seconds = -1, long milliseconds = 0);
 142   bool WaitForWrite(long seconds = -1, long milliseconds = 0);
 143   bool WaitForLost(long seconds = -1, long milliseconds = 0);
 144
 145   wxSocketFlags GetFlags() const { return m_flags; }
 146   void SetFlags(wxSocketFlags flags);
 147   void SetTimeout(long seconds);
 148
 149   bool GetOption(int level, int optname, void *optval, int *optlen);
 150   bool SetOption(int level, int optname, const void *optval, int optlen);
 151   wxUint32 GetLastIOSize() const { return m_lcount; }
 152
 153   // event handling
 154   void *GetClientData() const { return m_clientData; }
 155   void SetClientData(void *data) { m_clientData = data; }
 156   void SetEventHandler(wxEvtHandler& handler, int id = wxID_ANY);
 157   void SetNotify(wxSocketEventFlags flags);
 158   void Notify(bool notify);
 159
 160   // initialize/shutdown the sockets (usually called automatically)
 161   static bool IsInitialized();
 162   static bool Initialize();
 163   static void Shutdown();
 164
 165
 166   // Implementation from now on
 167   // --------------------------
 168
 169   // do not use, should be private (called from GSocket)
 170   void OnRequest(wxSocketNotify notify);
 171
 172   // do not use, not documented nor supported
 173   bool IsNoWait() const { return ((m_flags & wxSOCKET_NOWAIT) != 0); }
 174   wxSocketType GetType() const { return m_type; }
 175
 176 private:
 177   friend class wxSocketClient;
 178   friend class wxSocketServer;
 179   friend class wxDatagramSocket;
 180
 181   // low level IO
 182   wxUint32 _Read(void* buffer, wxUint32 nbytes);
 183   wxUint32 _Write(const void *buffer, wxUint32 nbytes);
 184   bool     _Wait(long seconds, long milliseconds, wxSocketEventFlags flags);
 185
 186   // pushback buffer
 187   void     Pushback(const void *buffer, wxUint32 size);
 188   wxUint32 GetPushback(void *buffer, wxUint32 size, bool peek);
 189
 190 private:
 191   // socket
 192   GSocket      *m_socket;           // GSocket
 193   wxSocketType  m_type;             // wxSocket type
 194
 195   // state
 196   wxSocketFlags m_flags;            // wxSocket flags
 197   bool          m_connected;        // connected?
 198   bool          m_establishing;     // establishing connection?
 199   bool          m_reading;          // busy reading?
 200   bool          m_writing;          // busy writing?
 201   bool          m_error;            // did last IO call fail?
 202   wxUint32      m_lcount;           // last IO transaction size
 203   unsigned long m_timeout;          // IO timeout value
 204   wxList        m_states;           // stack of states
 205   bool          m_interrupt;        // interrupt ongoing wait operations?
 206   bool          m_beingDeleted;     // marked for delayed deletion?
 207   wxIPV4address m_localAddress;     // bind to local address?
 208
 209   // pushback buffer
 210   void         *m_unread;           // pushback buffer
 211   wxUint32      m_unrd_size;        // pushback buffer size
 212   wxUint32      m_unrd_cur;         // pushback pointer (index into buffer)
 213
 214   // events
 215   int           m_id;               // socket id
 216   wxEvtHandler *m_handler;          // event handler
 217   void         *m_clientData;       // client data for events
 218   bool          m_notify;           // notify events to users?
 219   wxSocketEventFlags  m_eventmask;  // which events to notify?
 220
 221   // the initialization count, GSocket is initialized if > 0
 222   static size_t m_countInit;
 223
 224   DECLARE_NO_COPY_CLASS(wxSocketBase)
 225 };
 226
 227
 228 // --------------------------------------------------------------------------
 229 // wxSocketServer
 230 // --------------------------------------------------------------------------
 231
 232 class WXDLLIMPEXP_NET wxSocketServer : public wxSocketBase
 233 {
 234   DECLARE_CLASS(wxSocketServer)
 235
 236 public:
 237   wxSocketServer(const wxSockAddress& addr, wxSocketFlags flags = wxSOCKET_NONE);
 238
 239   wxSocketBase* Accept(bool wait = true);
 240   bool AcceptWith(wxSocketBase& socket, bool wait = true);
 241
 242   bool WaitForAccept(long seconds = -1, long milliseconds = 0);
 243
 244   DECLARE_NO_COPY_CLASS(wxSocketServer)
 245 };
 246
 247
 248 // --------------------------------------------------------------------------
 249 // wxSocketClient
 250 // --------------------------------------------------------------------------
 251
 252 class WXDLLIMPEXP_NET wxSocketClient : public wxSocketBase
 253 {
 254   DECLARE_CLASS(wxSocketClient)
 255
 256 public:
 257   wxSocketClient(wxSocketFlags flags = wxSOCKET_NONE);
 258   virtual ~wxSocketClient();
 259
 260   virtual bool Connect(const wxSockAddress& addr, bool wait = true);
 261   bool Connect(const wxSockAddress& addr, const wxSockAddress& local,
 262                bool wait = true);
 263
 264   bool WaitOnConnect(long seconds = -1, long milliseconds = 0);
 265
 266   // Sets initial socket buffer sizes using the SO_SNDBUF and SO_RCVBUF options
 267   // before calling connect (either one can be -1 to leave it unchanged)
 268   void SetInitialSocketBuffers(int recv, int send)
 269   {
 270       m_initialRecvBufferSize = recv;
 271       m_initialSendBufferSize = send;
 272   }
 273
 274 private:
 275   virtual bool DoConnect(const wxSockAddress& addr,
 276                          const wxSockAddress* local,
 277                          bool wait = true);
 278
 279   // buffer sizes, -1 if unset and defaults should be used
 280   int m_initialRecvBufferSize;
 281   int m_initialSendBufferSize;
 282
 283   DECLARE_NO_COPY_CLASS(wxSocketClient)
 284 };
 285
 286
 287 // --------------------------------------------------------------------------
 288 // wxDatagramSocket
 289 // --------------------------------------------------------------------------
 290
 291 // WARNING: still in alpha stage
 292
 293 class WXDLLIMPEXP_NET wxDatagramSocket : public wxSocketBase
 294 {
 295   DECLARE_CLASS(wxDatagramSocket)
 296
 297 public:
 298   wxDatagramSocket(const wxSockAddress& addr, wxSocketFlags flags = wxSOCKET_NONE);
 299
 300   wxDatagramSocket& RecvFrom( wxSockAddress& addr,
 301                               void* buf,
 302                               wxUint32 nBytes );
 303   wxDatagramSocket& SendTo( const wxSockAddress& addr,
 304                             const void* buf,
 305                             wxUint32 nBytes );
 306
 307 /* TODO:
 308   bool Connect(wxSockAddress& addr);
 309 */
 310   DECLARE_NO_COPY_CLASS(wxDatagramSocket)
 311 };
 312
 313
 314 // --------------------------------------------------------------------------
 315 // wxSocketEvent
 316 // --------------------------------------------------------------------------
 317
 318 class WXDLLIMPEXP_NET wxSocketEvent : public wxEvent
 319 {
 320 public:
 321   wxSocketEvent(int id = 0)
 322       : wxEvent(id, wxEVT_SOCKET)
 323       {
 324       }
 325
 326   wxSocketNotify  GetSocketEvent() const { return m_event; }
 327   wxSocketBase   *GetSocket() const      { return (wxSocketBase *) GetEventObject(); }
 328   void           *GetClientData() const  { return m_clientData; }
 329
 330   virtual wxEvent *Clone() const { return new wxSocketEvent(*this); }
 331
 332 public:
 333   wxSocketNotify  m_event;
 334   void           *m_clientData;
 335
 336   DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSocketEvent)
 337 };
 338
 339
 340 typedef void (wxEvtHandler::*wxSocketEventFunction)(wxSocketEvent&);
 341
 342 #define wxSocketEventHandler(func) \
 343     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSocketEventFunction, &func)
 344
 345 #define EVT_SOCKET(id, func) \
 346     wx__DECLARE_EVT1(wxEVT_SOCKET, id, wxSocketEventHandler(func))
 347
 348 #endif // wxUSE_SOCKETS
 349
 350 #endif // _WX_SOCKET_H_
 351