Domain.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Deutsches Elektronen-Synchrotron DESY, MSK, ChimeraTK Project <chimeratk-support@desy.de>
// SPDX-License-Identifier: LGPL-3.0-or-later
#pragma once
 
#include <boost/enable_shared_from_this.hpp>
#include <boost/shared_ptr.hpp>
 
#include <mutex>
 
namespace ChimeraTK::async {
 
  class Domain : public boost::enable_shared_from_this<Domain> {
   public:
    virtual void sendException(const std::exception_ptr& e) noexcept = 0;
    virtual void deactivate() = 0;
    virtual ~Domain() = default;
 
    std::lock_guard<std::mutex> getDomainLock() { return std::lock_guard<std::mutex>{_mutex}; }
 
   protected:
    // This mutex is protecting all members and all functions in Domain and DomainImpl
    std::mutex _mutex;
    bool _isActive{false};
 
    bool unsafeGetIsActive() const { return _isActive; }
 
    // The friend functions are only allowed to call unsafeGetIsActive(). They must not touch any of the
    // internal variables directly.
    friend class AsyncAccessorManager;
    friend class TriggeredPollDistributor;
    template<typename BackendSpecificDataType>
    friend class SubDomain;
    friend class MuxedInterruptDistributor;
 
    template<typename SourceType>
    friend class SourceTypedAsyncAccessorManager;
 
    template<typename UserType>
    friend class AsyncNDRegisterAccessor;
  };
} // namespace ChimeraTK::async