summaryrefslogtreecommitdiffstats
path: root/src/lib/statistics/counter_dict.h
blob: 6861abf3dbc96919ec3cd5fdba8b60cc8e91ede0 (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
151
152
153
154
155
156
157
158
159
160
161
// Copyright (C) 2011  Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.

#ifndef __COUNTER_DICT_H
#define __COUNTER_DICT_H 1

#include <statistics/counter.h>
#include <exceptions/exceptions.h>

#include <boost/noncopyable.hpp>
#include <boost/scoped_ptr.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/iterator/iterator_facade.hpp>

#include <cassert>
#include <stdexcept>
#include <string>
#include <vector>
#include <map>
#include <iterator>
#include <utility>

namespace {
typedef boost::shared_ptr<isc::statistics::Counter> CounterPtr;
typedef std::map<std::string, CounterPtr> DictionaryMap;
}

namespace isc {
namespace statistics {

class CounterDictionary : boost::noncopyable {
private:
    DictionaryMap dictionary_;
    std::vector<std::string> elements_;
    const size_t items_;
    // Default constructor is forbidden; number of counter items must be
    // specified at the construction of this class.
    CounterDictionary();
public:
    explicit inline CounterDictionary(const size_t items) :
        items_(items)
    {
        // The number of items must not be 0
        if (items == 0) {
            isc_throw(isc::InvalidParameter, "Items must not be 0");
        }
    };
    inline ~CounterDictionary() {};
    inline void addElement(const std::string& name) {
        // throw if the element already exists
        if (dictionary_.count(name) != 0) {
            isc_throw(isc::InvalidParameter,
                      "Element " << name << " already exists");
        }
        assert(items_ != 0);
        // Create a new Counter and add to the map
        dictionary_.insert(
            DictionaryMap::value_type(name, CounterPtr(new Counter(items_))));
    };
    inline void deleteElement(const std::string& name) {
        size_t result = dictionary_.erase(name);
        if (result != 1) {
            // If an element with specified name does not exist, throw
            // isc::OutOfRange.
            isc_throw(isc::OutOfRange,
                      "Element " << name << " does not exist");
        }
    };
    inline Counter& getElement(const std::string& name) {
        DictionaryMap::const_iterator i = dictionary_.find(name);
        if (i != dictionary_.end()) {
            // the key was found. return the element.
            return (*(i->second));
        } else {
            // If an element with specified name does not exist, throw
            // isc::OutOfRange.
            isc_throw(isc::OutOfRange,
                      "Element " << name << " does not exist");
        }
    };
    inline Counter& operator[](const std::string& name) {
        return (getElement(name));
    };
    /// \brief \c ConstIterator is a constant iterator that provides an
    /// interface for enumerating name of zones stored in CounterDictionary.
    ///
    /// This class is derived from boost::iterator_facade and uses pImpl
    /// idiom not to expose implementation detail of
    /// CounterDictionary::iterator.
    ///
    /// It is intended to walk through the elements when sending the
    /// counters to statistics module.
    class ConstIterator :
        public boost::iterator_facade<ConstIterator,
                                const std::string,
                                boost::forward_traversal_tag>
    {
        public:
            /// The constructor.
            ///
            /// This constructor is mostly exception free. But it may still
            /// throw a standard exception if memory allocation fails
            /// inside the method.
            inline ConstIterator() {}
            /// The destructor.
            ///
            /// This method never throws an exception.
            inline ~ConstIterator() {}
            /// Constructor from implementation detail DictionaryMap::const_iterator
            inline ConstIterator(
                DictionaryMap::const_iterator iterator) :
                iterator_(iterator)
            {}

        private:
            /// \brief An internal method to increment this iterator.
            inline void increment() {
                ++iterator_;
                return;
            }

            /// \brief An internal method to check equality.
            inline bool equal(const ConstIterator& other) const {
                return (iterator_ == other.iterator_);
            }

            /// \brief An internal method to dereference this iterator.
            inline const value_type& dereference() const {
                return (iterator_->first);
            }

        private:
            friend class boost::iterator_core_access;
            DictionaryMap::const_iterator iterator_;
    };

    inline ConstIterator begin() const {
        return (CounterDictionary::ConstIterator(dictionary_.begin()));
    };
    inline ConstIterator end() const {
        return (CounterDictionary::ConstIterator(dictionary_.end()));
    };

    typedef ConstIterator const_iterator;
};

}   // namespace statistics
}   // namespace isc

#endif