StreamContext.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_STREAMCONTEXT_H_
#define O2_FRAMEWORK_STREAMCONTEXT_H_
 
#include "Framework/DataRelayer.h"
#include "Framework/ServiceHandle.h"
#include "ProcessingContext.h"
#include "ServiceSpec.h"
#include <functional>
 
namespace o2::framework
{
 
struct ProcessingContext;
 
struct StreamContext {
  constexpr static ServiceKind service_kind = ServiceKind::Stream;
 
  // Invoked once per stream before we start processing
  // They are all guaranteed to be invoked before the PreRun
  // function terminates.
  // Notice this will mean that a StreamService which has
  // a start callback might be created upfront.
  void preStartStreamCallbacks(ServiceRegistryRef);
 
  void preProcessingCallbacks(ProcessingContext& pcx);
  void finaliseOutputsCallbacks(ProcessingContext&);
  void postProcessingCallbacks(ProcessingContext& pcx);
 
  void preEOSCallbacks(EndOfStreamContext& eosContext);
  void postEOSCallbacks(EndOfStreamContext& eosContext);
 
  std::vector<ServiceProcessingHandle> preProcessingHandles;
  std::vector<ServiceProcessingHandle> finaliseOutputsHandles;
  std::vector<ServiceProcessingHandle> postProcessingHandles;
 
  std::vector<ServiceEOSHandle> preEOSHandles;
  std::vector<ServiceEOSHandle> postEOSHandles;
 
  // Callbacks for services to be executed before a stream starts processing
  // Notice that in such a case all the services will be created upfront, so
  // the callback will be called for all of them.
  std::vector<ServiceStartStreamHandle> preStartStreamHandles;
 
  std::vector<DataRelayer::RecordAction> completed;
 
  // Information on wether or not all the required routes have been created.
  // This is used to check if the LifetimeTimeframe routes were all created
  // for a given iteration.
  // This is in the stream context to allow tracking data creation on a per thread
  // basis.
  std::vector<bool> routeDPLCreated;
  std::vector<bool> routeCreated;
};
 
} // namespace o2::framework
 
#endif // O2_FRAMEWORK_DATAPROCESSINGCONTEXT_H_