Export (0) Print
Expand All

WebSocketContext Class

.NET Framework 4.5

Used for accessing the information in the WebSocket handshake.

Namespace:  System.Net.WebSockets
Assembly:  System (in System.dll)

public abstract class WebSocketContext

The WebSocketContext type exposes the following members.

  NameDescription
Protected methodWebSocketContextCreates an instance of the WebSocketContext class.
Top

  NameDescription
Public propertyCookieCollectionThe cookies that were passed to the server during the opening handshake.
Public propertyHeadersThe HTTP headers that were sent to the server during the opening handshake.
Public propertyIsAuthenticatedWhether the WebSocket client is authenticated.
Public propertyIsLocalWhether the WebSocket client connected from the local machine.
Public propertyIsSecureConnectionWhether the WebSocket connection is secured using Secure Sockets Layer (SSL).
Public propertyOriginThe value of the Origin HTTP header included in the opening handshake.
Public propertyRequestUriThe URI requested by the WebSocket client.
Public propertySecWebSocketKeyThe value of the SecWebSocketKey HTTP header included in the opening handshake.
Public propertySecWebSocketProtocolsThe value of the SecWebSocketKey HTTP header included in the opening handshake.
Public propertySecWebSocketVersionThe list of subprotocols requested by the WebSocket client.
Public propertyUserAn object used to obtain identity, authentication information, and security roles for the WebSocket client.
Public propertyWebSocketThe WebSocket instance used to interact (send/receive/close/etc) with the WebSocket connection.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

.NET Framework

Supported in: 4.6, 4.5

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft