include/winsock.h

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