Fonction WebSocketSend (websocket.h)

Article
03/13/2024

La fonction WebSocketSend ajoute une opération d’envoi à la file d’attente d’opération du composant de protocole.

Syntaxe

HRESULT WebSocketSend(
  [in]           WEB_SOCKET_HANDLE      hWebSocket,
  [in]           WEB_SOCKET_BUFFER_TYPE BufferType,
  [in, optional] WEB_SOCKET_BUFFER      *pBuffer,
  [in, optional] PVOID                  Context
);

Paramètres

[in] hWebSocket

Type : WEB_SOCKET_HANDLE

Handle de session WebSocket retourné par un appel précédent à WebSocketCreateClientHandle ou WebSocketCreateServerHandle.

[in] BufferType

Type : WEB_SOCKET_BUFFER_TYPE

Type de données de mémoire tampon WebSocket à envoyer dans pBuffer.

[in, optional] pBuffer

Type : WEB_SOCKET_BUFFER*

Pointeur vers un tableau de structures WEB_SOCKET_BUFFER qui contient des données de mémoire tampon WebSocket à envoyer. Si BufferType est WEB_SOCKET_PING_PONG_BUFFER_TYPE ou WEB_SOCKET_UNSOLICITED_PONG_BUFFER_TYPE, pBuffer doit avoir la valeur NULL.

Note Une fois WEB_SOCKET_INDICATE_SEND_COMPLETE retourné par WebSocketGetAction pour cette action, le pointeur mémoire vers pBuffer peut être récupéré.

[in, optional] Context

Type : PVOID

Pointeur vers un handle de contexte d’application qui sera retourné par un appel suivant à WebSocketGetAction.

Valeur retournée

Type : HRESULT

Si la fonction réussit, elle retourne S_OK.

Si la fonction échoue, elle retourne l’un des éléments suivants ou un code d’erreur système défini dans WinError.h.

Code de retour	Description
E_INVALID_PROTOCOL_OPERATION	Le protocole a effectué une opération non valide.

Remarques

Une fois qu’une application a envoyé une mémoire tampon WebSocket WEB_SOCKET_CLOSE_BUFFER_TYPE avec succès, elle peut uniquement envoyer des trames de contrôle.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 8 [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2012 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	websocket.h
Bibliothèque	Websocket.lib
DLL	Websocket.dll

Voir aussi

WEB_SOCKET_ACTION

WebSocketAbortHandle

WebSocketCompleteAction

WebSocketGetAction

WebSocketReceive

Partager via