IArchMultithread.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) 2002 Chris Schoeneman
 * SPDX-License-Identifier: GPL-2.0-only WITH LicenseRef-OpenSSL-Exception
 */
 
#pragma once
 
#include <cstdint>

class ArchCondImpl;

using ArchCond = ArchCondImpl *;

class ArchMutexImpl;

using ArchMutex = ArchMutexImpl *;

class ArchThreadImpl;

using ArchThread = ArchThreadImpl *;


class IArchMultithread
{
public:
  using ThreadFunc = void *(*)(void *);
  using ThreadID = unsigned int;
 
  virtual ~IArchMultithread() = default;

  enum class ThreadSignal : uint8_t
  {
    Interrupt, 
    Terminate, 
    Hangup,    
    User,      
    MaxSignals 
  };

  using SignalFunc = void (*)(ThreadSignal, void *userData);


 
  //
  // condition variable methods
  //


  virtual ArchCond newCondVar() = 0;

  virtual void closeCondVar(ArchCond) = 0;


  virtual void signalCondVar(ArchCond) = 0;


  virtual void broadcastCondVar(ArchCond) = 0;


  virtual bool waitCondVar(ArchCond, ArchMutex, double timeout) = 0;
 
  //
  // mutex methods
  //


  virtual ArchMutex newMutex() = 0;

  virtual void closeMutex(ArchMutex) = 0;

  virtual void lockMutex(ArchMutex) = 0;

  virtual void unlockMutex(ArchMutex) = 0;
 
  //
  // thread methods
  //


  virtual ArchThread newThread(ThreadFunc func, void *userData) = 0;


  virtual ArchThread newCurrentThread() = 0;


  virtual ArchThread copyThread(ArchThread thread) = 0;


  virtual void closeThread(ArchThread) = 0;


  virtual void cancelThread(ArchThread thread) = 0;


  virtual void setPriorityOfThread(ArchThread, int n) = 0;


  virtual void testCancelThread() = 0;


  virtual bool wait(ArchThread thread, double timeout) = 0;


  virtual bool isSameThread(ArchThread, ArchThread) = 0;


  virtual bool isExitedThread(ArchThread thread) = 0;


  virtual void *getResultOfThread(ArchThread thread) = 0;


  virtual ThreadID getIDOfThread(ArchThread thread) = 0;


  virtual void setSignalHandler(ThreadSignal, SignalFunc func, void *userData) = 0;


  virtual void raiseSignal(ThreadSignal signal) = 0;

};