IEventQueue.h

Go to the documentation of this file.

/*
 * Deskflow -- mouse and keyboard sharing utility
 * SPDX-FileCopyrightText: (C) 2025 Deskflow Developers
 * SPDX-FileCopyrightText: (C) 2012 - 2016 Symless Ltd.
 * SPDX-FileCopyrightText: (C) 2004 Chris Schoeneman
 * SPDX-License-Identifier: GPL-2.0-only WITH LicenseRef-OpenSSL-Exception
 */
 
#pragma once
 
#include "base/Event.h"
#include "base/EventTypes.h"
#include "common/IInterface.h"
 
#include <functional>
#include <string>
 
class IEventQueueBuffer;
 
// Opaque type for timer info.  This is defined by subclasses of
// IEventQueueBuffer.
class EventQueueTimer;


class IEventQueue : public IInterface
{
public:
  using EventHandler = std::function<void(const Event &)>;
  class TimerEvent
  {
  public:
    EventQueueTimer *m_timer; 
    uint32_t m_count;         
  };




  virtual void loop() = 0;


  virtual void adoptBuffer(IEventQueueBuffer *) = 0;


  virtual bool getEvent(Event &event, double timeout = -1.0) = 0;


  virtual bool dispatchEvent(const Event &event) = 0;


  virtual void addEvent(const Event &event) = 0;


  virtual EventQueueTimer *newTimer(double duration, void *target) = 0;


  virtual EventQueueTimer *newOneShotTimer(double duration, void *target) = 0;


  virtual void deleteTimer(EventQueueTimer *) = 0;


  virtual void addHandler(EventTypes type, void *target, const EventHandler &handler) = 0;


  virtual void removeHandler(EventTypes type, void *target) = 0;


  virtual void removeHandlers(void *target) = 0;


  virtual void waitForReady() const = 0;




  virtual bool isEmpty() const = 0;


  virtual void *getSystemTarget() = 0;

};