wsk.h header

This header is used by netvista. For more information, see:

Functions

Title Description
WskCaptureProviderNPI The WskCaptureProviderNPI function captures a provider Network Programming Interface (NPI) when it becomes available from the WSK subsystem.
WskDeregister The WskDeregister function unregisters a WSK application's registration instance that was previously created by WskRegister.
WskQueryProviderCharacteristics The WskQueryProviderCharacteristics function queries the range of WSK NPI versions supported by the WSK subsystem.
WskRegister The WskRegister function registers a WSK application, given the application's WSK client Network Programming Interface (NPI).
WskReleaseProviderNPI The WskReleaseProviderNPI function releases a Network Programming Interface (NPI) that was captured with WskCaptureProviderNPI.

Callback functions

Title Description
PFN_WSK_ABORT_EVENT 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.
PFN_WSK_ACCEPT The WskAccept function accepts an incoming connection on a listening socket.
PFN_WSK_ACCEPT_EVENT The WskAcceptEvent event callback function notifies a WSK application that an incoming connection on a listening socket has been accepted.
PFN_WSK_BIND The WskBind function binds a socket to a local transport address.
PFN_WSK_CLIENT_EVENT The WskClientEvent event callback function notifies a WSK application about events that are not specific to a particular socket.
PFN_WSK_CLOSE_SOCKET The WskCloseSocket function closes a socket and frees any associated resources.
PFN_WSK_CONNECT The WskConnect function connects a connection-oriented or stream socket to a remote transport address.
PFN_WSK_CONNECT_EX The WskConnectEx function connects a connection-oriented or stream socket to a remote transport address.WskConnectEx is similar to WskConnect except that it can also optionally send a buffer of data during or after connection synchronization.
PFN_WSK_CONTROL_CLIENT The WskControlClient function performs control operations on a WSK client object.
PFN_WSK_CONTROL_SOCKET The WskControlSocket function performs control operations on a socket.
PFN_WSK_DISCONNECT The WskDisconnect function disconnects a connection-oriented or stream socket from a remote transport address.
PFN_WSK_DISCONNECT_EVENT The WskDisconnectEvent event callback function notifies a WSK application that a connection on a connection-oriented socket has been disconnected by the remote application.
PFN_WSK_FREE_ADDRESS_INFO The WskFreeAddressInfo function frees address information that the WskGetAddressInfo function has dynamically allocated.
PFN_WSK_GET_ADDRESS_INFO The WskGetAddressInfo function performs protocol-independent translation from a host name to a transport address.
PFN_WSK_GET_LOCAL_ADDRESS The WskGetLocalAddress function retrieves the local transport address of a socket.
PFN_WSK_GET_NAME_INFO The WskGetNameInfo function provides protocol-independent translation from a transport address to a host name.
PFN_WSK_GET_REMOTE_ADDRESS The WskGetRemoteAddress function retrieves the remote transport address of a connection-oriented or stream socket.
PFN_WSK_INSPECT_COMPLETE The WskInspectComplete function completes the inspection of a previously pended incoming connection request that was received on a listening socket that has conditional accept mode enabled.
PFN_WSK_INSPECT_EVENT The WskInspectEvent event callback function notifies a WSK application that an incoming connection request on a listening socket that has conditional accept mode enabled has been received.
PFN_WSK_LISTEN The WskListen function enables a stream socket to listen for incoming connections at the socket's bound address.
PFN_WSK_RECEIVE The WskReceive function receives data over a connection-oriented or stream socket from a remote transport address.
PFN_WSK_RECEIVE_EVENT The WskReceiveEvent event callback function notifies a WSK application that data has been received on a connection-oriented socket.
PFN_WSK_RECEIVE_FROM The WskReceiveFrom function receives a datagram and any associated control information from a remote transport address.
PFN_WSK_RECEIVE_FROM_EVENT The WskReceiveFromEvent event callback function notifies a WSK application that one or more datagrams have been received on a datagram socket.
PFN_WSK_RELEASE_DATA_INDICATION_LIST The WskRelease function releases a linked list of WSK_DATA_INDICATION structures that was previously retained by a WSK application.
PFN_WSK_RELEASE_DATAGRAM_INDICATION_LIST The WskRelease function releases a linked list of WSK_DATAGRAM_INDICATION structures that was previously retained by a WSK application.
PFN_WSK_SEND The WskSend function sends data over a connection-oriented or stream socket to a remote transport address.
PFN_WSK_SEND_BACKLOG_EVENT The WskSendBacklogEvent event callback function notifies a WSK application when the ideal send backlog size changes for a connection-oriented socket.
PFN_WSK_SEND_TO The WskSendTo function sends datagram data to a remote transport address.
PFN_WSK_SOCKET The WskSocket function creates a new socket and returns a pointer to the associated socket object.
PFN_WSK_SOCKET_CONNECT The WskSocketConnect function creates a new connection-oriented socket, binds it to a local transport address, connects it to a given remote transport address, and returns a pointer to the associated socket object.

Structures

Title Description
WSK_BUF The WSK_BUF structure defines a data buffer that is used for sending and receiving data over a socket.
WSK_CLIENT_CONNECTION_DISPATCH The WSK_CLIENT_CONNECTION_DISPATCH structure specifies a WSK application's dispatch table of event callback functions for a connection-oriented socket.
WSK_CLIENT_DATAGRAM_DISPATCH The WSK_CLIENT_DATAGRAM_DISPATCH structure specifies a WSK application's dispatch table of event callback functions for a datagram socket.
WSK_CLIENT_DISPATCH The WSK_CLIENT_DISPATCH structure specifies a WSK application's dispatch table of event callback functions for events that are not specific to a particular socket.
WSK_CLIENT_LISTEN_DISPATCH The WSK_CLIENT_LISTEN_DISPATCH structure specifies a WSK application's dispatch table of event callback functions for a listening socket.
WSK_CLIENT_NPI The WSK_CLIENT_NPI structure identifies a Network Programming Interface (NPI) implemented by a WSK client.
WSK_CLIENT_STREAM_DISPATCH The WSK_CLIENT_STREAM_DISPATCH structure specifies a WSK application's dispatch table of event callback functions for a stream socket.
WSK_DATA_INDICATION The WSK_DATA_INDICATION structure describes data that has been received on a connection-oriented socket.
WSK_DATAGRAM_INDICATION The WSK_DATAGRAM_INDICATION structure describes a datagram that has been received on a datagram socket.
WSK_EVENT_CALLBACK_CONTROL The WSK_EVENT_CALLBACK_CONTROL structure specifies the information for enabling and disabling a socket's event callback functions.
WSK_EXTENSION_CONTROL_IN The WSK_EXTENSION_CONTROL_IN structure specifies a WSK application's implementation of an extension interface for a socket.
WSK_EXTENSION_CONTROL_OUT The WSK_EXTENSION_CONTROL_OUT structure specifies the WSK subsystem's implementation of an extension interface for a socket.
WSK_INSPECT_ID The WSK_INSPECT_ID structure specifies an identifier for an incoming connection request on a listening socket.
WSK_PROVIDER_BASIC_DISPATCH The WSK_PROVIDER_BASIC_DISPATCH structure specifies the WSK subsystem's dispatch table of functions for a basic socket.
WSK_PROVIDER_CHARACTERISTICS The WSK_PROVIDER_CHARACTERISTICS structure specifies the characteristics of the WSK subsystem.
WSK_PROVIDER_CONNECTION_DISPATCH The WSK_PROVIDER_CONNECTION_DISPATCH structure specifies the WSK subsystem's table of functions for a connection-oriented socket.
WSK_PROVIDER_DATAGRAM_DISPATCH The WSK_PROVIDER_DATAGRAM_DISPATCH structure specifies the WSK subsystem's table of functions for a datagram socket.
WSK_PROVIDER_DISPATCH The WSK_PROVIDER_DISPATCH structure specifies the WSK subsystem's dispatch table of functions that are not specific to a particular socket.
WSK_PROVIDER_LISTEN_DISPATCH The WSK_PROVIDER_LISTEN_DISPATCH structure specifies the WSK subsystem's table of functions for a listening socket.
WSK_PROVIDER_NPI The WSK_PROVIDER_NPI structure identifies a provider Network Programming Interface (NPI) implemented by the WSK subsystem.
WSK_PROVIDER_STREAM_DISPATCH The WSK_PROVIDER_STREAM_DISPATCH structure specifies the WSK subsystem's table of functions for a stream socket.
WSK_REGISTRATION The WSK_REGISTRATION structure is used by the WSK subsystem to register or unregister a WSK application as a WSK client.
WSK_SOCKET The WSK_SOCKET structure defines a socket object for a socket.
WSK_TDI_MAP The WSK_TDI_MAP structure specifies a mapping between a particular address family, socket type, and protocol to the device name of a TDI transport.
WSK_TDI_MAP_INFO The WSK_TDI_MAP_INFO structure specifies a list that contains mappings of a combination of an address family, a socket type, and a protocol to the device name of a TDI transport.
WSK_TRANSPORT The WSK_TRANSPORT structure specifies an available transport that is supported by the WSK subsystem.