net/spdy/spdy_http_stream.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 #ifndef NET_SPDY_SPDY_HTTP_STREAM_H_
   6 #define NET_SPDY_SPDY_HTTP_STREAM_H_
   7
   8 #include <list>
   9
  10 #include "base/basictypes.h"
  11 #include "base/memory/ref_counted.h"
  12 #include "base/memory/weak_ptr.h"
  13 #include "net/base/completion_callback.h"
  14 #include "net/base/net_log.h"
  15 #include "net/http/http_stream.h"
  16 #include "net/spdy/spdy_read_queue.h"
  17 #include "net/spdy/spdy_session.h"
  18 #include "net/spdy/spdy_stream.h"
  19
  20 namespace net {
  21
  22 class DrainableIOBuffer;
  23 struct HttpRequestInfo;
  24 class HttpResponseInfo;
  25 class IOBuffer;
  26 class SpdySession;
  27 class UploadDataStream;
  28
  29 // The SpdyHttpStream is a HTTP-specific type of stream known to a SpdySession.
  30 class NET_EXPORT_PRIVATE SpdyHttpStream : public SpdyStream::Delegate,
  31                                           public HttpStream {
  32  public:
  33   // |spdy_session| must not be NULL.
  34   SpdyHttpStream(const base::WeakPtr<SpdySession>& spdy_session, bool direct);
  35   virtual ~SpdyHttpStream();
  36
  37   SpdyStream* stream() { return stream_.get(); }
  38
  39   // Cancels any callbacks from being invoked and deletes the stream.
  40   void Cancel();
  41
  42   // HttpStream implementation.
  43
  44   virtual int InitializeStream(const HttpRequestInfo* request_info,
  45                                RequestPriority priority,
  46                                const BoundNetLog& net_log,
  47                                const CompletionCallback& callback) OVERRIDE;
  48
  49   virtual int SendRequest(const HttpRequestHeaders& headers,
  50                           HttpResponseInfo* response,
  51                           const CompletionCallback& callback) OVERRIDE;
  52   virtual UploadProgress GetUploadProgress() const OVERRIDE;
  53   virtual int ReadResponseHeaders(const CompletionCallback& callback) OVERRIDE;
  54   virtual const HttpResponseInfo* GetResponseInfo() const OVERRIDE;
  55   virtual int ReadResponseBody(IOBuffer* buf,
  56                                int buf_len,
  57                                const CompletionCallback& callback) OVERRIDE;
  58   virtual void Close(bool not_reusable) OVERRIDE;
  59   virtual HttpStream* RenewStreamForAuth() OVERRIDE;
  60   virtual bool IsResponseBodyComplete() const OVERRIDE;
  61   virtual bool CanFindEndOfResponse() const OVERRIDE;
  62
  63   // Must not be called if a NULL SpdySession was pssed into the
  64   // constructor.
  65   virtual bool IsConnectionReused() const OVERRIDE;
  66
  67   virtual void SetConnectionReused() OVERRIDE;
  68   virtual bool IsConnectionReusable() const OVERRIDE;
  69   virtual int64 GetTotalReceivedBytes() const OVERRIDE;
  70   virtual bool GetLoadTimingInfo(
  71       LoadTimingInfo* load_timing_info) const OVERRIDE;
  72   virtual void GetSSLInfo(SSLInfo* ssl_info) OVERRIDE;
  73   virtual void GetSSLCertRequestInfo(
  74       SSLCertRequestInfo* cert_request_info) OVERRIDE;
  75   virtual bool IsSpdyHttpStream() const OVERRIDE;
  76   virtual void Drain(HttpNetworkSession* session) OVERRIDE;
  77   virtual void SetPriority(RequestPriority priority) OVERRIDE;
  78
  79   // SpdyStream::Delegate implementation.
  80   virtual void OnRequestHeadersSent() OVERRIDE;
  81   virtual SpdyResponseHeadersStatus OnResponseHeadersUpdated(
  82       const SpdyHeaderBlock& response_headers) OVERRIDE;
  83   virtual void OnDataReceived(scoped_ptr<SpdyBuffer> buffer) OVERRIDE;
  84   virtual void OnDataSent() OVERRIDE;
  85   virtual void OnClose(int status) OVERRIDE;
  86
  87  private:
  88   // Must be called only when |request_info_| is non-NULL.
  89   bool HasUploadData() const;
  90
  91   void OnStreamCreated(const CompletionCallback& callback, int rv);
  92
  93   // Reads the remaining data (whether chunked or not) from the
  94   // request body stream and sends it if there's any. The read and
  95   // subsequent sending may happen asynchronously. Must be called only
  96   // when HasUploadData() is true.
  97   void ReadAndSendRequestBodyData();
  98
  99   // Called when data has just been read from the request body stream;
 100   // does the actual sending of data.
 101   void OnRequestBodyReadCompleted(int status);
 102
 103   // Call the user callback.
 104   void DoCallback(int rv);
 105
 106   void ScheduleBufferedReadCallback();
 107
 108   // Returns true if the callback is invoked.
 109   bool DoBufferedReadCallback();
 110   bool ShouldWaitForMoreBufferedData() const;
 111
 112   base::WeakPtrFactory<SpdyHttpStream> weak_factory_;
 113
 114   const base::WeakPtr<SpdySession> spdy_session_;
 115   bool is_reused_;
 116   SpdyStreamRequest stream_request_;
 117   base::WeakPtr<SpdyStream> stream_;
 118
 119   bool stream_closed_;
 120
 121   // Set only when |stream_closed_| is true.
 122   int closed_stream_status_;
 123   SpdyStreamId closed_stream_id_;
 124   bool closed_stream_has_load_timing_info_;
 125   LoadTimingInfo closed_stream_load_timing_info_;
 126   int64 closed_stream_received_bytes_;
 127
 128   // The request to send.
 129   const HttpRequestInfo* request_info_;
 130
 131   // |response_info_| is the HTTP response data object which is filled in
 132   // when a SYN_REPLY comes in for the stream.
 133   // It is not owned by this stream object, or point to |push_response_info_|.
 134   HttpResponseInfo* response_info_;
 135
 136   scoped_ptr<HttpResponseInfo> push_response_info_;
 137
 138   // We don't use SpdyStream's |response_header_status_| as we
 139   // sometimes call back into our delegate before it is updated.
 140   SpdyResponseHeadersStatus response_headers_status_;
 141
 142   // We buffer the response body as it arrives asynchronously from the stream.
 143   SpdyReadQueue response_body_queue_;
 144
 145   CompletionCallback callback_;
 146
 147   // User provided buffer for the ReadResponseBody() response.
 148   scoped_refptr<IOBuffer> user_buffer_;
 149   int user_buffer_len_;
 150
 151   // Temporary buffer used to read the request body from UploadDataStream.
 152   scoped_refptr<IOBufferWithSize> request_body_buf_;
 153   int request_body_buf_size_;
 154
 155   // Is there a scheduled read callback pending.
 156   bool buffered_read_callback_pending_;
 157   // Has more data been received from the network during the wait for the
 158   // scheduled read callback.
 159   bool more_read_data_pending_;
 160
 161   // Is this spdy stream direct to the origin server (or to a proxy).
 162   bool direct_;
 163
 164   DISALLOW_COPY_AND_ASSIGN(SpdyHttpStream);
 165 };
 166
 167 }  // namespace net
 168
 169 #endif  // NET_SPDY_SPDY_HTTP_STREAM_H_