summaryrefslogtreecommitdiff
path: root/src/components/include/utils/messagemeter.h
blob: a5d9968d810438e063c0e4d56713ffb503fb26db (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
162
163
164
165
166
/*
 * Copyright (c) 2014, Ford Motor Company
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided with the
 * distribution.
 *
 * Neither the name of the Ford Motor Company nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef SRC_COMPONENTS_INCLUDE_UTILS_MESSAGEMETER_H_
#define SRC_COMPONENTS_INCLUDE_UTILS_MESSAGEMETER_H_

#include <cstddef>
#include <set>
#include <map>
#include "utils/date_time.h"

namespace utils {
/**
    @brief The MessageMeter class need to count message frequency
    Default time range value is 1 second
    IncomingDataHandler methods are reentrant and not thread-safe
    @tparam Id could be used for handling messages by session,
    connection or other identifier
 */
template <class Id>
class MessageMeter {
 public:
  MessageMeter();
  /**
     @brief Update frequency value for selected identifier
     @param Id - unique identifier
     @return frequency
   */
  size_t TrackMessage(const Id& id);
  /**
     @brief Update frequency value for selected identifier
     @param Id - unique identifier
     @param count - count of received messages
     @return frequency
   */
  size_t TrackMessages(const Id& id, const size_t count);
  /**
     @brief Frequency of messages for selected identifier
     @param Id - unique identifier
     @return frequency
   */
  size_t Frequency(const Id& id);

  /**
     @brief Remove all data refer to selected identifier
     @param Id - unique identifier
   */
  void RemoveIdentifier(const Id& id);

  /**
     @brief Remove all frequency data
   */
  void ClearIdentifiers();

  void set_time_range(const size_t time_range_msecs);
  void set_time_range(const TimevalStruct& time_range);
  TimevalStruct time_range() const;

 private:
  TimevalStruct time_range_;
  typedef std::multiset<TimevalStruct> Timings;
  typedef std::map<Id, Timings> TimingMap;
  TimingMap timing_map_;
};

template <class Id>
MessageMeter<Id>::MessageMeter()
  : time_range_(TimevalStruct {0, 0}) {
  time_range_.tv_sec = 1;
}

template <class Id>
size_t MessageMeter<Id>::TrackMessage(const Id& id) {
  return TrackMessages(id, 1);
}

template <class Id>
size_t MessageMeter<Id>::TrackMessages(const Id& id,
                                  const size_t count) {
  Timings& timings = timing_map_[id];
  const TimevalStruct current_time = date_time::DateTime::getCurrentTime();
  for (size_t i = 0; i < count; ++i) {
    // Adding to the end is amortized constant
    timings.insert(timings.end(), current_time);
  }
  return Frequency(id);
}

template <class Id>
size_t MessageMeter<Id>::Frequency(const Id& id) {
  typename TimingMap::iterator it = timing_map_.find(id);
  if(it == timing_map_.end()) {
    return 0u;
  }
  Timings& timings = it->second;
  if (timings.empty()) {
    return 0u;
  }
  const TimevalStruct actual_begin_time =
      date_time::DateTime::Sub(date_time::DateTime::getCurrentTime(),
                               time_range_);
  timings.erase(timings.begin(),
                timings.upper_bound(actual_begin_time));
  return timings.size();
}

template <class Id>
void MessageMeter<Id>::RemoveIdentifier(const Id& id) {
  timing_map_.erase(id);
}

template <class Id>
void MessageMeter<Id>::ClearIdentifiers() {
  timing_map_.clear();
}

template <class Id>
void MessageMeter<Id>::set_time_range(const size_t time_range_msecs) {
  // TODO(EZamakhov): move to date_time::DateTime
  const size_t secs =
      time_range_msecs / date_time::DateTime::MILLISECONDS_IN_SECOND;
  time_range_.tv_sec = secs;
  const size_t mSecs =
      time_range_msecs % date_time::DateTime::MILLISECONDS_IN_SECOND;
  time_range_.tv_usec =
      mSecs * date_time::DateTime::MICROSECONDS_IN_MILLISECONDS;
}
template <class Id>
void MessageMeter<Id>::set_time_range(const TimevalStruct& time_range) {
  time_range_ = time_range;
}
template <class Id>
TimevalStruct MessageMeter<Id>::time_range() const {
  return time_range_;
}
}  // namespace utils
#endif  // SRC_COMPONENTS_INCLUDE_UTILS_MESSAGEMETER_H_