net/websockets/websocket_handshake_stream_create_helper.h

   1 // Copyright 2013 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_WEBSOCKETS_WEBSOCKET_HANDSHAKE_STREAM_CREATE_HELPER_H_
   6 #define NET_WEBSOCKETS_WEBSOCKET_HANDSHAKE_STREAM_CREATE_HELPER_H_
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "net/base/net_export.h"
  12 #include "net/websockets/websocket_handshake_stream_base.h"
  13 #include "net/websockets/websocket_stream.h"
  14
  15 namespace net {
  16
  17 // Implementation of WebSocketHandshakeStreamBase::CreateHelper. This class is
  18 // used in the implementation of WebSocketStream::CreateAndConnectStream() and
  19 // is not intended to be used by itself.
  20 //
  21 // Holds the information needed to construct a
  22 // WebSocketBasicHandshakeStreamBase.
  23 class NET_EXPORT_PRIVATE WebSocketHandshakeStreamCreateHelper
  24     : public WebSocketHandshakeStreamBase::CreateHelper {
  25  public:
  26   explicit WebSocketHandshakeStreamCreateHelper(
  27       WebSocketStream::ConnectDelegate* connect_delegate,
  28       const std::vector<std::string>& requested_subprotocols);
  29
  30   virtual ~WebSocketHandshakeStreamCreateHelper();
  31
  32   // WebSocketHandshakeStreamBase::CreateHelper methods
  33
  34   // Create a WebSocketBasicHandshakeStream.
  35   virtual WebSocketHandshakeStreamBase* CreateBasicStream(
  36       scoped_ptr<ClientSocketHandle> connection,
  37       bool using_proxy) OVERRIDE;
  38
  39   // Unimplemented as of November 2013.
  40   virtual WebSocketHandshakeStreamBase* CreateSpdyStream(
  41       const base::WeakPtr<SpdySession>& session,
  42       bool use_relative_url) OVERRIDE;
  43
  44   // Return the WebSocketHandshakeStreamBase object that we created. In the case
  45   // where CreateBasicStream() was called more than once, returns the most
  46   // recent stream, which will be the one on which the handshake succeeded.
  47   WebSocketHandshakeStreamBase* stream() { return stream_; }
  48
  49  private:
  50   const std::vector<std::string> requested_subprotocols_;
  51
  52   // This is owned by the caller of CreateBaseStream() or
  53   // CreateSpdyStream(). Both the stream and this object will be destroyed
  54   // during the destruction of the URLRequest object associated with the
  55   // handshake.
  56   WebSocketHandshakeStreamBase* stream_;
  57
  58   WebSocketStream::ConnectDelegate* connect_delegate_;
  59
  60   DISALLOW_COPY_AND_ASSIGN(WebSocketHandshakeStreamCreateHelper);
  61 };
  62
  63 }  // namespace net
  64
  65 #endif  // NET_WEBSOCKETS_WEBSOCKET_HANDSHAKE_STREAM_CREATE_HELPER_H_