| // Copyright (c) 2012 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. |
| // |
| // The pure virtual class for send side congestion control algorithm. |
| |
| #ifndef NET_QUIC_CONGESTION_CONTROL_SEND_ALGORITHM_INTERFACE_H_ |
| #define NET_QUIC_CONGESTION_CONTROL_SEND_ALGORITHM_INTERFACE_H_ |
| |
| #include <algorithm> |
| #include <map> |
| |
| #include "base/basictypes.h" |
| #include "net/base/net_export.h" |
| #include "net/quic/quic_bandwidth.h" |
| #include "net/quic/quic_clock.h" |
| #include "net/quic/quic_config.h" |
| #include "net/quic/quic_connection_stats.h" |
| #include "net/quic/quic_protocol.h" |
| #include "net/quic/quic_time.h" |
| |
| namespace net { |
| |
| class RttStats; |
| |
| class NET_EXPORT_PRIVATE SendAlgorithmInterface { |
| public: |
| typedef std::map<QuicPacketSequenceNumber, TransmissionInfo> CongestionMap; |
| |
| static SendAlgorithmInterface* Create(const QuicClock* clock, |
| const RttStats* rtt_stats, |
| CongestionFeedbackType type, |
| QuicConnectionStats* stats); |
| |
| virtual ~SendAlgorithmInterface() {} |
| |
| virtual void SetFromConfig(const QuicConfig& config, bool is_server) = 0; |
| |
| // Called when we receive congestion feedback from remote peer. |
| virtual void OnIncomingQuicCongestionFeedbackFrame( |
| const QuicCongestionFeedbackFrame& feedback, |
| QuicTime feedback_receive_time) = 0; |
| |
| // Indicates an update to the congestion state, caused either by an incoming |
| // ack or loss event timeout. |rtt_updated| indicates whether a new |
| // latest_rtt sample has been taken, |byte_in_flight| the bytes in flight |
| // prior to the congestion event. |acked_packets| and |lost_packets| are |
| // any packets considered acked or lost as a result of the congestion event. |
| virtual void OnCongestionEvent(bool rtt_updated, |
| QuicByteCount bytes_in_flight, |
| const CongestionMap& acked_packets, |
| const CongestionMap& lost_packets) = 0; |
| |
| // Inform that we sent |bytes| to the wire, and if the packet is |
| // retransmittable. Returns true if the packet should be tracked by the |
| // congestion manager and included in bytes_in_flight, false otherwise. |
| // |bytes_in_flight| is the number of bytes in flight before the packet was |
| // sent. |
| // Note: this function must be called for every packet sent to the wire. |
| virtual bool OnPacketSent(QuicTime sent_time, |
| QuicByteCount bytes_in_flight, |
| QuicPacketSequenceNumber sequence_number, |
| QuicByteCount bytes, |
| HasRetransmittableData is_retransmittable) = 0; |
| |
| // Called when the retransmission timeout fires. Neither OnPacketAbandoned |
| // nor OnPacketLost will be called for these packets. |
| virtual void OnRetransmissionTimeout(bool packets_retransmitted) = 0; |
| |
| // Calculate the time until we can send the next packet. |
| virtual QuicTime::Delta TimeUntilSend( |
| QuicTime now, |
| QuicByteCount bytes_in_flight, |
| HasRetransmittableData has_retransmittable_data) const = 0; |
| |
| // What's the current estimated bandwidth in bytes per second. |
| // Returns 0 when it does not have an estimate. |
| virtual QuicBandwidth BandwidthEstimate() const = 0; |
| |
| // Get the send algorithm specific retransmission delay, called RTO in TCP, |
| // Note 1: the caller is responsible for sanity checking this value. |
| // Note 2: this will return zero if we don't have enough data for an estimate. |
| virtual QuicTime::Delta RetransmissionDelay() const = 0; |
| |
| // Returns the size of the current congestion window in bytes. Note, this is |
| // not the *available* window. Some send algorithms may not use a congestion |
| // window and will return 0. |
| virtual QuicByteCount GetCongestionWindow() const = 0; |
| }; |
| |
| } // namespace net |
| |
| #endif // NET_QUIC_CONGESTION_CONTROL_SEND_ALGORITHM_INTERFACE_H_ |