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