include/wx/private/selectdispatcher.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/private/selectdispatcher.h
   3 // Purpose:     wxSelectDispatcher class
   4 // Authors:     Lukasz Michalski and Vadim Zeitlin
   5 // Created:     December 2006
   6 // Copyright:   (c) Lukasz Michalski
   7 // RCS-ID:      $Id$
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_PRIVATE_SELECTDISPATCHER_H_
  12 #define _WX_PRIVATE_SELECTDISPATCHER_H_
  13
  14 #include "wx/defs.h"
  15
  16 #if wxUSE_SELECT_DISPATCHER
  17
  18 #if defined(HAVE_SYS_SELECT_H) || defined(__WATCOMC__)
  19     #include <sys/time.h>
  20     #include <sys/select.h>
  21 #endif
  22
  23 #ifdef __WATCOMC__
  24     #include <types.h>
  25     #include <sys/ioctl.h>
  26     #include <tcpustd.h>
  27 #else
  28     #include <sys/types.h>
  29 #endif
  30
  31 #include "wx/private/fdiodispatcher.h"
  32
  33 // helper class storing all the select() fd sets
  34 class WXDLLIMPEXP_BASE wxSelectSets
  35 {
  36 public:
  37     // ctor zeroes out all fd_sets
  38     wxSelectSets();
  39
  40     // default copy ctor, assignment operator and dtor are ok
  41
  42
  43     // return true if fd appears in any of the sets
  44     bool HasFD(int fd) const;
  45
  46     // add or remove FD to our sets depending on whether flags contains
  47     // wxFDIO_INPUT/OUTPUT/EXCEPTION bits
  48     bool SetFD(int fd, int flags);
  49
  50     // same as SetFD() except it unsets the bits set in the flags for the given
  51     // fd
  52     bool ClearFD(int fd)
  53     {
  54         return SetFD(fd, 0);
  55     }
  56
  57
  58     // call select() with our sets: the other parameters are the same as for
  59     // select() itself
  60     int Select(int nfds, struct timeval *tv);
  61
  62     // call the handler methods corresponding to the sets having this fd if it
  63     // is present in any set and return true if it is
  64     bool Handle(int fd, wxFDIOHandler& handler) const;
  65
  66 private:
  67     typedef void (wxFDIOHandler::*Callback)();
  68
  69     // the FD sets indices
  70     enum
  71     {
  72         Read,
  73         Write,
  74         Except,
  75         Max
  76     };
  77
  78     // the sets used with select()
  79     fd_set m_fds[Max];
  80
  81     // the wxFDIO_XXX flags, functions and names (used for debug messages only)
  82     // corresponding to the FD sets above
  83     static int ms_flags[Max];
  84     static const char *ms_names[Max];
  85     static Callback ms_handlers[Max];
  86 };
  87
  88 class WXDLLIMPEXP_BASE wxSelectDispatcher : public wxMappedFDIODispatcher
  89 {
  90 public:
  91     // default ctor
  92     wxSelectDispatcher() { m_maxFD = -1; }
  93
  94     // implement pure virtual methods of the base class
  95     virtual bool RegisterFD(int fd, wxFDIOHandler *handler, int flags = wxFDIO_ALL);
  96     virtual bool ModifyFD(int fd, wxFDIOHandler *handler, int flags = wxFDIO_ALL);
  97     virtual bool UnregisterFD(int fd);
  98     virtual bool HasPending() const;
  99     virtual int Dispatch(int timeout = TIMEOUT_INFINITE);
 100
 101 private:
 102     // common part of RegisterFD() and ModifyFD()
 103     bool DoUpdateFDAndHandler(int fd, wxFDIOHandler *handler, int flags);
 104
 105     // call the handlers for the fds present in the given sets, return the
 106     // number of handlers we called
 107     int ProcessSets(const wxSelectSets& sets);
 108
 109     // helper of ProcessSets(): call the handler if its fd is in the set
 110     void DoProcessFD(int fd, const fd_set& fds, wxFDIOHandler *handler,
 111                      const char *name);
 112
 113     // common part of HasPending() and Dispatch(): calls select() with the
 114     // specified timeout
 115     int DoSelect(wxSelectSets& sets, int timeout) const;
 116
 117
 118     // the select sets containing all the registered fds
 119     wxSelectSets m_sets;
 120
 121     // the highest registered fd value or -1 if none
 122     int m_maxFD;
 123 };
 124
 125 #endif // wxUSE_SELECT_DISPATCHER
 126
 127 #endif // _WX_PRIVATE_SOCKETEVTDISPATCH_H_