ControlService.h

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
#ifndef O2_FRAMEWORK_CONTROLSERVICE_H_
#define O2_FRAMEWORK_CONTROLSERVICE_H_
 
#include "Framework/ThreadSafetyAnalysis.h"
#include "Framework/ServiceRegistryRef.h"
#include "Framework/ServiceHandle.h"
#include <mutex>
 
namespace o2::framework
{
 
struct ServiceRegistry;
struct DeviceState;
struct DriverClient;
 
enum struct StreamingState : int;
 
enum struct QuitRequest {
  Me = 0,
  All = 1,
};
 
class ControlService
{
 public:
  constexpr static ServiceKind service_kind = ServiceKind::Global;
 
  ControlService(ServiceRegistryRef registry, DeviceState& deviceState);
  void readyToQuit(bool all) { this->readyToQuit(all ? QuitRequest::All : QuitRequest::Me); }
  void readyToQuit(QuitRequest kind);
  void endOfStream();
  void notifyStreamingState(StreamingState state);
  void push(std::string_view key, std::string_view value, int64_t timestamp);
  void notifyDeviceState(std::string state);
 
 private:
  bool mOnce = false;
  ServiceRegistryRef mRegistry;
  DeviceState& mDeviceState O2_DPL_GUARDED_BY(mMutex);
  DriverClient& mDriverClient O2_DPL_GUARDED_BY(mMutex);
  std::mutex mMutex;
};
 
} // namespace o2::framework
#endif // O2_FRAMEWORK_CONTROLSERVICE_H_