ProviderListener.h
Go to the documentation of this file.
1 #ifndef _RMS_PROVIDERLISTENER_H
2 #define _RMS_PROVIDERLISTENER_H
3 
4 #include <boost/shared_ptr.hpp>
5 
6 #include <string>
7 
8 namespace gov {
9 
10 namespace fnal {
11 
12 namespace cd {
13 
14 namespace rms {
15 
16 namespace provider {
17 
18 /**
19  * The interface for classes that want to be notified when a
20  * string message has been received from a provider.
21  *
22  * Classes that implement this interface and are declared
23  * as listeners for provider-level messages are notified
24  * when messages are received.
25  *
26  * @author Kurt Biery
27  * @author Steve Foulkes
28  * @version $Revision: 1.1.1.1.18.1 $ $Date: 2019/09/27 00:07:31 $
29  */
30 
32  public:
33 
34  /**
35  * Destructor (declared virtual to ensure that derived class
36  * destructors are always called).
37  */
38  virtual ~ProviderListener() {}
39 
40  /**
41  * Invoked when a string message is received from a provider.
42  *
43  * @param messageText The string containing the message that was
44  * received.
45  */
46  virtual void textReceived(boost::shared_ptr<std::string> messageText) = 0;
47 };
48 
49 } // end of namespace provider
50 
51 } // end of namespace rms
52 
53 } // end of namespace cd
54 
55 } // end of namespace fnal
56 
57 } // end of namespace gov
58 
59 #endif
Definition: fnal.py:1
c cd(1)
virtual void textReceived(boost::shared_ptr< std::string > messageText)=0