From 74ba3af20119e561873e9bd491798e5b6975f07a Mon Sep 17 00:00:00 2001 From: Richard Mudgett Date: Thu, 26 May 2011 18:10:46 +0000 Subject: [PATCH] Merged revisions 321044 via svnmerge from https://origsvn.digium.com/svn/asterisk/branches/1.8 ........ r321044 | rmudgett | 2011-05-26 13:10:17 -0500 (Thu, 26 May 2011) | 1 line Update ast_sockaddr comment with an important note. ........ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@321045 65c4cc65-6c06-0410-ace0-fbb531ad65f3 --- include/asterisk/netsock2.h | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/include/asterisk/netsock2.h b/include/asterisk/netsock2.h index 888861c651..c5c08cf731 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;