Edit

WSK_CLIENT_CONNECTION_DISPATCH structure (wsk.h)

  • Article

The WSK_CLIENT_CONNECTION_DISPATCH structure specifies a WSK application's dispatch table of event callback functions for a connection-oriented socket.

Syntax

typedef struct _WSK_CLIENT_CONNECTION_DISPATCH {
  PFN_WSK_RECEIVE_EVENT      WskReceiveEvent;
  PFN_WSK_DISCONNECT_EVENT   WskDisconnectEvent;
  PFN_WSK_SEND_BACKLOG_EVENT WskSendBacklogEvent;
} WSK_CLIENT_CONNECTION_DISPATCH, *PWSK_CLIENT_CONNECTION_DISPATCH;

Members

WskReceiveEvent

A pointer to the WSK application's WskReceiveEvent event callback function for the socket. If the WSK application does not enable the WskReceiveEvent event callback function for the socket, this pointer can be NULL.

WskDisconnectEvent

A pointer to the WSK application's WskDisconnectEvent event callback function for the socket. If the WSK application does not enable the WskDisconnectEvent event callback function for the socket, this pointer can be NULL.

WskSendBacklogEvent

A pointer to the WSK application's WskSendBacklogEvent event callback function for the socket. If the WSK application does not enable the WskSendBacklogEvent event callback function for the socket, this pointer can be NULL.

Remarks

A WSK application passes a pointer to a WSK_CLIENT_CONNECTION_DISPATCH structure to the WSK subsystem in one of the following ways:

  • When calling the WskSocket function to create a connection-oriented socket.
  • When calling the WskSocketConnect function to create, bind, and connect a connection-oriented socket.
  • When calling the WskAccept function to accept an incoming connection-oriented socket on a listening socket.
  • As a returned parameter when the WSK subsystem calls the WSK application's WskAcceptEvent event callback function. The WSK subsystem calls a WSK application's WskAcceptEvent event callback function to notify the WSK application that an incoming connection-oriented socket has been accepted on a listening socket.

Requirements

Requirement Value
Minimum supported client Available in Windows Vista and later versions of the Windows operating systems.
Header wsk.h (include Wsk.h)

See also

WSK_PROVIDER_CONNECTION_DISPATCH

WskAccept

WskAcceptEvent

WskDisconnectEvent

WskReceiveEvent

WskSendBacklogEvent

WskSocket

WskSocketConnect