blob: 851fa38ce1183394cb64e984651e7c3263b5e62d [file] [log] [blame]
henrike@webrtc.orgf0488722014-05-13 18:00:261/*
2 * Copyright 2013 The WebRTC Project Authors. All rights reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
Steve Anton10542f22019-01-11 17:11:0011#ifndef RTC_BASE_ASYNC_RESOLVER_INTERFACE_H_
12#define RTC_BASE_ASYNC_RESOLVER_INTERFACE_H_
henrike@webrtc.orgf0488722014-05-13 18:00:2613
Sameer Vijaykarb787e262022-08-11 09:52:5714#include "rtc_base/checks.h"
Steve Anton10542f22019-01-11 17:11:0015#include "rtc_base/socket_address.h"
Mirko Bonadei35214fc2019-09-23 12:54:2816#include "rtc_base/system/rtc_export.h"
Artem Titove41c4332018-07-25 13:04:2817#include "rtc_base/third_party/sigslot/sigslot.h"
henrike@webrtc.orgf0488722014-05-13 18:00:2618
Henrik Kjellanderec78f1c2017-06-29 05:52:5019namespace rtc {
20
21// This interface defines the methods to resolve the address asynchronously.
Harald Alvestrand4d25a772023-08-25 11:07:2822// TODO(bugs.webrtc.org/12598): Deprecate and remove.
Mirko Bonadei35214fc2019-09-23 12:54:2823class RTC_EXPORT AsyncResolverInterface {
Henrik Kjellanderec78f1c2017-06-29 05:52:5024 public:
25 AsyncResolverInterface();
26 virtual ~AsyncResolverInterface();
27
Artem Titov96e3b992021-07-26 14:03:1428 // Start address resolution of the hostname in `addr`.
Henrik Kjellanderec78f1c2017-06-29 05:52:5029 virtual void Start(const SocketAddress& addr) = 0;
Sameer Vijaykarb787e262022-08-11 09:52:5730 // Start address resolution of the hostname in `addr` matching `family`.
Sameer Vijaykarf4c01622022-08-11 15:38:5131 virtual void Start(const SocketAddress& addr, int family) = 0;
Artem Titov96e3b992021-07-26 14:03:1432 // Returns true iff the address from `Start` was successfully resolved.
33 // If the address was successfully resolved, sets `addr` to a copy of the
34 // address from `Start` with the IP address set to the top most resolved
35 // address of `family` (`addr` will have both hostname and the resolved ip).
Henrik Kjellanderec78f1c2017-06-29 05:52:5036 virtual bool GetResolvedAddress(int family, SocketAddress* addr) const = 0;
37 // Returns error from resolver.
38 virtual int GetError() const = 0;
39 // Delete the resolver.
40 virtual void Destroy(bool wait) = 0;
41 // Returns top most resolved IPv4 address if address is resolved successfully.
42 // Otherwise returns address set in SetAddress.
43 SocketAddress address() const {
44 SocketAddress addr;
45 GetResolvedAddress(AF_INET, &addr);
46 return addr;
47 }
48
49 // This signal is fired when address resolve process is completed.
50 sigslot::signal1<AsyncResolverInterface*> SignalDone;
51};
52
53} // namespace rtc
henrike@webrtc.orgf0488722014-05-13 18:00:2654
55#endif