[SPDY] Refactor SpdySession's write queue

net/spdy/spdy_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.
 
 #ifndef NET_SPDY_SPDY_STREAM_H_
 #define NET_SPDY_SPDY_STREAM_H_
 
-#include <list>
+#include <deque>
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/weak_ptr.h"
 #include "googleurl/src/gurl.h"
 #include "net/base/bandwidth_metrics.h"
 #include "net/base/io_buffer.h"
@@ skipping 76 matching lines @@
    private:
     DISALLOW_COPY_AND_ASSIGN(Delegate);
   };
 
   // Indicates pending frame type.
   enum FrameType {
     TYPE_HEADERS,
     TYPE_DATA
   };
 
-  // Structure to contains pending frame information.
-  typedef struct {
-    FrameType type;
-    union {
-      SpdyHeaderBlock* header_block;
-      SpdyFrame* data_frame;
-    };
-  } PendingFrame;
-
   // SpdyStream constructor
   SpdyStream(SpdySession* session,
              const std::string& path,
              RequestPriority priority,
              int32 initial_send_window_size,
              int32 initial_recv_window_size,
              bool pushed,
              const BoundNetLog& net_log);
 
   // Set new |delegate|. |delegate| must not be NULL.
@@ skipping 168 matching lines @@
   // Returns true if the URL for this stream is known.
   bool HasUrl() const;
 
   // Get the URL associated with this stream.  Only valid when has_url() is
   // true.
   GURL GetUrl() const;
 
   int GetProtocolVersion() const;
 
  private:
-  class SpdyStreamIOBufferProducer;
+  class SynStreamFrameProducer;
+  class HeaderFrameProducer;
 
   enum State {
     STATE_NONE,
     STATE_GET_DOMAIN_BOUND_CERT,
     STATE_GET_DOMAIN_BOUND_CERT_COMPLETE,
     STATE_SEND_DOMAIN_BOUND_CERT,
     STATE_SEND_DOMAIN_BOUND_CERT_COMPLETE,
     STATE_SEND_HEADERS,
     STATE_SEND_HEADERS_COMPLETE,
     STATE_SEND_BODY,
@@ skipping 26 matching lines @@
   int DoOpen(int result);
 
   // Update the histograms.  Can safely be called repeatedly, but should only
   // be called after the stream has completed.
   void UpdateHistograms();
 
   // When a server pushed stream is first created, this function is posted on
   // the MessageLoop to replay all the data that the server has already sent.
   void PushedStreamReplayData();
 
-  // Informs the SpdySession that this stream has a write available.
-  void SetHasWriteAvailable();
+  // Produces the SYN_STREAM frame for the stream. The stream must
+  // already be activated.
+  scoped_ptr<SpdyFrame> ProduceSynStreamFrame();
 
-  // Returns a newly created SPDY frame owned by the called that contains
-  // the next frame to be sent by this frame.  May return NULL if this
-  // stream has become stalled on flow control.
-  scoped_ptr<SpdyFrame> ProduceNextFrame();
+  // Produce the initial HEADER frame for the stream with the given
+  // block. The stream must already be activated.
+  scoped_ptr<SpdyFrame> ProduceHeaderFrame(
+      scoped_ptr<SpdyHeaderBlock> header_block);
 
   // If the stream is active and stream flow control is turned on,
   // called by OnDataReceived (which is in turn called by the session)
   // to decrease this stream's receive window size by
   // |delta_window_size|, which must be at least 1 and must not cause
   // this stream's receive window size to go negative.
   void DecreaseRecvWindowSize(int32 delta_window_size);
 
   base::WeakPtrFactory<SpdyStream> weak_ptr_factory_;
 
@@ skipping 25 matching lines @@
   // The request to send.
   scoped_ptr<SpdyHeaderBlock> request_;
 
   // The time at which the request was made that resulted in this response.
   // For cached responses, this time could be "far" in the past.
   base::Time request_time_;
 
   scoped_ptr<SpdyHeaderBlock> response_;
   base::Time response_time_;
 
-  // An in order list of pending frame data that are going to be sent. HEADERS
-  // frames are queued as SpdyHeaderBlock structures because these must be
-  // compressed just before sending. Data frames are queued as SpdyDataFrame.
-  std::list<PendingFrame> pending_frames_;
-
-  // An in order list of sending frame types. It will be used to know which type
-  // of frame is sent and which callback should be invoked in OnOpen().
-  std::list<FrameType> waiting_completions_;
+  // An in order list of sending frame types. Used communicate to the
+  // delegate which type of frame was sent in DoOpen().
+  //
+  // TODO(akalin): We can remove the need for this queue if we add an
+  // OnFrameSent() callback to SpdyFrameProducer and have the session
+  // call that instead of SpdyStream::OnWriteComplete().
+  std::deque<FrameType> waiting_completions_;
 
   State io_state_;
 
   // Since we buffer the response, we also buffer the response status.
   // Not valid until the stream is closed.
   int response_status_;
 
   bool cancelled_;
   bool has_upload_data_;
 
@@ skipping 11 matching lines @@
   std::string domain_bound_private_key_;
   std::string domain_bound_cert_;
   ServerBoundCertService::RequestHandle domain_bound_cert_request_handle_;
 
   DISALLOW_COPY_AND_ASSIGN(SpdyStream);
 };
 
 }  // namespace net
 
 #endif  // NET_SPDY_SPDY_STREAM_H_