DeviceBackendImpl.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 "async/DomainsContainer.h"
#include "DeviceBackend.h"
#include "Exception.h"
 
#include <ChimeraTK/cppext/finally.hpp>
 
#include <atomic>
#include <condition_variable>
#include <list>
#include <mutex>
#include <shared_mutex>
 
namespace ChimeraTK {
 
  /********************************************************************************************************************/
 
  class DeviceBackendImpl : public DeviceBackend {
   public:
    bool isOpen() override { return _opened; }
 
    bool isConnected() final {
      std::cerr << "Removed function DeviceBackendImpl::isConnected() called." << std::endl;
      std::cerr << "Do not use. This function has no valid meaning." << std::endl;
      std::terminate();
    }
 
    MetadataCatalogue getMetadataCatalogue() const override { return {}; }
 
    virtual void setExceptionImpl() noexcept {}
 
    void checkActiveException() final;
 
    void setException(const std::string& message) noexcept final;
 
    bool isFunctional() const noexcept final;
 
    std::string getActiveExceptionMessage() noexcept;
    std::set<DeviceBackend::BackendID> getInvolvedBackendIDs() override;
 
   protected:
    void setOpenedAndClearException() noexcept;
 
    std::atomic<bool> _opened{false};
 
    async::DomainsContainer _asyncDomainsContainer;
 
   private:
    std::atomic<bool> _hasActiveException{false};
 
    std::string _activeExceptionMessage;
 
    std::mutex _mx_activeExceptionMessage;
  };
 
  /********************************************************************************************************************/
 
  // This function is rather often called and hence implemented as inline in the header for performance reasons.
  inline bool DeviceBackendImpl::isFunctional() const noexcept {
    if(!_opened) return false;
    if(_hasActiveException) return false;
    return true;
  }
 
  /********************************************************************************************************************/
 
  // This function is rather often called and hence implemented as inline in the header for performance reasons.
  inline void DeviceBackendImpl::checkActiveException() {
    if(_hasActiveException) {
      std::lock_guard<std::mutex> lk(_mx_activeExceptionMessage);
      throw ChimeraTK::runtime_error(_activeExceptionMessage);
    }
  }
 
  /********************************************************************************************************************/
 
} // namespace ChimeraTK