mirror of
https://github.com/mollyim/webrtc.git
synced 2025-05-13 13:50:40 +01:00
b787e26369
The input SocketAddress for STUN host lookup is constructed with just the hostname, so the family is AF_UNSPEC. So added an overload with a target family to distinguish this from the family of the input addr. Bug: webrtc:14319, webrtc:14131 Change-Id: Ia5ac5aa2e894e0c4dfb4417e3e8a76a6cec3ea71 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/270624 Reviewed-by: Tomas Gunnarsson <tommi@webrtc.org> Commit-Queue: Sameer Vijaykar <samvi@google.com> Reviewed-by: Jonas Oreland <jonaso@webrtc.org> Reviewed-by: Jonas Oreland <jonaso@google.com> Cr-Commit-Position: refs/heads/main@{#37750}
104 lines
4.1 KiB
C++
104 lines
4.1 KiB
C++
/*
|
|
* Copyright 2021 The WebRTC Project Authors. All rights reserved.
|
|
*
|
|
* Use of this source code is governed by a BSD-style license
|
|
* that can be found in the LICENSE file in the root of the source
|
|
* tree. An additional intellectual property rights grant can be found
|
|
* in the file PATENTS. All contributing project authors may
|
|
* be found in the AUTHORS file in the root of the source tree.
|
|
*/
|
|
|
|
#ifndef API_ASYNC_DNS_RESOLVER_H_
|
|
#define API_ASYNC_DNS_RESOLVER_H_
|
|
|
|
#include <functional>
|
|
#include <memory>
|
|
|
|
#include "rtc_base/checks.h"
|
|
#include "rtc_base/socket_address.h"
|
|
#include "rtc_base/system/rtc_export.h"
|
|
|
|
namespace webrtc {
|
|
|
|
// This interface defines the methods to resolve a hostname asynchronously.
|
|
// The AsyncDnsResolverInterface class encapsulates a single name query.
|
|
//
|
|
// Usage:
|
|
// std::unique_ptr<AsyncDnsResolverInterface> resolver =
|
|
// factory->Create(address-to-be-resolved, [r = resolver.get()]() {
|
|
// if (r->result.GetResolvedAddress(AF_INET, &addr) {
|
|
// // success
|
|
// } else {
|
|
// // failure
|
|
// error = r->result().GetError();
|
|
// }
|
|
// // Release resolver.
|
|
// resolver_list.erase(std::remove_if(resolver_list.begin(),
|
|
// resolver_list.end(),
|
|
// [](refptr) { refptr.get() == r; });
|
|
// });
|
|
// resolver_list.push_back(std::move(resolver));
|
|
|
|
class AsyncDnsResolverResult {
|
|
public:
|
|
virtual ~AsyncDnsResolverResult() = default;
|
|
// Returns true iff the address from `Start` was successfully resolved.
|
|
// If the address was successfully resolved, sets `addr` to a copy of the
|
|
// address from `Start` with the IP address set to the top most resolved
|
|
// address of `family` (`addr` will have both hostname and the resolved ip).
|
|
virtual bool GetResolvedAddress(int family,
|
|
rtc::SocketAddress* addr) const = 0;
|
|
// Returns error from resolver.
|
|
virtual int GetError() const = 0;
|
|
};
|
|
|
|
// The API for a single name query.
|
|
// The constructor, destructor and all functions must be called from
|
|
// the same sequence, and the callback will also be called on that sequence.
|
|
// The class guarantees that the callback will not be called if the
|
|
// resolver's destructor has been called.
|
|
class RTC_EXPORT AsyncDnsResolverInterface {
|
|
public:
|
|
virtual ~AsyncDnsResolverInterface() = default;
|
|
|
|
// Start address resolution of the hostname in `addr`.
|
|
virtual void Start(const rtc::SocketAddress& addr,
|
|
std::function<void()> callback) = 0;
|
|
// Start address resolution of the hostname in `addr` matching `family`.
|
|
virtual void Start(const rtc::SocketAddress& addr,
|
|
int family,
|
|
std::function<void()> callback) = 0;
|
|
virtual const AsyncDnsResolverResult& result() const = 0;
|
|
};
|
|
|
|
// An abstract factory for creating AsyncDnsResolverInterfaces. This allows
|
|
// client applications to provide WebRTC with their own mechanism for
|
|
// performing DNS resolution.
|
|
class AsyncDnsResolverFactoryInterface {
|
|
public:
|
|
virtual ~AsyncDnsResolverFactoryInterface() = default;
|
|
|
|
// Creates an AsyncDnsResolver and starts resolving the name. The callback
|
|
// will be called when resolution is finished.
|
|
// The callback will be called on the sequence that the caller runs on.
|
|
virtual std::unique_ptr<webrtc::AsyncDnsResolverInterface> CreateAndResolve(
|
|
const rtc::SocketAddress& addr,
|
|
std::function<void()> callback) = 0;
|
|
// Creates an AsyncDnsResolver and starts resolving the name to an address
|
|
// matching the specified family. The callback will be called when resolution
|
|
// is finished. The callback will be called on the sequence that the caller
|
|
// runs on.
|
|
virtual std::unique_ptr<webrtc::AsyncDnsResolverInterface> CreateAndResolve(
|
|
const rtc::SocketAddress& addr,
|
|
int family,
|
|
std::function<void()> callback) = 0;
|
|
// Creates an AsyncDnsResolver and does not start it.
|
|
// For backwards compatibility, will be deprecated and removed.
|
|
// One has to do a separate Start() call on the
|
|
// resolver to start name resolution.
|
|
virtual std::unique_ptr<webrtc::AsyncDnsResolverInterface> Create() = 0;
|
|
};
|
|
|
|
} // namespace webrtc
|
|
|
|
#endif // API_ASYNC_DNS_RESOLVER_H_
|