admin/webrtc_m130
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
webrtc_m130/api/stats/attribute.h

92 lines
3.3 KiB
C
Raw Normal View History

[Stats] Introduce Attribute, implementing RTCStatsMemberInterface. The plan is to replace Members() with Attributes() instead. For backwards-compatability during the transition, Attribute implements RTCStatsMemberInterface but the two classes serve the same purpose which is to allow iterating all metrics of a stats object. The reason for moving away from "members" is that we already have a way to express a variable that maybe has a value: absl::optional<T>. The only information the member adds is the const char* name(), which we'll move to Attribute in a future CL. We don't need to maintain an RTCStatsMemberInterface::Type enum in the future because absl::variant<T> has absl::holds_alternative<T>. Step 1: Add Attributes(). Step 2: Migrate to Attributes() and delete Members(). Step 3: Replaces all uses of RTCStatsMember<T> with absl::optional<T> and delete RTCStatsMember + RTCStatsMemberInterface. Bug: webrtc:15164 Change-Id: I3fdd5b24214bb5cc340a54a0171df73b516e1803 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/333840 Commit-Queue: Henrik Boström <hbos@webrtc.org> Reviewed-by: Harald Alvestrand <hta@webrtc.org> Cr-Commit-Position: refs/heads/main@{#41507}
2024-01-11 11:41:10 +01:00
/*
* Copyright 2024 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_STATS_ATTRIBUTE_H_
#define API_STATS_ATTRIBUTE_H_
#include <map>
#include <memory>
#include <string>
#include <vector>
#include "absl/types/variant.h"
#include "api/stats/rtc_stats_member.h"
#include "rtc_base/system/rtc_export.h"
namespace webrtc {
// A light-weight wrapper of an RTCStats attribute (an individual metric).
Revert "[Stats] Move metric names to Attribute, constructed via AttributeInit." This reverts commit 84c48ae7513bad9c9ca19271569cd0431e780c32. Reason for revert: Breaks downstream project Original change's description: > [Stats] Move metric names to Attribute, constructed via AttributeInit. > > As of this CL, Attribute no longer implements RTCStatsMemberInterface > and a member no longer owns knowing its own name. The attribute knows > the name because we pass it down at construction time. > > To achieve this, the WEBRTC_RTCSTATS_IMPL() macro is updated to take > AttributeInits instead of raw member pointers, i.e. (name, ptr) pairs. > > By constructing RTCStatsMember<T> without a name parameter, it does the > same thing as the absl::optional<T> constructor. So RTCStatsMember<T>'s > days are numbered! > > Bug: webrtc:15164 > Change-Id: I560c0134bae1c2d7218426a1576425ecc1b677a7 > Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/334203 > Commit-Queue: Henrik Boström <hbos@webrtc.org> > Reviewed-by: Evan Shrubsole <eshr@google.com> > Cr-Commit-Position: refs/heads/main@{#41540} Bug: webrtc:15164 Change-Id: I9f416838153b26d4560ae98c37fb18a803d0295d No-Presubmit: true No-Tree-Checks: true No-Try: true Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/334901 Commit-Queue: Mirko Bonadei <mbonadei@webrtc.org> Bot-Commit: rubber-stamper@appspot.gserviceaccount.com <rubber-stamper@appspot.gserviceaccount.com> Owners-Override: Mirko Bonadei <mbonadei@webrtc.org> Cr-Commit-Position: refs/heads/main@{#41550}
2024-01-17 16:59:52 +00:00
class RTC_EXPORT Attribute : public RTCStatsMemberInterface {
[Stats] Introduce Attribute, implementing RTCStatsMemberInterface. The plan is to replace Members() with Attributes() instead. For backwards-compatability during the transition, Attribute implements RTCStatsMemberInterface but the two classes serve the same purpose which is to allow iterating all metrics of a stats object. The reason for moving away from "members" is that we already have a way to express a variable that maybe has a value: absl::optional<T>. The only information the member adds is the const char* name(), which we'll move to Attribute in a future CL. We don't need to maintain an RTCStatsMemberInterface::Type enum in the future because absl::variant<T> has absl::holds_alternative<T>. Step 1: Add Attributes(). Step 2: Migrate to Attributes() and delete Members(). Step 3: Replaces all uses of RTCStatsMember<T> with absl::optional<T> and delete RTCStatsMember + RTCStatsMemberInterface. Bug: webrtc:15164 Change-Id: I3fdd5b24214bb5cc340a54a0171df73b516e1803 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/333840 Commit-Queue: Henrik Boström <hbos@webrtc.org> Reviewed-by: Harald Alvestrand <hta@webrtc.org> Cr-Commit-Position: refs/heads/main@{#41507}
2024-01-11 11:41:10 +01:00
public:
// TODO(https://crbug.com/webrtc/15164): Replace uses of RTCStatsMember<T>
// with absl::optional<T> and update these pointer types.
typedef absl::variant<const RTCStatsMember<bool>*,
const RTCStatsMember<int32_t>*,
const RTCStatsMember<uint32_t>*,
const RTCStatsMember<int64_t>*,
const RTCStatsMember<uint64_t>*,
const RTCStatsMember<double>*,
const RTCStatsMember<std::string>*,
const RTCStatsMember<std::vector<bool>>*,
const RTCStatsMember<std::vector<int32_t>>*,
const RTCStatsMember<std::vector<uint32_t>>*,
const RTCStatsMember<std::vector<int64_t>>*,
const RTCStatsMember<std::vector<uint64_t>>*,
const RTCStatsMember<std::vector<double>>*,
const RTCStatsMember<std::vector<std::string>>*,
const RTCStatsMember<std::map<std::string, uint64_t>>*,
const RTCStatsMember<std::map<std::string, double>>*>
StatVariant;
template <typename T>
Revert "[Stats] Move metric names to Attribute, constructed via AttributeInit." This reverts commit 84c48ae7513bad9c9ca19271569cd0431e780c32. Reason for revert: Breaks downstream project Original change's description: > [Stats] Move metric names to Attribute, constructed via AttributeInit. > > As of this CL, Attribute no longer implements RTCStatsMemberInterface > and a member no longer owns knowing its own name. The attribute knows > the name because we pass it down at construction time. > > To achieve this, the WEBRTC_RTCSTATS_IMPL() macro is updated to take > AttributeInits instead of raw member pointers, i.e. (name, ptr) pairs. > > By constructing RTCStatsMember<T> without a name parameter, it does the > same thing as the absl::optional<T> constructor. So RTCStatsMember<T>'s > days are numbered! > > Bug: webrtc:15164 > Change-Id: I560c0134bae1c2d7218426a1576425ecc1b677a7 > Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/334203 > Commit-Queue: Henrik Boström <hbos@webrtc.org> > Reviewed-by: Evan Shrubsole <eshr@google.com> > Cr-Commit-Position: refs/heads/main@{#41540} Bug: webrtc:15164 Change-Id: I9f416838153b26d4560ae98c37fb18a803d0295d No-Presubmit: true No-Tree-Checks: true No-Try: true Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/334901 Commit-Queue: Mirko Bonadei <mbonadei@webrtc.org> Bot-Commit: rubber-stamper@appspot.gserviceaccount.com <rubber-stamper@appspot.gserviceaccount.com> Owners-Override: Mirko Bonadei <mbonadei@webrtc.org> Cr-Commit-Position: refs/heads/main@{#41550}
2024-01-17 16:59:52 +00:00
explicit Attribute(const RTCStatsMember<T>* attribute)
: RTCStatsMemberInterface(attribute->name()), attribute_(attribute) {}
~Attribute() override;
[Stats] Introduce Attribute, implementing RTCStatsMemberInterface. The plan is to replace Members() with Attributes() instead. For backwards-compatability during the transition, Attribute implements RTCStatsMemberInterface but the two classes serve the same purpose which is to allow iterating all metrics of a stats object. The reason for moving away from "members" is that we already have a way to express a variable that maybe has a value: absl::optional<T>. The only information the member adds is the const char* name(), which we'll move to Attribute in a future CL. We don't need to maintain an RTCStatsMemberInterface::Type enum in the future because absl::variant<T> has absl::holds_alternative<T>. Step 1: Add Attributes(). Step 2: Migrate to Attributes() and delete Members(). Step 3: Replaces all uses of RTCStatsMember<T> with absl::optional<T> and delete RTCStatsMember + RTCStatsMemberInterface. Bug: webrtc:15164 Change-Id: I3fdd5b24214bb5cc340a54a0171df73b516e1803 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/333840 Commit-Queue: Henrik Boström <hbos@webrtc.org> Reviewed-by: Harald Alvestrand <hta@webrtc.org> Cr-Commit-Position: refs/heads/main@{#41507}
2024-01-11 11:41:10 +01:00
const char* name() const;
const StatVariant& as_variant() const;
[Stats] Migrate RTCStats/Test to Attributes. One in series of CLs to migrate from Members() to Attributes() to unblock code deletion. Adds and makes use of has_value(), holds_alternative<T>() and get<T>() convenience methods. Bug: webrtc:15164 Change-Id: I2ae9869a5d1de3f3875c70494c9781d69da7f936 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/334160 Commit-Queue: Henrik Boström <hbos@webrtc.org> Reviewed-by: Harald Alvestrand <hta@webrtc.org> Reviewed-by: Evan Shrubsole <eshr@google.com> Cr-Commit-Position: refs/heads/main@{#41510}
2024-01-12 09:24:06 +01:00
bool has_value() const;
template <typename T>
bool holds_alternative() const {
return absl::holds_alternative<const RTCStatsMember<T>*>(attribute_);
}
template <typename T>
const T& get() const {
RTC_CHECK(holds_alternative<T>());
RTC_CHECK(has_value());
return absl::get<const RTCStatsMember<T>*>(attribute_)->value();
}
Revert "[Stats] Move metric names to Attribute, constructed via AttributeInit." This reverts commit 84c48ae7513bad9c9ca19271569cd0431e780c32. Reason for revert: Breaks downstream project Original change's description: > [Stats] Move metric names to Attribute, constructed via AttributeInit. > > As of this CL, Attribute no longer implements RTCStatsMemberInterface > and a member no longer owns knowing its own name. The attribute knows > the name because we pass it down at construction time. > > To achieve this, the WEBRTC_RTCSTATS_IMPL() macro is updated to take > AttributeInits instead of raw member pointers, i.e. (name, ptr) pairs. > > By constructing RTCStatsMember<T> without a name parameter, it does the > same thing as the absl::optional<T> constructor. So RTCStatsMember<T>'s > days are numbered! > > Bug: webrtc:15164 > Change-Id: I560c0134bae1c2d7218426a1576425ecc1b677a7 > Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/334203 > Commit-Queue: Henrik Boström <hbos@webrtc.org> > Reviewed-by: Evan Shrubsole <eshr@google.com> > Cr-Commit-Position: refs/heads/main@{#41540} Bug: webrtc:15164 Change-Id: I9f416838153b26d4560ae98c37fb18a803d0295d No-Presubmit: true No-Tree-Checks: true No-Try: true Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/334901 Commit-Queue: Mirko Bonadei <mbonadei@webrtc.org> Bot-Commit: rubber-stamper@appspot.gserviceaccount.com <rubber-stamper@appspot.gserviceaccount.com> Owners-Override: Mirko Bonadei <mbonadei@webrtc.org> Cr-Commit-Position: refs/heads/main@{#41550}
2024-01-17 16:59:52 +00:00
static Attribute FromMemberInterface(const RTCStatsMemberInterface* member);
// RTCStatsMemberInterface implementation.
// TODO(https://crbug.com/webrtc/15164): Delete RTCStatsMemberInterface in
// favor of absl::optional<T>.
RTCStatsMemberInterface::Type type() const override;
bool is_sequence() const override;
bool is_string() const override;
bool is_defined() const override;
std::string ValueToString() const override;
std::string ValueToJson() const override;
[Stats] Introduce Attribute, implementing RTCStatsMemberInterface. The plan is to replace Members() with Attributes() instead. For backwards-compatability during the transition, Attribute implements RTCStatsMemberInterface but the two classes serve the same purpose which is to allow iterating all metrics of a stats object. The reason for moving away from "members" is that we already have a way to express a variable that maybe has a value: absl::optional<T>. The only information the member adds is the const char* name(), which we'll move to Attribute in a future CL. We don't need to maintain an RTCStatsMemberInterface::Type enum in the future because absl::variant<T> has absl::holds_alternative<T>. Step 1: Add Attributes(). Step 2: Migrate to Attributes() and delete Members(). Step 3: Replaces all uses of RTCStatsMember<T> with absl::optional<T> and delete RTCStatsMember + RTCStatsMemberInterface. Bug: webrtc:15164 Change-Id: I3fdd5b24214bb5cc340a54a0171df73b516e1803 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/333840 Commit-Queue: Henrik Boström <hbos@webrtc.org> Reviewed-by: Harald Alvestrand <hta@webrtc.org> Cr-Commit-Position: refs/heads/main@{#41507}
2024-01-11 11:41:10 +01:00
Revert "[Stats] Move metric names to Attribute, constructed via AttributeInit." This reverts commit 84c48ae7513bad9c9ca19271569cd0431e780c32. Reason for revert: Breaks downstream project Original change's description: > [Stats] Move metric names to Attribute, constructed via AttributeInit. > > As of this CL, Attribute no longer implements RTCStatsMemberInterface > and a member no longer owns knowing its own name. The attribute knows > the name because we pass it down at construction time. > > To achieve this, the WEBRTC_RTCSTATS_IMPL() macro is updated to take > AttributeInits instead of raw member pointers, i.e. (name, ptr) pairs. > > By constructing RTCStatsMember<T> without a name parameter, it does the > same thing as the absl::optional<T> constructor. So RTCStatsMember<T>'s > days are numbered! > > Bug: webrtc:15164 > Change-Id: I560c0134bae1c2d7218426a1576425ecc1b677a7 > Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/334203 > Commit-Queue: Henrik Boström <hbos@webrtc.org> > Reviewed-by: Evan Shrubsole <eshr@google.com> > Cr-Commit-Position: refs/heads/main@{#41540} Bug: webrtc:15164 Change-Id: I9f416838153b26d4560ae98c37fb18a803d0295d No-Presubmit: true No-Tree-Checks: true No-Try: true Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/334901 Commit-Queue: Mirko Bonadei <mbonadei@webrtc.org> Bot-Commit: rubber-stamper@appspot.gserviceaccount.com <rubber-stamper@appspot.gserviceaccount.com> Owners-Override: Mirko Bonadei <mbonadei@webrtc.org> Cr-Commit-Position: refs/heads/main@{#41550}
2024-01-17 16:59:52 +00:00
protected:
const RTCStatsMemberInterface* member_ptr() const override;
bool IsEqual(const RTCStatsMemberInterface& other) const override;
[Stats] Introduce Attribute, implementing RTCStatsMemberInterface. The plan is to replace Members() with Attributes() instead. For backwards-compatability during the transition, Attribute implements RTCStatsMemberInterface but the two classes serve the same purpose which is to allow iterating all metrics of a stats object. The reason for moving away from "members" is that we already have a way to express a variable that maybe has a value: absl::optional<T>. The only information the member adds is the const char* name(), which we'll move to Attribute in a future CL. We don't need to maintain an RTCStatsMemberInterface::Type enum in the future because absl::variant<T> has absl::holds_alternative<T>. Step 1: Add Attributes(). Step 2: Migrate to Attributes() and delete Members(). Step 3: Replaces all uses of RTCStatsMember<T> with absl::optional<T> and delete RTCStatsMember + RTCStatsMemberInterface. Bug: webrtc:15164 Change-Id: I3fdd5b24214bb5cc340a54a0171df73b516e1803 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/333840 Commit-Queue: Henrik Boström <hbos@webrtc.org> Reviewed-by: Harald Alvestrand <hta@webrtc.org> Cr-Commit-Position: refs/heads/main@{#41507}
2024-01-11 11:41:10 +01:00
private:
StatVariant attribute_;
};
Revert "[Stats] Move metric names to Attribute, constructed via AttributeInit." This reverts commit 84c48ae7513bad9c9ca19271569cd0431e780c32. Reason for revert: Breaks downstream project Original change's description: > [Stats] Move metric names to Attribute, constructed via AttributeInit. > > As of this CL, Attribute no longer implements RTCStatsMemberInterface > and a member no longer owns knowing its own name. The attribute knows > the name because we pass it down at construction time. > > To achieve this, the WEBRTC_RTCSTATS_IMPL() macro is updated to take > AttributeInits instead of raw member pointers, i.e. (name, ptr) pairs. > > By constructing RTCStatsMember<T> without a name parameter, it does the > same thing as the absl::optional<T> constructor. So RTCStatsMember<T>'s > days are numbered! > > Bug: webrtc:15164 > Change-Id: I560c0134bae1c2d7218426a1576425ecc1b677a7 > Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/334203 > Commit-Queue: Henrik Boström <hbos@webrtc.org> > Reviewed-by: Evan Shrubsole <eshr@google.com> > Cr-Commit-Position: refs/heads/main@{#41540} Bug: webrtc:15164 Change-Id: I9f416838153b26d4560ae98c37fb18a803d0295d No-Presubmit: true No-Tree-Checks: true No-Try: true Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/334901 Commit-Queue: Mirko Bonadei <mbonadei@webrtc.org> Bot-Commit: rubber-stamper@appspot.gserviceaccount.com <rubber-stamper@appspot.gserviceaccount.com> Owners-Override: Mirko Bonadei <mbonadei@webrtc.org> Cr-Commit-Position: refs/heads/main@{#41550}
2024-01-17 16:59:52 +00:00
Attribute MemberToAttribute(const RTCStatsMemberInterface* member);
[Stats] Introduce Attribute, implementing RTCStatsMemberInterface. The plan is to replace Members() with Attributes() instead. For backwards-compatability during the transition, Attribute implements RTCStatsMemberInterface but the two classes serve the same purpose which is to allow iterating all metrics of a stats object. The reason for moving away from "members" is that we already have a way to express a variable that maybe has a value: absl::optional<T>. The only information the member adds is the const char* name(), which we'll move to Attribute in a future CL. We don't need to maintain an RTCStatsMemberInterface::Type enum in the future because absl::variant<T> has absl::holds_alternative<T>. Step 1: Add Attributes(). Step 2: Migrate to Attributes() and delete Members(). Step 3: Replaces all uses of RTCStatsMember<T> with absl::optional<T> and delete RTCStatsMember + RTCStatsMemberInterface. Bug: webrtc:15164 Change-Id: I3fdd5b24214bb5cc340a54a0171df73b516e1803 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/333840 Commit-Queue: Henrik Boström <hbos@webrtc.org> Reviewed-by: Harald Alvestrand <hta@webrtc.org> Cr-Commit-Position: refs/heads/main@{#41507}
2024-01-11 11:41:10 +01:00
} // namespace webrtc
#endif // API_STATS_ATTRIBUTE_H_
Reference in New Issue Copy Permalink