IScheduler.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2025 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, 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.                                             *
\***********************************************************************************/
#pragma once
 
#include <GaudiKernel/EventContext.h>
#include <GaudiKernel/IInterface.h>
#include <chrono>
#include <functional>
#include <memory>
#include <vector>

class GAUDI_API IScheduler : virtual public IInterface {
public:
  DeclareInterfaceID( IScheduler, 1, 0 );

  virtual StatusCode pushNewEvent( EventContext* eventContext ) = 0;

  virtual StatusCode pushNewEvents( std::vector<EventContext*>& eventContexts ) = 0;

  virtual StatusCode popFinishedEvent( EventContext*& eventContext ) = 0;

  virtual StatusCode tryPopFinishedEvent( EventContext*& eventContext ) = 0;

  virtual unsigned int freeSlots() = 0;
 
  virtual void dumpState() {}

  virtual StatusCode scheduleEventView( const EventContext* sourceContext, const std::string& nodeName,
                                        std::unique_ptr<EventContext> viewContext ) = 0;

  struct OccupancySnapshot {
    std::chrono::system_clock::time_point time;
    std::vector<std::vector<int>>         states;
  };
  virtual void recordOccupancy( int samplePeriod, std::function<void( OccupancySnapshot )> callback ) = 0;
};