henrike@webrtc.org | f048872 | 2014-05-13 18:00:26 | [diff] [blame] | 1 | /* |
| 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 Anton | 10542f2 | 2019-01-11 17:11:00 | [diff] [blame] | 11 | #ifndef RTC_BASE_ASYNC_RESOLVER_INTERFACE_H_ |
| 12 | #define RTC_BASE_ASYNC_RESOLVER_INTERFACE_H_ |
henrike@webrtc.org | f048872 | 2014-05-13 18:00:26 | [diff] [blame] | 13 | |
Sameer Vijaykar | b787e26 | 2022-08-11 09:52:57 | [diff] [blame] | 14 | #include "rtc_base/checks.h" |
Steve Anton | 10542f2 | 2019-01-11 17:11:00 | [diff] [blame] | 15 | #include "rtc_base/socket_address.h" |
Mirko Bonadei | 35214fc | 2019-09-23 12:54:28 | [diff] [blame] | 16 | #include "rtc_base/system/rtc_export.h" |
Artem Titov | e41c433 | 2018-07-25 13:04:28 | [diff] [blame] | 17 | #include "rtc_base/third_party/sigslot/sigslot.h" |
henrike@webrtc.org | f048872 | 2014-05-13 18:00:26 | [diff] [blame] | 18 | |
Henrik Kjellander | ec78f1c | 2017-06-29 05:52:50 | [diff] [blame] | 19 | namespace rtc { |
| 20 | |
| 21 | // This interface defines the methods to resolve the address asynchronously. |
Harald Alvestrand | 4d25a77 | 2023-08-25 11:07:28 | [diff] [blame] | 22 | // TODO(bugs.webrtc.org/12598): Deprecate and remove. |
Mirko Bonadei | 35214fc | 2019-09-23 12:54:28 | [diff] [blame] | 23 | class RTC_EXPORT AsyncResolverInterface { |
Henrik Kjellander | ec78f1c | 2017-06-29 05:52:50 | [diff] [blame] | 24 | public: |
| 25 | AsyncResolverInterface(); |
| 26 | virtual ~AsyncResolverInterface(); |
| 27 | |
Artem Titov | 96e3b99 | 2021-07-26 14:03:14 | [diff] [blame] | 28 | // Start address resolution of the hostname in `addr`. |
Henrik Kjellander | ec78f1c | 2017-06-29 05:52:50 | [diff] [blame] | 29 | virtual void Start(const SocketAddress& addr) = 0; |
Sameer Vijaykar | b787e26 | 2022-08-11 09:52:57 | [diff] [blame] | 30 | // Start address resolution of the hostname in `addr` matching `family`. |
Sameer Vijaykar | f4c0162 | 2022-08-11 15:38:51 | [diff] [blame] | 31 | virtual void Start(const SocketAddress& addr, int family) = 0; |
Artem Titov | 96e3b99 | 2021-07-26 14:03:14 | [diff] [blame] | 32 | // 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 Kjellander | ec78f1c | 2017-06-29 05:52:50 | [diff] [blame] | 36 | 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.org | f048872 | 2014-05-13 18:00:26 | [diff] [blame] | 54 | |
| 55 | #endif |