-
Notifications
You must be signed in to change notification settings - Fork 0
/
KVHandler.h
132 lines (102 loc) · 3.49 KB
/
KVHandler.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
// -----------------------------------------------------------------------------
// KVHandler.h KVHandler.h
// -----------------------------------------------------------------------------
/**
* @file
* @brief This file holds the definition of the @ref KVHandler class.
* @author Col. Walter E. Kurtz
* @version 2016-12-01
* @copyright GNU General Public License - Version 3.0
*/
// -----------------------------------------------------------------------------
// One-Definition-Rule One-Definition-Rule
// -----------------------------------------------------------------------------
#ifndef KVHANDLER_H_INCLUDE_NO1
#define KVHANDLER_H_INCLUDE_NO1
// -----------------------------------------------------------------------------
// Includes Includes
// -----------------------------------------------------------------------------
#include <string>
// -----------------------------------------------------------------------------
// Used namespaces Used namespaces
// -----------------------------------------------------------------------------
using namespace std;
// ---------
// KVHandler
// ---------
/**
* @brief This class defines the messages a KVParser can send.
*/
class KVHandler
{
public:
// ---------------------------------------------------------------------------
// Construction Construction
// ---------------------------------------------------------------------------
// ---------
// KVHandler
// ---------
/**
* @brief The standard-constructor.
*/
KVHandler();
// ----------
// ~KVHandler
// ----------
/**
* @brief The destructor is virtual.
*/
virtual ~KVHandler();
// ---------------------------------------------------------------------------
// Callback handler Callback handler
// ---------------------------------------------------------------------------
// --------------
// OnBeginParsing
// --------------
/**
*
*/
virtual void OnBeginParsing(const string& filename);
// ------------
// OnEndParsing
// ------------
/**
*
*/
virtual void OnEndParsing(bool healthy);
// ------
// OnData
// ------
/**
*
*/
virtual void OnData(const string& key, const string& value);
// ---------------------------------------------------------------------------
// Status information Status information
// ---------------------------------------------------------------------------
// -------
// healthy
// -------
/**
*
*/
virtual bool healthy() const;
protected:
// ---------------------------------------------------------------------------
// Internal methods Internal methods
// ---------------------------------------------------------------------------
// ----------
// setHealthy
// ----------
/**
*
*/
void setHealthy(bool healthy = true);
private:
// ---------------------------------------------------------------------------
// Attributes Attributes
// ---------------------------------------------------------------------------
/// the handler's healthy state
bool m_healthy;
};
#endif /* #ifndef KVHANDLER_H_INCLUDE_NO1 */