SIO_WSK_QUERY_IDEAL_SEND_BACKLOG

The SIO_WSK_QUERY_IDEAL_SEND_BACKLOG socket I/O control operation allows a WSK application to query the ideal send backlog size for a connection-oriented socket. This socket I/O control operation applies only to connection-oriented sockets.

The ideal send backlog size for a connection-oriented socket is the optimal amount of send data that needs to be kept outstanding (that is, passed to the WSK subsystem but not yet completed) to keep the socket's data stream full at all times. A WSK application can use this size to incrementally probe and lock the buffers of data to be sent based on the underlying connection's flow control state.

If a WSK application uses this socket I/O control operation to query the ideal send backlog size, it must do so after the connection-oriented socket has been connected to a remote transport address.

To query the ideal send backlog size for a connection-oriented socket, a WSK application calls the WskControlSocket function with the following parameters.

ParameterValue

RequestType

WskIoctl

ControlCode

SIO_WSK_QUERY_IDEAL_SEND_BACKLOG

Level

0

InputSize

0

InputBuffer

NULL

OutputSize

sizeof(SIZE_T)

OutputBuffer

A pointer to a SIZE_T-typed variable that receives the current ideal send backlog size

OutputSizeReturned

NULL

 

A WSK application must specify a pointer to an IRP when calling the WskControlSocket function to query the ideal send backlog size for a connection-oriented socket.

A connection-oriented socket can be notified of changes to the ideal send backlog size by enabling its WskSendBacklogEvent event callback function.

Requirements

Version

Available in Windows Vista and later versions of the Windows operating systems.

Header

Wsk.h (include Wsk.h)

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft