edm::TimeoutPoolOutputModule Class Reference

#include <TimeoutPoolOutputModule.h>

Inheritance diagram for edm::TimeoutPoolOutputModule:

Public Member Functions
TimeoutPoolOutputModule &	operator= (TimeoutPoolOutputModule const &)=delete
	TimeoutPoolOutputModule (ParameterSet const &ps)
	TimeoutPoolOutputModule (TimeoutPoolOutputModule const &)=delete
	~TimeoutPoolOutputModule () override
Public Member Functions inherited from edm::PoolOutputModule
AuxItemArray const &	auxItems () const
std::string const &	basketOrder () const
int	basketSize () const
BranchChildren const &	branchChildren () const
std::string const &	catalog () const
bool	compactEventAuxiliary () const
std::string const &	compressionAlgorithm () const
int	compressionLevel () const
std::string const &	currentFileName () const
DropMetaData const &	dropMetaData () const
int	eventAutoFlushSize () const
int	eventAuxiliaryBasketSize () const
std::string const &	fileName () const
int	inputFileCount () const
std::string const &	logicalFileName () const
unsigned int	maxFileSize () const
bool	mergeJob () const
std::string const &	moduleLabel () const
PoolOutputModule &	operator= (PoolOutputModule const &)=delete
bool	overrideInputFileSplitLevels () const
	PoolOutputModule (ParameterSet const &ps)
	PoolOutputModule (PoolOutputModule const &)=delete
std::vector< OutputItemList > const &	selectedOutputItemList () const
std::vector< OutputItemList > &	selectedOutputItemList ()
int	splitLevel () const
int	treeMaxVirtualSize () const
int	whyNotFastClonable () const
	~PoolOutputModule () override
Public Member Functions inherited from edm::one::OutputModule< WatchInputFiles >
SerialTaskQueue *	globalLuminosityBlocksQueue () final
SerialTaskQueue *	globalRunsQueue () final
const OutputModule &	operator= (const OutputModule &)=delete
	OutputModule (edm::ParameterSet const &iPSet)
	OutputModule (const OutputModule &)=delete
bool	wantsGlobalLuminosityBlocks () const final
bool	wantsGlobalRuns () const final
bool	wantsInputProcessBlocks () const final
bool	wantsProcessBlocks () const final
Public Member Functions inherited from edm::one::OutputModuleBase
OutputModuleBase &	operator= (OutputModuleBase const &)=delete
	OutputModuleBase (ParameterSet const &pset)
	OutputModuleBase (OutputModuleBase const &)=delete
SharedResourcesAcquirer &	sharedResourcesAcquirer ()
SubProcessParentageHelper const *	subProcessParentageHelper () const
bool	wantsStreamLuminosityBlocks () const
bool	wantsStreamRuns () const
Public Member Functions inherited from edm::core::OutputModuleCore
BranchIDLists const *	branchIDLists () const
std::array< bool, NumBranchTypes > const &	hasNewlyDroppedBranch () const
SelectedProductsForBranchType const &	keptProducts () const
int	maxEvents () const
const ModuleDescription &	moduleDescription () const
OutputModuleCore &	operator= (OutputModuleCore const &)=delete
	OutputModuleCore (ParameterSet const &pset)
	OutputModuleCore (OutputModuleCore const &)=delete
OutputProcessBlockHelper const &	outputProcessBlockHelper () const
std::string const &	processName () const
int	remainingEvents () const
bool	selected (BranchDescription const &desc) const
void	selectProducts (ProductRegistry const &preg, ThinnedAssociationsHelper const &, ProcessBlockHelperBase const &)
ThinnedAssociationsHelper const *	thinnedAssociationsHelper () const
bool	wantAllEvents () const
	~OutputModuleCore () override
Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const
void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...
	EDConsumerBase ()
	EDConsumerBase (EDConsumerBase const &)=delete
	EDConsumerBase (EDConsumerBase &&)=default
ESProxyIndex const *	esGetTokenIndices (edm::Transition iTrans) const
std::vector< ESProxyIndex > const &	esGetTokenIndicesVector (edm::Transition iTrans) const
std::vector< ESRecordIndex > const &	esGetTokenRecordIndicesVector (edm::Transition iTrans) const
ProductResolverIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
std::vector< ProductResolverIndexAndSkipBit > const &	itemsToGetFrom (BranchType iType) const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	modulesWhoseProductsAreConsumed (std::array< std::vector< ModuleDescription const *> *, NumBranchTypes > &modulesAll, std::vector< ModuleProcessName > &modulesInPreviousProcesses, ProductRegistry const &preg, std::map< std::string, ModuleDescription const *> const &labelsToDesc, std::string const &processName) const
EDConsumerBase const &	operator= (EDConsumerBase const &)=delete
EDConsumerBase &	operator= (EDConsumerBase &&)=default
bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
void	selectInputProcessBlocks (ProductRegistry const &productRegistry, ProcessBlockHelperBase const &processBlockHelperBase)
ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const
void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)
virtual	~EDConsumerBase () noexcept(false)

Static Public Member Functions
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
Static Public Member Functions inherited from edm::PoolOutputModule
static void	fillDescription (ParameterSetDescription &desc)
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
Static Public Member Functions inherited from edm::core::OutputModuleCore
static const std::string &	baseType ()
static void	fillDescription (ParameterSetDescription &desc, std::vector< std::string > const &iDefaultOutputCommands=ProductSelectorRules::defaultSelectionStrings())
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &)

Protected Member Functions
bool	shouldWeCloseFile () const override
	allow inheriting classes to override but still be able to call this method in the overridden version More...
void	write (EventForOutput const &e) override
Protected Member Functions inherited from edm::PoolOutputModule
virtual void	doExtrasAfterCloseFile ()
virtual std::pair< std::string, std::string >	physicalAndLogicalNameForNewFile ()
Protected Member Functions inherited from edm::one::OutputModuleBase
void	configure (OutputModuleDescription const &desc)
void	doBeginJob ()
bool	doEvent (EventTransitionInfo const &, ActivityRegistry *, ModuleCallingContext const *)
void	doPreallocate (PreallocationConfiguration const &)
Protected Member Functions inherited from edm::core::OutputModuleCore
void	configure (OutputModuleDescription const &desc)
ModuleDescription const &	description () const
void	doAccessInputProcessBlock (ProcessBlockPrincipal const &, ModuleCallingContext const *)
void	doBeginJob_ ()
bool	doBeginLuminosityBlock (LumiTransitionInfo const &, ModuleCallingContext const *)
void	doBeginProcessBlock (ProcessBlockPrincipal const &, ModuleCallingContext const *)
bool	doBeginRun (RunTransitionInfo const &, ModuleCallingContext const *)
void	doEndJob ()
bool	doEndLuminosityBlock (LumiTransitionInfo const &, ModuleCallingContext const *)
void	doEndProcessBlock (ProcessBlockPrincipal const &, ModuleCallingContext const *)
bool	doEndRun (RunTransitionInfo const &, ModuleCallingContext const *)
bool	doEvent_ (EventTransitionInfo const &, ActivityRegistry *, ModuleCallingContext const *)
void	doPreallocate_ (PreallocationConfiguration const &)
std::map< BranchID::value_type, BranchID::value_type > const &	droppedBranchIDToKeptBranchID ()
virtual void	preallocLumis (unsigned int)
ParameterSetID	selectorConfig () const
void	setEventSelectionInfo (std::map< std::string, std::vector< std::pair< std::string, int >>> const &outputModulePathPositions, bool anyProductProduced)
Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)
template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept
EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)
template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)
ConsumesCollector	consumesCollector ()
	Use a ConsumesCollector to gather consumes information from helper functions. More...
template<typename ProductType , BranchType B = InEvent>
void	consumesMany ()
void	consumesMany (const TypeToGet &id)
template<BranchType B>
void	consumesMany (const TypeToGet &id)
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)
template<Transition Tr = Transition::Event>
constexpr auto	esConsumes ()
template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag)
template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
void	resetItemsToGetFrom (BranchType iType)

Private Attributes
unsigned int	eventsWrittenInCurrentFile
time_t	m_lastEvent
int	m_timeout

Additional Inherited Members
Public Types inherited from edm::PoolOutputModule
using	AuxItemArray = std::array< AuxItem, numberOfRunLumiEventProductTrees >
enum	DropMetaData { DropNone, DropDroppedPrior, DropPrior, DropAll }
using	OutputItemList = std::vector< OutputItem >
Public Types inherited from edm::one::OutputModuleBase
typedef OutputModuleBase	ModuleType
Public Types inherited from edm::core::OutputModuleCore
typedef OutputModuleCore	ModuleType
Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels
Protected Attributes inherited from edm::core::OutputModuleCore
std::atomic< int >	remainingEvents_

Detailed Description

Definition at line 23 of file TimeoutPoolOutputModule.h.

Constructor & Destructor Documentation

TimeoutPoolOutputModule() [1/2]

edm::TimeoutPoolOutputModule::TimeoutPoolOutputModule ( ParameterSet const &  ps )

explicit

Definition at line 13 of file TimeoutPoolOutputModule.cc.

      : edm::one::OutputModuleBase::OutputModuleBase(ps),
        PoolOutputModule(ps),
        m_lastEvent(time(nullptr)),
        eventsWrittenInCurrentFile(0),
        m_timeout(-1)  // we want the first event right away
  {}

~TimeoutPoolOutputModule()

edm::TimeoutPoolOutputModule::~TimeoutPoolOutputModule ( )

inlineoverride

Definition at line 26 of file TimeoutPoolOutputModule.h.

{};

TimeoutPoolOutputModule() [2/2]

edm::TimeoutPoolOutputModule::TimeoutPoolOutputModule ( TimeoutPoolOutputModule const &  )

delete

Member Function Documentation

fillDescriptions()

void edm::TimeoutPoolOutputModule::fillDescriptions ( ConfigurationDescriptions &  descriptions )

static

Definition at line 21 of file TimeoutPoolOutputModule.cc.

References edm::ConfigurationDescriptions::add(), submitPVResolutionJobs::desc, and edm::PoolOutputModule::fillDescription().

                                                                                        {
    ParameterSetDescription desc;
    PoolOutputModule::fillDescription(desc);
    descriptions.add("TimeoutPoolOutputModule", desc);
  }

operator=()

TimeoutPoolOutputModule& edm::TimeoutPoolOutputModule::operator= ( TimeoutPoolOutputModule const &  )

delete

shouldWeCloseFile()

bool edm::TimeoutPoolOutputModule::shouldWeCloseFile ( ) const

overrideprotectedvirtual

allow inheriting classes to override but still be able to call this method in the overridden version

Reimplemented from edm::PoolOutputModule.

Definition at line 27 of file TimeoutPoolOutputModule.cc.

References edm::PoolOutputModule::currentFileName(), eventsWrittenInCurrentFile, m_lastEvent, m_timeout, submitPVValidationJobs::now, edm::PoolOutputModule::shouldWeCloseFile(), and protons_cff::time.

                                                        {
    time_t now(time(nullptr));
    if (PoolOutputModule::shouldWeCloseFile()) {
      edm::LogVerbatim("TimeoutPoolOutputModule")
          << " Closing file " << currentFileName() << " with " << eventsWrittenInCurrentFile << " events.";
      eventsWrittenInCurrentFile = 0;
      m_lastEvent = now;
      return true;
    }
    //    std::cout <<" Events "<< eventsWrittenInCurrentFile<<" time "<< now - m_lastEvent<<std::endl;
    if (eventsWrittenInCurrentFile == 0)
      return false;
    if (now - m_lastEvent < m_timeout)
      return false;
    // next files are needed in 15, 30 and 60 sec
    m_lastEvent = now;
    if (m_timeout == 30)
      m_timeout = 60;
    if (m_timeout == 15)
      m_timeout = 30;
    if (m_timeout == -1)
      m_timeout = 15;

    edm::LogVerbatim("TimeoutPoolOutputModule")
        << " Closing file " << currentFileName() << " with " << eventsWrittenInCurrentFile << " events.";
    eventsWrittenInCurrentFile = 0;
    return true;
  }

write()

void edm::TimeoutPoolOutputModule::write ( EventForOutput const &  e )

overrideprotectedvirtual

Reimplemented from edm::PoolOutputModule.

Definition at line 8 of file TimeoutPoolOutputModule.cc.

References MillePedeFileConverter_cfg::e, eventsWrittenInCurrentFile, and edm::PoolOutputModule::write().

                                                             {
    eventsWrittenInCurrentFile++;
    PoolOutputModule::write(e);
  }

Member Data Documentation

eventsWrittenInCurrentFile

unsigned int edm::TimeoutPoolOutputModule::eventsWrittenInCurrentFile

mutableprivate

Definition at line 38 of file TimeoutPoolOutputModule.h.

Referenced by shouldWeCloseFile(), and write().

m_lastEvent

time_t edm::TimeoutPoolOutputModule::m_lastEvent

mutableprivate

Definition at line 37 of file TimeoutPoolOutputModule.h.

Referenced by shouldWeCloseFile().

m_timeout

int edm::TimeoutPoolOutputModule::m_timeout

mutableprivate

Definition at line 39 of file TimeoutPoolOutputModule.h.

Referenced by shouldWeCloseFile().