blob: f9e27a5b335b5f6530e3791a2590e840f0918378 [file] [log] [blame]
// Copyright (c) 2013 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.
#include "net/base/net_export.h"
#include "net/base/network_isolation_key.h"
#include "net/base/privacy_mode.h"
#include "net/base/proxy_server.h"
#include "net/socket/socket_tag.h"
namespace net {
// SpdySessionKey is used as unique index for SpdySessionPool.
class NET_EXPORT_PRIVATE SpdySessionKey {
enum class IsProxySession {
// This means this is a ProxyServer::Direct() session for an HTTP2 proxy,
// with |host_port_pair| being the proxy host and port. This should not be
// confused with a tunnel over an HTTP2 proxy session, for which
// |proxy_server| will be information about the proxy being used, and
// |host_port_pair| will be information not about the proxy, but the host
// that we're proxying the connection to.
SpdySessionKey(const HostPortPair& host_port_pair,
const ProxyServer& proxy_server,
PrivacyMode privacy_mode,
IsProxySession is_proxy_session,
const SocketTag& socket_tag,
const NetworkIsolationKey& network_isolation_key,
bool disable_secure_dns);
SpdySessionKey(const SpdySessionKey& other);
// Comparator function so this can be placed in a std::map.
bool operator<(const SpdySessionKey& other) const;
// Equality tests of contents.
bool operator==(const SpdySessionKey& other) const;
bool operator!=(const SpdySessionKey& other) const;
// Struct returned by CompareForAliasing().
struct CompareForAliasingResult {
// True if the two SpdySessionKeys match, except possibly for their
// |host_port_pair| and |socket_tag|.
bool is_potentially_aliasable = false;
// True if the |socket_tag| fields match. If this is false, it's up to the
// caller to change the tag of the session (if possible) or to not alias the
// session, even if |is_potentially_aliasable| is true.
bool is_socket_tag_match = false;
// Checks if requests using SpdySessionKey can potentially be used to service
// requests using another. The caller *MUST* also make sure that the session
// associated with one key has been verified for use with the other.
// Note that this method is symmetric, so it doesn't matter which key's method
// is called on the other.
CompareForAliasingResult CompareForAliasing(
const SpdySessionKey& other) const;
const HostPortProxyPair& host_port_proxy_pair() const {
return host_port_proxy_pair_;
const HostPortPair& host_port_pair() const {
return host_port_proxy_pair_.first;
const ProxyServer& proxy_server() const {
return host_port_proxy_pair_.second;
PrivacyMode privacy_mode() const {
return privacy_mode_;
IsProxySession is_proxy_session() const { return is_proxy_session_; }
const SocketTag& socket_tag() const { return socket_tag_; }
const NetworkIsolationKey& network_isolation_key() const {
return network_isolation_key_;
bool disable_secure_dns() const { return disable_secure_dns_; }
// Returns the estimate of dynamically allocated memory in bytes.
size_t EstimateMemoryUsage() const;
HostPortProxyPair host_port_proxy_pair_;
// If enabled, then session cannot be tracked by the server.
PrivacyMode privacy_mode_ = PRIVACY_MODE_DISABLED;
IsProxySession is_proxy_session_;
SocketTag socket_tag_;
// Used to separate requests made in different contexts.
NetworkIsolationKey network_isolation_key_;
bool disable_secure_dns_;
} // namespace net