From: Richard Mudgett <rmudgett@digium.com>
Date: Thu, 26 May 2011 18:10:17 +0000 (+0000)
Subject: Update ast_sockaddr comment with an important note.
X-Git-Tag: 1.8.5-rc1~11^2~76
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7257b78f53fda5c2876630749c9078a1f7474f3c;p=thirdparty%2Fasterisk.git

Update ast_sockaddr comment with an important note.

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

diff --git a/include/asterisk/netsock2.h b/include/asterisk/netsock2.h
index 73c57c5d26..be816a1c4d 100644
--- a/include/asterisk/netsock2.h
+++ b/include/asterisk/netsock2.h
@@ -43,12 +43,22 @@ enum {
 };
 
 /*!
- * Socket address structure. The first member is big enough to contain addresses
- * of any family. The second member contains the length (in bytes) used in the
- * first member.
+ * \brief Socket address structure.
  *
- * Some BSDs have the length embedded in sockaddr structs. We ignore them.
- * (This is the right thing to do.)
+ * \details
+ * The first member is big enough to contain addresses of any
+ * family. The second member contains the length (in bytes) used
+ * in the first member.
+ *
+ * \note
+ * Some BSDs have the length embedded in sockaddr structs. We
+ * ignore them. (This is the right thing to do.)
+ *
+ * \note
+ * It is important to always initialize ast_sockaddr before use
+ * -- even if they are passed to ast_sockaddr_copy() as the
+ * underlying storage could be bigger than what ends up being
+ * copied -- leaving part of the data unitialized.
  */
 struct ast_sockaddr {
 	struct sockaddr_storage	 ss;