blob: 6fcf3888e18a8dd205460b3cbcb178a3bab25a8c [file] [log] [blame]
xunjieli11834f02015-12-22 04:27:081// Copyright 2015 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_HTTP_BIDIRECTIONAL_STREAM_H_
6#define NET_HTTP_BIDIRECTIONAL_STREAM_H_
7
8#include <stdint.h>
9
danakj1fd259a02016-04-16 03:17:0910#include <memory>
Bence Béky6d05ebd2017-05-16 00:09:0111#include <vector>
danakj1fd259a02016-04-16 03:17:0912
xunjieli11834f02015-12-22 04:27:0813#include "base/compiler_specific.h"
14#include "base/macros.h"
xunjielibe07785e2016-04-14 21:15:2915#include "base/memory/ref_counted.h"
xunjieli3b6ac702016-06-06 21:36:2816#include "base/memory/weak_ptr.h"
xunjielid58621f2016-08-12 18:33:0017#include "base/time/time.h"
xunjieli369d0922016-09-23 18:45:0618#include "net/base/load_timing_info.h"
bnc81c46c1f2016-10-04 16:25:5919#include "net/base/net_export.h"
xunjieli5749218c2016-03-22 16:43:0620#include "net/http/bidirectional_stream_impl.h"
xunjieli11834f02015-12-22 04:27:0821#include "net/http/http_stream_factory.h"
Bence Béky6b44abf2018-04-11 10:32:5122#include "net/http/http_stream_request.h"
mikecironef22f9812016-10-04 03:40:1923#include "net/log/net_log_with_source.h"
Bence Béky584ccf962020-10-22 20:18:3924#include "net/third_party/quiche/src/spdy/core/spdy_header_block.h"
Nico Weber13d106e2015-12-22 21:41:5625
tzik08d8d6e2018-07-09 04:11:4726namespace base {
27class OneShotTimer;
28} // namespace base
29
xunjieli11834f02015-12-22 04:27:0830namespace net {
31
32class HttpAuthController;
33class HttpNetworkSession;
34class HttpStream;
xunjieli11834f02015-12-22 04:27:0835class IOBuffer;
36class ProxyInfo;
xunjieli11834f02015-12-22 04:27:0837struct BidirectionalStreamRequestInfo;
Brad Lassey5f488db42017-07-19 00:30:4638struct NetErrorDetails;
xunjieli11834f02015-12-22 04:27:0839struct SSLConfig;
40
41// A class to do HTTP/2 bidirectional streaming. Note that at most one each of
xunjieli07a42ce2016-04-26 20:05:3142// ReadData or SendData/SendvData should be in flight until the operation
43// completes. The BidirectionalStream must be torn down before the
44// HttpNetworkSession.
Nico Weber43ddd7a32017-08-15 19:19:2745class NET_EXPORT BidirectionalStream : public BidirectionalStreamImpl::Delegate,
46 public HttpStreamRequest::Delegate {
xunjieli11834f02015-12-22 04:27:0847 public:
48 // Delegate interface to get notified of success of failure. Callbacks will be
49 // invoked asynchronously.
50 class NET_EXPORT Delegate {
51 public:
52 Delegate();
53
xunjieli07a42ce2016-04-26 20:05:3154 // Called when the stream is ready for writing and reading. This is called
55 // at most once for the lifetime of a stream.
xunjieli11834f02015-12-22 04:27:0856 // The delegate may call BidirectionalStream::ReadData to start reading,
57 // or call BidirectionalStream::SendData to send data.
58 // The delegate should not call BidirectionalStream::Cancel
59 // during this callback.
xunjielibcb0f86e2016-06-03 00:49:2960 // |request_headers_sent| if true, request headers have been sent. If false,
61 // SendRequestHeaders() needs to be explicitly called.
62 virtual void OnStreamReady(bool request_headers_sent) = 0;
xunjieli11834f02015-12-22 04:27:0863
64 // Called when headers are received. This is called at most once for the
65 // lifetime of a stream.
66 // The delegate may call BidirectionalStream::ReadData to start reading,
67 // call BidirectionalStream::SendData to send data,
68 // or call BidirectionalStream::Cancel to cancel the stream.
Ryan Hamilton0239aac2018-05-19 00:03:1369 virtual void OnHeadersReceived(
Bence Béky4c325e52020-10-22 20:48:0170 const spdy::Http2HeaderBlock& response_headers) = 0;
xunjieli11834f02015-12-22 04:27:0871
72 // Called when a pending read is completed asynchronously.
73 // |bytes_read| specifies how much data is read.
74 // The delegate may call BidirectionalStream::ReadData to continue
75 // reading, call BidirectionalStream::SendData to send data,
76 // or call BidirectionalStream::Cancel to cancel the stream.
77 virtual void OnDataRead(int bytes_read) = 0;
78
79 // Called when the entire buffer passed through SendData is sent.
80 // The delegate may call BidirectionalStream::ReadData to continue
81 // reading, call BidirectionalStream::SendData to send data,
82 // The delegate should not call BidirectionalStream::Cancel
83 // during this callback.
84 virtual void OnDataSent() = 0;
85
86 // Called when trailers are received. This is called as soon as trailers
87 // are received, which can happen before a read completes.
88 // The delegate is able to continue reading if there is no pending read and
89 // EOF has not been received, or to send data if there is no pending send.
Bence Béky4c325e52020-10-22 20:48:0190 virtual void OnTrailersReceived(const spdy::Http2HeaderBlock& trailers) = 0;
xunjieli11834f02015-12-22 04:27:0891
xunjieli707f8952016-06-06 15:22:0692 // Called when an error occurred. Do not call into the stream after this
93 // point. No other delegate functions will be called after this.
xunjieli11834f02015-12-22 04:27:0894 virtual void OnFailed(int error) = 0;
95
96 protected:
97 virtual ~Delegate();
98
99 private:
100 DISALLOW_COPY_AND_ASSIGN(Delegate);
101 };
102
103 // Constructs a BidirectionalStream. |request_info| contains information about
104 // the request, and must be non-NULL. |session| is the http network session
105 // with which this request will be made. |delegate| must be non-NULL.
106 // |session| and |delegate| must outlive |this|.
xunjielibcb0f86e2016-06-03 00:49:29107 // |send_request_headers_automatically| if true, request headers will be sent
108 // automatically when stream is negotiated. If false, request headers will be
109 // sent only when SendRequestHeaders() is invoked or with
110 // next SendData/SendvData.
danakj1fd259a02016-04-16 03:17:09111 BidirectionalStream(
112 std::unique_ptr<BidirectionalStreamRequestInfo> request_info,
113 HttpNetworkSession* session,
xunjielibcb0f86e2016-06-03 00:49:29114 bool send_request_headers_automatically,
danakj1fd259a02016-04-16 03:17:09115 Delegate* delegate);
xunjieli11834f02015-12-22 04:27:08116
117 // Constructor that accepts a Timer, which can be used in tests to control
118 // the buffering of received data.
danakj1fd259a02016-04-16 03:17:09119 BidirectionalStream(
120 std::unique_ptr<BidirectionalStreamRequestInfo> request_info,
121 HttpNetworkSession* session,
xunjielibcb0f86e2016-06-03 00:49:29122 bool send_request_headers_automatically,
danakj1fd259a02016-04-16 03:17:09123 Delegate* delegate,
tzik08d8d6e2018-07-09 04:11:47124 std::unique_ptr<base::OneShotTimer> timer);
xunjieli11834f02015-12-22 04:27:08125
xunjieli5749218c2016-03-22 16:43:06126 // Cancels |stream_request_| or |stream_impl_| if applicable.
xunjieli11834f02015-12-22 04:27:08127 // |this| should not be destroyed during Delegate::OnHeadersSent or
128 // Delegate::OnDataSent.
129 ~BidirectionalStream() override;
130
xunjielibcb0f86e2016-06-03 00:49:29131 // Sends request headers to server.
132 // When |send_request_headers_automatically_| is
133 // false and OnStreamReady() is invoked with request_headers_sent = false,
134 // headers will be combined with next SendData/SendvData unless this
135 // method is called first, in which case headers will be sent separately
136 // without delay.
137 // (This method cannot be called when |send_request_headers_automatically_| is
138 // true nor when OnStreamReady() is invoked with request_headers_sent = true,
139 // since headers have been sent by the stream when stream is negotiated
140 // successfully.)
141 void SendRequestHeaders();
142
xunjieli11834f02015-12-22 04:27:08143 // Reads at most |buf_len| bytes into |buf|. Returns the number of bytes read,
144 // or ERR_IO_PENDING if the read is to be completed asynchronously, or an
145 // error code if any error occurred. If returns 0, there is no more data to
Helen Li77b0acd2017-11-02 14:25:10146 // read. This should not be called before Delegate::OnStreamReady is
xunjieli11834f02015-12-22 04:27:08147 // invoked, and should not be called again unless it returns with number
148 // greater than 0 or until Delegate::OnDataRead is invoked.
149 int ReadData(IOBuffer* buf, int buf_len);
150
Helen Li77b0acd2017-11-02 14:25:10151 // Sends data. This should not be called before Delegate::OnStreamReady is
xunjieli11834f02015-12-22 04:27:08152 // invoked, and should not be called again until Delegate::OnDataSent is
153 // invoked. If |end_stream| is true, the DATA frame will have an END_STREAM
154 // flag.
xunjieli2328a2682016-05-16 19:38:25155 void SendvData(const std::vector<scoped_refptr<IOBuffer>>& buffers,
xunjieli07a42ce2016-04-26 20:05:31156 const std::vector<int>& lengths,
157 bool end_stream);
158
xunjieli11834f02015-12-22 04:27:08159 // Returns the protocol used by this stream. If stream has not been
160 // established, return kProtoUnknown.
161 NextProto GetProtocol() const;
162
163 // Total number of bytes received over the network of SPDY data, headers, and
164 // push_promise frames associated with this stream, including the size of
165 // frame headers, after SSL decryption and not including proxy overhead.
166 // If stream has not been established, return 0.
167 int64_t GetTotalReceivedBytes() const;
168
169 // Total number of bytes sent over the network of SPDY frames associated with
170 // this stream, including the size of frame headers, before SSL encryption and
171 // not including proxy overhead. Note that some SPDY frames such as pings are
172 // not associated with any stream, and are not included in this value.
173 int64_t GetTotalSentBytes() const;
174
xunjieli369d0922016-09-23 18:45:06175 // Gets LoadTimingInfo of this stream.
176 void GetLoadTimingInfo(LoadTimingInfo* load_timing_info) const;
xunjieli11834f02015-12-22 04:27:08177
Brad Lassey5f488db42017-07-19 00:30:46178 // Get the network error details this stream is encountering.
179 // Fills in |details| if it is available; leaves |details| unchanged if it
180 // is unavailable.
181 void PopulateNetErrorDetails(NetErrorDetails* details);
182
xunjieli11834f02015-12-22 04:27:08183 private:
Helen Li43e3bee2018-03-21 16:57:11184 void StartRequest(const SSLConfig& ssl_config);
xunjieli5749218c2016-03-22 16:43:06185 // BidirectionalStreamImpl::Delegate implementation:
xunjielibcb0f86e2016-06-03 00:49:29186 void OnStreamReady(bool request_headers_sent) override;
Ryan Hamilton0239aac2018-05-19 00:03:13187 void OnHeadersReceived(
Bence Béky4c325e52020-10-22 20:48:01188 const spdy::Http2HeaderBlock& response_headers) override;
xunjieli11834f02015-12-22 04:27:08189 void OnDataRead(int bytes_read) override;
190 void OnDataSent() override;
Bence Béky4c325e52020-10-22 20:48:01191 void OnTrailersReceived(const spdy::Http2HeaderBlock& trailers) override;
xunjieli11834f02015-12-22 04:27:08192 void OnFailed(int error) override;
193
194 // HttpStreamRequest::Delegate implementation:
195 void OnStreamReady(const SSLConfig& used_ssl_config,
196 const ProxyInfo& used_proxy_info,
bnc5029f4632017-06-08 16:19:00197 std::unique_ptr<HttpStream> stream) override;
xunjieli5749218c2016-03-22 16:43:06198 void OnBidirectionalStreamImplReady(
199 const SSLConfig& used_ssl_config,
200 const ProxyInfo& used_proxy_info,
bnc5029f4632017-06-08 16:19:00201 std::unique_ptr<BidirectionalStreamImpl> stream) override;
xunjieli11834f02015-12-22 04:27:08202 void OnWebSocketHandshakeStreamReady(
203 const SSLConfig& used_ssl_config,
204 const ProxyInfo& used_proxy_info,
bnc5029f4632017-06-08 16:19:00205 std::unique_ptr<WebSocketHandshakeStreamBase> stream) override;
Ryan Hamilton75f197262017-08-17 14:00:07206 void OnStreamFailed(int status,
207 const NetErrorDetails& net_error_details,
Wojciech Dzierżanowskiabdeeaf2019-04-01 20:16:22208 const SSLConfig& used_ssl_config,
dalyk6d7a8c52019-12-18 21:43:01209 const ProxyInfo& used_proxy_info,
210 ResolveErrorInfo resolve_error_info) override;
xunjieli11834f02015-12-22 04:27:08211 void OnCertificateError(int status,
212 const SSLConfig& used_ssl_config,
213 const SSLInfo& ssl_info) override;
214 void OnNeedsProxyAuth(const HttpResponseInfo& response_info,
215 const SSLConfig& used_ssl_config,
216 const ProxyInfo& used_proxy_info,
217 HttpAuthController* auth_controller) override;
218 void OnNeedsClientAuth(const SSLConfig& used_ssl_config,
219 SSLCertRequestInfo* cert_info) override;
xunjieli11834f02015-12-22 04:27:08220 void OnQuicBroken() override;
221
xunjieli3b6ac702016-06-06 21:36:28222 // Helper method to notify delegate if there is an error.
223 void NotifyFailed(int error);
224
xunjieli11834f02015-12-22 04:27:08225 // BidirectionalStreamRequestInfo used when requesting the stream.
danakj1fd259a02016-04-16 03:17:09226 std::unique_ptr<BidirectionalStreamRequestInfo> request_info_;
tfarina428341112016-09-22 13:38:20227 const NetLogWithSource net_log_;
xunjieli11834f02015-12-22 04:27:08228
xunjielib3a648e2016-03-22 03:39:51229 HttpNetworkSession* session_;
230
xunjielibcb0f86e2016-06-03 00:49:29231 bool send_request_headers_automatically_;
232 // Whether request headers have been sent, as indicated in OnStreamReady()
233 // callback.
234 bool request_headers_sent_;
235
xunjieli11834f02015-12-22 04:27:08236 Delegate* const delegate_;
237
238 // Timer used to buffer data received in short time-spans and send a single
239 // read completion notification.
tzik08d8d6e2018-07-09 04:11:47240 std::unique_ptr<base::OneShotTimer> timer_;
xunjieli5749218c2016-03-22 16:43:06241 // HttpStreamRequest used to request a BidirectionalStreamImpl. This is NULL
242 // if the request has been canceled or completed.
danakj1fd259a02016-04-16 03:17:09243 std::unique_ptr<HttpStreamRequest> stream_request_;
xunjieli5749218c2016-03-22 16:43:06244 // The underlying BidirectioanlStreamImpl used for this stream. It is
245 // non-NULL, if the |stream_request_| successfully finishes.
danakj1fd259a02016-04-16 03:17:09246 std::unique_ptr<BidirectionalStreamImpl> stream_impl_;
xunjieli11834f02015-12-22 04:27:08247
xunjielibe07785e2016-04-14 21:15:29248 // Buffer used for reading.
249 scoped_refptr<IOBuffer> read_buffer_;
xunjieli07a42ce2016-04-26 20:05:31250 // List of buffers used for writing.
251 std::vector<scoped_refptr<IOBuffer>> write_buffer_list_;
252 // List of buffer length.
253 std::vector<int> write_buffer_len_list_;
xunjielibe07785e2016-04-14 21:15:29254
xunjieli369d0922016-09-23 18:45:06255 // TODO(xunjieli): Remove this once LoadTimingInfo has response end.
xunjielid58621f2016-08-12 18:33:00256 base::TimeTicks read_end_time_;
xunjieli369d0922016-09-23 18:45:06257
258 // Load timing info of this stream. |connect_timing| is obtained when headers
259 // are received. Other fields are populated at different stages of the request
260 LoadTimingInfo load_timing_info_;
xunjielid58621f2016-08-12 18:33:00261
Jeremy Romand54000b22019-07-08 18:40:16262 base::WeakPtrFactory<BidirectionalStream> weak_factory_{this};
xunjieli3b6ac702016-06-06 21:36:28263
xunjieli11834f02015-12-22 04:27:08264 DISALLOW_COPY_AND_ASSIGN(BidirectionalStream);
265};
266
267} // namespace net
268
269#endif // NET_HTTP_BIDIRECTIONAL_STREAM_H_