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
|
/*
* Copyright 2023 The WebRTC Project Authors. All rights reserved.
*
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
#ifndef API_ENVIRONMENT_ENVIRONMENT_FACTORY_H_
#define API_ENVIRONMENT_ENVIRONMENT_FACTORY_H_
#include <memory>
#include <utility>
#include "absl/base/nullability.h"
#include "api/environment/environment.h"
#include "api/field_trials_view.h"
#include "api/ref_counted_base.h"
#include "api/rtc_event_log/rtc_event_log.h"
#include "api/scoped_refptr.h"
#include "api/task_queue/task_queue_factory.h"
#include "rtc_base/system/rtc_export.h"
#include "system_wrappers/include/clock.h"
namespace webrtc {
// Constructs `Environment`.
// Individual utilities are provided using one of the `Set` functions.
// `Set` functions do nothing when nullptr value is passed.
// Creates default implementations for utilities that are not provided.
//
// Examples:
// Environment default_env = EnvironmentFactory().Create();
//
// EnvironmentFactory factory;
// factory.Set(std::make_unique<CustomTaskQueueFactory>());
// factory.Set(std::make_unique<CustomFieldTrials>());
// Environment custom_env = factory.Create();
//
class RTC_EXPORT EnvironmentFactory final {
public:
EnvironmentFactory() = default;
explicit EnvironmentFactory(const Environment& env);
EnvironmentFactory(const EnvironmentFactory&) = default;
EnvironmentFactory(EnvironmentFactory&&) = default;
EnvironmentFactory& operator=(const EnvironmentFactory&) = default;
EnvironmentFactory& operator=(EnvironmentFactory&&) = default;
~EnvironmentFactory() = default;
void Set(absl_nullable std::unique_ptr<const FieldTrialsView> utility);
void Set(absl_nullable std::unique_ptr<Clock> utility);
void Set(absl_nullable std::unique_ptr<TaskQueueFactory> utility);
void Set(absl_nullable std::unique_ptr<RtcEventLog> utility);
void Set(const FieldTrialsView* absl_nullable utility);
void Set(Clock* absl_nullable utility);
void Set(TaskQueueFactory* absl_nullable utility);
void Set(RtcEventLog* absl_nullable utility);
Environment Create() const;
private:
Environment CreateWithDefaults() &&;
scoped_refptr<const RefCountedBase> leaf_;
const FieldTrialsView* absl_nullable field_trials_ = nullptr;
Clock* absl_nullable clock_ = nullptr;
TaskQueueFactory* absl_nullable task_queue_factory_ = nullptr;
RtcEventLog* absl_nullable event_log_ = nullptr;
};
// Helper for concise way to create an environment.
// `Environment env = CreateEnvironment(utility1, utility2)` is a shortcut to
// `EnvironmentFactory factory;
// factory.Set(utility1);
// factory.Set(utility2);
// Environment env = factory.Create();`
//
// Examples:
// Environment default_env = CreateEnvironment();
// Environment custom_env =
// CreateEnvironment(std::make_unique<CustomTaskQueueFactory>(),
// std::make_unique<CustomFieldTrials>());
template <typename... Utilities>
Environment CreateEnvironment(Utilities&&... utilities);
//------------------------------------------------------------------------------
// Implementation details follow
//------------------------------------------------------------------------------
inline void EnvironmentFactory::Set(
const FieldTrialsView* absl_nullable utility) {
if (utility != nullptr) {
field_trials_ = utility;
}
}
inline void EnvironmentFactory::Set(Clock* absl_nullable utility) {
if (utility != nullptr) {
clock_ = utility;
}
}
inline void EnvironmentFactory::Set(TaskQueueFactory* absl_nullable utility) {
if (utility != nullptr) {
task_queue_factory_ = utility;
}
}
inline void EnvironmentFactory::Set(RtcEventLog* absl_nullable utility) {
if (utility != nullptr) {
event_log_ = utility;
}
}
namespace webrtc_create_environment_internal {
inline void Set(EnvironmentFactory& /* factory */) {}
template <typename FirstUtility, typename... Utilities>
void Set(EnvironmentFactory& factory,
FirstUtility&& first,
Utilities&&... utilities) {
factory.Set(std::forward<FirstUtility>(first));
Set(factory, std::forward<Utilities>(utilities)...);
}
} // namespace webrtc_create_environment_internal
template <typename... Utilities>
Environment CreateEnvironment(Utilities&&... utilities) {
EnvironmentFactory factory;
webrtc_create_environment_internal::Set(
factory, std::forward<Utilities>(utilities)...);
return factory.Create();
}
} // namespace webrtc
#endif // API_ENVIRONMENT_ENVIRONMENT_FACTORY_H_
|
