eventdispatcher.h

   1 /*
   2     Copyright 2007 Chris Tallon
   3
   4     This file is part of VOMP.
   5
   6     VOMP is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     VOMP is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with VOMP; if not, write to the Free Software
  18     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19 */
  20
  21 #ifndef EVENTDISPATCHER_H
  22 #define EVENTDISPATCHER_H
  23
  24 #include <stdio.h>
  25 #include <list>
  26
  27 #ifndef WIN32
  28 #include "threadp.h"
  29 #else
  30 #include "threadwin.h"
  31 #endif
  32
  33 #include "defines.h"
  34
  35 using namespace std;
  36
  37
  38 class EDReceiver //(implementation in eventdispatcher.cc)
  39 {
  40   friend class EventDispatcher;
  41
  42   public:
  43     EDReceiver();
  44     virtual ~EDReceiver();
  45
  46   protected:
  47     virtual bool call(void* userTag)=0; // Implementor must override this and do the actual call
  48                            // return true to have EventDispatcher remove receiver from list after call
  49     bool nomorecalls;
  50     bool callinprogress;
  51
  52 #ifndef WIN32
  53     pthread_cond_t cond;
  54 #else
  55     HANDLE cond;
  56 #endif
  57 };
  58
  59 class EventDispatcher
  60 {
  61
  62   public:
  63     typedef list<EDReceiver*> EDRL;
  64
  65     EventDispatcher();
  66     virtual ~EventDispatcher() {};
  67
  68   protected:
  69     void edRegister(EDReceiver* edr);
  70     void edUnregister(EDReceiver* edr);
  71     bool edFindAndCall(void* userTag);
  72     void edLock();
  73     void edUnlock();
  74     void edSleepThisReceiver(EDReceiver* edr);
  75
  76     // EventDispatcher implementor must override the following. When edFindAndCall is called,
  77     // The EventDispatcher class will call ed_cb_find() on each receiver until the implementor
  78     // returns true = this is the receiver to call.
  79     virtual bool ed_cb_find(EDReceiver* edr, void* userTag)=0;
  80
  81     EDRL receivers;
  82
  83 #ifndef WIN32
  84     pthread_mutex_t mutex;
  85 #else
  86     HANDLE mutex;
  87 #endif
  88 };
  89
  90 #endif