net/quic/congestion_control/receive_algorithm_interface.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4 //
   5 // The pure virtual class for receive side congestion algorithm.
   6
   7 #ifndef NET_QUIC_CONGESTION_CONTROL_RECEIVE_ALGORITHM_INTERFACE_H_
   8 #define NET_QUIC_CONGESTION_CONTROL_RECEIVE_ALGORITHM_INTERFACE_H_
   9
  10 #include "base/basictypes.h"
  11 #include "net/base/net_export.h"
  12 #include "net/quic/quic_clock.h"
  13 #include "net/quic/quic_protocol.h"
  14 #include "net/quic/quic_time.h"
  15
  16 namespace net {
  17
  18 class NET_EXPORT_PRIVATE ReceiveAlgorithmInterface {
  19  public:
  20   static ReceiveAlgorithmInterface* Create(CongestionFeedbackType type);
  21
  22   virtual ~ReceiveAlgorithmInterface() {}
  23
  24   // Returns false if no QuicCongestionFeedbackFrame block is needed.
  25   // Otherwise fills in feedback and return true.
  26   virtual bool GenerateCongestionFeedback(
  27       QuicCongestionFeedbackFrame* feedback) = 0;
  28
  29   // Should be called for each incoming packet.
  30   // bytes: is the packet size in bytes including IP headers.
  31   // sequence_number: is the unique sequence number from the QUIC packet header.
  32   // timestamp: is the sent timestamp from the QUIC packet header.
  33   virtual void RecordIncomingPacket(QuicByteCount bytes,
  34                                     QuicPacketSequenceNumber sequence_number,
  35                                     QuicTime timestamp) = 0;
  36 };
  37
  38 }  // namespace net
  39
  40 #endif  // NET_QUIC_CONGESTION_CONTROL_RECEIVE_ALGORITHM_INTERFACE_H_