Add API allowing xAPPs to send alarm messages
[ric-plt/xapp-frame-cpp.git] / src / xapp / xapp.hpp
1 // vi: ts=4 sw=4 noet:
2 /*
3 ==================================================================================
4         Copyright (c) 2020 Nokia
5         Copyright (c) 2020 AT&T Intellectual Property.
6
7    Licensed under the Apache License, Version 2.0 (the "License");
8    you may not use this file except in compliance with the License.
9    You may obtain a copy of the License at
10
11        http://www.apache.org/licenses/LICENSE-2.0
12
13    Unless required by applicable law or agreed to in writing, software
14    distributed under the License is distributed on an "AS IS" BASIS,
15    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16    See the License for the specific language governing permissions and
17    limitations under the License.
18 ==================================================================================
19 */
20
21 /*
22         Mnemonic:       xapp.hpp
23         Abstract:       Headers for the xapp class. This class extends the messenger class
24                                 as most of the function of this class would be just passing through
25                                 calls to the messenger object.
26
27         Date:           13 March 2020
28         Author:         E. Scott Daniels
29 */
30
31 #ifndef _xapp_hpp
32 #define _xapp_hpp
33
34
35 #include <iostream>
36 #include <string>
37 #include <mutex>
38 #include <map>
39
40 #include <rmr/rmr.h>
41
42 #include "callback.hpp"
43 #include "messenger.hpp"
44
45 class Xapp : public xapp::Messenger {
46
47         private:
48                 std::string name;
49
50                 // copy and assignment are PRIVATE because we cant "clone" the listen environment
51                 Xapp( const Xapp& soi );
52                 Xapp& operator=( const Xapp& soi );
53
54         public:
55                 Xapp( const char* listen_port, bool wait4rt );  // builder
56                 Xapp( );
57                 ~Xapp();                                                                        // destroyer
58
59                 void Run( int nthreads );                                       // message listen driver
60                 void Halt( );                                                           // force to stop
61 };
62
63 #endif