InertMessageSvc Class Reference

Thread safe extension to the standard MessageSvc. More...

#include <MessageSvc/InertMessageSvc.h>

Inheritance diagram for InertMessageSvc:
Collaboration diagram for InertMessageSvc:

Public Member Functions

 InertMessageSvc (const std::string &name, ISvcLocator *pSvcLocator)
 Standard constructor. More...
 
virtual ~InertMessageSvc ()
 Destructor. More...
 
virtual StatusCode initialize ()
 Initialization of the service. More...
 
virtual StatusCode finalize ()
 Finalization of the service. More...
 
virtual void reportMessage (const Message &msg)
 Implementation of IMessageSvc::reportMessage() More...
 
virtual void reportMessage (const Message &msg, int outputLevel)
 Implementation of IMessageSvc::reportMessage() More...
 
virtual void reportMessage (const StatusCode &code, const std::string &source="")
 Implementation of IMessageSvc::reportMessage() More...
 
- Public Member Functions inherited from MessageSvc
 MessageSvc (const std::string &name, ISvcLocator *svcloc)
 
 ~MessageSvc () override=default
 
StatusCode reinitialize () override
 Reinitialize Service. More...
 
StatusCode initialize () override
 Initialize Service. More...
 
StatusCode finalize () override
 Finalize Service. More...
 
void reportMessage (const Message &message) override
 
void reportMessage (const Message &msg, int outputLevel) override
 
void reportMessage (const StatusCode &code, const std::string &source="") override
 
void reportMessage (const char *source, int type, const char *message) override
 
void reportMessage (const std::string &source, int type, const std::string &message) override
 
void insertMessage (const StatusCode &code, const Message &message) override
 
void eraseMessage () override
 
void eraseMessage (const StatusCode &code) override
 
void eraseMessage (const StatusCode &code, const Message &message) override
 
void insertStream (int message_type, const std::string &name, std::ostream *stream) override
 
void eraseStream () override
 
void eraseStream (int message_type) override
 
void eraseStream (int message_type, std::ostream *stream) override
 
void eraseStream (std::ostream *stream) override
 
std::ostreamdefaultStream () const override
 
void setDefaultStream (std::ostream *stream) override
 
int outputLevel () const override
 
int outputLevel (const std::string &source) const override
 
void setOutputLevel (int new_level) override
 
void setOutputLevel (const std::string &source, int new_level) override
 
bool useColor () const override
 
std::string getLogColor (int logLevel) const override
 
int messageCount (MSG::Level logLevel) const override
 
void incrInactiveCount (MSG::Level level, const std::string &src) override
 
- Public Member Functions inherited from extends< Service, IMessageSvc, IInactiveMessageCounter >
void * i_cast (const InterfaceID &tid) const override
 Implementation of IInterface::i_cast. More...
 
StatusCode queryInterface (const InterfaceID &ti, void **pp) override
 Implementation of IInterface::queryInterface. More...
 
std::vector< std::stringgetInterfaceNames () const override
 Implementation of IInterface::getInterfaceNames. More...
 
 ~extends () override=default
 Virtual destructor. More...
 
- Public Member Functions inherited from Service
const std::stringname () const override
 Retrieve name of the service. More...
 
StatusCode configure () override
 
StatusCode initialize () override
 
StatusCode start () override
 
StatusCode stop () override
 
StatusCode finalize () override
 
StatusCode terminate () override
 
Gaudi::StateMachine::State FSMState () const override
 
Gaudi::StateMachine::State targetFSMState () const override
 
StatusCode reinitialize () override
 
StatusCode restart () override
 
StatusCode sysInitialize () override
 Initialize Service. More...
 
StatusCode sysStart () override
 Initialize Service. More...
 
StatusCode sysStop () override
 Initialize Service. More...
 
StatusCode sysFinalize () override
 Finalize Service. More...
 
StatusCode sysReinitialize () override
 Re-initialize the Service. More...
 
StatusCode sysRestart () override
 Re-initialize the Service. More...
 
StatusCode setProperty (const Property &p) override
 
StatusCode setProperty (const std::string &s) override
 
StatusCode setProperty (const std::string &n, const std::string &v) override
 
StatusCode getProperty (Property *p) const override
 
const PropertygetProperty (const std::string &name) const override
 
StatusCode getProperty (const std::string &n, std::string &v) const override
 
const std::vector< Property * > & getProperties () const override
 
bool hasProperty (const std::string &name) const override
 
template<class TYPE >
StatusCode setProperty (const std::string &name, const TYPE &value)
 set the property form the value More...
 
 Service (std::string name, ISvcLocator *svcloc)
 Standard Constructor. More...
 
SmartIF< ISvcLocator > & serviceLocator () const override
 Retrieve pointer to service locator. More...
 
StatusCode setProperties ()
 Method for setting declared properties to the values specified for the job. More...
 
template<class T >
StatusCode service (const std::string &name, const T *&psvc, bool createIf=true) const
 Access a service by name, creating it if it doesn't already exist. More...
 
template<class T >
StatusCode service (const std::string &name, T *&psvc, bool createIf=true) const
 
template<typename IFace = IService>
SmartIF< IFace > service (const std::string &name, bool createIf=true) const
 
template<class T >
StatusCode service (const std::string &svcType, const std::string &svcName, T *&psvc) const
 Access a service by name and type, creating it if it doesn't already exist. More...
 
template<class T >
PropertydeclareProperty (const std::string &name, T &property, const std::string &doc="none") const
 Declare the named property. More...
 
PropertydeclareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
 Declare remote named properties. More...
 
template<class T >
StatusCode declarePrivateTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
 Declare used Private tool. More...
 
template<class T >
StatusCode declarePublicTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
 Declare used Public tool. More...
 
SmartIF< IAuditorSvc > & auditorSvc () const
 The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...
 
- Public Member Functions inherited from CommonMessagingBase
virtual ~CommonMessagingBase ()=default
 Virtual destructor. More...
 
SmartIF< IMessageSvc > & msgSvc () const
 The standard message service. More...
 
MsgStreammsgStream () const
 Return an uninitialized MsgStream. More...
 
MsgStreammsgStream (const MSG::Level level) const
 Predefined configurable message stream for the efficient printouts. More...
 
MsgStreamalways () const
 shortcut for the method msgStream(MSG::ALWAYS) More...
 
MsgStreamfatal () const
 shortcut for the method msgStream(MSG::FATAL) More...
 
MsgStreamerr () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamerror () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamwarning () const
 shortcut for the method msgStream(MSG::WARNING) More...
 
MsgStreaminfo () const
 shortcut for the method msgStream(MSG::INFO) More...
 
MsgStreamdebug () const
 shortcut for the method msgStream(MSG::DEBUG) More...
 
MsgStreamverbose () const
 shortcut for the method msgStream(MSG::VERBOSE) More...
 
MsgStreammsg () const
 shortcut for the method msgStream(MSG::INFO) More...
 
MSG::Level msgLevel () const
 get the output level from the embedded MsgStream More...
 
MSG::Level outputLevel () const __attribute__((deprecated))
 Backward compatibility function for getting the output level. More...
 
bool msgLevel (MSG::Level lvl) const
 get the output level from the embedded MsgStream More...
 
- Public Member Functions inherited from extend_interfaces< Interfaces...>
 ~extend_interfaces () override=default
 Virtual destructor. More...
 

Public Attributes

 verbosity = VERBOSE
 
int evtslots = 10
 
int evtMax = 50
 
int cardinality = 20
 
int algosInFlight = 20
 
tuple whiteboard
 
tuple slimeventloopmgr = HiveSlimEventLoopMgr(OutputLevel=verbosity)
 
tuple scheduler
 
tuple a1
 
tuple a2
 
string EvtSel = 'NONE'
 
list ExtSvc = [whiteboard]
 
 EventLoop = slimeventloopmgr,
 
list TopAlg = [a1,a2]
 
string MessageSvcType = "InertMessageSvc"
 

Private Types

typedef std::function< void()> messageAction
 
typedef std::shared_ptr< messageActionmessageActionPtr
 This is done since the copy of the lambda storage is too expensive. More...
 

Private Member Functions

void m_activate ()
 
void m_deactivate ()
 

Private Attributes

bool m_isActive
 
tbb::concurrent_bounded_queue< messageActionPtrm_messageActionsQueue
 
std::thread m_thread
 

Additional Inherited Members

- Public Types inherited from MessageSvc
typedef std::pair< std::string, std::ostream * > NamedStream
 
typedef std::multimap< int, NamedStreamStreamMap
 
typedef std::multimap< StatusCode, MessageMessageMap
 
typedef std::map< std::string, int > ThresholdMap
 
- Public Types inherited from extends< Service, IMessageSvc, IInactiveMessageCounter >
using base_class = extends
 Typedef to this class. More...
 
using extend_interfaces_base = extend_interfaces< Interfaces...>
 Typedef to the base of this class. More...
 
- Public Types inherited from Service
typedef Gaudi::PluginService::Factory< IService *, const std::string &, ISvcLocator * > Factory
 
- Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using base_class = CommonMessaging
 
- Public Types inherited from extend_interfaces< Interfaces...>
using ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
 take union of the ext_iids of all Interfaces... More...
 
- Protected Member Functions inherited from MessageSvc
virtual void i_reportMessage (const Message &msg, int outputLevel)
 Internal implementation of reportMessage(const Message&,int) without lock. More...
 
virtual void i_reportMessage (const StatusCode &code, const std::string &source)
 Internal implementation of reportMessage(const StatusCode&,const std::string&) without lock. More...
 
- Protected Member Functions inherited from Service
 ~Service () override
 Standard Destructor. More...
 
int outputLevel () const
 get the Service's output level More...
 
- Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
void updateMsgStreamOutputLevel (int level)
 Update the output level of the cached MsgStream. More...
 
- Protected Attributes inherited from Service
IntegerProperty m_outputLevel = MSG::NIL
 Service output level. More...
 
Gaudi::StateMachine::State m_state = Gaudi::StateMachine::OFFLINE
 Service state. More...
 
Gaudi::StateMachine::State m_targetState = Gaudi::StateMachine::OFFLINE
 Service state. More...
 

Detailed Description

Thread safe extension to the standard MessageSvc.

The InertMessageSvc runs in a separate thread sleeping until the arrival of a message to print out therefore using a very limited amount of resources. The most important part of its implementation is the presence of a TBB concurrent bounded queue which not only allows to serialise the received messages in order to print them but also to put the thread where the service is located to sleep when the queue is empty.

Author
Danilo Piparo
Date
12/02/2013

Definition at line 26 of file InertMessageSvc.h.

Member Typedef Documentation

Definition at line 56 of file InertMessageSvc.h.

This is done since the copy of the lambda storage is too expensive.

Definition at line 58 of file InertMessageSvc.h.

Constructor & Destructor Documentation

InertMessageSvc::InertMessageSvc ( const std::string name,
ISvcLocator pSvcLocator 
)

Standard constructor.

Definition at line 17 of file InertMessageSvc.cpp.

18  : MessageSvc(name, pSvcLocator),
19  m_isActive(false){
20 }
MessageSvc(const std::string &name, ISvcLocator *svcloc)
Definition: MessageSvc.cpp:58
InertMessageSvc::~InertMessageSvc ( )
virtual

Destructor.

Definition at line 24 of file InertMessageSvc.cpp.

24  {
25 }

Member Function Documentation

virtual StatusCode InertMessageSvc::finalize ( )
virtual

Finalization of the service.

StatusCode InertMessageSvc::initialize ( )
virtual

Initialization of the service.

Definition at line 29 of file InertMessageSvc.cpp.

29  {
30  StatusCode sc = MessageSvc::initialize(); // must be executed first
31  if ( sc.isFailure() ) return sc; // error printed already by MessageSvc
32 
33  info() << "Activating in a separate thread" << endmsg;
35  this));
36 
37  return StatusCode::SUCCESS;
38 }
MsgStream & info() const
shortcut for the method msgStream(MSG::INFO)
std::thread m_thread
bool isFailure() const
Test for a status code of FAILURE.
Definition: StatusCode.h:86
StatusCode initialize() override
Initialize Service.
Definition: MessageSvc.cpp:123
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
T bind(T...args)
STL class.
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244
void InertMessageSvc::m_activate ( )
private

Definition at line 54 of file InertMessageSvc.cpp.

54  {
55  m_isActive=true;
56  messageActionPtr thisMessageAction;
57  while (m_isActive or not m_messageActionsQueue.empty()){
58  m_messageActionsQueue.pop(thisMessageAction);
59  (*thisMessageAction)();
60  }
61 }
std::shared_ptr< messageAction > messageActionPtr
This is done since the copy of the lambda storage is too expensive.
tbb::concurrent_bounded_queue< messageActionPtr > m_messageActionsQueue
void InertMessageSvc::m_deactivate ( )
private

Definition at line 65 of file InertMessageSvc.cpp.

65  {
66 
67  if (m_isActive){
68  // This would be the last action
69  m_messageActionsQueue.push(messageActionPtr(new messageAction([this]() {m_isActive=false;})));
70  }
71 }
std::shared_ptr< messageAction > messageActionPtr
This is done since the copy of the lambda storage is too expensive.
tbb::concurrent_bounded_queue< messageActionPtr > m_messageActionsQueue
std::function< void()> messageAction
void InertMessageSvc::reportMessage ( const Message msg)
virtual

Implementation of IMessageSvc::reportMessage()

Definition at line 88 of file InertMessageSvc.cpp.

88  {
90  messageActionPtr(new messageAction([this,msg] ()
91  {this->i_reportMessage(msg, this->outputLevel(msg.getSource()));})));
92 }
virtual void i_reportMessage(const Message &msg, int outputLevel)
Internal implementation of reportMessage(const Message&,int) without lock.
Definition: MessageSvc.cpp:451
std::shared_ptr< messageAction > messageActionPtr
This is done since the copy of the lambda storage is too expensive.
tbb::concurrent_bounded_queue< messageActionPtr > m_messageActionsQueue
const std::string & getSource() const
Get the message source.
Definition: Message.cpp:115
int outputLevel() const override
Definition: MessageSvc.cpp:693
std::function< void()> messageAction
void InertMessageSvc::reportMessage ( const Message msg,
int  outputLevel 
)
virtual

Implementation of IMessageSvc::reportMessage()

The message action is created and pushed to the message queue.

The message is captured by value since the one referenced by msg can (and basically always will given the asynchronous nature of the printing) go out of scope before the differed print.

Definition at line 80 of file InertMessageSvc.cpp.

80  {
82  messageActionPtr(new messageAction([this, msg,outputLevel] ()
83  {this->i_reportMessage(msg, outputLevel);})));
84 }
virtual void i_reportMessage(const Message &msg, int outputLevel)
Internal implementation of reportMessage(const Message&,int) without lock.
Definition: MessageSvc.cpp:451
std::shared_ptr< messageAction > messageActionPtr
This is done since the copy of the lambda storage is too expensive.
tbb::concurrent_bounded_queue< messageActionPtr > m_messageActionsQueue
int outputLevel() const override
Definition: MessageSvc.cpp:693
std::function< void()> messageAction
void InertMessageSvc::reportMessage ( const StatusCode code,
const std::string source = "" 
)
virtual

Implementation of IMessageSvc::reportMessage()

Definition at line 96 of file InertMessageSvc.cpp.

96  {
98  messageActionPtr(new messageAction([this,code,source] ()
99  {this->i_reportMessage(code, source);})));
100 }
virtual void i_reportMessage(const Message &msg, int outputLevel)
Internal implementation of reportMessage(const Message&,int) without lock.
Definition: MessageSvc.cpp:451
std::shared_ptr< messageAction > messageActionPtr
This is done since the copy of the lambda storage is too expensive.
tbb::concurrent_bounded_queue< messageActionPtr > m_messageActionsQueue
std::function< void()> messageAction

Member Data Documentation

tuple InertMessageSvc.a1
Initial value:
1 = CPUCruncher("A1",
2  DataOutputs = ['/Event/a1'],
3  varRuntime=.1,
4  avgRuntime=.5 )

Definition at line 29 of file InertMessageSvc.py.

tuple InertMessageSvc.a2
Initial value:
1 = CPUCruncher("A2",
2  DataInputs = [],
3  DataOutputs = ['/Event/a2'])

Definition at line 33 of file InertMessageSvc.py.

int InertMessageSvc.algosInFlight = 20

Definition at line 17 of file InertMessageSvc.py.

int InertMessageSvc.cardinality = 20

Definition at line 16 of file InertMessageSvc.py.

InertMessageSvc.EventLoop = slimeventloopmgr,

Definition at line 45 of file InertMessageSvc.py.

int InertMessageSvc.evtMax = 50

Definition at line 15 of file InertMessageSvc.py.

string InertMessageSvc.EvtSel = 'NONE'

Definition at line 43 of file InertMessageSvc.py.

int InertMessageSvc.evtslots = 10

Definition at line 14 of file InertMessageSvc.py.

list InertMessageSvc.ExtSvc = [whiteboard]

Definition at line 44 of file InertMessageSvc.py.

bool InertMessageSvc::m_isActive
private

Definition at line 54 of file InertMessageSvc.h.

tbb::concurrent_bounded_queue<messageActionPtr> InertMessageSvc::m_messageActionsQueue
private

Definition at line 59 of file InertMessageSvc.h.

std::thread InertMessageSvc::m_thread
private

Definition at line 61 of file InertMessageSvc.h.

string InertMessageSvc.MessageSvcType = "InertMessageSvc"

Definition at line 47 of file InertMessageSvc.py.

tuple InertMessageSvc.scheduler
Initial value:
1 = ForwardSchedulerSvc(MaxEventsInFlight = evtslots,
2  MaxAlgosInFlight = algosInFlight,
3  OutputLevel=verbosity,
4  AlgosDependencies = [[],[]])

Definition at line 24 of file InertMessageSvc.py.

tuple InertMessageSvc.slimeventloopmgr = HiveSlimEventLoopMgr(OutputLevel=verbosity)

Definition at line 22 of file InertMessageSvc.py.

list InertMessageSvc.TopAlg = [a1,a2]

Definition at line 46 of file InertMessageSvc.py.

InertMessageSvc.verbosity = VERBOSE

Definition at line 8 of file InertMessageSvc.py.

tuple InertMessageSvc.whiteboard
Initial value:
1 = HiveWhiteBoard("EventDataSvc",
2  EventSlots = evtslots)

Definition at line 19 of file InertMessageSvc.py.


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