summaryrefslogtreecommitdiff
path: root/agent/data/scalar.hpp
blob: 2fc4a24539fefd223fb9eab2656796908c36d7fa (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
138
139
140
141
142
143
144
145
146
147
148
149
150
/**
 * @brief Export DBus property to scalar MIB value
 *
 * This file is part of sila-snmp project.
 *
 * Copyright (c) 2022 SILA
 *
 * 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.
 *
 */
#pragma once

#include "sdbusplus/helper.hpp"
#include <memory>

namespace phosphor
{
namespace snmp
{
namespace data
{
template <typename T> class Scalar
{
  public:
    using value_t = std::variant<T>;

    /* Define all of the basic class operations:
     *     Not allowed:
     *         - Default constructor to avoid nullptrs.
     *         - Copy operations due to internal unique_ptr.
     *     Allowed:
     *         - Move operations.
     *         - Destructor.
     */
    Scalar() = delete;
    Scalar(const Scalar&) = delete;
    Scalar& operator=(const Scalar&) = delete;
    Scalar(Scalar&&) = default;
    Scalar& operator=(Scalar&&) = default;
    ~Scalar() = default;

    /**
     * @brief Object constructor
     */
    Scalar(const std::string& path, const std::string& iface,
           const std::string& prop, const T& initValue) :
        _value(initValue),
        _path(path), _iface(iface), _prop(prop),
        _onChangedMatch(sdbusplus::helper::helper::getBus(),
                        sdbusplus::bus::match::rules::propertiesChanged(
                            path.c_str(), iface.c_str()),
                        std::bind(&Scalar<T>::onPropertyChanged, this,
                                  std::placeholders::_1))
    {
    }

    /**
     * @brief Sent request to DBus object and store new value of property
     */
    void update()
    {
        try
        {
            auto service = sdbusplus::helper::helper::getService(_path, _iface);
            auto r = sdbusplus::helper::helper::callMethod(
                service, _path, sdbusplus::helper::PROPERTIES_IFACE, "Get",
                _iface, _prop);

            value_t var;
            r.read(var);
            setValue(var);
        }
        catch (const sdbusplus::exception::SdBusError&)
        {
            // Corresponding service is not started yet.
            // When service is started, we'll receive data with
            // `propertiesChanged` signal.
            // So, this catch block is just for silencing the exception.
        }
    }

    const T& getValue() const
    {
        return _value;
    }

    const std::string& getPath() const
    {
        return _path;
    }

    const std::string& getInterface() const
    {
        return _iface;
    }

    const std::string& getProperty() const
    {
        return _prop;
    }

  protected:
    /**
     * @brief DBus signal `PropertiesChanged` handler
     */
    void onPropertyChanged(sdbusplus::message::message& m)
    {
        std::string iface;
        std::map<std::string, value_t> data;
        std::vector<std::string> v;

        m.read(iface, data, v);

        if (data.find(_prop) != data.end())
        {
            setValue(data[_prop]);
        }
    }

    /**
     * @brief Setter for actual value
     */
    virtual void setValue(value_t& var)
    {
        auto newValue = std::get<T>(var);
        std::swap(_value, newValue);
    }

  private:
    T _value;
    std::string _path;
    std::string _iface;
    std::string _prop;

    sdbusplus::bus::match::match _onChangedMatch;
};

} // namespace data
} // namespace snmp
} // namespace phosphor