summaryrefslogtreecommitdiffstats
path: root/src/usr/diag/attn/test/attnfakeprd.H
blob: e3c907a91ba9d496347a3323b5efd16b272cb43f (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
/*  IBM_PROLOG_BEGIN_TAG
 *  This is an automatically generated prolog.
 *
 *  $Source: src/usr/diag/attn/test/attnfakeprd.H $
 *
 *  IBM CONFIDENTIAL
 *
 *  COPYRIGHT International Business Machines Corp. 2012
 *
 *  p1
 *
 *  Object Code Only (OCO) source materials
 *  Licensed Internal Code Source Materials
 *  IBM HostBoot Licensed Internal Code
 *
 *  The source code for this program is not published or other-
 *  wise divested of its trade secrets, irrespective of what has
 *  been deposited with the U.S. Copyright Office.
 *
 *  Origin: 30
 *
 *  IBM_PROLOG_END_TAG
 */
#ifndef __TEST_ATTNFAKEPRD_H
#define __TEST_ATTNFAKEPRD_H

/**
 * @file attnfakeprd.H
 *
 * @brief HBATTN fake PRD class definitions.
 */

#include "attntest.H"
#include "../attnprd.H"

namespace ATTN
{

/**
 * @brief FakePrd
 *
 * Basic PRD implementation that eventually clears every attention it
 * receives.
 */
class FakePrd : public PrdImpl
{
    public:

        /**
         * @brief ctor
         *
         * @param[in] i_injectSink The system where attentions
         *                     should be cleared.
         */
        explicit FakePrd(InjectSink & i_injectSink);

        /**
         * @brief dtor
         */
        ~FakePrd() {}

        /**
         * @brief callPrd Simulate a call to PRD.
         *
         * Sleeps random intervals, to simulate PRD processing times.  Periodically
         * does not clear some attentions, to simulate real PRD behavior.
         *
         * @param[in] i_attentions List of attentions for PRD to analyze.
         *
         * @return errlHndl_t Error log.
         *
         * @retval[0] No error occurred.
         * @retval[!0] Unexpected error occurred.
         */
        errlHndl_t callPrd(const AttentionList & i_attentions);

    private:

        /**
         * @brief iv_injectSink The system where attentions should
         *                  be cleared.
         */
        InjectSink * iv_injectSink;
};
}
#endif
OpenPOWER on IntegriCloud