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
This commit is contained in:
Richard Mudgett
2011-05-26 18:10:17 +00:00
parent 22d4d91c2c
commit 7257b78f53

View File

@@ -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;