Introduce STATE_RESERVED_REMOTE. No behavioral changes

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 <deque>
 #include <string>
 #include <vector>
@@ skipping 268 matching lines @@
   // writes.
   bool WasEverUsed() const;
 
   const BoundNetLog& net_log() const { return net_log_; }
 
   base::Time GetRequestTime() const;
   void SetRequestTime(base::Time t);
 
   // Called at most once by the SpdySession when the initial response
   // headers have been received for this stream, i.e., a SYN_REPLY (or
-  // SYN_STREAM for push streams) frame has been received. This is the
-  // entry point for a push stream. Returns a status code; if it is
-  // an error, the stream was closed by this function.
+  // SYN_STREAM for push streams) frame has been received. Returns a status
+  // code; if it is an error, the stream was closed by this function.
   int OnInitialResponseHeadersReceived(const SpdyHeaderBlock& response_headers,
                                        base::Time response_time,
                                        base::TimeTicks recv_first_byte_time);
 
   // Called by the SpdySession (only after
   // OnInitialResponseHeadersReceived() has been called) when
   // late-bound headers are received for a stream. Returns a status
   // code; if it is an error, the stream was closed by this function.
   int OnAdditionalResponseHeadersReceived(
       const SpdyHeaderBlock& additional_response_headers);
 
+  // Called by the SpdySession when PUSH_PROMISE is received. This is the

[Johnny, 2014/06/05 02:56:04]

I'm worried about the use of exact frame names in comments & code names, here
and elsewhere. I think that'll confuse readers as to when a literal SYN_STREAM
or PUSH_PROMISE frame is meant, vs when we just mean "a frame carrying request
headers opening a stream".

[baranovich, 2014/06/05 19:16:58]

Done.

+  // entry point for a push stream.. Stream transits to STATE_RESERVED_REMOTE
+  // state. Returns a status code; if it is an error, the stream was closed by
+  // this function.
+  int OnPushPromiseHeadersReceived(const SpdyHeaderBlock& headers);
+
   // Called by the SpdySession when response data has been received
   // for this stream.  This callback may be called multiple times as
   // data arrives from the network, and will never be called prior to
   // OnResponseHeadersReceived.
   //
   // |buffer| contains the data received, or NULL if the stream is
   //          being closed.  The stream must copy any data from this
   //          buffer before returning from this callback.
   //
   // |length| is the number of bytes received (at most 2^24 - 1) or 0 if
@@ skipping 120 matching lines @@
 
  private:
   class SynStreamBufferProducer;
   class HeaderBufferProducer;
 
   // SpdyStream states and transitions are modeled
   // on the HTTP/2 stream state machine. All states and transitions
   // are modeled, with the exceptions of RESERVED_LOCAL (the client
   // cannot initate push streams), and the transition to OPEN due to
   // a remote SYN_STREAM (the client can only initate streams).
-  // TODO(jgraettinger): RESERVED_REMOTE must be added to the state
-  // machine when PUSH_PROMISE is implemented.
   enum State {
     STATE_IDLE,
     STATE_OPEN,
     STATE_HALF_CLOSED_LOCAL_UNCLAIMED,
     STATE_HALF_CLOSED_LOCAL,
     STATE_HALF_CLOSED_REMOTE,
+    STATE_RESERVED_REMOTE,
     STATE_CLOSED,
   };
 
   // Update the histograms.  Can safely be called repeatedly, but should only
   // be called after the stream has completed.
   void UpdateHistograms();
 
   // When a server-push stream is claimed by SetDelegate(), this function is
   // posted on the current MessageLoop to replay everything the server has sent.
   // From the perspective of SpdyStream's state machine, headers, data, and
@@ skipping 100 matching lines @@
   bool write_handler_guard_;
 
   base::WeakPtrFactory<SpdyStream> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(SpdyStream);
 };
 
 }  // namespace net
 
 #endif  // NET_SPDY_SPDY_STREAM_H_