eventdispatcher.h

   1 /*
   2     Copyright 2007-2020 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, see <https://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef EVENTDISPATCHER_H
  21 #define EVENTDISPATCHER_H
  22
  23 #include <list>
  24 #include <mutex>
  25 #include <condition_variable>
  26
  27 #include "defines.h"
  28
  29 class EDReceiver
  30 {
  31   friend class EventDispatcher;
  32
  33   public:
  34     virtual ~EDReceiver() {};
  35
  36   protected:
  37     virtual void call(void* userTag, bool& r_deregisterEDR, bool& r_wakeThread, bool& deleteEDR)=0; // Implementor must override this and do the actual call
  38                            // In the call set the following bools:
  39                            // r_deregisterEDR: true = remove EDReceiver from list after call
  40                            // r_wakeThread: true = wake up a RequestResponse thread which is waiting for a VDR response
  41                            // r_deleteEDR: true = delete the EDReceiver object once the call has finished
  42     bool nomorecalls{};
  43     bool callinprogress{};
  44
  45     std::condition_variable cond;
  46 };
  47
  48 class EventDispatcher
  49 {
  50   public:
  51     typedef std::list<EDReceiver*> EDRL;
  52
  53     virtual ~EventDispatcher() {};
  54
  55   protected:
  56     void edRegister(EDReceiver* edr);
  57     void edUnregister(EDReceiver* edr);
  58     bool edFindAndCall(void* userTag);
  59     void edLock();
  60     void edUnlock();
  61     void edSleepThisReceiver(EDReceiver* edr);
  62
  63     // EventDispatcher implementor must override the following. When edFindAndCall is called,
  64     // The EventDispatcher class will call ed_cb_find() on each receiver until the implementor
  65     // returns true = this is the receiver to call.
  66     virtual bool ed_cb_find(EDReceiver* edr, void* userTag)=0;
  67
  68     EDRL receivers;
  69
  70     std::mutex edMutex;
  71 };
  72
  73 #endif