WebdaqInfoSvc.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TRIGSERVICES_WEBDAQINFOSVC_H
#define TRIGSERVICES_WEBDAQINFOSVC_H
 
#include "AthenaBaseComps/AthService.h"
#include "GaudiKernel/IIncidentListener.h"
#include "CxxUtils/checker_macros.h"
 
#include "TrigServicesUtils.h"
 
#include "hltinterface/IInfoRegister.h"
 
#include <nlohmann/json_fwd.hpp>
 
#include <atomic>
#include <map>
#include <memory>
#include <mutex>
#include <string>
#include <thread>
#include <unordered_map>
#include <vector>
 
class TObject;
 
namespace hltinterface {
  class ContainerFactory;
  class GenericHLTContainer;
}

class WebdaqInfoSvc : public extends<AthService, IIncidentListener>,
                      public hltinterface::IInfoRegister
{
public:
  using base_class::base_class;
  virtual ~WebdaqInfoSvc() noexcept override {}
 
  virtual StatusCode initialize ATLAS_NOT_THREAD_SAFE () override;
  virtual StatusCode configure() override { return StatusCode::SUCCESS; }
  virtual StatusCode stop() override;
  virtual StatusCode finalize() override;
  virtual void handle(const Incident& incident) override;
 
  // ------------------------------------------------------------------------
  // hltinterface::IInfoRegister — IS
  // ------------------------------------------------------------------------
  virtual bool configure     (const boost::property_tree::ptree&) override { return true; }
  virtual bool prepareForRun (const boost::property_tree::ptree&) override { return true; }
  virtual bool prepareWorker (const boost::property_tree::ptree&) override { return true; }
  virtual bool finalizeWorker(const boost::property_tree::ptree&) override { return true; }
  virtual bool finalize      (const boost::property_tree::ptree&) override { return true; }
 
  // The by-value strings below are imposed by the hltinterface::IInfoRegister base class.
  // cppcheck-suppress passedByValue; signature fixed by hltinterface::IInfoRegister
  virtual bool registerObject(const std::string publishPath,
                              std::shared_ptr<hltinterface::GenericHLTContainer> obj) override;
  // cppcheck-suppress passedByValue; signature fixed by hltinterface::IInfoRegister
  virtual bool releaseObject (const std::string fullName) override;
  virtual bool pullInfo      (const std::string&, const std::string&) override { NOSUPPORT(DEBUG, "pullInfo"); }
 
  virtual bool beginEvent(const boost::property_tree::ptree&) override { return true; }
  virtual bool endEvent  (const boost::property_tree::ptree&) override;
 
  virtual std::vector<std::shared_ptr<hltinterface::GenericHLTContainer>>
       queryISRegistry(const std::string&) override { NOSUPPORT(DEBUG, "queryISRegistry"); }
 
  // ------------------------------------------------------------------------
  // hltinterface::IInfoRegister — Histograms (handled by WebdaqHistSvc, unsupported).
  // ------------------------------------------------------------------------
  virtual void get        (const std::string&, THList&) override { NOSUPPORT_VOID(DEBUG, "Histogram retrieval"); }
  virtual void getUnsummed(const std::string&,
                           std::map<std::string, std::vector<TObject*>>&) override { NOSUPPORT_VOID(DEBUG, "Histogram retrieval"); }
  virtual void clear      (const std::string&) override { NOSUPPORT_VOID(DEBUG, "Histogram clearing"); }
  virtual void reset      (const std::string&) override { NOSUPPORT_VOID(DEBUG, "Histogram reset"); }
 
  virtual bool registerTObject (const std::string&, const std::string&, TObject*) override { NOSUPPORT(WARNING, "Histogram registration"); }
  virtual bool discoverTObject (const std::string&, const std::string&, TObject*&) override { NOSUPPORT(WARNING, "Histogram discovery"); }
  virtual bool releaseTObject  (const std::string&, const std::string&) override { NOSUPPORT(WARNING, "Histogram release"); }
  virtual void clearToRelease  (const std::string&) override { NOSUPPORT_VOID(DEBUG, "Histogram release"); }

  virtual mutex_type& getPublicationMutex() const override {
    // We want to give non-const access through a const interface (IInfoRegister declares this const) --> need annotated local
    mutex_type& mtx ATLAS_THREAD_SAFE = m_pubMutex;
    return mtx;
  }
  virtual void setModification(bool b) override { p_setModification(b); }
 
private:
  struct Holder;

  void publishingTask() const;
  bool publishOne(Holder& h) const;
  static nlohmann::json serializeContainer(hltinterface::GenericHLTContainer& cont);
  std::vector<std::shared_ptr<Holder>> holders() const;

  std::shared_ptr<hltinterface::ContainerFactory> m_factory;

  std::unordered_map<std::string, std::shared_ptr<Holder>> m_objs;
  mutable std::mutex m_objsMtx;

  std::thread       m_thread;
  std::atomic<bool> m_stopFlag{false};
 
  std::string m_partition;
  std::string m_tdaqWebdaqBase;
  std::string m_tdaqIsServerName;

  mutable std::mutex m_pubMutex;
 
  Gaudi::Property<std::string> m_isServerName{this, "ISServerName", "DF",
      "Name of the IS server to publish to (used if TDAQ_IS_SERVER unset)"};
  Gaudi::Property<unsigned int> m_intervalSeconds{this, "IntervalSeconds", 10,
      "Period between publication cycles (s)"};
};
 
#endif // TRIGSERVICES_WEBDAQINFOSVC_H