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