From: Russell Bryant <russell@russellbryant.com>
Date: Sat, 2 Dec 2006 03:50:58 +0000 (+0000)
Subject: Backport the comment containing the warning regarding the limitations on the
X-Git-Tag: 1.4.0-beta4~42
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=1298cf0ea6d6b3abfc957edde4a5ba5063f37340;p=thirdparty%2Fasterisk.git

Backport the comment containing the warning regarding the limitations on the
usage of this function.  It is thread safe, but not technically reentrant.


git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/1.4@48195 65c4cc65-6c06-0410-ace0-fbb531ad65f3
---

diff --git a/include/asterisk/utils.h b/include/asterisk/utils.h
index 30e9523e29..3fb817980a 100644
--- a/include/asterisk/utils.h
+++ b/include/asterisk/utils.h
@@ -218,6 +218,16 @@ static force_inline void ast_slinear_saturated_divide(short *input, short *value
 
 int test_for_thread_safety(void);
 
+/*!
+ * \brief thread-safe replacement for inet_ntoa().
+ *
+ * \note It is very important to note that even though this is a thread-safe
+ *       replacement for inet_ntoa(), it is *not* reentrant.  In a single
+ *       thread, the result from a previous call to this function is no longer
+ *       valid once it is called again.  If the result from multiple calls to
+ *       this function need to be kept or used at once, then the result must be
+ *       copied to a local buffer before calling this function again.
+ */
 const char *ast_inet_ntoa(struct in_addr ia);
 
 #ifdef inet_ntoa