Authors: Chris Morgan <cmorgan@wpi.edu>, James Abbatiello <abbeyj@wpi.edu>
[wine/multimedia.git] / include / winsock.h
blob74c4bb1ee646a3f34a6ab723e730b020792166c3
1 /* WINSOCK.H--definitions to be used with the WINSOCK.DLL
3 * This header file corresponds to version 1.1 of the Windows Sockets
4 * specification.
5 */
7 #ifndef _WINSOCKAPI_
8 #define _WINSOCKAPI_
10 /* Solaris kludge */
11 #undef FSHIFT
12 #undef PAGESIZE
13 #undef TRANSPARENT
14 #include <netinet/in.h>
15 #undef FSHIFT
16 #undef PAGESIZE
17 #undef TRANSPARENT
19 #include <arpa/inet.h>
20 #include <sys/types.h>
21 #include <sys/time.h>
22 #include <fcntl.h>
23 #include <netdb.h>
24 #include <sys/socket.h>
26 #ifdef HAVE_IPX_GNU
27 # include <netipx/ipx.h>
28 # define HAVE_IPX
29 #endif
31 #ifdef HAVE_IPX_LINUX
32 # include <asm/types.h>
33 # include <linux/ipx.h>
34 # define HAVE_IPX
35 #endif
37 #include "windef.h"
38 #include "task.h"
40 #ifdef __cplusplus
41 extern "C" {
42 #endif /* defined(__cplusplus) */
44 #include "pshpack1.h"
46 /* Win16 socket-related types */
48 typedef UINT16 SOCKET16;
49 typedef UINT SOCKET;
51 typedef struct ws_hostent
53 SEGPTR h_name; /* official name of host */
54 SEGPTR h_aliases; /* alias list */
55 INT16 h_addrtype; /* host address type */
56 INT16 h_length; /* length of address */
57 SEGPTR h_addr_list; /* list of addresses from name server */
58 } _ws_hostent;
60 typedef struct ws_protoent
62 SEGPTR p_name; /* official protocol name */
63 SEGPTR p_aliases; /* alias list */
64 INT16 p_proto; /* protocol # */
65 } _ws_protoent;
67 typedef struct ws_servent
69 SEGPTR s_name; /* official service name */
70 SEGPTR s_aliases; /* alias list */
71 INT16 s_port; /* port # */
72 SEGPTR s_proto; /* protocol to use */
73 } _ws_servent;
75 typedef struct ws_netent
77 SEGPTR n_name; /* official name of net */
78 SEGPTR n_aliases; /* alias list */
79 INT16 n_addrtype; /* net address type */
80 INT n_net; /* network # */
81 } _ws_netent;
83 typedef struct sockaddr ws_sockaddr;
85 typedef struct
87 UINT16 fd_count; /* how many are SET? */
88 SOCKET16 fd_array[FD_SETSIZE]; /* an array of SOCKETs */
89 } ws_fd_set16;
91 typedef struct
93 UINT fd_count; /* how many are SET? */
94 SOCKET fd_array[FD_SETSIZE]; /* an array of SOCKETs */
95 } ws_fd_set32;
97 /* ws_fd_set operations */
99 INT16 WINAPI __WSAFDIsSet16( SOCKET16, ws_fd_set16 * );
100 INT WINAPI __WSAFDIsSet( SOCKET, ws_fd_set32 * );
102 #define __WS_FD_CLR(fd, set, cast) do { \
103 UINT16 __i; \
104 for (__i = 0; __i < ((cast*)(set))->fd_count ; __i++) \
106 if (((cast*)(set))->fd_array[__i] == fd) \
108 while (__i < ((cast*)(set))->fd_count-1) \
110 ((cast*)(set))->fd_array[__i] = \
111 ((cast*)(set))->fd_array[__i+1]; \
112 __i++; \
114 ((cast*)(set))->fd_count--; \
115 break; \
118 } while(0)
119 #define WS_FD_CLR16(fd, set) __WS_FD_CLR((fd),(set), ws_fd_set16)
120 #define WS_FD_CLR(fd, set) __WS_FD_CLR((fd),(set), ws_fd_set32)
122 #define __WS_FD_SET(fd, set, cast) do { \
123 if (((cast*)(set))->fd_count < FD_SETSIZE) \
124 ((cast*)(set))->fd_array[((cast*)(set))->fd_count++]=(fd);\
125 } while(0)
126 #define WS_FD_SET16(fd, set) __WS_FD_SET((fd),(set), ws_fd_set16)
127 #define WS_FD_SET(fd, set) __WS_FD_SET((fd),(set), ws_fd_set32)
129 #define WS_FD_ZERO16(set) (((ws_fd_set16*)(set))->fd_count=0)
130 #define WS_FD_ZERO(set) (((ws_fd_set32*)(set))->fd_count=0)
132 #define WS_FD_ISSET16(fd, set) __WSAFDIsSet16((SOCKET16)(fd), (ws_fd_set16*)(set))
133 #define WS_FD_ISSET(fd, set) __WSAFDIsSet((SOCKET)(fd), (ws_fd_set32*)(set))
136 * Internet address (old style... should be updated)
139 struct ws_in_addr
141 union {
142 struct { BYTE s_b1,s_b2,s_b3,s_b4; } S_un_b;
143 struct { UINT16 s_w1,s_w2; } S_un_w;
144 UINT S_addr;
145 } S_un;
146 #define ws_addr S_un.S_addr /* can be used for most tcp & ip code */
147 #define ws_host S_un.S_un_b.s_b2 /* host on imp */
148 #define ws_net S_un.S_un_b.s_b1 /* network */
149 #define ws_imp S_un.S_un_w.s_w2 /* imp */
150 #define ws_impno S_un.S_un_b.s_b4 /* imp # */
151 #define ws_lh S_un.S_un_b.s_b3 /* logical host */
154 struct ws_sockaddr_in
156 INT16 sin_family;
157 UINT16 sin_port;
158 struct ws_in_addr sin_addr;
159 BYTE sin_zero[8];
162 #define WSADESCRIPTION_LEN 256
163 #define WSASYS_STATUS_LEN 128
165 typedef struct WSAData {
166 WORD wVersion;
167 WORD wHighVersion;
168 char szDescription[WSADESCRIPTION_LEN+1];
169 char szSystemStatus[WSASYS_STATUS_LEN+1];
170 UINT16 iMaxSockets;
171 UINT16 iMaxUdpDg;
172 SEGPTR lpVendorInfo;
173 } WSADATA, *LPWSADATA;
175 #include "poppack.h"
177 /* ----------------------------------- no Win16 structure defs beyond this line! */
180 * This is used instead of -1, since the
181 * SOCKET type is unsigned.
183 #define INVALID_SOCKET16 (~0)
184 #define INVALID_SOCKET (~0)
185 #define SOCKET_ERROR (-1)
189 * Types
191 #define WS_SOCK_STREAM 1 /* stream socket */
192 #define WS_SOCK_DGRAM 2 /* datagram socket */
193 #define WS_SOCK_RAW 3 /* raw-protocol interface */
194 #define WS_SOCK_RDM 4 /* reliably-delivered message */
195 #define WS_SOCK_SEQPACKET 5 /* sequenced packet stream */
197 #define WS_SOL_SOCKET 0xffff
198 #define WS_IPPROTO_TCP 6
201 * Option flags per-socket.
203 #define WS_SO_DEBUG 0x0001 /* turn on debugging info recording */
204 #define WS_SO_ACCEPTCONN 0x0002 /* socket has had listen() */
205 #define WS_SO_REUSEADDR 0x0004 /* allow local address reuse */
206 #define WS_SO_KEEPALIVE 0x0008 /* keep connections alive */
207 #define WS_SO_DONTROUTE 0x0010 /* just use interface addresses */
208 #define WS_SO_BROADCAST 0x0020 /* permit sending of broadcast msgs */
209 #define WS_SO_USELOOPBACK 0x0040 /* bypass hardware when possible */
210 #define WS_SO_LINGER 0x0080 /* linger on close if data present */
211 #define WS_SO_OOBINLINE 0x0100 /* leave received OOB data in line */
213 #define WS_SO_DONTLINGER (UINT)(~WS_SO_LINGER)
216 * Additional options.
218 #define WS_SO_SNDBUF 0x1001 /* send buffer size */
219 #define WS_SO_RCVBUF 0x1002 /* receive buffer size */
220 #define WS_SO_SNDLOWAT 0x1003 /* send low-water mark */
221 #define WS_SO_RCVLOWAT 0x1004 /* receive low-water mark */
222 #define WS_SO_SNDTIMEO 0x1005 /* send timeout */
223 #define WS_SO_RCVTIMEO 0x1006 /* receive timeout */
224 #define WS_SO_ERROR 0x1007 /* get error status and clear */
225 #define WS_SO_TYPE 0x1008 /* get socket type */
227 #define WS_IOCPARM_MASK 0x7f /* parameters must be < 128 bytes */
228 #define WS_IOC_VOID 0x20000000 /* no parameters */
229 #define WS_IOC_OUT 0x40000000 /* copy out parameters */
230 #define WS_IOC_IN 0x80000000 /* copy in parameters */
231 #define WS_IOC_INOUT (WS_IOC_IN|WS_IOC_OUT)
232 #define WS_IOR(x,y,t) (WS_IOC_OUT|(((UINT)sizeof(t)&WS_IOCPARM_MASK)<<16)|((x)<<8)|(y))
233 #define WS_IOW(x,y,t) (WS_IOC_IN|(((UINT)sizeof(t)&WS_IOCPARM_MASK)<<16)|((x)<<8)|(y))
235 /* IPPROTO_TCP options */
236 #define WS_TCP_NODELAY 1 /* do not apply nagle algorithm */
239 * Socket I/O flags (supported by spec 1.1)
242 #define WS_FIONREAD WS_IOR('f', 127, u_long)
243 #define WS_FIONBIO WS_IOW('f', 126, u_long)
245 #define WS_SIOCATMARK WS_IOR('s', 7, u_long)
248 * Maximum queue length specifiable by listen.
250 #ifdef SOMAXCONN
251 #undef SOMAXCONN
252 #endif
253 #define SOMAXCONN 5
255 #ifndef MSG_DONTROUTE
256 #define MSG_DONTROUTE 0x4 /* send without using routing tables */
257 #endif
258 #define MSG_MAXIOVLEN 16
261 * Define constant based on rfc883, used by gethostbyxxxx() calls.
263 #define MAXGETHOSTSTRUCT 1024
266 * Define flags to be used with the WSAAsyncSelect() call.
268 #define FD_READ WS_FD_READ
269 #define FD_WRITE WS_FD_WRITE
270 #define FD_OOB WS_FD_OOB
271 #define FD_ACCEPT WS_FD_ACCEPT
272 #define FD_CONNECT WS_FD_CONNECT
273 #define FD_CLOSE WS_FD_CLOSE
274 #define WS_FD_READ 0x0001
275 #define WS_FD_WRITE 0x0002
276 #define WS_FD_OOB 0x0004
277 #define WS_FD_ACCEPT 0x0008
278 #define WS_FD_CONNECT 0x0010
279 #define WS_FD_CLOSE 0x0020
281 #define WS_FD_LISTENING 0x10000000 /* internal per-socket flags */
282 #define WS_FD_NONBLOCKING 0x20000000
283 #define WS_FD_CONNECTED 0x40000000
284 #define WS_FD_RAW 0x80000000
285 #define WS_FD_SERVEVENT 0x01000000
286 #define WS_FD_INTERNAL 0xFFFF0000
289 * All Windows Sockets error constants are biased by WSABASEERR from
290 * the "normal"
292 #define WSABASEERR 10000
294 * Windows Sockets definitions of regular Microsoft C error constants
296 #define WSAEINTR (WSABASEERR+4)
297 #define WSAEBADF (WSABASEERR+9)
298 #define WSAEACCES (WSABASEERR+13)
299 #define WSAEFAULT (WSABASEERR+14)
300 #define WSAEINVAL (WSABASEERR+22)
301 #define WSAEMFILE (WSABASEERR+24)
304 * Windows Sockets definitions of regular Berkeley error constants
306 #define WSAEWOULDBLOCK (WSABASEERR+35)
307 #define WSAEINPROGRESS (WSABASEERR+36)
308 #define WSAEALREADY (WSABASEERR+37)
309 #define WSAENOTSOCK (WSABASEERR+38)
310 #define WSAEDESTADDRREQ (WSABASEERR+39)
311 #define WSAEMSGSIZE (WSABASEERR+40)
312 #define WSAEPROTOTYPE (WSABASEERR+41)
313 #define WSAENOPROTOOPT (WSABASEERR+42)
314 #define WSAEPROTONOSUPPORT (WSABASEERR+43)
315 #define WSAESOCKTNOSUPPORT (WSABASEERR+44)
316 #define WSAEOPNOTSUPP (WSABASEERR+45)
317 #define WSAEPFNOSUPPORT (WSABASEERR+46)
318 #define WSAEAFNOSUPPORT (WSABASEERR+47)
319 #define WSAEADDRINUSE (WSABASEERR+48)
320 #define WSAEADDRNOTAVAIL (WSABASEERR+49)
321 #define WSAENETDOWN (WSABASEERR+50)
322 #define WSAENETUNREACH (WSABASEERR+51)
323 #define WSAENETRESET (WSABASEERR+52)
324 #define WSAECONNABORTED (WSABASEERR+53)
325 #define WSAECONNRESET (WSABASEERR+54)
326 #define WSAENOBUFS (WSABASEERR+55)
327 #define WSAEISCONN (WSABASEERR+56)
328 #define WSAENOTCONN (WSABASEERR+57)
329 #define WSAESHUTDOWN (WSABASEERR+58)
330 #define WSAETOOMANYREFS (WSABASEERR+59)
331 #define WSAETIMEDOUT (WSABASEERR+60)
332 #define WSAECONNREFUSED (WSABASEERR+61)
333 #define WSAELOOP (WSABASEERR+62)
334 #define WSAENAMETOOLONG (WSABASEERR+63)
335 #define WSAEHOSTDOWN (WSABASEERR+64)
336 #define WSAEHOSTUNREACH (WSABASEERR+65)
337 #define WSAENOTEMPTY (WSABASEERR+66)
338 #define WSAEPROCLIM (WSABASEERR+67)
339 #define WSAEUSERS (WSABASEERR+68)
340 #define WSAEDQUOT (WSABASEERR+69)
341 #define WSAESTALE (WSABASEERR+70)
342 #define WSAEREMOTE (WSABASEERR+71)
345 * Extended Windows Sockets error constant definitions
347 #define WSASYSNOTREADY (WSABASEERR+91)
348 #define WSAVERNOTSUPPORTED (WSABASEERR+92)
349 #define WSANOTINITIALISED (WSABASEERR+93)
352 * Error return codes from gethostbyname() and gethostbyaddr()
353 * (when using the resolver). Note that these errors are
354 * retrieved via WSAGetLastError() and must therefore follow
355 * the rules for avoiding clashes with error numbers from
356 * specific implementations or language run-time systems.
357 * For this reason the codes are based at WSABASEERR+1001.
358 * Note also that [WSA]NO_ADDRESS is defined only for
359 * compatibility purposes.
362 /* #define h_errno WSAGetLastError() */
364 /* Authoritative Answer: Host not found */
365 #define WSAHOST_NOT_FOUND (WSABASEERR+1001)
367 /* Non-Authoritative: Host not found, or SERVERFAIL */
368 #define WSATRY_AGAIN (WSABASEERR+1002)
370 /* Non recoverable errors, FORMERR, REFUSED, NOTIMP */
371 #define WSANO_RECOVERY (WSABASEERR+1003)
373 /* Valid name, no data record of requested type */
374 #define WSANO_DATA (WSABASEERR+1004)
376 /* no address, look for MX record */
377 #define WSANO_ADDRESS WSANO_DATA
379 /* Socket function prototypes */
381 #ifdef __cplusplus
382 extern "C" {
383 #endif
385 /* Microsoft Windows Extension function prototypes */
387 INT16 WINAPI WSAStartup16(UINT16 wVersionRequired, LPWSADATA lpWSAData);
388 INT WINAPI WSAStartup(UINT wVersionRequired, LPWSADATA lpWSAData);
389 void WINAPI WSASetLastError16(INT16 iError);
390 void WINAPI WSASetLastError(INT iError);
391 INT WINAPI WSACleanup(void);
392 INT WINAPI WSAGetLastError(void);
393 BOOL WINAPI WSAIsBlocking(void);
394 INT WINAPI WSACancelBlockingCall(void);
395 INT16 WINAPI WSAUnhookBlockingHook16(void);
396 INT WINAPI WSAUnhookBlockingHook(void);
397 FARPROC16 WINAPI WSASetBlockingHook16(FARPROC16 lpBlockFunc);
398 FARPROC WINAPI WSASetBlockingHook(FARPROC lpBlockFunc);
400 HANDLE16 WINAPI WSAAsyncGetServByName16(HWND16 hWnd, UINT16 wMsg, LPCSTR name, LPCSTR proto,
401 SEGPTR buf, INT16 buflen);
402 HANDLE WINAPI WSAAsyncGetServByName(HWND hWnd, UINT uMsg, LPCSTR name, LPCSTR proto,
403 LPSTR sbuf, INT buflen);
405 HANDLE16 WINAPI WSAAsyncGetServByPort16(HWND16 hWnd, UINT16 wMsg, INT16 port,
406 LPCSTR proto, SEGPTR buf, INT16 buflen);
407 HANDLE WINAPI WSAAsyncGetServByPort(HWND hWnd, UINT uMsg, INT port,
408 LPCSTR proto, LPSTR sbuf, INT buflen);
410 HANDLE16 WINAPI WSAAsyncGetProtoByName16(HWND16 hWnd, UINT16 wMsg,
411 LPCSTR name, SEGPTR buf, INT16 buflen);
412 HANDLE WINAPI WSAAsyncGetProtoByName(HWND hWnd, UINT uMsg,
413 LPCSTR name, LPSTR sbuf, INT buflen);
415 HANDLE16 WINAPI WSAAsyncGetProtoByNumber16(HWND16 hWnd, UINT16 wMsg,
416 INT16 number, SEGPTR buf, INT16 buflen);
417 HANDLE WINAPI WSAAsyncGetProtoByNumber(HWND hWnd, UINT uMsg,
418 INT number, LPSTR sbuf, INT buflen);
420 HANDLE16 WINAPI WSAAsyncGetHostByName16(HWND16 hWnd, UINT16 wMsg,
421 LPCSTR name, SEGPTR buf, INT16 buflen);
422 HANDLE WINAPI WSAAsyncGetHostByName(HWND hWnd, UINT uMsg,
423 LPCSTR name, LPSTR sbuf, INT buflen);
425 HANDLE16 WINAPI WSAAsyncGetHostByAddr16(HWND16 hWnd, UINT16 wMsg, LPCSTR addr,
426 INT16 len, INT16 type, SEGPTR buf, INT16 buflen);
427 HANDLE WINAPI WSAAsyncGetHostByAddr(HWND hWnd, UINT uMsg, LPCSTR addr,
428 INT len, INT type, LPSTR sbuf, INT buflen);
430 INT16 WINAPI WSACancelAsyncRequest16(HANDLE16 hAsyncTaskHandle);
431 INT WINAPI WSACancelAsyncRequest(HANDLE hAsyncTaskHandle);
433 INT16 WINAPI WSAAsyncSelect16(SOCKET16 s, HWND16 hWnd, UINT16 wMsg, LONG lEvent);
434 INT WINAPI WSAAsyncSelect(SOCKET s, HWND hWnd, UINT uMsg, LONG lEvent);
438 * Address families
440 #define WS_AF_UNSPEC 0 /* unspecified */
441 #define WS_AF_UNIX 1 /* local to host (pipes, portals) */
442 #define WS_AF_INET 2 /* internetwork: UDP, TCP, etc. */
443 #define WS_AF_IMPLINK 3 /* arpanet imp addresses */
444 #define WS_AF_PUP 4 /* pup protocols: e.g. BSP */
445 #define WS_AF_CHAOS 5 /* mit CHAOS protocols */
446 #define WS_AF_NS 6 /* XEROX NS protocols */
447 #define WS_AF_IPX WS_AF_NS /* IPX protocols: IPX, SPX, etc. */
448 #define WS_AF_ISO 7 /* ISO protocols */
449 #define WS_AF_OSI AF_ISO /* OSI is ISO */
450 #define WS_AF_ECMA 8 /* european computer manufacturers */
451 #define WS_AF_DATAKIT 9 /* datakit protocols */
452 #define WS_AF_CCITT 10 /* CCITT protocols, X.25 etc */
453 #define WS_AF_SNA 11 /* IBM SNA */
454 #define WS_AF_DECnet 12 /* DECnet */
455 #define WS_AF_DLI 13 /* Direct data link interface */
456 #define WS_AF_LAT 14 /* LAT */
457 #define WS_AF_HYLINK 15 /* NSC Hyperchannel */
458 #define WS_AF_APPLETALK 16 /* AppleTalk */
459 #define WS_AF_NETBIOS 17 /* NetBios-style addresses */
460 #define WS_AF_VOICEVIEW 18 /* VoiceView */
461 #define WS_AF_FIREFOX 19 /* Protocols from Firefox */
462 #define WS_AF_UNKNOWN1 20 /* Somebody is using this! */
463 #define WS_AF_BAN 21 /* Banyan */
464 #define WS_AF_ATM 22 /* Native ATM Services */
465 #define WS_AF_INET6 23 /* Internetwork Version 6 */
466 #define WS_AF_CLUSTER 24 /* Microsoft Wolfpack */
467 #define WS_AF_12844 25 /* IEEE 1284.4 WG AF */
468 #define WS_AF_IRDA 26 /* IrDA */
470 #define WS_AF_MAX 27
472 #include "pshpack1.h"
474 struct ws_sockaddr_ipx
476 INT16 sipx_family;
477 UINT sipx_network;
478 CHAR sipx_node[6];
479 UINT16 sipx_port;
482 #include "poppack.h"
484 #ifdef __cplusplus
486 #endif
488 /* Microsoft Windows Extended data types */
489 typedef struct sockaddr SOCKADDR, *PSOCKADDR, *LPSOCKADDR;
490 typedef struct sockaddr_in SOCKADDR_IN, *PSOCKADDR_IN, *LPSOCKADDR_IN;
491 typedef struct linger LINGER, *PLINGER, *LPLINGER;
492 typedef struct in_addr IN_ADDR, *PIN_ADDR, *LPIN_ADDR;
493 typedef struct fd_set FD_SET, *PFD_SET, *LPFD_SET;
494 typedef struct hostent HOSTENT, *PHOSTENT, *LPHOSTENT;
495 typedef struct servent SERVENT, *PSERVENT, *LPSERVENT;
496 typedef struct protoent PROTOENT, *PPROTOENT, *LPPROTOENT;
497 typedef struct timeval TIMEVAL, *PTIMEVAL, *LPTIMEVAL;
500 * Windows message parameter composition and decomposition
501 * macros.
503 * WSAMAKEASYNCREPLY is intended for use by the Windows Sockets implementation
504 * when constructing the response to a WSAAsyncGetXByY() routine.
506 #define WSAMAKEASYNCREPLY(buflen,error) MAKELONG(buflen,error)
508 * WSAMAKESELECTREPLY is intended for use by the Windows Sockets implementation
509 * when constructing the response to WSAAsyncSelect().
511 #define WSAMAKESELECTREPLY(event,error) MAKELONG(event,error)
513 * WSAGETASYNCBUFLEN is intended for use by the Windows Sockets application
514 * to extract the buffer length from the lParam in the response
515 * to a WSAGetXByY().
517 #define WSAGETASYNCBUFLEN(lParam) LOWORD(lParam)
519 * WSAGETASYNCERROR is intended for use by the Windows Sockets application
520 * to extract the error code from the lParam in the response
521 * to a WSAGetXByY().
523 #define WSAGETASYNCERROR(lParam) HIWORD(lParam)
525 * WSAGETSELECTEVENT is intended for use by the Windows Sockets application
526 * to extract the event code from the lParam in the response
527 * to a WSAAsyncSelect().
529 #define WSAGETSELECTEVENT(lParam) LOWORD(lParam)
531 * WSAGETSELECTERROR is intended for use by the Windows Sockets application
532 * to extract the error code from the lParam in the response
533 * to a WSAAsyncSelect().
535 #define WSAGETSELECTERROR(lParam) HIWORD(lParam)
537 #ifdef __cplusplus
538 } /* extern "C" */
539 #endif /* defined(__cplusplus) */
541 #endif /* _WINSOCKAPI_ */