Introduce RequestWebSocketStream into HttpStreamFactory

net/http/http_stream_factory_impl_request.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_HTTP_HTTP_STREAM_FACTORY_IMPL_REQUEST_H_
 #define NET_HTTP_HTTP_STREAM_FACTORY_IMPL_REQUEST_H_
 
 #include <set>
 #include "base/memory/scoped_ptr.h"
 #include "googleurl/src/gurl.h"
 #include "net/base/net_log.h"
 #include "net/http/http_stream_factory_impl.h"
 #include "net/socket/ssl_client_socket.h"
 
 namespace net {
 
+class ClientSocketHandle;
+class SpdySession;
+
 class HttpStreamFactoryImpl::Request : public HttpStreamRequest {
  public:
   Request(const GURL& url,
           HttpStreamFactoryImpl* factory,
           HttpStreamRequest::Delegate* delegate,
-          const BoundNetLog& net_log);
+          const BoundNetLog& net_log,
+          bool for_websocket);
   virtual ~Request();
 
   // The GURL from the HttpRequestInfo the started the Request.
   const GURL& url() const { return url_; }
 
   // Called when the Job determines the appropriate |spdy_session_key| for the
   // Request. Note that this does not mean that SPDY is necessarily supported
   // for this HostPortProxyPair, since we may need to wait for NPN to complete
   // before knowing if SPDY is available.
   void SetSpdySessionKey(const HostPortProxyPair& spdy_session_key);
@@ skipping 28 matching lines @@
                           scoped_refptr<SpdySession> spdy_session,
                           bool direct);
 
   // HttpStreamRequest::Delegate methods which we implement. Note we don't
   // actually subclass HttpStreamRequest::Delegate.
 
   void OnStreamReady(Job* job,
                      const SSLConfig& used_ssl_config,
                      const ProxyInfo& used_proxy_info,
                      HttpStreamBase* stream);
+  // Called by an attached Job if it wants to pass a spdy session
+  // to the delegate.
+  void OnSpdySessionReadyForWS(Job* job,

[mmenke, 2013/05/15 15:38:20]

I think the code is clearer if we don't abbreviate websocket.  Does make for
longer names, but I think the clarity is worth the ugliness and extra line
breaks.

[yhirano, 2013/05/16 05:02:35]

Done.

+                               const SSLConfig& used_ssl_config,
+                               const ProxyInfo& used_proxy_info,
+                               scoped_refptr<SpdySession> session);
+  void OnSocketReady(Job* job,
+                     const SSLConfig& used_ssl_config,
+                     const ProxyInfo& used_proxy_info,
+                     ClientSocketHandle* connection);

[mmenke, 2013/05/15 15:38:20]

I think we need to decide if we're going to consider this a generic way to get a
lower-level connection object, or if this is specific for websockets.

In the latter case, all of these should have WebSocket in the title.  In the
latter, they should not.

[Adam Rice, 2013/05/16 04:00:36]

Unless we have another use case on the table, I would like to keep it
WebSocket-only for now. It would be easier to rename and generalise these
interfaces in the future that it would be to try to predict the future now.

[yhirano, 2013/05/16 05:02:35]

I see, I renamed the delegate functions.

   void OnStreamFailed(Job* job, int status, const SSLConfig& used_ssl_config);
   void OnCertificateError(Job* job,
                           int status,
                           const SSLConfig& used_ssl_config,
                           const SSLInfo& ssl_info);
   void OnNeedsProxyAuth(Job* job,
                         const HttpResponseInfo& proxy_response,
                         const SSLConfig& used_ssl_config,
                         const ProxyInfo& used_proxy_info,
                         HttpAuthController* auth_controller);
   void OnNeedsClientAuth(Job* job,
                          const SSLConfig& used_ssl_config,
                          SSLCertRequestInfo* cert_info);
   void OnHttpsProxyTunnelResponse(
       Job *job,
       const HttpResponseInfo& response_info,
       const SSLConfig& used_ssl_config,
       const ProxyInfo& used_proxy_info,
       HttpStreamBase* stream);
 
+  bool for_websocket() const { return for_websocket_; }
+
   // HttpStreamRequest methods.
 
   virtual int RestartTunnelWithProxyAuth(
       const AuthCredentials& credentials) OVERRIDE;
   virtual LoadState GetLoadState() const OVERRIDE;
   virtual bool was_npn_negotiated() const OVERRIDE;
   virtual NextProto protocol_negotiated() const OVERRIDE;
   virtual bool using_spdy() const OVERRIDE;
 
  private:
   // Used to orphan all jobs in |jobs_| other than |job| which becomes "bound"
   // to the request.
   void OrphanJobsExcept(Job* job);
 
   // Used to orphan all jobs in |jobs_|.
   void OrphanJobs();
 
+  // Orphan a job if appropriate.
+  void Orphan(Job* job);
+
   const GURL url_;
   HttpStreamFactoryImpl* const factory_;
   HttpStreamRequest::Delegate* const delegate_;
   const BoundNetLog net_log_;
 
   // At the point where Job is irrevocably tied to the Request, we set this.
   scoped_ptr<Job> bound_job_;
   std::set<HttpStreamFactoryImpl::Job*> jobs_;
   scoped_ptr<const HostPortProxyPair> spdy_session_key_;
   scoped_ptr<const HttpPipelinedHost::Key> http_pipelining_key_;
 
   bool completed_;
   bool was_npn_negotiated_;
   // Protocol negotiated with the server.
   NextProto protocol_negotiated_;
   bool using_spdy_;
+  bool for_websocket_;
 
   DISALLOW_COPY_AND_ASSIGN(Request);
 };
 
 }  // namespace net
 
-#endif  // NET_HTTP_HTTP_STREAM_FACTORY_IMPL_H_
+#endif  // NET_HTTP_HTTP_STREAM_FACTORY_IMPL_REQUEST_H_