Skip to content

Latest commit

 

History

History
149 lines (107 loc) · 5.45 KB

nc-wsk-pfn_wsk_abort_event.md

File metadata and controls

149 lines (107 loc) · 5.45 KB
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NC:wsk.PFN_WSK_ABORT_EVENT
PFN_WSK_ABORT_EVENT (wsk.h)
The WskAbortEvent event callback function notifies a WSK application that an incoming connection request on a listening socket that has conditional accept mode enabled has been dropped.
netvista\wskabortevent.htm
netvista
05/02/2018
PFN_WSK_ABORT_EVENT callback function
PFN_WSK_ABORT_EVENT, PFN_WSK_ABORT_EVENT callback, WskAbortEvent, WskAbortEvent callback function [Network Drivers Starting with Windows Vista], netvista.wskabortevent, wsk/WskAbortEvent, wskref_592d9a56-6a77-4c24-aaec-e70f84d23e49.xml
wsk.h
Wsk.h
Windows
Available in Windows Vista and later versions of the Windows operating systems.
<= DISPATCH_LEVEL
Windows
PFN_WSK_ABORT_EVENT
wsk/PFN_WSK_ABORT_EVENT
APIRef
kbSyntax
UserDefined
wsk.h
PFN_WSK_ABORT_EVENT

PFN_WSK_ABORT_EVENT callback function

-description

The WskAbortEvent event callback function notifies a WSK application that an incoming connection request on a listening socket that has conditional accept mode enabled has been dropped.

-parameters

-param SocketContext [in, optional]

A pointer to the socket context for the listening socket on which the incoming connection request was received. The WSK application provided this pointer to the WSK subsystem when it called the WskSocket function to create the listening socket.

-param InspectID [in]

A pointer to a WSK_INSPECT_ID structure. The contents of the structure identify the incoming connection request that has been dropped.

-returns

A WSK application's WskAbortEvent event callback function must always return STATUS_SUCCESS.

-remarks

The WSK subsystem calls a WSK application's WskAbortEvent event callback function only when the following conditions are true:

  • The WSK application created a listening socket that has conditional accept mode enabled.
  • An incoming connection request has been received on the listening socket, and the WSK subsystem has called the WSK application's WskInspectEvent event callback function.
  • The WSK application returned WskInspectPend or WskInspectAccept from its WskAbortEvent event callback function for the incoming connection request.
  • The incoming connection request has been dropped either locally or remotely before being fully established.
When the WSK subsystem calls a WSK application's WskAbortEvent event callback function, the application should terminate the inspection for the incoming connection request. The connection request is identified by the contents of the WSK_INSPECT_ID structure that is pointed to by the InspectID parameter.

If the WSK application calls the WskInspectComplete function on an incoming connection request that has been aborted, the connection will not be established even if WskInspectAccept is specified in the Action parameter.

A WSK application can enable conditional accept mode on a listening socket by enabling the SO_CONDITIONAL_ACCEPT socket option. For more information about conditionally accepting incoming connections, see Listening for and Accepting Incoming Connections.

The WSK subsystem calls a WSK application's WskAbortEvent event callback function at IRQL <= DISPATCH_LEVEL.

A WSK application's WskAbortEvent event callback function must not wait for completion of other WSK requests in the context of WSK completion or event callback functions. The callback can initiate other WSK requests (assuming that it doesn't spend too much time at DISPATCH_LEVEL), but it must not wait for their completion even when the callback is called at IRQL = PASSIVE_LEVEL.

-see-also

WSK_CLIENT_LISTEN_DISPATCH

WSK_INSPECT_ID

WskControlSocket

WskInspectComplete

WskInspectEvent

WskSocket