PFN_WSK_SEND_BACKLOG_EVENT fonction de rappel (wsk.h)

Article
03/05/2024

La fonction de rappel d’événement WskSendBacklogEvent avertit une application WSK lorsque la taille de backlog d’envoi idéale change pour un socket orienté connexion.

Syntaxe

PFN_WSK_SEND_BACKLOG_EVENT PfnWskSendBacklogEvent;

NTSTATUS PfnWskSendBacklogEvent(
  [in, optional] PVOID SocketContext,
  [in]           SIZE_T IdealBacklogSize
)
{...}

Paramètres

[in, optional] SocketContext

Pointeur vers le contexte de socket pour le socket orienté connexion qui informe l’application WSK d’une modification de sa taille de backlog d’envoi idéale. L’application WSK a fourni ce pointeur vers le sous-système WSK de l’une des manières suivantes :

Il a appelé la fonction WskSocket pour créer le socket.
Il a appelé la fonction WskSocketConnect pour créer le socket.
Il a appelé la fonction WskAccept pour accepter le socket en tant que connexion entrante.
Sa fonction de rappel d’événement WskAcceptEvent a été appelée pour accepter le socket en tant que connexion entrante.

[in] IdealBacklogSize

Variable qui contient la nouvelle taille de backlog d’envoi idéale.

Valeur retournée

La fonction de rappel d’événement WskSendBacklogEvent d’une application WSK doit toujours retourner STATUS_SUCCESS.

Remarques

Le sous-système WSK appelle la fonction de rappel d’événement WskSendBacklogEvent d’une application WSK lorsque la taille du backlog d’envoi idéale change pour un socket orienté connexion uniquement si la fonction de rappel d’événement était précédemment activée avec l’option de socket SO_WSK_EVENT_CALLBACK . Pour plus d’informations sur l’activation des fonctions de rappel d’événements d’un socket, consultez Activation et désactivation des fonctions de rappel d’événements.

La taille de backlog d’envoi idéale pour un socket orienté connexion est la quantité optimale de données d’envoi qui doivent être conservées en attente (c’est-à-dire passées au sous-système WSK, mais pas encore terminées) pour maintenir le flux de données du socket complet à tout moment. Une application WSK peut utiliser cette taille pour sonder et verrouiller de manière incrémentielle les mémoires tampons des données à envoyer en fonction de l’état de contrôle de flux de la connexion sous-jacente.

Une application WSK peut obtenir la taille de backlog idéale actuelle pour un socket orienté connexion à tout moment en appelant la fonction WskControlSocket .

Le sous-système WSK appelle la fonction de rappel d’événement WskSendBacklogEvent d’une application WSK à l’adresse IRQL <= DISPATCH_LEVEL.

La fonction de rappel d’événement WskSendBacklogEvent d’une application WSK ne doit pas attendre l’achèvement d’autres demandes WSK dans le contexte de l’achèvement WSK ou des fonctions de rappel d’événements. Le rappel peut lancer d’autres demandes WSK (en supposant qu’il ne passe pas trop de temps à DISPATCH_LEVEL), mais il ne doit pas attendre leur achèvement même lorsque le rappel est appelé à IRQL = PASSIVE_LEVEL.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Disponible dans Windows Vista et les versions ultérieures des systèmes d’exploitation Windows.
Plateforme cible	Windows
En-tête	wsk.h (inclure Wsk.h)
IRQL	<= DISPATCH_LEVEL