1998-09-05 Roland McGrath <roland@baalperazim.frob.com>
[kopensolaris-gnu/glibc.git] / socket / sys / socket.h
1 /* Declarations of socket constants, types, and functions.
2    Copyright (C) 1991, 92, 94, 95, 96, 97, 98 Free Software Foundation, Inc.
3    This file is part of the GNU C Library.
4
5    The GNU C Library is free software; you can redistribute it and/or
6    modify it under the terms of the GNU Library General Public License as
7    published by the Free Software Foundation; either version 2 of the
8    License, or (at your option) any later version.
9
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    Library General Public License for more details.
14
15    You should have received a copy of the GNU Library General Public
16    License along with the GNU C Library; see the file COPYING.LIB.  If not,
17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18    Boston, MA 02111-1307, USA.  */
19
20 #ifndef _SYS_SOCKET_H
21 #define _SYS_SOCKET_H   1
22
23 #include <features.h>
24
25 __BEGIN_DECLS
26
27 #define __need_size_t
28 #include <stddef.h>
29
30
31 /* This operating system-specific header file defines the SOCK_*, PF_*,
32    AF_*, MSG_*, SOL_*, and SO_* constants, and the `struct sockaddr',
33    `struct msghdr', and `struct linger' types.  */
34 #include <bits/socket.h>
35
36 /* Get the definition of `sockaddr_union'.  */
37 #include <bits/sockunion.h>
38
39 #ifdef __USE_BSD
40 /* This is the 4.3 BSD `struct sockaddr' format, which is used as wire
41    format in the grotty old 4.3 `talk' protocol.  */
42 struct osockaddr
43   {
44     unsigned short int sa_family;
45     unsigned char sa_data[14];
46   };
47 #endif
48
49 /* This is the type we use for generic socket address arguments.
50
51    With GCC 2.7 and later, the funky union causes redeclarations or
52    uses with any of the listed types to be allowed without complaint.
53    G++ 2.7 does not support transparent unions so there we want the
54    old-style declaration, too.  */
55 #if     (!defined __GNUC__ || __GNUC__ < 2 || defined __cplusplus || \
56          (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
57 # define __SOCKADDR_ARG         struct sockaddr *
58 # define __CONST_SOCKADDR_ARG   __const struct sockaddr *
59 #else
60 /* Add more `struct sockaddr_AF' types here as necessary.
61    These are all the ones I found on NetBSD and Linux.  */
62 # define __SOCKADDR_ALLTYPES \
63   __SOCKADDR_ONETYPE (sockaddr) \
64   __SOCKADDR_ONETYPE (sockaddr_at) \
65   __SOCKADDR_ONETYPE (sockaddr_ax25) \
66   __SOCKADDR_ONETYPE (sockaddr_dl) \
67   __SOCKADDR_ONETYPE (sockaddr_eon) \
68   __SOCKADDR_ONETYPE (sockaddr_in) \
69   __SOCKADDR_ONETYPE (sockaddr_in6) \
70   __SOCKADDR_ONETYPE (sockaddr_inarp) \
71   __SOCKADDR_ONETYPE (sockaddr_ipx) \
72   __SOCKADDR_ONETYPE (sockaddr_iso) \
73   __SOCKADDR_ONETYPE (sockaddr_ns) \
74   __SOCKADDR_ONETYPE (sockaddr_un) \
75   __SOCKADDR_ONETYPE (sockaddr_x25)
76
77 # define __SOCKADDR_ONETYPE(type) struct type *__##type##__;
78 typedef union { __SOCKADDR_ALLTYPES
79               } __SOCKADDR_ARG __attribute__ ((__transparent_union__));
80 # undef __SOCKADDR_ONETYPE
81 # define __SOCKADDR_ONETYPE(type) __const struct type *__##type##__;
82 typedef union { __SOCKADDR_ALLTYPES
83               } __CONST_SOCKADDR_ARG __attribute__ ((__transparent_union__));
84 # undef __SOCKADDR_ONETYPE
85 #endif
86
87
88 /* Create a new socket of type TYPE in domain DOMAIN, using
89    protocol PROTOCOL.  If PROTOCOL is zero, one is chosen automatically.
90    Returns a file descriptor for the new socket, or -1 for errors.  */
91 extern int socket __P ((int __domain, int __type, int __protocol));
92
93 /* Create two new sockets, of type TYPE in domain DOMAIN and using
94    protocol PROTOCOL, which are connected to each other, and put file
95    descriptors for them in FDS[0] and FDS[1].  If PROTOCOL is zero,
96    one will be chosen automatically.  Returns 0 on success, -1 for errors.  */
97 extern int socketpair __P ((int __domain, int __type, int __protocol,
98                             int __fds[2]));
99
100 /* Give the socket FD the local address ADDR (which is LEN bytes long).  */
101 extern int bind __P ((int __fd, __CONST_SOCKADDR_ARG __addr, socklen_t __len));
102
103 /* Put the local address of FD into *ADDR and its length in *LEN.  */
104 extern int getsockname __P ((int __fd, __SOCKADDR_ARG __addr,
105                              socklen_t *__len));
106
107 /* Open a connection on socket FD to peer at ADDR (which LEN bytes long).
108    For connectionless socket types, just set the default address to send to
109    and the only address from which to accept transmissions.
110    Return 0 on success, -1 for errors.  */
111 extern int __connect __P ((int __fd,
112                            __CONST_SOCKADDR_ARG __addr, socklen_t __len));
113 extern int connect __P ((int __fd,
114                          __CONST_SOCKADDR_ARG __addr, socklen_t __len));
115
116 /* Put the address of the peer connected to socket FD into *ADDR
117    (which is *LEN bytes long), and its actual length into *LEN.  */
118 extern int getpeername __P ((int __fd, __SOCKADDR_ARG __addr,
119                              socklen_t *__len));
120
121
122 /* Send N bytes of BUF to socket FD.  Returns the number sent or -1.  */
123 extern int __send __P ((int __fd, __const __ptr_t __buf, size_t __n,
124                         int __flags));
125 extern int send __P ((int __fd, __const __ptr_t __buf, size_t __n,
126                       int __flags));
127
128 /* Read N bytes into BUF from socket FD.
129    Returns the number read or -1 for errors.  */
130 extern int recv __P ((int __fd, __ptr_t __buf, size_t __n, int __flags));
131
132 /* Send N bytes of BUF on socket FD to peer at address ADDR (which is
133    ADDR_LEN bytes long).  Returns the number sent, or -1 for errors.  */
134 extern int sendto __P ((int __fd, __const __ptr_t __buf, size_t __n,
135                         int __flags, __CONST_SOCKADDR_ARG __addr,
136                         socklen_t __addr_len));
137
138 /* Read N bytes into BUF through socket FD.
139    If ADDR is not NULL, fill in *ADDR_LEN bytes of it with tha address of
140    the sender, and store the actual size of the address in *ADDR_LEN.
141    Returns the number of bytes read or -1 for errors.  */
142 extern int recvfrom __P ((int __fd, __ptr_t __buf, size_t __n, int __flags,
143                           __SOCKADDR_ARG __addr, socklen_t *__addr_len));
144
145
146 /* Send a message described MESSAGE on socket FD.
147    Returns the number of bytes sent, or -1 for errors.  */
148 extern int sendmsg __P ((int __fd, __const struct msghdr *__message,
149                          int __flags));
150
151 /* Receive a message as described by MESSAGE from socket FD.
152    Returns the number of bytes read or -1 for errors.  */
153 extern int recvmsg __P ((int __fd, struct msghdr *__message, int __flags));
154
155
156 /* Put the current value for socket FD's option OPTNAME at protocol level LEVEL
157    into OPTVAL (which is *OPTLEN bytes long), and set *OPTLEN to the value's
158    actual length.  Returns 0 on success, -1 for errors.  */
159 extern int getsockopt __P ((int __fd, int __level, int __optname,
160                             __ptr_t __optval, socklen_t *__optlen));
161
162 /* Set socket FD's option OPTNAME at protocol level LEVEL
163    to *OPTVAL (which is OPTLEN bytes long).
164    Returns 0 on success, -1 for errors.  */
165 extern int setsockopt __P ((int __fd, int __level, int __optname,
166                             __const __ptr_t __optval, socklen_t __optlen));
167
168
169 /* Prepare to accept connections on socket FD.
170    N connection requests will be queued before further requests are refused.
171    Returns 0 on success, -1 for errors.  */
172 extern int listen __P ((int __fd, unsigned int __n));
173
174 /* Await a connection on socket FD.
175    When a connection arrives, open a new socket to communicate with it,
176    set *ADDR (which is *ADDR_LEN bytes long) to the address of the connecting
177    peer and *ADDR_LEN to the address's actual length, and return the
178    new socket's descriptor, or -1 for errors.  */
179 extern int accept __P ((int __fd, __SOCKADDR_ARG __addr,
180                         socklen_t *__addr_len));
181
182 /* Shut down all or part of the connection open on socket FD.
183    HOW determines what to shut down:
184      0 = No more receptions;
185      1 = No more transmissions;
186      2 = No more receptions or transmissions.
187    Returns 0 on success, -1 for errors.  */
188 extern int shutdown __P ((int __fd, int __how));
189
190
191 /* FDTYPE is S_IFSOCK or another S_IF* macro defined in <sys/stat.h>;
192    returns 1 if FD is open on an object of the indicated type, 0 if not,
193    or -1 for errors (setting errno).  */
194 extern int isfdtype __P ((int __fd, int __fdtype));
195
196 __END_DECLS
197
198 #endif /* sys/socket.h */