* Annotate ws2san.h.

svn path=/trunk/; revision=59623
This commit is contained in:
Amine Khaldi 2013-08-03 13:08:00 +00:00
parent 1d5b84ea4c
commit c3dde44d13

View file

@ -22,6 +22,7 @@
#pragma once #pragma once
#ifndef _WS2SAN_H_
#define _WS2SAN_H_ #define _WS2SAN_H_
#ifdef __cplusplus #ifdef __cplusplus
@ -79,172 +80,186 @@ typedef struct _WSPUPCALLTABLEEX {
typedef struct _WSABUFEX { typedef struct _WSABUFEX {
u_long len; u_long len;
char FAR *buf; _Field_size_bytes_(len) char FAR *buf;
HANDLE handle; HANDLE handle;
} WSABUFEX, FAR * LPWSABUFEX; } WSABUFEX, FAR * LPWSABUFEX;
typedef int typedef
_Must_inspect_result_
int
(WSPAPI *LPWSPSTARTUPEX)( (WSPAPI *LPWSPSTARTUPEX)(
IN WORD wVersionRequested, _In_ WORD wVersionRequested,
OUT LPWSPDATA lpWSPData, _Out_ LPWSPDATA lpWSPData,
IN LPWSAPROTOCOL_INFOW lpProtocolInfo, _In_ LPWSAPROTOCOL_INFOW lpProtocolInfo,
IN LPWSPUPCALLTABLEEX lpUpcallTable, _In_ LPWSPUPCALLTABLEEX lpUpcallTable,
OUT LPWSPPROC_TABLE lpProcTable); _Out_ LPWSPPROC_TABLE lpProcTable);
typedef HANDLE typedef
_Must_inspect_result_
HANDLE
(WSPAPI *LPFN_WSPREGISTERMEMORY)( (WSPAPI *LPFN_WSPREGISTERMEMORY)(
IN SOCKET s, _In_ SOCKET s,
IN PVOID lpBuffer, _In_reads_bytes_(dwBufferLength) PVOID lpBuffer,
IN DWORD dwBufferLength, _In_ DWORD dwBufferLength,
IN DWORD dwFlags, _In_ DWORD dwFlags,
OUT LPINT lpErrno); _Out_ LPINT lpErrno);
typedef int typedef int
(WSPAPI *LPFN_WSPDEREGISTERMEMORY)( (WSPAPI *LPFN_WSPDEREGISTERMEMORY)(
IN SOCKET s, _In_ SOCKET s,
IN HANDLE Handle, _In_ HANDLE Handle,
OUT LPINT lpErrno); _Out_ LPINT lpErrno);
typedef int typedef
_Must_inspect_result_
int
(WSPAPI *LPFN_WSPREGISTERRDMAMEMORY)( (WSPAPI *LPFN_WSPREGISTERRDMAMEMORY)(
IN SOCKET s, _In_ SOCKET s,
IN PVOID lpBuffer, _In_reads_bytes_(dwBufferLength) PVOID lpBuffer,
IN DWORD dwBufferLength, _In_ DWORD dwBufferLength,
IN DWORD dwFlags, _In_ DWORD dwFlags,
OUT LPVOID lpRdmaBufferDescriptor, _Out_writes_bytes_(*lpdwDescriptorLength) LPVOID lpRdmaBufferDescriptor,
IN OUT LPDWORD lpdwDescriptorLength, _Inout_ LPDWORD lpdwDescriptorLength,
OUT LPINT lpErrno); _Out_ LPINT lpErrno);
typedef int typedef int
(WSPAPI *LPFN_WSPDEREGISTERRDMAMEMORY)( (WSPAPI *LPFN_WSPDEREGISTERRDMAMEMORY)(
IN SOCKET s, _In_ SOCKET s,
IN LPVOID lpRdmaBufferDescriptor, _In_reads_bytes_(dwDescriptorLength) LPVOID lpRdmaBufferDescriptor,
IN DWORD dwDescriptorLength, _In_ DWORD dwDescriptorLength,
OUT LPINT lpErrno); _Out_ LPINT lpErrno);
typedef int typedef int
(WSPAPI *LPFN_WSPRDMAWRITE)( (WSPAPI *LPFN_WSPRDMAWRITE)(
IN SOCKET s, _In_ SOCKET s,
IN LPWSABUFEX lpBuffers, _In_reads_(dwBufferCount) LPWSABUFEX lpBuffers,
IN DWORD dwBufferCount, _In_ DWORD dwBufferCount,
IN LPVOID lpTargetBufferDescriptor, _In_reads_bytes_(dwTargetDescriptorLength) LPVOID lpTargetBufferDescriptor,
IN DWORD dwTargetDescriptorLength, _In_ DWORD dwTargetDescriptorLength,
IN DWORD dwTargetBufferOffset, _In_ DWORD dwTargetBufferOffset,
OUT LPDWORD lpdwNumberOfBytesWritten, _Out_ LPDWORD lpdwNumberOfBytesWritten,
IN DWORD dwFlags, _In_ DWORD dwFlags,
IN LPWSAOVERLAPPED lpOverlapped OPTIONAL, _In_opt_ LPWSAOVERLAPPED lpOverlapped,
IN LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine OPTIONAL, _In_opt_ LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine,
IN LPWSATHREADID lpThreadId, _In_ LPWSATHREADID lpThreadId,
OUT LPINT lpErrno); _Out_ LPINT lpErrno);
typedef int typedef int
(WSPAPI *LPFN_WSPRDMAREAD)( (WSPAPI *LPFN_WSPRDMAREAD)(
IN SOCKET s, _In_ SOCKET s,
IN LPWSABUFEX lpBuffers, _In_reads_(dwBufferCount) LPWSABUFEX lpBuffers,
IN DWORD dwBufferCount, _In_ DWORD dwBufferCount,
IN LPVOID lpTargetBufferDescriptor, _In_reads_bytes_(dwTargetDescriptorLength) LPVOID lpTargetBufferDescriptor,
IN DWORD dwTargetDescriptorLength, _In_ DWORD dwTargetDescriptorLength,
IN DWORD dwTargetBufferOffset, _In_ DWORD dwTargetBufferOffset,
OUT LPDWORD lpdwNumberOfBytesRead, _Out_ LPDWORD lpdwNumberOfBytesRead,
IN DWORD dwFlags, _In_ DWORD dwFlags,
IN LPWSAOVERLAPPED lpOverlapped OPTIONAL, _In_opt_ LPWSAOVERLAPPED lpOverlapped,
IN LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine OPTIONAL, _In_opt_ LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine,
IN LPWSATHREADID lpThreadId, _In_ LPWSATHREADID lpThreadId,
OUT LPINT lpErrno); _Out_ LPINT lpErrno);
#if(_WIN32_WINNT >= 0x0501) #if(_WIN32_WINNT >= 0x0501)
typedef int typedef
_Must_inspect_result_
int
(WSPAPI *LPFN_WSPMEMORYREGISTRATIONCACHECALLBACK)( (WSPAPI *LPFN_WSPMEMORYREGISTRATIONCACHECALLBACK)(
IN PVOID lpvAddress, _In_reads_bytes_(Size) PVOID lpvAddress,
IN SIZE_T Size, _In_ SIZE_T Size,
OUT LPINT lpErrno); _Out_ LPINT lpErrno);
#endif #endif
_Must_inspect_result_
int int
WSPAPI WSPAPI
WSPStartupEx( WSPStartupEx(
IN WORD wVersionRequested, _In_ WORD wVersionRequested,
OUT LPWSPDATA lpWSPData, _Out_ LPWSPDATA lpWSPData,
IN LPWSAPROTOCOL_INFOW lpProtocolInfo, _In_ LPWSAPROTOCOL_INFOW lpProtocolInfo,
IN LPWSPUPCALLTABLEEX lpUpcallTable, _In_ LPWSPUPCALLTABLEEX lpUpcallTable,
OUT LPWSPPROC_TABLE lpProcTable); _Out_ LPWSPPROC_TABLE lpProcTable);
_Must_inspect_result_
HANDLE HANDLE
WSPAPI WSPAPI
WSPRegisterMemory( WSPRegisterMemory(
IN SOCKET s, _In_ SOCKET s,
IN PVOID lpBuffer, _In_reads_bytes_(dwBufferLength) PVOID lpBuffer,
IN DWORD dwBufferLength, _In_ DWORD dwBufferLength,
IN DWORD dwFlags, _In_ DWORD dwFlags,
OUT LPINT lpErrno); _Out_ LPINT lpErrno);
int int
WSPAPI WSPAPI
WSPDeregisterMemory( WSPDeregisterMemory(
IN SOCKET s, _In_ SOCKET s,
IN HANDLE Handle, _In_ HANDLE Handle,
OUT LPINT lpErrno); _Out_ LPINT lpErrno);
_Must_inspect_result_
int int
WSPAPI WSPAPI
WSPRegisterRdmaMemory( WSPRegisterRdmaMemory(
IN SOCKET s, _In_ SOCKET s,
IN PVOID lpBuffer, _In_reads_bytes_(dwBufferLength) PVOID lpBuffer,
IN DWORD dwBufferLength, _In_ DWORD dwBufferLength,
IN DWORD dwFlags, _In_ DWORD dwFlags,
OUT LPVOID lpRdmaBufferDescriptor, _Out_writes_bytes_(*lpdwDescriptorLength) LPVOID lpRdmaBufferDescriptor,
IN OUT LPDWORD lpdwDescriptorLength, _Inout_ LPDWORD lpdwDescriptorLength,
OUT LPINT lpErrno); _Out_ LPINT lpErrno);
int int
WSPAPI WSPAPI
WSPDeregisterRdmaMemory( WSPDeregisterRdmaMemory(
IN SOCKET s, _In_ SOCKET s,
IN LPVOID lpRdmaBufferDescriptor, _In_reads_bytes_(dwDescriptorLength) LPVOID lpRdmaBufferDescriptor,
IN DWORD dwDescriptorLength, _In_ DWORD dwDescriptorLength,
OUT LPINT lpErrno); _Out_ LPINT lpErrno);
int int
WSPAPI WSPAPI
WSPRdmaWrite( WSPRdmaWrite(
IN SOCKET s, _In_ SOCKET s,
IN LPWSABUFEX lpBuffers, _In_reads_(dwBufferCount) LPWSABUFEX lpBuffers,
IN DWORD dwBufferCount, _In_ DWORD dwBufferCount,
IN LPVOID lpTargetBufferDescriptor, _In_reads_bytes_(dwTargetDescriptorLength) LPVOID lpTargetBufferDescriptor,
IN DWORD dwTargetDescriptorLength, _In_ DWORD dwTargetDescriptorLength,
IN DWORD dwTargetBufferOffset, _In_ DWORD dwTargetBufferOffset,
OUT LPDWORD lpdwNumberOfBytesWritten, _Out_ LPDWORD lpdwNumberOfBytesWritten,
IN DWORD dwFlags, _In_ DWORD dwFlags,
IN LPWSAOVERLAPPED lpOverlapped OPTIONAL, _In_opt_ LPWSAOVERLAPPED lpOverlapped,
IN LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine OPTIONAL, _In_opt_ LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine,
IN LPWSATHREADID lpThreadId, _In_ LPWSATHREADID lpThreadId,
OUT LPINT lpErrno); _Out_ LPINT lpErrno);
int int
WSPAPI WSPAPI
WSPRdmaRead( WSPRdmaRead(
IN SOCKET s, _In_ SOCKET s,
IN LPWSABUFEX lpBuffers, _In_reads_(dwBufferCount) LPWSABUFEX lpBuffers,
IN DWORD dwBufferCount, _In_ DWORD dwBufferCount,
IN LPVOID lpTargetBufferDescriptor, _In_reads_bytes_(dwTargetDescriptorLength) LPVOID lpTargetBufferDescriptor,
IN DWORD dwTargetDescriptorLength, _In_ DWORD dwTargetDescriptorLength,
IN DWORD dwTargetBufferOffset, _In_ DWORD dwTargetBufferOffset,
OUT LPDWORD lpdwNumberOfBytesRead, _Out_ LPDWORD lpdwNumberOfBytesRead,
IN DWORD dwFlags, _In_ DWORD dwFlags,
IN LPWSAOVERLAPPED lpOverlapped OPTIONAL, _In_opt_ LPWSAOVERLAPPED lpOverlapped,
IN LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine OPTIONAL, _In_opt_ LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine,
IN LPWSATHREADID lpThreadId, _In_ LPWSATHREADID lpThreadId,
OUT LPINT lpErrno); _Out_ LPINT lpErrno);
#if(_WIN32_WINNT >= 0x0501) #if(_WIN32_WINNT >= 0x0501)
_Must_inspect_result_
int int
WSPAPI WSPAPI
WSPMemoryRegistrationCacheCallback( WSPMemoryRegistrationCacheCallback(
IN PVOID lpvAddress, _In_reads_bytes_(Size) PVOID lpvAddress,
IN SIZE_T Size, _In_ SIZE_T Size,
OUT LPINT lpErrno); _Out_ LPINT lpErrno);
#endif #endif
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
#endif /* _WS2SAN_H_ */