xref: /aosp_15_r20/external/webrtc/rtc_base/async_resolver_interface.h (revision d9f758449e529ab9291ac668be2861e7a55c2422)
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 
11 #ifndef RTC_BASE_ASYNC_RESOLVER_INTERFACE_H_
12 #define RTC_BASE_ASYNC_RESOLVER_INTERFACE_H_
13 
14 #include "rtc_base/checks.h"
15 #include "rtc_base/socket_address.h"
16 #include "rtc_base/system/rtc_export.h"
17 #include "rtc_base/third_party/sigslot/sigslot.h"
18 
19 namespace rtc {
20 
21 // This interface defines the methods to resolve the address asynchronously.
22 class RTC_EXPORT AsyncResolverInterface {
23  public:
24   AsyncResolverInterface();
25   virtual ~AsyncResolverInterface();
26 
27   // Start address resolution of the hostname in `addr`.
28   virtual void Start(const SocketAddress& addr) = 0;
29   // Start address resolution of the hostname in `addr` matching `family`.
30   virtual void Start(const SocketAddress& addr, int family) = 0;
31   // 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).
35   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.
address()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
53 
54 #endif
55