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