From: Sean Bright <seanbright@users.noreply.github.com>
Date: Thu, 11 May 2023 19:05:49 +0000 (-0400)
Subject: utils.h: Deprecate `ast_gethostbyname()`. (#79)
X-Git-Tag: 21.0.0-pre1~85
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f414815159b91e3d6862ddb06f85aecf9eeb787a;p=thirdparty%2Fasterisk.git

utils.h: Deprecate `ast_gethostbyname()`. (#79)

Deprecate `ast_gethostbyname()` in favor of `ast_sockaddr_resolve()` and
`ast_sockaddr_resolve_first_af()`. `ast_gethostbyname()` has not been
used by any in-tree code since 2021.

This function will be removed entirely in Asterisk 23.

Resolves: #78

UpgradeNote: ast_gethostbyname() has been deprecated and will be removed
in Asterisk 23. New code should use `ast_sockaddr_resolve()` and
`ast_sockaddr_resolve_first_af()`.
---

diff --git a/include/asterisk/utils.h b/include/asterisk/utils.h
index 3c06e834eb..30913fc05d 100644
--- a/include/asterisk/utils.h
+++ b/include/asterisk/utils.h
@@ -210,7 +210,12 @@ struct ast_hostent {
 	char buf[1024];
 };
 
-/*! \brief Thread-safe gethostbyname function to use in Asterisk */
+/*!
+ * \brief Thread-safe gethostbyname function to use in Asterisk
+ *
+ * \deprecated Replaced by \c ast_sockaddr_resolve() and \c ast_sockaddr_resolve_first_af()
+ * \note To be removed in Asterisk 23.
+ */
 struct hostent *ast_gethostbyname(const char *host, struct ast_hostent *hp);
 
 /*! \brief Produces MD5 hash based on input string */