lintel 0.2.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
lintel::IHistoryService Class Referenceabstract

#include <IHistoryService.h>

Inheritance diagram for lintel::IHistoryService:
lintel::HistoryService lintel::NoopHistoryService

Public Member Functions

virtual ~IHistoryService ()=default
 
virtual void historizeOf (std::vector< HistoryEntry > entries)=0
 
virtual const std::string & getProcessName () const =0
 
virtual std::vector< HistoryEntry > allOf () const =0
 
virtual std::vector< HistoryEntry > allOf (const std::string &label) const =0
 
virtual std::vector< HistoryEntry > allOf (const std::string &processName, const std::string &serviceName) const =0
 
virtual std::vector< HistoryEntry > allOfProcess (const std::string &processName) const =0
 
virtual std::vector< HistoryEntry > allOfService (const std::string &serviceName) const =0
 

Detailed Description

Interface for the history service.

The real implementation (HistoryService) is only created in the process that the configuration explicitly declares as its owner. Every other process receives a NoopHistoryService so that services depending on this interface stay resolvable without ever running a history service.

Constructor & Destructor Documentation

◆ ~IHistoryService()

virtual lintel::IHistoryService::~IHistoryService ( )
virtualdefault

Member Function Documentation

◆ allOf() [1/3]

virtual std::vector< HistoryEntry > lintel::IHistoryService::allOf ( ) const
pure virtual
Returns
all history entries

Implemented in lintel::HistoryService, and lintel::NoopHistoryService.

◆ allOf() [2/3]

virtual std::vector< HistoryEntry > lintel::IHistoryService::allOf ( const std::string &  label) const
pure virtual
Parameters
labelfilter by label
Returns
matching entries

Implemented in lintel::NoopHistoryService, and lintel::HistoryService.

◆ allOf() [3/3]

virtual std::vector< HistoryEntry > lintel::IHistoryService::allOf ( const std::string &  processName,
const std::string &  serviceName 
) const
pure virtual
Parameters
processNamefilter by process name
serviceNamefilter by service name
Returns
matching entries

Implemented in lintel::NoopHistoryService, and lintel::HistoryService.

◆ allOfProcess()

virtual std::vector< HistoryEntry > lintel::IHistoryService::allOfProcess ( const std::string &  processName) const
pure virtual
Parameters
processNamefilter by process name
Returns
matching entries

Implemented in lintel::NoopHistoryService, and lintel::HistoryService.

◆ allOfService()

virtual std::vector< HistoryEntry > lintel::IHistoryService::allOfService ( const std::string &  serviceName) const
pure virtual
Parameters
serviceNamefilter by service name
Returns
matching entries

Implemented in lintel::NoopHistoryService, and lintel::HistoryService.

◆ getProcessName()

virtual const std::string & lintel::IHistoryService::getProcessName ( ) const
pure virtual
Returns
the process name of the owning process

Implemented in lintel::HistoryService, and lintel::NoopHistoryService.

◆ historizeOf()

virtual void lintel::IHistoryService::historizeOf ( std::vector< HistoryEntry >  entries)
pure virtual

Record history entries (may be queued for batch insert).

Parameters
entriesentries to record

Implemented in lintel::HistoryService, and lintel::NoopHistoryService.


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