aboutsummaryrefslogtreecommitdiffstats
path: root/man3/sockaddr-struct.3
diff options
context:
space:
mode:
authorAlejandro Colomar <alx.manpages@gmail.com>2022-02-24 22:58:36 +0100
committerAlejandro Colomar <alx.manpages@gmail.com>2022-02-25 12:50:31 +0100
commitbbb0155b0664a62fc1d1b7282c1466c738e9d6ba (patch)
treeb2748cd72ae2406b50d216915e12e4f78478b255 /man3/sockaddr-struct.3
parent7fc1ad39e51527dd20946f3481b0869f6db26a7d (diff)
downloadman-pages-bbb0155b0664a62fc1d1b7282c1466c738e9d6ba.tar.gz
sockaddr-struct.3, sockaddr_storage-struct.3: Document sockaddr_storage
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Diffstat (limited to 'man3/sockaddr-struct.3')
-rw-r--r--man3/sockaddr-struct.321
1 files changed, 19 insertions, 2 deletions
diff --git a/man3/sockaddr-struct.3 b/man3/sockaddr-struct.3
index 0db6b5930b..6e2050c6b9 100644
--- a/man3/sockaddr-struct.3
+++ b/man3/sockaddr-struct.3
@@ -1,6 +1,6 @@
.TH SOCKADDR 3 2022-02-24 Linux "Linux Programmer's Manual"
.SH NAME
-sockaddr, socklen_t \- socket address
+sockaddr, sockaddr_storage, socklen_t \- socket address
.SH SYNOPSIS
.nf
.B #include <sys/socket.h>
@@ -10,6 +10,10 @@ sockaddr, socklen_t \- socket address
.BR " char sa_data[];" " /* Socket address */"
.B };
.PP
+.B struct sockaddr_storage {
+.BR " sa_family_t ss_family;" " /* Address family */"
+.B };
+.PP
.BR typedef " /* ... */ " socklen_t;
.fi
.SH DESCRIPTION
@@ -17,6 +21,16 @@ sockaddr, socklen_t \- socket address
.I sockaddr
Describes a socket address.
.TP
+.I sockaddr_storage
+According to POSIX,
+a structure large enough to accomodate all supported
+.IR sockaddr_ *
+address structures.
+It's aligned so that a pointer to it can be cast
+as a pointer to other
+.IR sockaddr_ *
+structures and used to access its fields.
+.TP
.I socklen_t
Describes the length of a socket address.
According to POSIX,
@@ -34,5 +48,8 @@ is also defined in
.BR getpeername (2),
.BR getsockname (2),
.BR socket (2),
+.BR getaddrinfo (3),
.BR gethostbyaddr (3),
-.BR getnameinfo (3)
+.BR getnameinfo (3),
+.BR ipv6 (7),
+.BR socket (7)