List-like structure for storing and retaining event backups. More...

#include <ProcessedEventsBackupList.h>

Collaboration diagram for ProcessedEventsBackupList:

[legend]

Public Member Functions
void	storeEvent (std::unique_ptr< EvtMessage > evtMsg, const StoreObjPtr< EventMetaData > &evtMetaData, const unsigned int workerId)
	Add a new event backup with the given information. Takes ownership of the evt message.

void	removeEvent (const EventMetaData &evtMetaData)
	Remove all backups with the given event meta data (on confirmation)

int	checkForTimeout (const Duration &timeout) const
	Check the items for timeout. Returns -1 if no timeout happened and the worker id, if it did.

template<class AZMQClient >
void	sendWorkerBackupEvents (unsigned int worker, const AZMQClient &socket)
	Send all backups of a given worker directly to the multicast and delete them.

unsigned int	size () const
	Check the size.

Private Types
using	Duration = std::chrono::milliseconds
	Short for the class of a duration (always measured in milliseconds)

Private Attributes
std::vector< ProcessedEventBackup >	m_evtBackupVector
	The vector where the event backups are stored.

Detailed Description

List-like structure for storing and retaining event backups.

Definition at line 24 of file ProcessedEventsBackupList.h.

Member Typedef Documentation

◆ Duration

using Duration = std::chrono::milliseconds

private

Short for the class of a duration (always measured in milliseconds)

Definition at line 26 of file ProcessedEventsBackupList.h.

Member Function Documentation

◆ checkForTimeout()

int checkForTimeout ( const Duration & timeout ) const

Check the items for timeout. Returns -1 if no timeout happened and the worker id, if it did.

Definition at line 31 of file ProcessedEventsBackupList.cc.

{
  if (m_evtBackupVector.empty()) {
    return -1;
  }
  if (std::chrono::system_clock::now() - m_evtBackupVector[0].getTimestamp() > timeout) {
    return m_evtBackupVector[0].getWorkerId();
  } else {
    return -1;
  }
}

◆ removeEvent()

void removeEvent ( const EventMetaData & evtMetaData )

Remove all backups with the given event meta data (on confirmation)

Definition at line 19 of file ProcessedEventsBackupList.cc.

{
  const auto oldSize = m_evtBackupVector.size();
 
  m_evtBackupVector.erase(std::remove(m_evtBackupVector.begin(), m_evtBackupVector.end(), evtMetaData),
                          m_evtBackupVector.end());
 
  if (oldSize == m_evtBackupVector.size()) {
    B2WARNING("Event: " << evtMetaData.getEvent() << ", no matching event backup found in backup list");
  }
}

◆ size()

unsigned int size ( ) const

Check the size.

Definition at line 43 of file ProcessedEventsBackupList.cc.

{
  return m_evtBackupVector.size();
}

◆ storeEvent()

void storeEvent	(	std::unique_ptr< EvtMessage >	evtMsg,
		const StoreObjPtr< EventMetaData > &	evtMetaData,
		const unsigned int	workerId
	)

Add a new event backup with the given information. Takes ownership of the evt message.

Definition at line 12 of file ProcessedEventsBackupList.cc.

{
  EventMetaData eventMetaData(evtMetaData->getEvent(), evtMetaData->getRun(), evtMetaData->getExperiment());
  m_evtBackupVector.emplace_back(std::move(evtMsg), eventMetaData, workerId);
}

Member Data Documentation

◆ m_evtBackupVector

std::vector<ProcessedEventBackup> m_evtBackupVector

private

The vector where the event backups are stored.

Definition at line 47 of file ProcessedEventsBackupList.h.

The documentation for this class was generated from the following files:

framework/pcore/zmq/processModules/include/ProcessedEventsBackupList.h
framework/pcore/zmq/processModules/src/ProcessedEventsBackupList.cc

Public Member Functions

Private Types

Private Attributes