blob: 829dc7e23b81bcc03bb796a76623f9c6064db081 [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.
Mirko Bonadei35214fc2019-09-23 12:54:2822class RTC_EXPORT AsyncResolverInterface {
Henrik Kjellanderec78f1c2017-06-29 05:52:5023 public:
24 AsyncResolverInterface();
25 virtual ~AsyncResolverInterface();
26
Artem Titov96e3b992021-07-26 14:03:1427 // Start address resolution of the hostname in `addr`.
Henrik Kjellanderec78f1c2017-06-29 05:52:5028 virtual void Start(const SocketAddress& addr) = 0;
Sameer Vijaykarb787e262022-08-11 09:52:5729 // Start address resolution of the hostname in `addr` matching `family`.
Sameer Vijaykarf4c01622022-08-11 15:38:5130 virtual void Start(const SocketAddress& addr, int family) = 0;
Artem Titov96e3b992021-07-26 14:03:1431 // Returns true iff the address from `Start` was successfully resolved.
32 // If the address was successfully resolved, sets `addr` to a copy of the
33 // address from `Start` with the IP address set to the top most resolved
34 // address of `family` (`addr` will have both hostname and the resolved ip).
Henrik Kjellanderec78f1c2017-06-29 05:52:5035 virtual bool GetResolvedAddress(int family, SocketAddress* addr) const = 0;
36 // Returns error from resolver.
37 virtual int GetError() const = 0;
38 // Delete the resolver.
39 virtual void Destroy(bool wait) = 0;
40 // Returns top most resolved IPv4 address if address is resolved successfully.
41 // Otherwise returns address set in SetAddress.
42 SocketAddress address() const {
43 SocketAddress addr;
44 GetResolvedAddress(AF_INET, &addr);
45 return addr;
46 }
47
48 // This signal is fired when address resolve process is completed.
49 sigslot::signal1<AsyncResolverInterface*> SignalDone;
50};
51
52} // namespace rtc
henrike@webrtc.orgf0488722014-05-13 18:00:2653
54#endif