blob: 7895c9b01137a54f2ccaeddf503b9491f83d4cf5 (
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
|
// Copyright 2017 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_FEATURE_ENGAGEMENT_INTERNAL_EVENT_MODEL_H_
#define COMPONENTS_FEATURE_ENGAGEMENT_INTERNAL_EVENT_MODEL_H_
#include <map>
#include <string>
#include "base/callback.h"
#include "base/macros.h"
namespace feature_engagement {
class Event;
// A EventModel provides all necessary runtime state.
class EventModel {
public:
// Callback for when model initialization has finished. The |success|
// argument denotes whether the model was successfully initialized.
using OnModelInitializationFinished = base::OnceCallback<void(bool success)>;
virtual ~EventModel() = default;
// Initialize the model, including all underlying sub systems. When all
// required operations have been finished, a callback is posted.
virtual void Initialize(OnModelInitializationFinished callback,
uint32_t current_day) = 0;
// Returns whether the model is ready, i.e. whether it has been successfully
// initialized.
virtual bool IsReady() const = 0;
// Retrieves the Event object for the event with the given name. If the event
// is not found, a nullptr will be returned. Calling this before the
// EventModel has finished initializing will result in undefined behavior.
virtual const Event* GetEvent(const std::string& event_name) const = 0;
// Returns the number of times the event with |event_name| happened in the
// past |window_size| days from and including |current_day|.
// If |window_size| > |current_day|, all events since UNIX epoch will
// be counted, since |current_day| represents number of days since UNIX epoch.
virtual uint32_t GetEventCount(const std::string& event_name,
uint32_t current_day,
uint32_t window_size) const = 0;
// Increments the counter for today for how many times the event has happened.
// If the event has never happened before, the Event object will be created.
// The |current_day| should be the number of days since UNIX epoch (see
// TimeProvider::GetCurrentDay()).
virtual void IncrementEvent(const std::string& event_name,
uint32_t current_day) = 0;
protected:
EventModel() = default;
private:
DISALLOW_COPY_AND_ASSIGN(EventModel);
};
} // namespace feature_engagement
#endif // COMPONENTS_FEATURE_ENGAGEMENT_INTERNAL_EVENT_MODEL_H_
|
