Clarify the desired semantics of AsyncResolverInterface::GetResolvedAddress.
Bug: webrtc:9861
Change-Id: I4b0bf0619a5e2b04765a727a183584dcf0a4cf41
Reviewed-on: https://webrtc-review.googlesource.com/c/106142
Reviewed-by: Qingsi Wang <qingsi@webrtc.org>
Commit-Queue: Zach Stein <zstein@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#25380}diff --git a/rtc_base/asyncresolverinterface.h b/rtc_base/asyncresolverinterface.h
index 5b2303f..f3df884 100644
--- a/rtc_base/asyncresolverinterface.h
+++ b/rtc_base/asyncresolverinterface.h
@@ -22,9 +22,12 @@
AsyncResolverInterface();
virtual ~AsyncResolverInterface();
- // Start address resolve process.
+ // Start address resolution of the hostname in |addr|.
virtual void Start(const SocketAddress& addr) = 0;
- // Returns top most resolved address of |family|
+ // Returns true iff the address from |Start| was successfully resolved.
+ // If the address was successfully resolved, sets |addr| to a copy of the
+ // address from |Start| with the IP address set to the top most resolved
+ // address of |family| (|addr| will have both hostname and the resolved ip).
virtual bool GetResolvedAddress(int family, SocketAddress* addr) const = 0;
// Returns error from resolver.
virtual int GetError() const = 0;