Index: net/http/bidirectional_stream.h |
diff --git a/net/http/bidirectional_stream.h b/net/http/bidirectional_stream.h |
new file mode 100644 |
index 0000000000000000000000000000000000000000..7f41fd04f08a035330aba6d4406caee196ee3ec4 |
--- /dev/null |
+++ b/net/http/bidirectional_stream.h |
@@ -0,0 +1,187 @@ |
+// Copyright 2015 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_HTTP_BIDIRECTIONAL_STREAM_H_ |
+#define NET_HTTP_BIDIRECTIONAL_STREAM_H_ |
+ |
+#include <stdint.h> |
+ |
+#include "base/macros.h" |
+#include "base/memory/scoped_ptr.h" |
+#include "net/base/request_priority.h" |
+#include "net/http/bidirectional_stream_job.h" |
+#include "net/http/http_stream_factory.h" |
+#include "net/ssl/ssl_config.h" |
+ |
+namespace net { |
+ |
+class BoundNetLog; |
+class HttpAuthController; |
+class HttpNetworkSession; |
+class HttpStream; |
+class HttpStreamRequest; |
+class IOBuffer; |
+class ProxyInfo; |
+class SpdyHeaderBlock; |
+ |
+// A class to do HTTP/2 bidirectional streaming. Note that at most one each of |
+// ReadData or SendData should be in flight until the operation completes |
+// The BidirectionalStream must be torn down before the HttpNetworkSession. |
+class NET_EXPORT BidirectionalStream : public BidirectionalStreamJob::Delegate, |
+ public HttpStreamRequest::Delegate { |
+ public: |
+ // Delegate interface to get notified of success of failure. Callbacks will be |
+ // invoked asynchronously. |
+ // TODO(xunjieli): Surface the protocol negotiated. |
+ class NET_EXPORT Delegate { |
+ public: |
+ Delegate() {} |
+ |
+ // Called when headers have been sent. |
+ // The delegate may call BidirectionalStreamJob::SendData to start |
+ // sending data. |
+ virtual void OnHeadersSent() = 0; |
+ |
+ // Called when headers are received. This is called at most once for the |
+ // lifetime of a stream. |
+ // The delegate may call BidirectionalStream::ReadData to start reading |
+ // or call BidirectionalStream::Cancel to cancel the stream. |
+ virtual void OnHeadersReceived(const SpdyHeaderBlock& response_headers) = 0; |
+ |
+ // Called when read is completed asynchronously. |bytes_read| specifies how |
+ // much data is available. |
+ // The delegate may call BidirectionalStream::ReadData to continue |
+ // reading or call BidirectionalStream::Cancel to cancel the stream. |
+ virtual void OnDataRead(int bytes_read) = 0; |
+ |
+ // Called when the entire buffer passed through SendData is sent. |
+ virtual void OnDataSent() = 0; |
+ |
+ // Called when trailers are received. |
+ virtual void OnTrailersReceived(const SpdyHeaderBlock& trailers) = 0; |
+ |
+ // Called when the stream is closed or an error occurred. |
+ // No other delegate functions will be called after this. |
+ virtual void OnFailed(int error) = 0; |
+ |
+ protected: |
+ virtual ~Delegate() {} |
+ |
+ private: |
+ DISALLOW_COPY_AND_ASSIGN(Delegate); |
+ }; |
+ |
+ struct NET_EXPORT RequestInfo { |
+ RequestInfo(); |
+ ~RequestInfo(); |
+ |
+ // The requested URL. |
+ GURL url; |
mmenke
2015/12/11 16:42:53
include GURL
xunjieli
2015/12/11 23:48:40
Done.
|
+ |
+ // The method to use (GET, POST, etc.). |
+ std::string method; |
+ |
+ // Any extra request headers (including User-Agent). |
+ HttpRequestHeaders extra_headers; |
+ }; |
+ |
+ BidirectionalStream(const RequestInfo& request_info, |
+ RequestPriority priority, |
+ HttpNetworkSession* session, |
+ Delegate* delegate); |
+ |
+ // Cancels |stream_request_| or |stream_job_| if applicable. |
+ ~BidirectionalStream() override; |
+ |
+ // Reads at most |buf_len| bytes into |buf|. Returns the number of bytes read, |
+ // or ERR_IO_PENDING if the read is to be completed asynchronously, or an |
+ // error code if any error occurred. |
+ // This should not be called before Delegate::OnHeadersSent is invoked, and |
+ // should not be called again unless it IO completes synchronously or until |
+ // Delegate::OnDataRead is invoked. |
+ int ReadData(IOBuffer* buf, int buf_len); |
+ |
+ // Sends data. This should not be called before Delegate::OnHeadersSent is |
+ // invoked, and should not be called again until Delegate::OnDataSent is |
+ // invoked. |
+ void SendData(IOBuffer* data, int length, bool end_stream); |
+ |
+ // If there is |stream_request_|, cancel it. If |stream_job_| is established, |
+ // cancel it. No delegate method will be called after Cancel(). |
+ // Any pending operations may or may not succeed. |
+ void Cancel(); |
+ |
+ // Getters that should only be called after headers have been received: |
+ |
+ // Returns the protocol used by this stream. Always between |
+ // kProtoSPDYMinimumVersion and kProtoSPDYMaximumVersion. |
+ NextProto GetProtocol() const; |
+ |
+ // Total number of bytes received over the network of SPDY data, headers, and |
+ // push_promise frames associated with this stream, including the size of |
+ // frame headers, after SSL decryption and not including proxy overhead. |
+ int64_t GetTotalReceivedBytes() const; |
+ |
+ // Total number of bytes sent over the network of SPDY frames associated with |
+ // this stream, including the size of frame headers, before SSL encryption and |
+ // not including proxy overhead. Note that some SPDY frames such as pings are |
+ // not associated with any stream, and are not included in this value. |
+ int64_t GetTotalSentBytes() const; |
+ |
+ // TODO(xunjieli): Implement a method to do flow control and a method to ping |
+ // remote end point. |
+ |
+ private: |
+ // BidirectionalStreamJob::Delegate implementation: |
+ void OnHeadersSent() override; |
+ void OnHeadersReceived(const SpdyHeaderBlock& response_headers) override; |
+ void OnDataRead(int bytes_read) override; |
+ void OnDataSent() override; |
+ void OnTrailersReceived(const SpdyHeaderBlock& trailers) override; |
+ void OnFailed(int error) override; |
+ |
+ // HttpStreamRequest::Delegate implementation: |
+ void OnStreamReady(const SSLConfig& used_ssl_config, |
+ const ProxyInfo& used_proxy_info, |
+ HttpStream* stream) override; |
+ void OnBidirectionalStreamJobReady(const SSLConfig& used_ssl_config, |
+ const ProxyInfo& used_proxy_info, |
+ BidirectionalStreamJob* stream) override; |
+ void OnWebSocketHandshakeStreamReady( |
+ const SSLConfig& used_ssl_config, |
+ const ProxyInfo& used_proxy_info, |
+ WebSocketHandshakeStreamBase* stream) override; |
+ void OnStreamFailed(int status, |
+ const SSLConfig& used_ssl_config, |
+ SSLFailureState ssl_failure_state) override; |
+ void OnCertificateError(int status, |
+ const SSLConfig& used_ssl_config, |
+ const SSLInfo& ssl_info) override; |
+ void OnNeedsProxyAuth(const HttpResponseInfo& response_info, |
+ const SSLConfig& used_ssl_config, |
+ const ProxyInfo& used_proxy_info, |
+ HttpAuthController* auth_controller) override; |
+ void OnNeedsClientAuth(const SSLConfig& used_ssl_config, |
+ SSLCertRequestInfo* cert_info) override; |
+ void OnHttpsProxyTunnelResponse(const HttpResponseInfo& response_info, |
+ const SSLConfig& used_ssl_config, |
+ const ProxyInfo& used_proxy_info, |
+ HttpStream* stream) override; |
+ void OnQuicBroken() override; |
+ |
+ const RequestInfo request_info_; |
+ const RequestPriority priority_; |
+ const BoundNetLog net_log_; |
+ |
+ Delegate* const delegate_; |
+ |
+ scoped_ptr<HttpStreamRequest> stream_request_; |
+ scoped_ptr<BidirectionalStreamJob> stream_job_; |
+ |
+ DISALLOW_COPY_AND_ASSIGN(BidirectionalStream); |
+}; |
+ |
+} // namespace net |
+ |
+#endif // NET_HTTP_BIDIRECTIONAL_STREAM_H_ |