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 #include <sys/types.h>
  17
  18 #include "wx/private/fdiodispatcher.h"
  19
  20 // helper class storing all the select() fd sets
  21 class WXDLLIMPEXP_BASE wxSelectSets
  22 {
  23 public:
  24     // ctor zeroes out all fd_sets
  25     wxSelectSets();
  26
  27     // default copy ctor, assignment operator and dtor are ok
  28
  29
  30     // return true if fd appears in any of the sets
  31     bool HasFD(int fd) const;
  32
  33     // add or remove FD to our sets depending on whether flags contains
  34     // wxFDIO_INPUT/OUTPUT/EXCEPTION bits
  35     bool SetFD(int fd, int flags);
  36
  37     // same as SetFD() except it unsets the bits set in the flags for the given
  38     // fd
  39     bool ClearFD(int fd, int flags)
  40     {
  41         return SetFD(fd, wxFDIO_ALL & ~flags);
  42     }
  43
  44
  45     // call select() with our sets: the other parameters are the same as for
  46     // select() itself
  47     int Select(int nfds, struct timeval *tv);
  48
  49     // call the handler methods corresponding to the sets having this fd
  50     void Handle(int fd, wxFDIOHandler& handler) const;
  51
  52 private:
  53     typedef void (wxFDIOHandler::*Callback)();
  54
  55     // the FD sets indices
  56     enum
  57     {
  58         Read,
  59         Write,
  60         Except,
  61         Max
  62     };
  63
  64     // the sets used with select()
  65     fd_set m_fds[Max];
  66
  67     // the wxFDIO_XXX flags, functions and names (used for debug messages only)
  68     // corresponding to the FD sets above
  69     static int ms_flags[Max];
  70     static const char *ms_names[Max];
  71     static Callback ms_handlers[Max];
  72 };
  73
  74 class WXDLLIMPEXP_BASE wxSelectDispatcher : public wxMappedFDIODispatcher
  75 {
  76 public:
  77     // returns the unique instance of this class, the pointer shouldn't be
  78     // deleted and is normally never NULL
  79     static wxSelectDispatcher *Get();
  80
  81     // if we have any registered handlers, check for any pending events to them
  82     // and dispatch them -- this is used from wxX11 and wxDFB event loops
  83     // implementation
  84     static void DispatchPending();
  85
  86     // implement pure virtual methods of the base class
  87     virtual bool RegisterFD(int fd, wxFDIOHandler *handler, int flags = wxFDIO_ALL);
  88     virtual bool ModifyFD(int fd, wxFDIOHandler *handler, int flags = wxFDIO_ALL);
  89     virtual bool UnregisterFD(int fd, int flags = wxFDIO_ALL);
  90     virtual void RunLoop(int timeout = TIMEOUT_INFINITE);
  91
  92 protected:
  93     wxSelectDispatcher();
  94
  95 private:
  96     // common part of RegisterFD() and ModifyFD()
  97     bool DoUpdateFDAndHandler(int fd, wxFDIOHandler *handler, int flags);
  98
  99     // call the handlers for the fds present in the given sets
 100     void ProcessSets(const wxSelectSets& sets);
 101
 102     // helper of ProcessSets(): call the handler if its fd is in the set
 103     void DoProcessFD(int fd, const fd_set& fds, wxFDIOHandler *handler,
 104                      const char *name);
 105
 106
 107     // the select sets containing all the registered fds
 108     wxSelectSets m_sets;
 109
 110     // the highest registered fd value or -1 if none
 111     int m_maxFD;
 112 };
 113
 114
 115 #endif // _WX_PRIVATE_SOCKETEVTDISPATCH_H_