net/dns/address_sorter.h

// 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_DNS_ADDRESS_SORTER_H_
#define NET_DNS_ADDRESS_SORTER_H_

#include <memory>
#include <vector>

#include "base/functional/callback.h"
#include "net/base/ip_endpoint.h"
#include "net/base/net_export.h"

namespace net {

class AddressList;

// Sorts AddressList according to RFC3484, by likelihood of successful
// connection. Depending on the platform, the sort could be performed
// asynchronously by the OS, or synchronously by local implementation.
// AddressSorter does not necessarily preserve port numbers on the sorted list.
class NET_EXPORT AddressSorter {
 public:
  using CallbackType =
      base::OnceCallback<void(bool success, std::vector<IPEndPoint> sorted)>;

  AddressSorter(const AddressSorter&) = delete;
  AddressSorter& operator=(const AddressSorter&) = delete;

  virtual ~AddressSorter() = default;

  // Sorts `endpoints`, which must include at least one IPv6 address.
  // Calls `callback` upon completion. Could complete synchronously. Could
  // complete after this AddressSorter is destroyed.
  virtual void Sort(const std::vector<IPEndPoint>& endpoints,
                    CallbackType callback) const = 0;

  // Creates platform-dependent AddressSorter.
  static std::unique_ptr<AddressSorter> CreateAddressSorter();

 protected:
  AddressSorter() = default;
};

}  // namespace net

#endif  // NET_DNS_ADDRESS_SORTER_H_