blob: f10f10c5faf37ae4b1eca4a3500b13e01aaa9b2b (
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
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
132
133
134
135
136
137
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/diag/prdf/common/framework/resolution/iipTerminateResolution.h $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* COPYRIGHT International Business Machines Corp. 1997,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 iipTerminateResolution_h
#define iipTerminateResolution_h
// Class Description *************************************************
//
// Name: TerminateResolution
// Base class: Resolution
//
// Description: This module contains the Processor Runtime
// Diagnostics TerminateResolution class declaration.
// TerminateResolution provides a mechanism to terminate
// the operation of the machine on a recovered error attention
// after PRD exists.
// This resolution was made to be used with other Resolutions in
// a resolution list.
//
// Usage: Abstract base class
//
// Static Globals
// TerminateResolution bringDownMachine();
// FinalResolution co(&someMruList);
// ResolutionList resolution (&co,&bringDownMachine);
//
// int32_t foo(ResolutionMap &resolutionMap)
// {
// resolutionMap.Add(BIT_LIST_STRING_01,&resolution);
// }
// ...
// int32_t foo(STEP_CODE_DATA_STRUCT &serviceData,
// ResolutionMap &map)
// {
// Resolution &r = map.LookUp(BIT_LIST_STRING_01);
// int32_t rc = r.Resolve(serviceData); // flag the termination of machine
// return(rc);
// }
//
// End Class Description *********************************************
/*--------------------------------------------------------------------*/
//--------------------------------------------------------------------
// Includes
//--------------------------------------------------------------------
#if !defined(iipResolution_h)
#include <iipResolution.h>
#endif
namespace PRDF
{
//--------------------------------------------------------------------
// Forward References
//--------------------------------------------------------------------
class TerminateResolution: public Resolution
{
public:
TerminateResolution();
// Function Specification ********************************************
//
// Purpose: Constructor
// Parameters: None
// Returns: Nothing
// Requirements: None
// Promises: Object created
// Exceptions: None
// Concurrency: synchronous
// Notes:
//
// End Function Specification ****************************************
// virtual ~TerminateResolution();
// Function Specification ********************************************
//
// Purpose: Destruction
// Parameters: None.
// Returns: No value returned
// Requirements: None.
// Promises: None.
// Exceptions: None.
// Concurrency: Reentrant
// Notes: The compiler default is sufficient
//
// End Function Specification ****************************************
virtual int32_t Resolve(STEP_CODE_DATA_STRUCT & data);
// Function Specification ********************************************
//
// Purpose: Tells the ServiceDataCollector (data) that machine operation
// needs to be terminated.
// Parameters: Reference to the ServiceDataCollector
// Returns: Return code (rc)
// Requirements: None
// Promises: data.serviceData->Terminate() == TRUE
// Exceptions: None
// Concurrency: synchronous
// Notes: if rc != SUCCESS then state of service data is unpredictable
//
// End Function Specification ****************************************
// Copy ctor - compiler default is sufficient
// Assignment - compiler default is sufficient
private: // functions
private: // Data
};
inline
TerminateResolution::TerminateResolution(): Resolution() {}
} // end namespace PRDF
#endif /* iipResolution_h */
|
