.
[glibc/history.git] / bits / socket.h
blob20e6f0337f07ca4b51a80dd7a8890a1cc7dff37f
1 /* System-specific socket constants and types. Generic/4.3 BSD version.
2 Copyright (C) 1991,92,1994-1999,2000,2001 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public
16 License along with the GNU C Library; if not, write to the Free
17 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
18 02111-1307 USA. */
20 #ifndef __BITS_SOCKET_H
21 #define __BITS_SOCKET_H 1
23 #if !defined _SYS_SOCKET_H && !defined _NETINET_IN_H
24 # error "Never include <bits/socket.h> directly; use <sys/socket.h> instead."
25 #endif
27 #include <limits.h>
28 #include <bits/types.h>
30 #define __need_size_t
31 #include <stddef.h>
33 /* Type for length arguments in socket calls. */
34 #ifndef __socklen_t_defined
35 typedef __socklen_t socklen_t;
36 # define __socklen_t_defined
37 #endif
40 /* Types of sockets. */
41 enum __socket_type
43 SOCK_STREAM = 1, /* Sequenced, reliable, connection-based
44 byte streams. */
45 #define SOCK_STREAM SOCK_STREAM
46 SOCK_DGRAM = 2, /* Connectionless, unreliable datagrams
47 of fixed maximum length. */
48 #define SOCK_DGRAM SOCK_DGRAM
49 SOCK_RAW = 3, /* Raw protocol interface. */
50 #define SOCK_RAW SOCK_RAW
51 SOCK_RDM = 4, /* Reliably-delivered messages. */
52 #define SOCK_RDM SOCK_RDM
53 SOCK_SEQPACKET = 5 /* Sequenced, reliable, connection-based,
54 datagrams of fixed maximum length. */
55 #define SOCK_SEQPACKET SOCK_SEQPACKET
58 /* Protocol families. */
59 #define PF_UNSPEC 0 /* Unspecified. */
60 #define PF_LOCAL 1 /* Local to host (pipes and file-domain). */
61 #define PF_UNIX PF_LOCAL /* Old BSD name for PF_LOCAL. */
62 #define PF_FILE PF_LOCAL /* POSIX name for PF_LOCAL. */
63 #define PF_INET 2 /* IP protocol family. */
64 #define PF_IMPLINK 3 /* ARPAnet IMP protocol. */
65 #define PF_PUP 4 /* PUP protocols. */
66 #define PF_CHAOS 5 /* MIT Chaos protocols. */
67 #define PF_NS 6 /* Xerox NS protocols. */
68 #define PF_ISO 7 /* ISO protocols. */
69 #define PF_OSI PF_ISO
70 #define PF_ECMA 8 /* ECMA protocols. */
71 #define PF_DATAKIT 9 /* AT&T Datakit protocols. */
72 #define PF_CCITT 10 /* CCITT protocols (X.25 et al). */
73 #define PF_SNA 11 /* IBM SNA protocol. */
74 #define PF_DECnet 12 /* DECnet protocols. */
75 #define PF_DLI 13 /* Direct data link interface. */
76 #define PF_LAT 14 /* DEC Local Area Transport protocol. */
77 #define PF_HYLINK 15 /* NSC Hyperchannel protocol. */
78 #define PF_APPLETALK 16 /* Don't use this. */
79 #define PF_ROUTE 17 /* Internal Routing Protocol. */
80 #define PF_LINK 18 /* Link layer interface. */
81 #define PF_XTP 19 /* eXpress Transfer Protocol (no AF). */
82 #define PF_COIP 20 /* Connection-oriented IP, aka ST II. */
83 #define PF_CNT 21 /* Computer Network Technology. */
84 #define PF_RTIP 22 /* Help Identify RTIP packets. **/
85 #define PF_IPX 23 /* Novell Internet Protocol. */
86 #define PF_SIP 24 /* Simple Internet Protocol. */
87 #define PF_PIP 25 /* Help Identify PIP packets. */
88 #define PF_INET6 26 /* IP version 6. */
89 #define PF_MAX 27
91 /* Address families. */
92 #define AF_UNSPEC PF_UNSPEC
93 #define AF_LOCAL PF_LOCAL
94 #define AF_UNIX PF_UNIX
95 #define AF_FILE PF_FILE
96 #define AF_INET PF_INET
97 #define AF_IMPLINK PF_IMPLINK
98 #define AF_PUP PF_PUP
99 #define AF_CHAOS PF_CHAOS
100 #define AF_NS PF_NS
101 #define AF_ISO PF_ISO
102 #define AF_OSI PF_OSI
103 #define AF_ECMA PF_ECMA
104 #define AF_DATAKIT PF_DATAKIT
105 #define AF_CCITT PF_CCITT
106 #define AF_SNA PF_SNA
107 #define AF_DECnet PF_DECnet
108 #define AF_DLI PF_DLI
109 #define AF_LAT PF_LAT
110 #define AF_HYLINK PF_HYLINK
111 #define AF_APPLETALK PF_APPLETALK
112 #define AF_ROUTE PF_ROUTE
113 #define AF_LINK PF_LINK
114 #define pseudo_AF_XTP PF_XTP
115 #define AF_COIP PF_COIP
116 #define AF_CNT PF_CNT
117 #define pseudo_AF_RTIP PF_RTIP
118 #define AF_IPX PF_IPX
119 #define AF_SIP PF_SIP
120 #define pseudo_AF_PIP PF_PIP
121 #define AF_INET6 PF_INET6
122 #define AF_MAX PF_MAX
125 /* Get the definition of the macro to define the common sockaddr members. */
126 #include <bits/sockaddr.h>
128 /* Structure describing a generic socket address. */
129 struct sockaddr
131 __SOCKADDR_COMMON (sa_); /* Common data: address family and length. */
132 char sa_data[14]; /* Address data. */
136 /* Structure large enough to hold any socket address (with the historical
137 exception of AF_UNIX). We reserve 128 bytes. */
138 #if ULONG_MAX > 0xffffffff
139 # define __ss_aligntype __uint64_t
140 #else
141 # define __ss_aligntype __uint32_t
142 #endif
143 #define _SS_SIZE 128
144 #define _SS_PADSIZE (_SS_SIZE - (2 * sizeof (__ss_aligntype)))
146 struct sockaddr_storage
148 __SOCKADDR_COMMON (ss_); /* Address family, etc. */
149 __ss_aligntype __ss_align; /* Force desired alignment. */
150 char __ss_padding[_SS_PADSIZE];
154 /* Bits in the FLAGS argument to `send', `recv', et al. */
155 enum
157 MSG_OOB = 0x01, /* Process out-of-band data. */
158 #define MSG_OOB MSG_OOB
159 MSG_PEEK = 0x02, /* Peek at incoming messages. */
160 #define MSG_PEEK MSG_PEEK
161 MSG_DONTROUTE = 0x04, /* Don't use local routing. */
162 #define MSG_DONTROUTE MSG_DONTROUTE
163 MSG_EOR = 0x08, /* Data completes record. */
164 #define MSG_EOR MSG_EOR
165 MSG_TRUNC = 0x10, /* Data discarded before delivery. */
166 #define MSG_TRUNC MSG_TRUNC
167 MSG_CTRUNC = 0x20, /* Control data lost before delivery. */
168 #define MSG_CTRUNC MSG_CTRUNC
169 MSG_WAITALL = 0x40, /* Wait for full request or error. */
170 #define MSG_WAITALL MSG_WAITALL
171 MSG_DONTWAIT = 0x80 /* This message should be nonblocking. */
172 #define MSG_DONTWAIT MSG_DONTWAIT
176 /* Structure describing messages sent by
177 `sendmsg' and received by `recvmsg'. */
178 struct msghdr
180 __ptr_t msg_name; /* Address to send to/receive from. */
181 socklen_t msg_namelen; /* Length of address data. */
183 struct iovec *msg_iov; /* Vector of data to send/receive into. */
184 int msg_iovlen; /* Number of elements in the vector. */
186 __ptr_t msg_accrights; /* Access rights information. */
187 socklen_t msg_accrightslen; /* Length of access rights information. */
189 int msg_flags; /* Flags in received message. */
193 /* Protocol number used to manipulate socket-level options
194 with `getsockopt' and `setsockopt'. */
195 #define SOL_SOCKET 0xffff
197 /* Socket-level options for `getsockopt' and `setsockopt'. */
198 enum
200 SO_DEBUG = 0x0001, /* Record debugging information. */
201 #define SO_DEBUG SO_DEBUG
202 SO_ACCEPTCONN = 0x0002, /* Accept connections on socket. */
203 #define SO_ACCEPTCONN SO_ACCEPTCONN
204 SO_REUSEADDR = 0x0004, /* Allow reuse of local addresses. */
205 #define SO_REUSEADDR SO_REUSEADDR
206 SO_KEEPALIVE = 0x0008, /* Keep connections alive and send
207 SIGPIPE when they die. */
208 #define SO_KEEPALIVE SO_KEEPALIVE
209 SO_DONTROUTE = 0x0010, /* Don't do local routing. */
210 #define SO_DONTROUTE SO_DONTROUTE
211 SO_BROADCAST = 0x0020, /* Allow transmission of
212 broadcast messages. */
213 #define SO_BROADCAST SO_BROADCAST
214 SO_USELOOPBACK = 0x0040, /* Use the software loopback to avoid
215 hardware use when possible. */
216 #define SO_USELOOPBACK SO_USELOOPBACK
217 SO_LINGER = 0x0080, /* Block on close of a reliable
218 socket to transmit pending data. */
219 #define SO_LINGER SO_LINGER
220 SO_OOBINLINE = 0x0100, /* Receive out-of-band data in-band. */
221 #define SO_OOBINLINE SO_OOBINLINE
222 SO_REUSEPORT = 0x0200, /* Allow local address and port reuse. */
223 #define SO_REUSEPORT SO_REUSEPORT
224 SO_SNDBUF = 0x1001, /* Send buffer size. */
225 #define SO_SNDBUF SO_SNDBUF
226 SO_RCVBUF = 0x1002, /* Receive buffer. */
227 #define SO_RCVBUF SO_RCVBUF
228 SO_SNDLOWAT = 0x1003, /* Send low-water mark. */
229 #define SO_SNDLOWAT SO_SNDLOWAT
230 SO_RCVLOWAT = 0x1004, /* Receive low-water mark. */
231 #define SO_RCVLOWAT SO_RCVLOWAT
232 SO_SNDTIMEO = 0x1005, /* Send timeout. */
233 #define SO_SNDTIMEO SO_SNDTIMEO
234 SO_RCVTIMEO = 0x1006, /* Receive timeout. */
235 #define SO_RCVTIMEO SO_RCVTIMEO
236 SO_ERROR = 0x1007, /* Get and clear error status. */
237 #define SO_ERROR SO_ERROR
238 SO_STYLE = 0x1008, /* Get socket connection style. */
239 #define SO_STYLE SO_STYLE
240 SO_TYPE = SO_STYLE /* Compatible name for SO_STYLE. */
241 #define SO_TYPE SO_TYPE
244 /* Structure used to manipulate the SO_LINGER option. */
245 struct linger
247 int l_onoff; /* Nonzero to linger on close. */
248 int l_linger; /* Time to linger. */
251 #endif /* bits/socket.h */