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
|
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_REPORTING_STORAGE_STORAGE_MODULE_H_
#define COMPONENTS_REPORTING_STORAGE_STORAGE_MODULE_H_
#include "base/functional/callback.h"
#include "base/memory/ref_counted.h"
#include "base/memory/scoped_refptr.h"
#include "components/reporting/compression/compression_module.h"
#include "components/reporting/encryption/encryption_module_interface.h"
#include "components/reporting/proto/synced/record.pb.h"
#include "components/reporting/proto/synced/record_constants.pb.h"
#include "components/reporting/storage/storage.h"
#include "components/reporting/storage/storage_configuration.h"
#include "components/reporting/storage/storage_module_interface.h"
#include "components/reporting/storage/storage_uploader_interface.h"
#include "components/reporting/util/status.h"
#include "components/reporting/util/statusor.h"
namespace reporting {
class StorageModule : public StorageModuleInterface {
public:
// Factory method creates |StorageModule| object.
static void Create(
const StorageOptions& options,
UploaderInterface::AsyncStartUploaderCb async_start_upload_cb,
scoped_refptr<EncryptionModuleInterface> encryption_module,
scoped_refptr<CompressionModule> compression_module,
base::OnceCallback<void(StatusOr<scoped_refptr<StorageModule>>)>
callback);
StorageModule(const StorageModule& other) = delete;
StorageModule& operator=(const StorageModule& other) = delete;
// AddRecord will add |record| (taking ownership) to the |StorageModule|
// according to the provided |priority|. On completion, |callback| will be
// called.
void AddRecord(Priority priority,
Record record,
EnqueueCallback callback) override;
// Initiates upload of collected records according to the priority.
// Called usually for a queue with an infinite or very large upload period.
// Multiple |Flush| calls can safely run in parallel.
// Returns error if cannot start upload.
void Flush(Priority priority, FlushCallback callback) override;
// Once a record has been successfully uploaded, the sequence information
// can be passed back to the StorageModule here for record deletion.
// If |force| is false (which is used in most cases), |sequence_information|
// only affects Storage if no higher sequencing was confirmed before;
// otherwise it is accepted unconditionally.
// Declared virtual for testing purposes.
virtual void ReportSuccess(SequenceInformation sequence_information,
bool force);
// If the server attached signed encryption key to the response, it needs to
// be paased here.
// Declared virtual for testing purposes.
virtual void UpdateEncryptionKey(SignedEncryptionInfo signed_encryption_key);
protected:
// Constructor can only be called by |Create| factory method.
StorageModule();
// Refcounted object must have destructor declared protected or private.
~StorageModule() override;
private:
friend base::RefCountedThreadSafe<StorageModule>;
// Storage backend (currently only Storage).
// TODO(b/160334561): make it a pluggable interface.
scoped_refptr<Storage> storage_;
};
} // namespace reporting
#endif // COMPONENTS_REPORTING_STORAGE_STORAGE_MODULE_H_
|
