Landing Recent QUIC changes until 03:18 AM, May 28, UTC

net/quic/core/quic_stream.h

 // 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 base class for client/server QUIC streams.
 
 // It does not contain the entire interface needed by an application to interact
 // with a QUIC stream.  Some parts of the interface must be obtained by
 // accessing the owning session object.  A subclass of QuicStream
 // connects the object and the application that generates and consumes the data
@@ skipping 11 matching lines @@
 #include <list>
 #include <string>
 
 #include "base/macros.h"
 #include "net/base/iovec.h"
 #include "net/quic/core/quic_flow_controller.h"
 #include "net/quic/core/quic_iovector.h"
 #include "net/quic/core/quic_packets.h"
 #include "net/quic/core/quic_stream_sequencer.h"
 #include "net/quic/core/quic_types.h"
+#include "net/quic/core/stream_notifier_interface.h"
 #include "net/quic/platform/api/quic_export.h"
 #include "net/quic/platform/api/quic_reference_counted.h"
 #include "net/quic/platform/api/quic_string_piece.h"
 
 namespace net {
 
 namespace test {
 class QuicStreamPeer;
 }  // namespace test
 
 class QuicSession;
 
-class QUIC_EXPORT_PRIVATE QuicStream {
+class QUIC_EXPORT_PRIVATE QuicStream : public StreamNotifierInterface {
  public:
   QuicStream(QuicStreamId id, QuicSession* session);
 
-  virtual ~QuicStream();
+  ~QuicStream() override;
 
   // Not in use currently.
   void SetFromConfig();
 
   // Called by the session when a (potentially duplicate) stream frame has been
   // received for this stream.
   virtual void OnStreamFrame(const QuicStreamFrame& frame);
 
   // Called by the session when the connection becomes writeable to allow the
   // stream to write any pending data.
@@ skipping 25 matching lines @@
 
   // Called by the subclass or the sequencer to reset the stream from this
   // end.
   virtual void Reset(QuicRstStreamErrorCode error);
 
   // Called by the subclass or the sequencer to close the entire connection from
   // this end.
   virtual void CloseConnectionWithDetails(QuicErrorCode error,
                                           const std::string& details);
 
+  // Returns true if this stream is still waiting for acks of sent data.
+  // This will return false if all data has been acked, or if the stream
+  // is no longer interested in data being acked (which happens when
+  // a stream is reset because of an error).
+  bool IsWaitingForAcks() const;
+
   QuicStreamId id() const { return id_; }
 
   QuicRstStreamErrorCode stream_error() const { return stream_error_; }
   QuicErrorCode connection_error() const { return connection_error_; }
 
   bool reading_stopped() const {
     return sequencer_.ignore_read_data() || read_side_closed_;
   }
   bool write_side_closed() const { return write_side_closed_; }
 
@@ skipping 78 matching lines @@
   // If fin is true: if it is immediately passed on to the session,
   // write_side_closed() becomes true, otherwise fin_buffered_ becomes true.
   void WriteOrBufferData(
       QuicStringPiece data,
       bool fin,
       QuicReferenceCountedPointer<QuicAckListenerInterface> ack_listener);
 
   // Adds random padding after the fin is consumed for this stream.
   void AddRandomPaddingAfterFin();
 
+  // StreamNotifierInterface methods:
+  void OnStreamFrameAcked(const QuicStreamFrame& frame,
+                          QuicTime::Delta ack_delay_time) override;
+  void OnStreamFrameRetransmitted(const QuicStreamFrame& frame) override;
+
  protected:
   // Sends as many bytes in the first |count| buffers of |iov| to the connection
   // as the connection will consume.
   // If |ack_listener| is provided, then it will be notified once all
   // the ACKs for this write have been received.
   // Returns the number of bytes consumed by the connection.
   QuicConsumedData WritevData(
       const struct iovec* iov,
       int iov_count,
       bool fin,
@@ skipping 17 matching lines @@
   const QuicSession* session() const { return session_; }
   QuicSession* session() { return session_; }
 
   const QuicStreamSequencer* sequencer() const { return &sequencer_; }
   QuicStreamSequencer* sequencer() { return &sequencer_; }
 
   void DisableConnectionFlowControlForThisStream() {
     stream_contributes_to_connection_flow_control_ = false;
   }
 
+  void set_ack_listener(
+      QuicReferenceCountedPointer<QuicAckListenerInterface> ack_listener) {
+    ack_listener_ = std::move(ack_listener);
+  }
+
  private:
   friend class test::QuicStreamPeer;
   friend class QuicStreamUtils;
 
   // Close the read side of the socket.  May cause the stream to be closed.
   // Subclasses and consumers should use StopReading to terminate reading early.
   void CloseReadSide();
 
   // Subclasses and consumers should use reading_stopped.
   bool read_side_closed() const { return read_side_closed_; }
@@ skipping 24 matching lines @@
   uint64_t queued_data_bytes_;
 
   QuicStreamSequencer sequencer_;
   QuicStreamId id_;
   // Pointer to the owning QuicSession object.
   QuicSession* session_;
   // Bytes read and written refer to payload bytes only: they do not include
   // framing, encryption overhead etc.
   uint64_t stream_bytes_read_;
   uint64_t stream_bytes_written_;
+  // Written bytes which have been acked.
+  uint64_t stream_bytes_acked_;
 
   // Stream error code received from a RstStreamFrame or error code sent by the
   // visitor or sequencer in the RstStreamFrame.
   QuicRstStreamErrorCode stream_error_;
   // Connection error code due to which the stream was closed. |stream_error_|
   // is set to |QUIC_STREAM_CONNECTION_ERROR| when this happens and consumers
   // should check |connection_error_|.
   QuicErrorCode connection_error_;
 
   // True if the read side is closed and further frames should be rejected.
   bool read_side_closed_;
   // True if the write side is closed, and further writes should fail.
   bool write_side_closed_;
 
   // True if the subclass has written a FIN with WriteOrBufferData, but it was
   // buffered in queued_data_ rather than being sent to the session.
   bool fin_buffered_;
   // True if a FIN has been sent to the session.
   bool fin_sent_;
+  // True if a FIN has been acked.
+  bool fin_acked_;
 
   // True if this stream has received (and the sequencer has accepted) a
   // StreamFrame with the FIN set.
   bool fin_received_;
 
   // True if an RST_STREAM has been sent to the session.
   // In combination with fin_sent_, used to ensure that a FIN and/or a
   // RST_STREAM is always sent to terminate the stream.
   bool rst_sent_;
 
@@ skipping 15 matching lines @@
   bool stream_contributes_to_connection_flow_control_;
 
   // A counter incremented when OnCanWrite() is called and no progress is made.
   // For debugging only.
   size_t busy_counter_;
 
   // Indicates whether paddings will be added after the fin is consumed for this
   // stream.
   bool add_random_padding_after_fin_;
 
+  // Ack listener of this stream, and it is notified when any of written bytes
+  // are acked.
+  QuicReferenceCountedPointer<QuicAckListenerInterface> ack_listener_;
+
   DISALLOW_COPY_AND_ASSIGN(QuicStream);
 };
 
 }  // namespace net
 
 #endif  // NET_QUIC_CORE_QUIC_STREAM_H_