blob: 8cc3421b2059a3bd502224f726807f783b619e55 (
plain)
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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/errl/plugins/errluserdetails.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* COPYRIGHT International Business Machines Corp. 2011,2014 */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); */
/* you may not use this file except in compliance with the License. */
/* You may obtain a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or */
/* implied. See the License for the specific language governing */
/* permissions and limitations under the License. */
/* */
/* IBM_PROLOG_END_TAG */
#ifndef ERRL_ERRLUSERDETAILS_H
#define ERRL_ERRLUSERDETAILS_H
/**
* @file errluserdetails.H
*
* Defines the ErrlUserDetailsParser base class
*
* For each class derived from ErrlUserDetails used to create user detail data,
* derive a class from ErrlUserDetailsParser to parse user detail data
*/
#include <stdint.h>
namespace ERRORLOG
{
/**
*
* @class ErrlUserDetailsParser
*
* This is an abstract base class that defines how user detail error log data
* should be parsed. For every different format of user detail data, a
* component should create a class that derives from this class.
*/
class ErrlUserDetailsParser
{
public:
/**
* @brief Constructor
*
*/
ErrlUserDetailsParser()
{
}
/**
* @brief Destructor
*
*/
virtual ~ErrlUserDetailsParser()
{
}
/**
* @brief Parses user detail data from an error log
*
* Parses the supplied user detail data and outputs info to i_parser. This
* is a pure virtual function that must be overridden by a concrete derived
* class that is specific to a particular component, version and subsection
*
* @param i_version
* Version of the data
*
* @param i_parse
* ErrlUsrParser object for outputting information
*
* @param i_pBuffer
* Pointer to buffer containing detail data
*
* @param i_buflen
* Length of the buffer
*
* @return None
*
*/
virtual void parse(errlver_t i_version,
ErrlUsrParser & i_parser,
void * i_pBuffer,
const uint32_t i_buflen) const = 0;
private:
// Disabled
ErrlUserDetailsParser(const ErrlUserDetailsParser &);
ErrlUserDetailsParser & operator=(const ErrlUserDetailsParser &);
};
}
#endif
|
