blob: 86007e123cc9a9307f3315fdb744ef0d831d99c4 [file] [log] [blame]
// Copyright 2016 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 NET_NQE_NETWORK_QUALITY_OBSERVATION_H_
#define NET_NQE_NETWORK_QUALITY_OBSERVATION_H_
#include <stdint.h>
#include <vector>
#include "base/time/time.h"
#include "net/base/net_export.h"
#include "net/nqe/network_quality_estimator_util.h"
#include "net/nqe/network_quality_observation_source.h"
#include "third_party/abseil-cpp/absl/types/optional.h"
namespace net {
namespace nqe {
namespace internal {
// Records observations of network quality metrics (such as round trip time
// or throughput), along with the time the observation was made. Observations
// can be made at several places in the network stack, thus the observation
// source is provided as well.
class NET_EXPORT_PRIVATE Observation {
public:
Observation(int32_t value,
base::TimeTicks timestamp,
int32_t signal_strength,
NetworkQualityObservationSource source);
Observation(int32_t value,
base::TimeTicks timestamp,
int32_t signal_strength,
NetworkQualityObservationSource source,
const absl::optional<IPHash>& host);
Observation(const Observation& other);
Observation& operator=(const Observation& other);
~Observation();
// Value of the observation.
int32_t value() const { return value_; }
// Time when the observation was taken.
base::TimeTicks timestamp() const { return timestamp_; }
// Signal strength when the observation was taken. Set to INT32_MIN when the
// value is unavailable. Otherwise, must be between 0 and 4 (both inclusive).
int32_t signal_strength() const { return signal_strength_; }
// The source of the observation.
NetworkQualityObservationSource source() const { return source_; }
// A unique identifier for the remote host which was used for the measurement.
absl::optional<IPHash> host() const { return host_; }
// Returns the observation categories to which this observation belongs to.
std::vector<ObservationCategory> GetObservationCategories() const;
private:
int32_t value_;
base::TimeTicks timestamp_;
// Signal strength of the network when the observation was taken. Set to
// INT32_MIN when the value is unavailable. Otherwise, must be between 0 and 4
// (both inclusive).
int32_t signal_strength_;
NetworkQualityObservationSource source_;
absl::optional<IPHash> host_;
};
} // namespace internal
} // namespace nqe
} // namespace net
#endif // NET_NQE_NETWORK_QUALITY_OBSERVATION_H_