ws2san.h File Reference

Go to the source code of this file.

Classes
struct	_WSPUPCALLTABLEEX
struct	_WSABUFEX

Macros
#define	_WS2SAN_H_
#define	SO_MAX_RDMA_SIZE   0x700D
#define	SO_RDMA_THRESHOLD_SIZE   0x700E
#define	MEM_READ   1
#define	MEM_WRITE   2
#define	MEM_READWRITE   3
#define	WSAID_REGISTERMEMORY    {0xC0B422F5, 0xF58C, 0x11d1, {0xAD, 0x6C, 0x00, 0xC0, 0x4F, 0xA3, 0x4A, 0x2D}}
#define	WSAID_DEREGISTERMEMORY    {0xC0B422F6, 0xF58C, 0x11d1, {0xAD, 0x6C, 0x00, 0xC0, 0x4F, 0xA3, 0x4A, 0x2D}}
#define	WSAID_REGISTERRDMAMEMORY    {0xC0B422F7, 0xF58C, 0x11d1, {0xAD, 0x6C, 0x00, 0xC0, 0x4F, 0xA3, 0x4A, 0x2D}}
#define	WSAID_DEREGISTERRDMAMEMORY    {0xC0B422F8, 0xF58C, 0x11d1, {0xAD, 0x6C, 0x00, 0xC0, 0x4F, 0xA3, 0x4A, 0x2D}}
#define	WSAID_RDMAWRITE    {0xC0B422F9, 0xF58C, 0x11d1, {0xAD, 0x6C, 0x00, 0xC0, 0x4F, 0xA3, 0x4A, 0x2D}}
#define	WSAID_RDMAREAD    {0xC0B422FA, 0xF58C, 0x11d1, {0xAD, 0x6C, 0x00, 0xC0, 0x4F, 0xA3, 0x4A, 0x2D}}

Typedefs
typedef struct _WSPUPCALLTABLEEX	WSPUPCALLTABLEEX
typedef struct _WSPUPCALLTABLEEX *	LPWSPUPCALLTABLEEX
typedef struct _WSABUFEX	WSABUFEX
typedef struct _WSABUFEX *	LPWSABUFEX
typedef _Must_inspect_result_ int(WSPAPI *	LPWSPSTARTUPEX) (_In_ WORD wVersionRequested, _Out_ LPWSPDATA lpWSPData, _In_ LPWSAPROTOCOL_INFOW lpProtocolInfo, _In_ LPWSPUPCALLTABLEEX lpUpcallTable, _Out_ LPWSPPROC_TABLE lpProcTable)
typedef _Must_inspect_result_ HANDLE(WSPAPI *	LPFN_WSPREGISTERMEMORY) (_In_ SOCKET s, _In_reads_bytes_(dwBufferLength) PVOID lpBuffer, _In_ DWORD dwBufferLength, _In_ DWORD dwFlags, _Out_ LPINT lpErrno)
typedef int(WSPAPI *	LPFN_WSPDEREGISTERMEMORY) (_In_ SOCKET s, _In_ HANDLE Handle, _Out_ LPINT lpErrno)
typedef _Must_inspect_result_ int(WSPAPI *	LPFN_WSPREGISTERRDMAMEMORY) (_In_ SOCKET s, _In_reads_bytes_(dwBufferLength) PVOID lpBuffer, _In_ DWORD dwBufferLength, _In_ DWORD dwFlags, _Out_writes_bytes_(*lpdwDescriptorLength) LPVOID lpRdmaBufferDescriptor, _Inout_ LPDWORD lpdwDescriptorLength, _Out_ LPINT lpErrno)
typedef int(WSPAPI *	LPFN_WSPDEREGISTERRDMAMEMORY) (_In_ SOCKET s, _In_reads_bytes_(dwDescriptorLength) LPVOID lpRdmaBufferDescriptor, _In_ DWORD dwDescriptorLength, _Out_ LPINT lpErrno)
typedef int(WSPAPI *	LPFN_WSPRDMAWRITE) (_In_ SOCKET s, _In_reads_(dwBufferCount) LPWSABUFEX lpBuffers, _In_ DWORD dwBufferCount, _In_reads_bytes_(dwTargetDescriptorLength) LPVOID lpTargetBufferDescriptor, _In_ DWORD dwTargetDescriptorLength, _In_ DWORD dwTargetBufferOffset, _Out_ LPDWORD lpdwNumberOfBytesWritten, _In_ DWORD dwFlags, _In_opt_ LPWSAOVERLAPPED lpOverlapped, _In_opt_ LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine, _In_ LPWSATHREADID lpThreadId, _Out_ LPINT lpErrno)
typedef int(WSPAPI *	LPFN_WSPRDMAREAD) (_In_ SOCKET s, _In_reads_(dwBufferCount) LPWSABUFEX lpBuffers, _In_ DWORD dwBufferCount, _In_reads_bytes_(dwTargetDescriptorLength) LPVOID lpTargetBufferDescriptor, _In_ DWORD dwTargetDescriptorLength, _In_ DWORD dwTargetBufferOffset, _Out_ LPDWORD lpdwNumberOfBytesRead, _In_ DWORD dwFlags, _In_opt_ LPWSAOVERLAPPED lpOverlapped, _In_opt_ LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine, _In_ LPWSATHREADID lpThreadId, _Out_ LPINT lpErrno)

Functions
_Must_inspect_result_ int WSPAPI	WSPStartupEx (_In_ WORD wVersionRequested, _Out_ LPWSPDATA lpWSPData, _In_ LPWSAPROTOCOL_INFOW lpProtocolInfo, _In_ LPWSPUPCALLTABLEEX lpUpcallTable, _Out_ LPWSPPROC_TABLE lpProcTable)
_Must_inspect_result_ HANDLE WSPAPI	WSPRegisterMemory (_In_ SOCKET s, _In_reads_bytes_(dwBufferLength) PVOID lpBuffer, _In_ DWORD dwBufferLength, _In_ DWORD dwFlags, _Out_ LPINT lpErrno)
int WSPAPI	WSPDeregisterMemory (_In_ SOCKET s, _In_ HANDLE Handle, _Out_ LPINT lpErrno)
_Must_inspect_result_ int WSPAPI	WSPRegisterRdmaMemory (_In_ SOCKET s, _In_reads_bytes_(dwBufferLength) PVOID lpBuffer, _In_ DWORD dwBufferLength, _In_ DWORD dwFlags, _Out_writes_bytes_(*lpdwDescriptorLength) LPVOID lpRdmaBufferDescriptor, _Inout_ LPDWORD lpdwDescriptorLength, _Out_ LPINT lpErrno)
int WSPAPI	WSPDeregisterRdmaMemory (_In_ SOCKET s, _In_reads_bytes_(dwDescriptorLength) LPVOID lpRdmaBufferDescriptor, _In_ DWORD dwDescriptorLength, _Out_ LPINT lpErrno)
int WSPAPI	WSPRdmaWrite (_In_ SOCKET s, _In_reads_(dwBufferCount) LPWSABUFEX lpBuffers, _In_ DWORD dwBufferCount, _In_reads_bytes_(dwTargetDescriptorLength) LPVOID lpTargetBufferDescriptor, _In_ DWORD dwTargetDescriptorLength, _In_ DWORD dwTargetBufferOffset, _Out_ LPDWORD lpdwNumberOfBytesWritten, _In_ DWORD dwFlags, _In_opt_ LPWSAOVERLAPPED lpOverlapped, _In_opt_ LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine, _In_ LPWSATHREADID lpThreadId, _Out_ LPINT lpErrno)
int WSPAPI	WSPRdmaRead (_In_ SOCKET s, _In_reads_(dwBufferCount) LPWSABUFEX lpBuffers, _In_ DWORD dwBufferCount, _In_reads_bytes_(dwTargetDescriptorLength) LPVOID lpTargetBufferDescriptor, _In_ DWORD dwTargetDescriptorLength, _In_ DWORD dwTargetBufferOffset, _Out_ LPDWORD lpdwNumberOfBytesRead, _In_ DWORD dwFlags, _In_opt_ LPWSAOVERLAPPED lpOverlapped, _In_opt_ LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine, _In_ LPWSATHREADID lpThreadId, _Out_ LPINT lpErrno)

Macro Definition Documentation

_WS2SAN_H_

#define _WS2SAN_H_

Definition at line 26 of file ws2san.h.

MEM_READ

#define MEM_READ   1

Definition at line 35 of file ws2san.h.

MEM_READWRITE

#define MEM_READWRITE   3

Definition at line 37 of file ws2san.h.

MEM_WRITE

#define MEM_WRITE   2

Definition at line 36 of file ws2san.h.

SO_MAX_RDMA_SIZE

#define SO_MAX_RDMA_SIZE   0x700D

Definition at line 32 of file ws2san.h.

SO_RDMA_THRESHOLD_SIZE

#define SO_RDMA_THRESHOLD_SIZE   0x700E

Definition at line 33 of file ws2san.h.

WSAID_DEREGISTERMEMORY

#define WSAID_DEREGISTERMEMORY    {0xC0B422F6, 0xF58C, 0x11d1, {0xAD, 0x6C, 0x00, 0xC0, 0x4F, 0xA3, 0x4A, 0x2D}}

Definition at line 42 of file ws2san.h.

WSAID_DEREGISTERRDMAMEMORY

#define WSAID_DEREGISTERRDMAMEMORY    {0xC0B422F8, 0xF58C, 0x11d1, {0xAD, 0x6C, 0x00, 0xC0, 0x4F, 0xA3, 0x4A, 0x2D}}

Definition at line 48 of file ws2san.h.

WSAID_RDMAREAD

#define WSAID_RDMAREAD    {0xC0B422FA, 0xF58C, 0x11d1, {0xAD, 0x6C, 0x00, 0xC0, 0x4F, 0xA3, 0x4A, 0x2D}}

Definition at line 54 of file ws2san.h.

WSAID_RDMAWRITE

#define WSAID_RDMAWRITE    {0xC0B422F9, 0xF58C, 0x11d1, {0xAD, 0x6C, 0x00, 0xC0, 0x4F, 0xA3, 0x4A, 0x2D}}

Definition at line 51 of file ws2san.h.

WSAID_REGISTERMEMORY

#define WSAID_REGISTERMEMORY    {0xC0B422F5, 0xF58C, 0x11d1, {0xAD, 0x6C, 0x00, 0xC0, 0x4F, 0xA3, 0x4A, 0x2D}}

Definition at line 39 of file ws2san.h.

WSAID_REGISTERRDMAMEMORY

#define WSAID_REGISTERRDMAMEMORY    {0xC0B422F7, 0xF58C, 0x11d1, {0xAD, 0x6C, 0x00, 0xC0, 0x4F, 0xA3, 0x4A, 0x2D}}

Definition at line 45 of file ws2san.h.

Typedef Documentation

LPFN_WSPDEREGISTERMEMORY

typedef int(WSPAPI * LPFN_WSPDEREGISTERMEMORY) (_In_ SOCKET s, _In_ HANDLE Handle, _Out_ LPINT lpErrno)

Definition at line 107 of file ws2san.h.

LPFN_WSPDEREGISTERRDMAMEMORY

typedef int(WSPAPI * LPFN_WSPDEREGISTERRDMAMEMORY) (_In_ SOCKET s, _In_reads_bytes_(dwDescriptorLength) LPVOID lpRdmaBufferDescriptor, _In_ DWORD dwDescriptorLength, _Out_ LPINT lpErrno)

Definition at line 125 of file ws2san.h.

LPFN_WSPRDMAREAD

typedef int(WSPAPI * LPFN_WSPRDMAREAD) (_In_ SOCKET s, _In_reads_(dwBufferCount) LPWSABUFEX lpBuffers, _In_ DWORD dwBufferCount, _In_reads_bytes_(dwTargetDescriptorLength) LPVOID lpTargetBufferDescriptor, _In_ DWORD dwTargetDescriptorLength, _In_ DWORD dwTargetBufferOffset, _Out_ LPDWORD lpdwNumberOfBytesRead, _In_ DWORD dwFlags, _In_opt_ LPWSAOVERLAPPED lpOverlapped, _In_opt_ LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine, _In_ LPWSATHREADID lpThreadId, _Out_ LPINT lpErrno)

Definition at line 147 of file ws2san.h.

LPFN_WSPRDMAWRITE

typedef int(WSPAPI * LPFN_WSPRDMAWRITE) (_In_ SOCKET s, _In_reads_(dwBufferCount) LPWSABUFEX lpBuffers, _In_ DWORD dwBufferCount, _In_reads_bytes_(dwTargetDescriptorLength) LPVOID lpTargetBufferDescriptor, _In_ DWORD dwTargetDescriptorLength, _In_ DWORD dwTargetBufferOffset, _Out_ LPDWORD lpdwNumberOfBytesWritten, _In_ DWORD dwFlags, _In_opt_ LPWSAOVERLAPPED lpOverlapped, _In_opt_ LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine, _In_ LPWSATHREADID lpThreadId, _Out_ LPINT lpErrno)

Definition at line 132 of file ws2san.h.

LPFN_WSPREGISTERMEMORY

typedef _Must_inspect_result_ HANDLE(WSPAPI * LPFN_WSPREGISTERMEMORY) (_In_ SOCKET s, _In_reads_bytes_(dwBufferLength) PVOID lpBuffer, _In_ DWORD dwBufferLength, _In_ DWORD dwFlags, _Out_ LPINT lpErrno)

Definition at line 99 of file ws2san.h.

LPFN_WSPREGISTERRDMAMEMORY

typedef _Must_inspect_result_ int(WSPAPI * LPFN_WSPREGISTERRDMAMEMORY) (_In_ SOCKET s, _In_reads_bytes_(dwBufferLength) PVOID lpBuffer, _In_ DWORD dwBufferLength, _In_ DWORD dwFlags, _Out_writes_bytes_(*lpdwDescriptorLength) LPVOID lpRdmaBufferDescriptor, _Inout_ LPDWORD lpdwDescriptorLength, _Out_ LPINT lpErrno)

Definition at line 115 of file ws2san.h.

LPWSABUFEX

typedef struct _WSABUFEX* LPWSABUFEX

LPWSPSTARTUPEX

typedef _Must_inspect_result_ int(WSPAPI * LPWSPSTARTUPEX) (_In_ WORD wVersionRequested, _Out_ LPWSPDATA lpWSPData, _In_ LPWSAPROTOCOL_INFOW lpProtocolInfo, _In_ LPWSPUPCALLTABLEEX lpUpcallTable, _Out_ LPWSPPROC_TABLE lpProcTable)

Definition at line 89 of file ws2san.h.

LPWSPUPCALLTABLEEX

typedef struct _WSPUPCALLTABLEEX* LPWSPUPCALLTABLEEX

WSABUFEX

typedef struct _WSABUFEX WSABUFEX

WSPUPCALLTABLEEX

typedef struct _WSPUPCALLTABLEEX WSPUPCALLTABLEEX

Function Documentation

WSPDeregisterMemory()

int WSPAPI WSPDeregisterMemory	(	_In_ SOCKET	s,
		_In_ HANDLE	Handle,
		_Out_ LPINT	lpErrno
	)

WSPDeregisterRdmaMemory()

int WSPAPI WSPDeregisterRdmaMemory	(	_In_ SOCKET	s,
		_In_reads_bytes_(dwDescriptorLength) LPVOID	lpRdmaBufferDescriptor,
		_In_ DWORD	dwDescriptorLength,
		_Out_ LPINT	lpErrno
	)

WSPRdmaRead()

int WSPAPI WSPRdmaRead	(	_In_ SOCKET	s,
		_In_reads_(dwBufferCount) LPWSABUFEX	lpBuffers,
		_In_ DWORD	dwBufferCount,
		_In_reads_bytes_(dwTargetDescriptorLength) LPVOID	lpTargetBufferDescriptor,
		_In_ DWORD	dwTargetDescriptorLength,
		_In_ DWORD	dwTargetBufferOffset,
		_Out_ LPDWORD	lpdwNumberOfBytesRead,
		_In_ DWORD	dwFlags,
		_In_opt_ LPWSAOVERLAPPED	lpOverlapped,
		_In_opt_ LPWSAOVERLAPPED_COMPLETION_ROUTINE	lpCompletionRoutine,
		_In_ LPWSATHREADID	lpThreadId,
		_Out_ LPINT	lpErrno
	)

WSPRdmaWrite()

int WSPAPI WSPRdmaWrite	(	_In_ SOCKET	s,
		_In_reads_(dwBufferCount) LPWSABUFEX	lpBuffers,
		_In_ DWORD	dwBufferCount,
		_In_reads_bytes_(dwTargetDescriptorLength) LPVOID	lpTargetBufferDescriptor,
		_In_ DWORD	dwTargetDescriptorLength,
		_In_ DWORD	dwTargetBufferOffset,
		_Out_ LPDWORD	lpdwNumberOfBytesWritten,
		_In_ DWORD	dwFlags,
		_In_opt_ LPWSAOVERLAPPED	lpOverlapped,
		_In_opt_ LPWSAOVERLAPPED_COMPLETION_ROUTINE	lpCompletionRoutine,
		_In_ LPWSATHREADID	lpThreadId,
		_Out_ LPINT	lpErrno
	)

WSPRegisterMemory()

_Must_inspect_result_ HANDLE WSPAPI WSPRegisterMemory	(	_In_ SOCKET	s,
		_In_reads_bytes_(dwBufferLength) PVOID	lpBuffer,
		_In_ DWORD	dwBufferLength,
		_In_ DWORD	dwFlags,
		_Out_ LPINT	lpErrno
	)

WSPRegisterRdmaMemory()

_Must_inspect_result_ int WSPAPI WSPRegisterRdmaMemory	(	_In_ SOCKET	s,
		_In_reads_bytes_(dwBufferLength) PVOID	lpBuffer,
		_In_ DWORD	dwBufferLength,
		_In_ DWORD	dwFlags,
		_Out_writes_bytes_ *lpdwDescriptorLength LPVOID	lpRdmaBufferDescriptor,
		_Inout_ LPDWORD	lpdwDescriptorLength,
		_Out_ LPINT	lpErrno
	)

WSPStartupEx()

_Must_inspect_result_ int WSPAPI WSPStartupEx	(	_In_ WORD	wVersionRequested,
		_Out_ LPWSPDATA	lpWSPData,
		_In_ LPWSAPROTOCOL_INFOW	lpProtocolInfo,
		_In_ LPWSPUPCALLTABLEEX	lpUpcallTable,
		_Out_ LPWSPPROC_TABLE	lpProcTable
	)