IWebSocketContext Interface

Represents context support for bi-directional WebSocket communications over a single TCP socket.

Syntax

class IWebSocketContext : public IHttpStoredContext  

Methods

The following table lists the methods exposed by the IWebSocketContext interface.

Name Description
CancelOutstandingIO Cancels all remaining input or output operations.
CloseTcpConnection Signals the close of the TCP connection. The connection will not shut down until both sides acknowledge the close.
GetCloseStatus Retrieves the close status code for the connection.
ReadFragment Reads a data fragment from an asynchronous connection.
SendConnectionClose Signals the close of a WebSocket connection.
WriteFragment Writes a data fragment to an asynchronous connection.

Derived Classes

This interface contains no derived classes.

Inheritance Hierarchy

IHttpStoredContext

IWebSocketContext

Requirements

Type Description
Client - IIS 7.0 on Windows Vista
- IIS 7.5 on Windows 7
- IIS 8.0 on Windows 8
- IIS 10.0 on Windows 10
Server - IIS 7.0 on Windows Server 2008
- IIS 7.5 on Windows Server 2008 R2
- IIS 8.0 on Windows Server 2012
- IIS 8.5 on Windows Server 2012 R2
- IIS 10.0 on Windows Server 2016
Product - IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0
- IIS Express 7.5, IIS Express 8.0, IIS Express 10.0
Header Iiswebsocket.h

See Also

Web Server Core Interfaces