xref: /aosp_15_r20/external/webrtc/rtc_base/async_resolver_interface.h (revision d9f758449e529ab9291ac668be2861e7a55c2422)
1*d9f75844SAndroid Build Coastguard Worker /*
2*d9f75844SAndroid Build Coastguard Worker  *  Copyright 2013 The WebRTC Project Authors. All rights reserved.
3*d9f75844SAndroid Build Coastguard Worker  *
4*d9f75844SAndroid Build Coastguard Worker  *  Use of this source code is governed by a BSD-style license
5*d9f75844SAndroid Build Coastguard Worker  *  that can be found in the LICENSE file in the root of the source
6*d9f75844SAndroid Build Coastguard Worker  *  tree. An additional intellectual property rights grant can be found
7*d9f75844SAndroid Build Coastguard Worker  *  in the file PATENTS.  All contributing project authors may
8*d9f75844SAndroid Build Coastguard Worker  *  be found in the AUTHORS file in the root of the source tree.
9*d9f75844SAndroid Build Coastguard Worker  */
10*d9f75844SAndroid Build Coastguard Worker 
11*d9f75844SAndroid Build Coastguard Worker #ifndef RTC_BASE_ASYNC_RESOLVER_INTERFACE_H_
12*d9f75844SAndroid Build Coastguard Worker #define RTC_BASE_ASYNC_RESOLVER_INTERFACE_H_
13*d9f75844SAndroid Build Coastguard Worker 
14*d9f75844SAndroid Build Coastguard Worker #include "rtc_base/checks.h"
15*d9f75844SAndroid Build Coastguard Worker #include "rtc_base/socket_address.h"
16*d9f75844SAndroid Build Coastguard Worker #include "rtc_base/system/rtc_export.h"
17*d9f75844SAndroid Build Coastguard Worker #include "rtc_base/third_party/sigslot/sigslot.h"
18*d9f75844SAndroid Build Coastguard Worker 
19*d9f75844SAndroid Build Coastguard Worker namespace rtc {
20*d9f75844SAndroid Build Coastguard Worker 
21*d9f75844SAndroid Build Coastguard Worker // This interface defines the methods to resolve the address asynchronously.
22*d9f75844SAndroid Build Coastguard Worker class RTC_EXPORT AsyncResolverInterface {
23*d9f75844SAndroid Build Coastguard Worker  public:
24*d9f75844SAndroid Build Coastguard Worker   AsyncResolverInterface();
25*d9f75844SAndroid Build Coastguard Worker   virtual ~AsyncResolverInterface();
26*d9f75844SAndroid Build Coastguard Worker 
27*d9f75844SAndroid Build Coastguard Worker   // Start address resolution of the hostname in `addr`.
28*d9f75844SAndroid Build Coastguard Worker   virtual void Start(const SocketAddress& addr) = 0;
29*d9f75844SAndroid Build Coastguard Worker   // Start address resolution of the hostname in `addr` matching `family`.
30*d9f75844SAndroid Build Coastguard Worker   virtual void Start(const SocketAddress& addr, int family) = 0;
31*d9f75844SAndroid Build Coastguard Worker   // Returns true iff the address from `Start` was successfully resolved.
32*d9f75844SAndroid Build Coastguard Worker   // If the address was successfully resolved, sets `addr` to a copy of the
33*d9f75844SAndroid Build Coastguard Worker   // address from `Start` with the IP address set to the top most resolved
34*d9f75844SAndroid Build Coastguard Worker   // address of `family` (`addr` will have both hostname and the resolved ip).
35*d9f75844SAndroid Build Coastguard Worker   virtual bool GetResolvedAddress(int family, SocketAddress* addr) const = 0;
36*d9f75844SAndroid Build Coastguard Worker   // Returns error from resolver.
37*d9f75844SAndroid Build Coastguard Worker   virtual int GetError() const = 0;
38*d9f75844SAndroid Build Coastguard Worker   // Delete the resolver.
39*d9f75844SAndroid Build Coastguard Worker   virtual void Destroy(bool wait) = 0;
40*d9f75844SAndroid Build Coastguard Worker   // Returns top most resolved IPv4 address if address is resolved successfully.
41*d9f75844SAndroid Build Coastguard Worker   // Otherwise returns address set in SetAddress.
address()42*d9f75844SAndroid Build Coastguard Worker   SocketAddress address() const {
43*d9f75844SAndroid Build Coastguard Worker     SocketAddress addr;
44*d9f75844SAndroid Build Coastguard Worker     GetResolvedAddress(AF_INET, &addr);
45*d9f75844SAndroid Build Coastguard Worker     return addr;
46*d9f75844SAndroid Build Coastguard Worker   }
47*d9f75844SAndroid Build Coastguard Worker 
48*d9f75844SAndroid Build Coastguard Worker   // This signal is fired when address resolve process is completed.
49*d9f75844SAndroid Build Coastguard Worker   sigslot::signal1<AsyncResolverInterface*> SignalDone;
50*d9f75844SAndroid Build Coastguard Worker };
51*d9f75844SAndroid Build Coastguard Worker 
52*d9f75844SAndroid Build Coastguard Worker }  // namespace rtc
53*d9f75844SAndroid Build Coastguard Worker 
54*d9f75844SAndroid Build Coastguard Worker #endif
55