b619936dee
This is part of the work to add a selector argument to getStats(). Changes: - TakeReferencedStats() added, which traverses the stats graph and takes any stats from the report that are directly or indirectly accessible from the starting stats objects in the stats graph. The result is returned as a stats report. - GetStatsReferencedIds(), an efficient helper function for getting neighbor stats object IDs. - RTCStatsReport::Take(), removed the stats object with the given ID and returns ownership of it (so that it can be added to another report). TakeReferencedStats() is tested with a bunch of sample stats graphs. GetStatsReferencedIds() is tested in the rtcstats_integrationttest.cc, making sure the expected IDs are returned. The expected IDs are the values of the stats object members with the "Id" or "Ids" suffix. Design doc: https://docs.google.com/document/d/18BywbtXgHCjsbR5nWBedpzqDjAfXrFSTJNiADnzoK0w/edit?usp=sharing Bug: chromium:680172 Change-Id: I5da9da8250da0cb05adb864015901393a4290776 Reviewed-on: https://webrtc-review.googlesource.com/60869 Commit-Queue: Henrik Boström <hbos@webrtc.org> Reviewed-by: Taylor Brandstetter <deadbeef@webrtc.org> Cr-Commit-Position: refs/heads/master@{#22381}
104 lines
3.3 KiB
C++
104 lines
3.3 KiB
C++
/*
|
|
* Copyright 2016 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_RTCSTATSREPORT_H_
|
|
#define API_STATS_RTCSTATSREPORT_H_
|
|
|
|
#include <map>
|
|
#include <memory>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "api/stats/rtcstats.h"
|
|
#include "rtc_base/refcount.h"
|
|
#include "rtc_base/refcountedobject.h"
|
|
#include "rtc_base/scoped_ref_ptr.h"
|
|
|
|
namespace webrtc {
|
|
|
|
// A collection of stats.
|
|
// This is accessible as a map from |RTCStats::id| to |RTCStats|.
|
|
class RTCStatsReport : public rtc::RefCountInterface {
|
|
public:
|
|
typedef std::map<std::string, std::unique_ptr<const RTCStats>> StatsMap;
|
|
|
|
class ConstIterator {
|
|
public:
|
|
ConstIterator(const ConstIterator&& other);
|
|
~ConstIterator();
|
|
|
|
ConstIterator& operator++();
|
|
ConstIterator& operator++(int);
|
|
const RTCStats& operator*() const;
|
|
const RTCStats* operator->() const;
|
|
bool operator==(const ConstIterator& other) const;
|
|
bool operator!=(const ConstIterator& other) const;
|
|
|
|
private:
|
|
friend class RTCStatsReport;
|
|
ConstIterator(const rtc::scoped_refptr<const RTCStatsReport>& report,
|
|
StatsMap::const_iterator it);
|
|
|
|
// Reference report to make sure it is kept alive.
|
|
rtc::scoped_refptr<const RTCStatsReport> report_;
|
|
StatsMap::const_iterator it_;
|
|
};
|
|
|
|
// TODO(hbos): Remove "= 0" once Chromium unittest has been updated to call
|
|
// with a parameter. crbug.com/627816
|
|
static rtc::scoped_refptr<RTCStatsReport> Create(int64_t timestamp_us = 0);
|
|
|
|
explicit RTCStatsReport(int64_t timestamp_us);
|
|
RTCStatsReport(const RTCStatsReport& other) = delete;
|
|
|
|
int64_t timestamp_us() const { return timestamp_us_; }
|
|
void AddStats(std::unique_ptr<const RTCStats> stats);
|
|
const RTCStats* Get(const std::string& id) const;
|
|
size_t size() const { return stats_.size(); }
|
|
|
|
// Removes the stats object from the report, returning ownership of it or null
|
|
// if there is no object with |id|.
|
|
std::unique_ptr<const RTCStats> Take(const std::string& id);
|
|
// Takes ownership of all the stats in |victim|, leaving it empty.
|
|
void TakeMembersFrom(rtc::scoped_refptr<RTCStatsReport> victim);
|
|
|
|
// Stats iterators. Stats are ordered lexicographically on |RTCStats::id|.
|
|
ConstIterator begin() const;
|
|
ConstIterator end() const;
|
|
|
|
// Gets the subset of stats that are of type |T|, where |T| is any class
|
|
// descending from |RTCStats|.
|
|
template<typename T>
|
|
std::vector<const T*> GetStatsOfType() const {
|
|
std::vector<const T*> stats_of_type;
|
|
for (const RTCStats& stats : *this) {
|
|
if (stats.type() == T::kType)
|
|
stats_of_type.push_back(&stats.cast_to<const T>());
|
|
}
|
|
return stats_of_type;
|
|
}
|
|
|
|
// Creates a JSON readable string representation of the report,
|
|
// listing all of its stats objects.
|
|
std::string ToJson() const;
|
|
|
|
friend class rtc::RefCountedObject<RTCStatsReport>;
|
|
|
|
private:
|
|
~RTCStatsReport() override;
|
|
|
|
int64_t timestamp_us_;
|
|
StatsMap stats_;
|
|
};
|
|
|
|
} // namespace webrtc
|
|
|
|
#endif // API_STATS_RTCSTATSREPORT_H_
|