include/ws2spi.h

   1 /**
   2  * @file ws2spi.h
   3  * @copy 2012 MinGW.org project
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice (including the next
  13  * paragraph) shall be included in all copies or substantial portions of the
  14  * Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  22  * DEALINGS IN THE SOFTWARE.
  23  */
  24 #ifndef _WS2SPI_H
  25 #define _WS2SPI_H
  26 #pragma GCC system_header
  27
  28 #include <winsock2.h>
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif /* __cplusplus */
  33
  34 #define WSPAPI WSAAPI
  35 #define WSPDESCRIPTION_LEN 255
  36
  37 #ifndef RC_INVOKED
  38
  39 typedef struct WSPData {
  40         WORD wVersion;
  41         WORD wHighVersion;
  42         WCHAR szDescription[WSPDESCRIPTION_LEN+1];
  43 } WSPDATA, FAR *LPWSPDATA;
  44 typedef struct _WSATHREADID {
  45         HANDLE ThreadHandle;
  46         DWORD Reserved;
  47 } WSATHREADID, FAR *LPWSATHREADID;
  48
  49 typedef BOOL (CALLBACK FAR *LPBLOCKINGCALLBACK)(DWORD);
  50 typedef VOID (CALLBACK FAR *LPWSAUSERAPC)(DWORD);
  51
  52 /* Prototypes for service provider procedure table */
  53 typedef SOCKET (WSPAPI *LPWSPACCEPT)(SOCKET,LPSOCKADDR,LPINT,LPCONDITIONPROC,DWORD,LPINT);
  54 typedef INT (WSPAPI *LPWSPADDRESSTOSTRING)(LPSOCKADDR,DWORD,LPWSAPROTOCOL_INFOW,LPWSTR,LPDWORD,LPINT);
  55 typedef INT (WSPAPI *LPWSPASYNCSELECT)(SOCKET,HWND,UINT,LONG,LPINT);
  56 typedef INT (WSPAPI *LPWSPBIND)(SOCKET,const struct sockaddr*,INT,LPINT);
  57 typedef INT (WSPAPI *LPWSPCANCELBLOCKINGCALL)(LPINT);
  58 typedef INT (WSPAPI *LPWSPCLEANUP)(LPINT);
  59 typedef INT (WSPAPI *LPWSPCLOSESOCKET)(SOCKET,LPINT);
  60 typedef INT (WSPAPI *LPWSPCONNECT)(SOCKET,const struct sockaddr*,INT,LPWSABUF,LPWSABUF,LPQOS,LPQOS,LPINT);
  61 typedef INT (WSPAPI *LPWSPDUPLICATESOCKET)(SOCKET,DWORD,LPWSAPROTOCOL_INFOW,LPINT);
  62 typedef INT (WSPAPI *LPWSPENUMNETWORKEVENTS)(SOCKET,WSAEVENT,LPWSANETWORKEVENTS,LPINT);
  63 typedef INT (WSPAPI *LPWSPEVENTSELECT)(SOCKET,WSAEVENT,LONG,LPINT);
  64 typedef BOOL (WSPAPI *LPWSPGETOVERLAPPEDRESULT)(SOCKET,LPWSAOVERLAPPED,LPDWORD,BOOL,LPDWORD,LPINT);
  65 typedef INT (WSPAPI *LPWSPGETPEERNAME)(SOCKET,LPSOCKADDR,LPINT,LPINT);
  66 typedef BOOL (WSPAPI *LPWSPGETQOSBYNAME)(SOCKET,LPWSABUF,LPQOS,LPINT);
  67 typedef INT (WSPAPI *LPWSPGETSOCKNAME)(SOCKET,LPSOCKADDR,LPINT,LPINT);
  68 typedef INT (WSPAPI *LPWSPGETSOCKOPT)(SOCKET,INT,INT,CHAR FAR*,LPINT,LPINT);
  69 typedef INT (WSPAPI *LPWSPIOCTL)(SOCKET,DWORD,LPVOID,DWORD,LPVOID,DWORD,LPDWORD,
  70              LPWSAOVERLAPPED,LPWSAOVERLAPPED_COMPLETION_ROUTINE,LPWSATHREADID,LPINT);
  71 typedef SOCKET (WSPAPI *LPWSPJOINLEAF)(SOCKET,const struct sockaddr*,INT,LPWSABUF,LPWSABUF,LPQOS,LPQOS,DWORD,LPINT);
  72 typedef INT (WSPAPI *LPWSPLISTEN)(SOCKET,INT,LPINT);
  73 typedef INT (WSPAPI *LPWSPRECV)(SOCKET,LPWSABUF,DWORD,LPDWORD,LPDWORD,
  74 LPWSAOVERLAPPED,LPWSAOVERLAPPED_COMPLETION_ROUTINE,LPWSATHREADID,LPINT);
  75 typedef INT (WSPAPI *LPWSPRECVDISCONNECT)(SOCKET,LPWSABUF,LPINT);
  76 typedef INT (WSPAPI *LPWSPRECVFROM)(SOCKET,LPWSABUF,DWORD,LPDWORD,LPDWORD,LPSOCKADDR,
  77 LPINT,LPWSAOVERLAPPED,LPWSAOVERLAPPED_COMPLETION_ROUTINE,LPWSATHREADID,LPINT);
  78 typedef INT (WSPAPI *LPWSPSELECT)(INT,LPFD_SET,LPFD_SET,LPFD_SET,CONST TIMEVAL*,LPINT);
  79 typedef INT (WSPAPI *LPWSPSEND)(SOCKET,LPWSABUF,DWORD,LPDWORD,DWORD,
  80 LPWSAOVERLAPPED,LPWSAOVERLAPPED_COMPLETION_ROUTINE,LPWSATHREADID,LPINT);
  81 typedef INT (WSPAPI *LPWSPSENDDISCONNECT)(SOCKET,LPWSABUF,LPINT);
  82 typedef INT (WSPAPI *LPWSPSENDTO)(SOCKET,LPWSABUF,DWORD,LPDWORD,DWORD,const struct sockaddr*,
  83              INT,LPWSAOVERLAPPED,LPWSAOVERLAPPED_COMPLETION_ROUTINE,LPWSATHREADID,LPINT);
  84 typedef INT (WSPAPI *LPWSPSETSOCKOPT)(SOCKET,INT,INT,CONST CHAR FAR*,INT,LPINT);
  85 typedef INT (WSPAPI *LPWSPSHUTDOWN)(SOCKET,INT,LPINT);
  86 typedef SOCKET (WSPAPI *LPWSPSOCKET)(INT,INT,INT,LPWSAPROTOCOL_INFOW,GROUP,DWORD,LPINT);
  87 typedef INT (WSPAPI *LPWSPSTRINGTOADDRESS)(LPWSTR,INT,LPWSAPROTOCOL_INFOW,LPSOCKADDR,LPINT,LPINT);
  88
  89 /* Service provider procedure table */
  90 typedef struct _WSPPROC_TABLE {
  91   LPWSPACCEPT lpWSPAccept;
  92   LPWSPADDRESSTOSTRING lpWSPAddressToString;
  93   LPWSPASYNCSELECT lpWSPAsyncSelect;
  94   LPWSPBIND lpWSPBind;
  95   LPWSPCANCELBLOCKINGCALL lpWSPCancelBlockingCall;
  96   LPWSPCLEANUP lpWSPCleanup;
  97   LPWSPCLOSESOCKET lpWSPCloseSocket;
  98   LPWSPCONNECT lpWSPConnect;
  99   LPWSPDUPLICATESOCKET lpWSPDuplicateSocket;
 100   LPWSPENUMNETWORKEVENTS lpWSPEnumNetworkEvents;
 101   LPWSPEVENTSELECT lpWSPEventSelect;
 102   LPWSPGETOVERLAPPEDRESULT lpWSPGetOverlappedResult;
 103   LPWSPGETPEERNAME lpWSPGetPeerName;
 104   LPWSPGETSOCKNAME lpWSPGetSockName;
 105   LPWSPGETSOCKOPT lpWSPGetSockOpt;
 106   LPWSPGETQOSBYNAME lpWSPGetQOSByName;
 107   LPWSPIOCTL lpWSPIoctl;
 108   LPWSPJOINLEAF lpWSPJoinLeaf;
 109   LPWSPLISTEN lpWSPListen;
 110   LPWSPRECV lpWSPRecv;
 111   LPWSPRECVDISCONNECT lpWSPRecvDisconnect;
 112   LPWSPRECVFROM lpWSPRecvFrom;
 113   LPWSPSELECT lpWSPSelect;
 114   LPWSPSEND lpWSPSend;
 115   LPWSPSENDDISCONNECT lpWSPSendDisconnect;
 116   LPWSPSENDTO lpWSPSendTo;
 117   LPWSPSETSOCKOPT lpWSPSetSockOpt;
 118   LPWSPSHUTDOWN lpWSPShutdown;
 119   LPWSPSOCKET lpWSPSocket;
 120   LPWSPSTRINGTOADDRESS lpWSPStringToAddress;
 121 } WSPPROC_TABLE, FAR* LPWSPPROC_TABLE;
 122
 123 /* Prototypes for service provider upcall procedure table */
 124 typedef BOOL (WSPAPI *LPWPUCLOSEEVENT)(WSAEVENT,LPINT);
 125 typedef INT (WSPAPI *LPWPUCLOSESOCKETHANDLE)(SOCKET,LPINT);
 126 typedef INT (WSPAPI *LPWPUCLOSETHREAD)(LPWSATHREADID,LPINT);
 127 typedef WSAEVENT (WSPAPI *LPWPUCREATEEVENT)(LPINT);
 128 typedef SOCKET (WSPAPI *LPWPUCREATESOCKETHANDLE)(DWORD,DWORD,LPINT);
 129 typedef SOCKET (WSPAPI *LPWPUFDISSET)(SOCKET,LPFD_SET);
 130 typedef INT (WSPAPI *LPWPUGETPROVIDERPATH)(LPGUID,LPWSTR,LPINT,LPINT);
 131 typedef SOCKET (WSPAPI *LPWPUMODIFYIFSHANDLE)(DWORD,SOCKET,LPINT);
 132 typedef INT (WSPAPI *LPWPUOPENCURRENTTHREAD)(LPWSATHREADID,LPINT);
 133 typedef BOOL (WSPAPI *LPWPUPOSTMESSAGE)(HWND,UINT,WPARAM,LPARAM);
 134 typedef INT (WSPAPI *LPWPUQUERYBLOCKINGCALLBACK)(DWORD,LPBLOCKINGCALLBACK FAR*,LPDWORD,LPINT);
 135 typedef INT (WSPAPI *LPWPUQUERYSOCKETHANDLECONTEXT)(SOCKET,LPDWORD,LPINT);
 136 typedef INT (WSPAPI *LPWPUQUEUEAPC)(LPWSATHREADID,LPWSAUSERAPC,DWORD,LPINT);
 137 typedef BOOL (WSPAPI *LPWPURESETEVENT)(WSAEVENT,LPINT);
 138 typedef BOOL (WSPAPI *LPWPUSETEVENT)(WSAEVENT,LPINT);
 139 /* Available only directly from the DLL */
 140 typedef INT (WSPAPI *LPWPUCOMPLETEOVERLAPPEDREQUEST)(SOCKET,LPWSAOVERLAPPED,DWORD,DWORD,LPINT);
 141
 142 /* Service Provider upcall table */
 143 typedef struct _WSPUPCALLTABLE {
 144         LPWPUCLOSEEVENT lpWPUCloseEvent;
 145         LPWPUCLOSESOCKETHANDLE lpWPUCloseSocketHandle;
 146         LPWPUCREATEEVENT lpWPUCreateEvent;
 147         LPWPUCREATESOCKETHANDLE lpWPUCreateSocketHandle;
 148         LPWPUFDISSET lpWPUFDIsSet;
 149         LPWPUGETPROVIDERPATH lpWPUGetProviderPath;
 150         LPWPUMODIFYIFSHANDLE lpWPUModifyIFSHandle;
 151         LPWPUPOSTMESSAGE lpWPUPostMessage;
 152         LPWPUQUERYBLOCKINGCALLBACK lpWPUQueryBlockingCallback;
 153         LPWPUQUERYSOCKETHANDLECONTEXT lpWPUQuerySocketHandleContext;
 154         LPWPUQUEUEAPC lpWPUQueueApc;
 155         LPWPURESETEVENT lpWPUResetEvent;
 156         LPWPUSETEVENT lpWPUSetEvent;
 157         LPWPUOPENCURRENTTHREAD lpWPUOpenCurrentThread;
 158         LPWPUCLOSETHREAD lpWPUCloseThread;
 159 } WSPUPCALLTABLE, FAR* LPWSPUPCALLTABLE;
 160
 161 typedef INT (WSPAPI *LPWSPSTARTUP)(WORD,LPWSPDATA,LPWSAPROTOCOL_INFOW,WSPUPCALLTABLE,LPWSPPROC_TABLE);
 162
 163 /* Prototypes for service provider namespace procedure table */
 164 typedef INT (WSPAPI *LPNSPCLEANUP)(LPGUID);
 165 typedef INT (WSPAPI *LPNSPGETSERVICECLASSINFO)(LPGUID,LPDWORD,LPWSASERVICECLASSINFOW);
 166 typedef INT (WSPAPI *LPNSPINSTALLSERVICECLASS)(LPGUID,LPWSASERVICECLASSINFOW);
 167 typedef INT (WSPAPI *LPNSPLOOKUPSERVICEBEGIN)(LPGUID,LPWSAQUERYSETW,LPWSASERVICECLASSINFOW,DWORD,LPHANDLE);
 168 typedef INT (WSPAPI *LPNSPLOOKUPSERVICEEND)(HANDLE);
 169 typedef INT (WSPAPI *LPNSPLOOKUPSERVICENEXT)(HANDLE,DWORD,LPDWORD,LPWSAQUERYSET);
 170 typedef INT (WSPAPI *LPNSPREMOVESERVICECLASS)(LPGUID,LPGUID);
 171 typedef INT (WSPAPI *LPNSPSETSERVICE)(LPGUID,LPWSASERVICECLASSINFOW,LPWSAQUERYSETW,WSAESETSERVICEOP,DWORD);
 172
 173 typedef struct _NSP_ROUTINE {
 174   DWORD cbSize;
 175   DWORD dwMajorVersion;
 176   DWORD dwMinorVersion;
 177   LPNSPCLEANUP NSPCleanup;
 178   LPNSPLOOKUPSERVICEBEGIN NSPLookupServiceBegin;
 179   LPNSPLOOKUPSERVICENEXT NSPLookupServiceNext;
 180   LPNSPLOOKUPSERVICEEND NSPLookupServiceEnd;
 181   LPNSPSETSERVICE NSPSetService;
 182   LPNSPINSTALLSERVICECLASS NSPInstallServiceClass;
 183   LPNSPREMOVESERVICECLASS NSPRemoveServiceClass;
 184   LPNSPGETSERVICECLASSINFO NSPGetServiceClassInfo;
 185 } NSP_ROUTINE, *PNSP_ROUTINE, *LPNSP_ROUTINE;
 186
 187 INT WSPAPI NSPStartup(LPGUID,LPNSP_ROUTINE);
 188
 189 /* WinSock 2 DLL function prototypes */
 190 INT WSPAPI WPUCompleteOverlappedRequest(SOCKET,LPWSAOVERLAPPED,DWORD,DWORD,LPINT);
 191 INT WSPAPI WSPStartup(WORD,LPWSPDATA,LPWSAPROTOCOL_INFOW,WSPUPCALLTABLE,LPWSPPROC_TABLE);
 192 INT WSPAPI WSCDeinstallProvider(LPGUID,LPINT);
 193 INT WSPAPI WSCEnumProtocols(LPINT,LPWSAPROTOCOL_INFOW,LPDWORD,LPINT);
 194 INT WSPAPI WSCGetProviderPath(LPGUID,LPWSTR,LPINT,LPINT);
 195 INT WSPAPI WSCInstallProvider(CONST LPGUID,CONST LPWSTR,CONST LPWSAPROTOCOL_INFOW,DWORD,LPINT);
 196 INT WSPAPI WSCEnableNSProvider(LPGUID,BOOL);
 197 INT WSPAPI WSCInstallNameSpace(LPWSTR,LPWSTR,DWORD,DWORD,LPGUID);
 198 INT WSPAPI WSCUnInstallNameSpace(LPGUID);
 199 INT WSPAPI WSCWriteProviderOrder(LPDWORD,DWORD);
 200
 201 #endif /* RC_INVOKED */
 202
 203 #ifdef __cplusplus
 204 }
 205 #endif /* __cplusplus */
 206 #endif