blob: d694af2f333fb4229c50a48fd6d8e142bb6fa257 [file] [log] [blame]
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef NET_BASE_HOST_PORT_PAIR_H_
#define NET_BASE_HOST_PORT_PAIR_H_
#include <stdint.h>
#include <string>
#include <tuple>
#include "base/strings/string_piece.h"
#include "base/values.h"
#include "net/base/net_export.h"
#include "third_party/abseil-cpp/absl/types/optional.h"
class GURL;
namespace url {
class SchemeHostPort;
} // namespace url
namespace net {
class IPEndPoint;
class NET_EXPORT HostPortPair {
public:
HostPortPair();
// If |in_host| represents an IPv6 address, it should not bracket the address.
HostPortPair(base::StringPiece in_host, uint16_t in_port);
// Creates a HostPortPair for the origin of |url|.
static HostPortPair FromURL(const GURL& url);
static HostPortPair FromSchemeHostPort(
const url::SchemeHostPort& scheme_host_port);
// Creates a HostPortPair from an IPEndPoint.
static HostPortPair FromIPEndPoint(const IPEndPoint& ipe);
// Creates a HostPortPair from a string formatted in same manner as
// ToString().
static HostPortPair FromString(base::StringPiece str);
// Nullopt if `value` is malformed to be deserialized to HostPortPair.
static absl::optional<HostPortPair> FromValue(const base::Value& value);
// TODO(willchan): Define a functor instead.
// Comparator function so this can be placed in a std::map.
bool operator<(const HostPortPair& other) const {
return std::tie(port_, host_) < std::tie(other.port_, other.host_);
}
bool operator==(const HostPortPair& other) const { return Equals(other); }
// Equality test of contents. (Probably another violation of style guide).
bool Equals(const HostPortPair& other) const {
return host_ == other.host_ && port_ == other.port_;
}
bool IsEmpty() const {
return host_.empty() && port_ == 0;
}
const std::string& host() const {
return host_;
}
uint16_t port() const { return port_; }
void set_host(const std::string& in_host) {
host_ = in_host;
}
void set_port(uint16_t in_port) { port_ = in_port; }
// ToString() will convert the HostPortPair to "host:port". If |host_| is an
// IPv6 literal, it will add brackets around |host_|.
std::string ToString() const;
// Returns |host_|, adding IPv6 brackets if needed.
std::string HostForURL() const;
base::Value ToValue() const;
private:
// If |host_| represents an IPv6 address, this string will not contain
// brackets around the address.
std::string host_;
uint16_t port_;
};
} // namespace net
#endif // NET_BASE_HOST_PORT_PAIR_H_