summaryrefslogtreecommitdiffstats
path: root/third_party/libwebrtc/api/network_state_predictor.h
diff options
context:
space:
mode:
Diffstat (limited to 'third_party/libwebrtc/api/network_state_predictor.h')
-rw-r--r--third_party/libwebrtc/api/network_state_predictor.h56
1 files changed, 56 insertions, 0 deletions
diff --git a/third_party/libwebrtc/api/network_state_predictor.h b/third_party/libwebrtc/api/network_state_predictor.h
new file mode 100644
index 0000000000..9cf5ab6f02
--- /dev/null
+++ b/third_party/libwebrtc/api/network_state_predictor.h
@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) 2019 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_NETWORK_STATE_PREDICTOR_H_
+#define API_NETWORK_STATE_PREDICTOR_H_
+
+#include <memory>
+#include <vector>
+
+namespace webrtc {
+
+enum class BandwidthUsage {
+ kBwNormal = 0,
+ kBwUnderusing = 1,
+ kBwOverusing = 2,
+ kLast
+};
+
+// TODO(yinwa): work in progress. API in class NetworkStatePredictor should not
+// be used by other users until this comment is removed.
+
+// NetworkStatePredictor predict network state based on current network metrics.
+// Usage:
+// Setup by calling Initialize.
+// For each update, call Update. Update returns network state
+// prediction.
+class NetworkStatePredictor {
+ public:
+ virtual ~NetworkStatePredictor() {}
+
+ // Returns current network state prediction.
+ // Inputs: send_time_ms - packet send time.
+ // arrival_time_ms - packet arrival time.
+ // network_state - computed network state.
+ virtual BandwidthUsage Update(int64_t send_time_ms,
+ int64_t arrival_time_ms,
+ BandwidthUsage network_state) = 0;
+};
+
+class NetworkStatePredictorFactoryInterface {
+ public:
+ virtual std::unique_ptr<NetworkStatePredictor>
+ CreateNetworkStatePredictor() = 0;
+ virtual ~NetworkStatePredictorFactoryInterface() = default;
+};
+
+} // namespace webrtc
+
+#endif // API_NETWORK_STATE_PREDICTOR_H_