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