RmsMessageListener.h
Go to the documentation of this file.
1 #ifndef _RMS_MESSAGELISTENER_H
2 #define _RMS_MESSAGELISTENER_H
3 
4 #include <rms/base/RmsMessage.h>
5 
6 #include <boost/shared_ptr.hpp>
7 
8 namespace gov {
9 
10 namespace fnal {
11 
12 namespace cd {
13 
14 namespace rms {
15 
16 /**
17  * This Interface defines the interface used by message listeners in RMS.
18  * A message listener is an object that is notified asynchronously when
19  * messages arrive (similar to a callback in C).
20  *
21  * @author Kurt Biery
22  * @author Steve Foulkes
23  * @version $Revision: 1.1.1.1.18.1 $ $Date: 2019/09/27 00:07:31 $
24  */
25 
27  public:
28 
29  /**
30  * Destructor (declared virtual to ensure that derived class
31  * destructors are always called).
32  */
33  virtual ~RmsMessageListener() {}
34 
35  /**
36  * Passes the specified message to the listener.
37  *
38  * @param theMessage The message that was received by a consumer
39  * or producer and is now being passed to the listener.
40  */
41  virtual void messageReceived(boost::shared_ptr<base::RmsMessage>
42  theMessage) = 0;
43 };
44 
45 } // end of namespace rms
46 
47 } // end of namespace cd
48 
49 } // end of namespace fnal
50 
51 } // end of namespace gov
52 
53 #endif
Definition: fnal.py:1
virtual void messageReceived(boost::shared_ptr< base::RmsMessage > theMessage)=0
c cd(1)