IEventQueueBuffer.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 <assert.h>
#include <cstdint>
 
class Event;
class EventQueueTimer;


class IEventQueueBuffer
{
public:
  virtual ~IEventQueueBuffer() = default;
  enum class Type : uint8_t
  {
    Unknown, 
    System,  
    User     
  };




  virtual void init() = 0;


  virtual void waitForEvent(double timeout) = 0;


  virtual Type getEvent(Event &event, uint32_t &dataID) = 0;


  virtual bool addEvent(uint32_t dataID) = 0;




  virtual bool isEmpty() const = 0;


  virtual EventQueueTimer *newTimer(double duration, bool oneShot) const = 0;


  virtual void deleteTimer(EventQueueTimer *) const = 0;

};