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