net/socket/client_socket_factory.h

   1 // Copyright (c) 2011 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_SOCKET_CLIENT_SOCKET_FACTORY_H_
   6 #define NET_SOCKET_CLIENT_SOCKET_FACTORY_H_
   7 #pragma once
   8
   9 #include <string>
  10
  11 #include "base/basictypes.h"
  12 #include "net/base/net_export.h"
  13 #include "net/base/net_log.h"
  14 #include "net/base/rand_callback.h"
  15 #include "net/udp/datagram_socket.h"
  16
  17 namespace net {
  18
  19 class AddressList;
  20 class ClientSocketHandle;
  21 class DatagramClientSocket;
  22 class HostPortPair;
  23 class SSLClientSocket;
  24 struct SSLClientSocketContext;
  25 struct SSLConfig;
  26 class SSLHostInfo;
  27 class StreamSocket;
  28
  29 // An interface used to instantiate StreamSocket objects.  Used to facilitate
  30 // testing code with mock socket implementations.
  31 class NET_EXPORT ClientSocketFactory {
  32  public:
  33   virtual ~ClientSocketFactory() {}
  34
  35   // |source| is the NetLog::Source for the entity trying to create the socket,
  36   // if it has one.
  37   virtual DatagramClientSocket* CreateDatagramClientSocket(
  38       DatagramSocket::BindType bind_type,
  39       const RandIntCallback& rand_int_cb,
  40       NetLog* net_log,
  41       const NetLog::Source& source) = 0;
  42
  43   virtual StreamSocket* CreateTransportClientSocket(
  44       const AddressList& addresses,
  45       NetLog* net_log,
  46       const NetLog::Source& source) = 0;
  47
  48   // It is allowed to pass in a |transport_socket| that is not obtained from a
  49   // socket pool. The caller could create a ClientSocketHandle directly and call
  50   // set_socket() on it to set a valid StreamSocket instance.
  51   virtual SSLClientSocket* CreateSSLClientSocket(
  52       ClientSocketHandle* transport_socket,
  53       const HostPortPair& host_and_port,
  54       const SSLConfig& ssl_config,
  55       SSLHostInfo* ssl_host_info,
  56       const SSLClientSocketContext& context) = 0;
  57
  58   // Deprecated function (http://crbug.com/37810) that takes a StreamSocket.
  59   virtual SSLClientSocket* CreateSSLClientSocket(
  60       StreamSocket* transport_socket,
  61       const HostPortPair& host_and_port,
  62       const SSLConfig& ssl_config,
  63       SSLHostInfo* ssl_host_info,
  64       const SSLClientSocketContext& context);
  65
  66   // Clears cache used for SSL session resumption.
  67   virtual void ClearSSLSessionCache() = 0;
  68
  69   // Returns the default ClientSocketFactory.
  70   static ClientSocketFactory* GetDefaultFactory();
  71
  72   // Instructs the default ClientSocketFactory to use the system SSL library.
  73   static void UseSystemSSL();
  74 };
  75
  76 }  // namespace net
  77
  78 #endif  // NET_SOCKET_CLIENT_SOCKET_FACTORY_H_