blob: de4bb1a90bf575799c24f673a5f492cf82a54a69 [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_ESTIMATOR_PARAMS_H_
#define NET_NQE_NETWORK_QUALITY_ESTIMATOR_PARAMS_H_
#include <map>
#include <string>
#include "base/macros.h"
#include "base/optional.h"
#include "base/sequence_checker.h"
#include "net/base/net_export.h"
#include "net/base/network_change_notifier.h"
#include "net/nqe/effective_connection_type.h"
#include "net/nqe/network_quality.h"
namespace net {
// Forces NQE to return a specific effective connection type. Set using the
// |params| provided to the NetworkQualityEstimatorParams constructor.
NET_EXPORT extern const char kForceEffectiveConnectionType[];
// NetworkQualityEstimatorParams computes the configuration parameters for
// the network quality estimator.
class NET_EXPORT NetworkQualityEstimatorParams {
public:
// Algorithms supported by network quality estimator for computing effective
// connection type.
enum class EffectiveConnectionTypeAlgorithm {
HTTP_RTT_AND_DOWNSTREAM_THROUGHOUT = 0,
TRANSPORT_RTT_OR_DOWNSTREAM_THROUGHOUT,
EFFECTIVE_CONNECTION_TYPE_ALGORITHM_LAST
};
// |params| is the map containing all field trial parameters related to
// NetworkQualityEstimator field trial.
explicit NetworkQualityEstimatorParams(
const std::map<std::string, std::string>& params);
~NetworkQualityEstimatorParams();
// Returns the algorithm to use for computing effective connection type. The
// value is obtained from |params|. If the value from |params| is unavailable,
// a default value is used.
EffectiveConnectionTypeAlgorithm GetEffectiveConnectionTypeAlgorithm() const;
// Returns a descriptive name corresponding to |connection_type|.
static const char* GetNameForConnectionType(
NetworkChangeNotifier::ConnectionType connection_type);
// Returns the default observation for connection |type|. The default
// observations are different for different connection types (e.g., 2G, 3G,
// 4G, WiFi). The default observations may be used to determine the network
// quality in absence of any other information.
const nqe::internal::NetworkQuality& DefaultObservation(
NetworkChangeNotifier::ConnectionType type) const;
// Returns the typical network quality for connection |type|.
const nqe::internal::NetworkQuality& TypicalNetworkQuality(
EffectiveConnectionType type) const;
// Returns the threshold for effective connection type |type|.
const nqe::internal::NetworkQuality& ConnectionThreshold(
EffectiveConnectionType type) const;
// Returns the minimum number of requests in-flight to consider the network
// fully utilized. A throughput observation is taken only when the network is
// considered as fully utilized.
size_t throughput_min_requests_in_flight() const;
// Tiny transfer sizes may give inaccurate throughput results.
// Minimum size of the transfer over which the throughput is computed.
int64_t GetThroughputMinTransferSizeBits() const;
// Returns the weight multiplier per second, which represents the factor by
// which the weight of an observation reduces every second.
double weight_multiplier_per_second() const {
return weight_multiplier_per_second_;
}
// Returns the factor by which the weight of an observation reduces for every
// signal strength level difference between the current signal strength, and
// the signal strength at the time when the observation was taken.
double weight_multiplier_per_signal_strength_level() const {
return weight_multiplier_per_signal_strength_level_;
}
// Returns the fraction of URL requests that should record the correlation
// UMA.
double correlation_uma_logging_probability() const {
return correlation_uma_logging_probability_;
}
// Returns an unset value if the effective connection type has not been forced
// via the |params| provided to this class. Otherwise, returns a value set to
// the effective connection type that has been forced.
base::Optional<EffectiveConnectionType> forced_effective_connection_type()
const {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
return forced_effective_connection_type_;
}
void SetForcedEffectiveConnectionType(
EffectiveConnectionType forced_effective_connection_type) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
forced_effective_connection_type_ = forced_effective_connection_type;
}
// Returns true if reading from the persistent cache is enabled.
bool persistent_cache_reading_enabled() const {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
return persistent_cache_reading_enabled_;
}
void set_persistent_cache_reading_enabled(
bool persistent_cache_reading_enabled) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
persistent_cache_reading_enabled_ = persistent_cache_reading_enabled;
}
// Returns the the minimum interval betweeen consecutive notifications to a
// single socket watcher.
base::TimeDelta min_socket_watcher_notification_interval() const {
return min_socket_watcher_notification_interval_;
}
// Returns the algorithm that should be used for computing effective
// connection type. Returns an empty string if a valid algorithm parameter is
// not specified.
static EffectiveConnectionTypeAlgorithm
GetEffectiveConnectionTypeAlgorithmFromString(
const std::string& algorithm_param_value);
void SetEffectiveConnectionTypeAlgorithm(
EffectiveConnectionTypeAlgorithm algorithm) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
effective_connection_type_algorithm_ = algorithm;
}
// Returns the multiplier by which the transport RTT should be multipled when
// computing the HTTP RTT. The multiplied value of the transport RTT serves
// as a lower bound to the HTTP RTT estimate. e.g., if the multiplied
// transport RTT is 100 msec., then HTTP RTT estimate can't be lower than
// 100 msec. Returns a negative value if the param is not set.
double lower_bound_http_rtt_transport_rtt_multiplier() const {
return lower_bound_http_rtt_transport_rtt_multiplier_;
}
// Returns the multiplier by which the transport RTT should be multipled when
// computing the HTTP RTT. The multiplied value of the transport RTT serves
// as an upper bound to the HTTP RTT estimate. e.g., if the multiplied
// transport RTT is 100 msec., then HTTP RTT estimate can't be more than
// 100 msec. Returns a negative value if the param is not set.
double upper_bound_http_rtt_transport_rtt_multiplier() const {
return upper_bound_http_rtt_transport_rtt_multiplier_;
}
// Returns the minimum interval between successive computations of the
// increase in transport RTT.
base::TimeDelta increase_in_transport_rtt_logging_interval() const {
return increase_in_transport_rtt_logging_interval_;
}
// The maximum age of RTT observations for them to be considered recent for
// the computation of the increase in RTT.
base::TimeDelta recent_time_threshold() const {
return recent_time_threshold_;
}
// The maximum age of observations for them to be considered useful for
// calculating the minimum transport RTT from the historical data.
base::TimeDelta historical_time_threshold() const {
return historical_time_threshold_;
}
// Determines if the responses smaller than |kMinTransferSizeInBytes|
// or shorter than |kMinTransferSizeInBytes| can be used in estimating the
// network quality. Set to true only for tests.
bool use_small_responses() const;
// |use_small_responses| should only be true when testing.
// Allows the responses smaller than |kMinTransferSizeInBits| to be used for
// network quality estimation.
void SetUseSmallResponsesForTesting(bool use_small_responses);
// If an in-flight request does not receive any data for a duration longer
// than the value of this multiplier times the current HTTP RTT estimate, then
// the request should be considered as hanging. If this multiplier has a
// negative or a zero value, then none of the request should be considered as
// hanging.
int hanging_request_duration_http_rtt_multiplier() const {
return hanging_request_duration_http_rtt_multiplier_;
}
// An in-flight request may be marked as hanging only if it does not receive
// any data for at least this duration.
base::TimeDelta hanging_request_min_duration() const {
return hanging_request_min_duration_;
}
// Returns true if default values provided by the platform should be used for
// estimation. Set to false only for testing.
bool add_default_platform_observations() const {
return add_default_platform_observations_;
}
private:
// Map containing all field trial parameters related to
// NetworkQualityEstimator field trial.
const std::map<std::string, std::string> params_;
const size_t throughput_min_requests_in_flight_;
const int throughput_min_transfer_size_kilobytes_;
const double weight_multiplier_per_second_;
const double weight_multiplier_per_signal_strength_level_;
const double correlation_uma_logging_probability_;
base::Optional<EffectiveConnectionType> forced_effective_connection_type_;
bool persistent_cache_reading_enabled_;
const base::TimeDelta min_socket_watcher_notification_interval_;
const double lower_bound_http_rtt_transport_rtt_multiplier_;
const double upper_bound_http_rtt_transport_rtt_multiplier_;
const base::TimeDelta increase_in_transport_rtt_logging_interval_;
const base::TimeDelta recent_time_threshold_;
const base::TimeDelta historical_time_threshold_;
const int hanging_request_duration_http_rtt_multiplier_;
const base::TimeDelta hanging_request_min_duration_;
const bool add_default_platform_observations_;
bool use_small_responses_;
EffectiveConnectionTypeAlgorithm effective_connection_type_algorithm_;
// Default network quality observations obtained from |params_|.
nqe::internal::NetworkQuality
default_observations_[NetworkChangeNotifier::CONNECTION_LAST + 1];
// Typical network quality for different effective connection types obtained
// from |params_|.
nqe::internal::NetworkQuality typical_network_quality_
[EffectiveConnectionType::EFFECTIVE_CONNECTION_TYPE_LAST];
// Thresholds for different effective connection types obtained from
// |params_|. These thresholds encode how different connection types behave
// in general.
nqe::internal::NetworkQuality connection_thresholds_
[EffectiveConnectionType::EFFECTIVE_CONNECTION_TYPE_LAST];
SEQUENCE_CHECKER(sequence_checker_);
DISALLOW_COPY_AND_ASSIGN(NetworkQualityEstimatorParams);
};
} // namespace net
#endif // NET_NQE_NETWORK_QUALITY_ESTIMATOR_PARAMS_H_