Annotation of src/sys/sys/socket.h, Revision 1.5.4.1
1.1 cgd 1: /*
2: * Copyright (c) 1982,1985,1986,1988 Regents of the University of California.
3: * All rights reserved.
4: *
5: * Redistribution and use in source and binary forms, with or without
6: * modification, are permitted provided that the following conditions
7: * are met:
8: * 1. Redistributions of source code must retain the above copyright
9: * notice, this list of conditions and the following disclaimer.
10: * 2. Redistributions in binary form must reproduce the above copyright
11: * notice, this list of conditions and the following disclaimer in the
12: * documentation and/or other materials provided with the distribution.
13: * 3. All advertising materials mentioning features or use of this software
14: * must display the following acknowledgement:
15: * This product includes software developed by the University of
16: * California, Berkeley and its contributors.
17: * 4. Neither the name of the University nor the names of its contributors
18: * may be used to endorse or promote products derived from this software
19: * without specific prior written permission.
20: *
21: * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24: * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31: * SUCH DAMAGE.
32: *
1.4 cgd 33: * from: @(#)socket.h 7.13 (Berkeley) 4/20/91
1.5.4.1 ! mycroft 34: * $Id: socket.h,v 1.5 1993/06/27 05:59:06 andrew Exp $
1.1 cgd 35: */
36:
1.2 mycroft 37: #ifndef _SYS_SOCKET_H_
38: #define _SYS_SOCKET_H_
39:
1.1 cgd 40: /*
41: * Definitions related to sockets: types, address families, options.
42: */
43:
44: /*
45: * Types
46: */
47: #define SOCK_STREAM 1 /* stream socket */
48: #define SOCK_DGRAM 2 /* datagram socket */
49: #define SOCK_RAW 3 /* raw-protocol interface */
50: #define SOCK_RDM 4 /* reliably-delivered message */
51: #define SOCK_SEQPACKET 5 /* sequenced packet stream */
52:
53: /*
54: * Option flags per-socket.
55: */
56: #define SO_DEBUG 0x0001 /* turn on debugging info recording */
57: #define SO_ACCEPTCONN 0x0002 /* socket has had listen() */
58: #define SO_REUSEADDR 0x0004 /* allow local address reuse */
59: #define SO_KEEPALIVE 0x0008 /* keep connections alive */
60: #define SO_DONTROUTE 0x0010 /* just use interface addresses */
61: #define SO_BROADCAST 0x0020 /* permit sending of broadcast msgs */
62: #define SO_USELOOPBACK 0x0040 /* bypass hardware when possible */
63: #define SO_LINGER 0x0080 /* linger on close if data present */
64: #define SO_OOBINLINE 0x0100 /* leave received OOB data in line */
65:
66: /*
67: * Additional options, not kept in so_options.
68: */
69: #define SO_SNDBUF 0x1001 /* send buffer size */
70: #define SO_RCVBUF 0x1002 /* receive buffer size */
71: #define SO_SNDLOWAT 0x1003 /* send low-water mark */
72: #define SO_RCVLOWAT 0x1004 /* receive low-water mark */
73: #define SO_SNDTIMEO 0x1005 /* send timeout */
74: #define SO_RCVTIMEO 0x1006 /* receive timeout */
75: #define SO_ERROR 0x1007 /* get error status and clear */
76: #define SO_TYPE 0x1008 /* get socket type */
77:
78: /*
79: * Structure used for manipulating linger option.
80: */
81: struct linger {
82: int l_onoff; /* option on/off */
83: int l_linger; /* linger time */
84: };
85:
86: /*
87: * Level number for (get/set)sockopt() to apply to socket itself.
88: */
89: #define SOL_SOCKET 0xffff /* options for socket level */
90:
91: /*
92: * Address families.
93: */
94: #define AF_UNSPEC 0 /* unspecified */
1.5.4.1 ! mycroft 95: #define AF_LOCAL 1 /* local to host (pipes, portals) */
! 96: #define AF_UNIX AF_LOCAL
1.1 cgd 97: #define AF_INET 2 /* internetwork: UDP, TCP, etc. */
98: #define AF_IMPLINK 3 /* arpanet imp addresses */
99: #define AF_PUP 4 /* pup protocols: e.g. BSP */
100: #define AF_CHAOS 5 /* mit CHAOS protocols */
101: #define AF_NS 6 /* XEROX NS protocols */
102: #define AF_ISO 7 /* ISO protocols */
103: #define AF_OSI AF_ISO
104: #define AF_ECMA 8 /* european computer manufacturers */
105: #define AF_DATAKIT 9 /* datakit protocols */
106: #define AF_CCITT 10 /* CCITT protocols, X.25 etc */
107: #define AF_SNA 11 /* IBM SNA */
108: #define AF_DECnet 12 /* DECnet */
109: #define AF_DLI 13 /* DEC Direct data link interface */
110: #define AF_LAT 14 /* LAT */
111: #define AF_HYLINK 15 /* NSC Hyperchannel */
112: #define AF_APPLETALK 16 /* Apple Talk */
113: #define AF_ROUTE 17 /* Internal Routing Protocol */
114: #define AF_LINK 18 /* Link layer interface */
115: #define pseudo_AF_XTP 19 /* eXpress Transfer Protocol (no AF) */
116:
117: #define AF_MAX 20
118:
119: /*
120: * Structure used by kernel to store most
121: * addresses.
122: */
123: struct sockaddr {
124: u_char sa_len; /* total length */
125: u_char sa_family; /* address family */
126: char sa_data[14]; /* actually longer; address value */
127: };
128:
129: /*
130: * Structure used by kernel to pass protocol
131: * information in raw sockets.
132: */
133: struct sockproto {
134: u_short sp_family; /* address family */
135: u_short sp_protocol; /* protocol */
136: };
137:
138: /*
139: * Protocol families, same as address families for now.
140: */
141: #define PF_UNSPEC AF_UNSPEC
1.5.4.1 ! mycroft 142: #define PF_LOCAL AF_LOCAL
! 143: #define PF_UNIX AF_LOCAL
1.1 cgd 144: #define PF_INET AF_INET
145: #define PF_IMPLINK AF_IMPLINK
146: #define PF_PUP AF_PUP
147: #define PF_CHAOS AF_CHAOS
148: #define PF_NS AF_NS
149: #define PF_ISO AF_ISO
150: #define PF_OSI AF_ISO
151: #define PF_ECMA AF_ECMA
152: #define PF_DATAKIT AF_DATAKIT
153: #define PF_CCITT AF_CCITT
154: #define PF_SNA AF_SNA
155: #define PF_DECnet AF_DECnet
156: #define PF_DLI AF_DLI
157: #define PF_LAT AF_LAT
158: #define PF_HYLINK AF_HYLINK
159: #define PF_APPLETALK AF_APPLETALK
160: #define PF_ROUTE AF_ROUTE
161: #define PF_LINK AF_LINK
162: #define PF_XTP pseudo_AF_XTP /* really just proto family, no AF */
163:
164: #define PF_MAX AF_MAX
165:
166: /*
167: * Maximum queue length specifiable by listen.
168: */
169: #define SOMAXCONN 5
170:
171: /*
172: * Message header for recvmsg and sendmsg calls.
173: * Used value-result for recvmsg, value only for sendmsg.
174: */
175: struct msghdr {
176: caddr_t msg_name; /* optional address */
177: u_int msg_namelen; /* size of address */
178: struct iovec *msg_iov; /* scatter/gather array */
179: u_int msg_iovlen; /* # elements in msg_iov */
180: caddr_t msg_control; /* ancillary data, see below */
181: u_int msg_controllen; /* ancillary data buffer len */
182: int msg_flags; /* flags on received message */
183: };
184:
185: #define MSG_OOB 0x1 /* process out-of-band data */
186: #define MSG_PEEK 0x2 /* peek at incoming message */
187: #define MSG_DONTROUTE 0x4 /* send without using routing tables */
188: #define MSG_EOR 0x8 /* data completes record */
189: #define MSG_TRUNC 0x10 /* data discarded before delivery */
190: #define MSG_CTRUNC 0x20 /* control data lost before delivery */
191: #define MSG_WAITALL 0x40 /* wait for full request or error */
192:
193: /*
194: * Header for ancillary data objects in msg_control buffer.
195: * Used for additional information with/about a datagram
196: * not expressible by flags. The format is a sequence
197: * of message elements headed by cmsghdr structures.
198: */
199: struct cmsghdr {
200: u_int cmsg_len; /* data byte count, including hdr */
201: int cmsg_level; /* originating protocol */
202: int cmsg_type; /* protocol-specific type */
203: /* followed by u_char cmsg_data[]; */
204: };
205:
206: /* given pointer to struct adatahdr, return pointer to data */
207: #define CMSG_DATA(cmsg) ((u_char *)((cmsg) + 1))
208:
209: /* given pointer to struct adatahdr, return pointer to next adatahdr */
210: #define CMSG_NXTHDR(mhdr, cmsg) \
211: (((caddr_t)(cmsg) + (cmsg)->cmsg_len + sizeof(struct cmsghdr) > \
212: (mhdr)->msg_control + (mhdr)->msg_controllen) ? \
213: (struct cmsghdr *)NULL : \
214: (struct cmsghdr *)((caddr_t)(cmsg) + ALIGN((cmsg)->cmsg_len)))
215:
216: #define CMSG_FIRSTHDR(mhdr) ((struct cmsghdr *)(mhdr)->msg_control)
217:
218: /* "Socket"-level control message types: */
219: #define SCM_RIGHTS 0x01 /* access rights (array of int) */
220:
221: /*
222: * 4.3 compat sockaddr, move to compat file later
223: */
224: struct osockaddr {
225: u_short sa_family; /* address family */
226: char sa_data[14]; /* up to 14 bytes of direct address */
227: };
228:
229: /*
230: * 4.3-compat message header (move to compat file later).
231: */
232: struct omsghdr {
233: caddr_t msg_name; /* optional address */
234: int msg_namelen; /* size of address */
235: struct iovec *msg_iov; /* scatter/gather array */
236: int msg_iovlen; /* # elements in msg_iov */
237: caddr_t msg_accrights; /* access rights sent/received */
238: int msg_accrightslen;
239: };
240:
1.5 andrew 241: #ifdef KERNEL
242:
243: /* structure prototypes */
244: struct socket;
245: struct mbuf;
246:
247: /* function prototypes */
248: int socreate __P((int dom, struct socket **aso, int type, int proto));
249: int sobind __P((struct socket *so, struct mbuf *nam));
250: int solisten __P((struct socket *so, int backlog));
251: int sofree __P((struct socket *so));
252: int soclose __P((struct socket *so));
253: int soabort __P((struct socket *so));
254: int soaccept __P((struct socket *so, struct mbuf *nam));
255: int soconnect __P((struct socket *so, struct mbuf *nam));
256: int soconnect2 __P((struct socket *so1, struct socket *so2));
257: int sodisconnect __P((struct socket *so));
258: int sosend __P((struct socket *so, struct mbuf *addr, struct uio *uio,
259: struct mbuf *top, struct mbuf *control, int flags));
260: int soreceive __P((struct socket *so, struct mbuf **paddr, struct uio *uio,
261: struct mbuf **mp0, struct mbuf **controlp, int *flagsp));
262:
263: void socantsendmore __P((struct socket *so));
264: void socantrcvmore __P((struct socket *so));
265:
266: #else /* !KERNEL */
1.1 cgd 267:
268: #include <sys/cdefs.h>
269:
270: __BEGIN_DECLS
271: int accept __P((int, struct sockaddr *, int *));
272: int bind __P((int, const struct sockaddr *, int));
273: int connect __P((int, const struct sockaddr *, int));
274: int getpeername __P((int, struct sockaddr *, int *));
275: int getsockname __P((int, struct sockaddr *, int *));
276: int getsockopt __P((int, int, int, void *, int *));
277: int listen __P((int, int));
278: int recv __P((int, void *, int, int));
279: int recvfrom __P((int, void *, int, int,
280: struct sockaddr *, int *));
281: int recvmsg __P((int, struct msghdr *, int));
282: int send __P((int, const void *, int, int));
283: int sendto __P((int, const void *, int, int, const struct sockaddr *, int));
284: int sendmsg __P((int, const struct msghdr *, int));
285: int setsockopt __P((int, int, int, const void *, int));
286: int shutdown __P((int, int));
287: int socket __P((int, int, int));
288: int socketpair __P((int, int, int, int *));
289: __END_DECLS
290:
1.3 mycroft 291: #endif /* !KERNEL */
1.2 mycroft 292:
293: #endif /* !_SYS_SOCKET_H_ */
CVSweb <webmaster@jp.NetBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to socket.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [cvs.NetBSD.org] / src / sys / sys