WebSocketContext Class

.NET Framework (current version)
 

Used for accessing the information in the WebSocket handshake.

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


public abstract class WebSocketContext

NameDescription
System_CAPS_protmethodWebSocketContext()

Creates an instance of the WebSocketContext class.

NameDescription
System_CAPS_pubpropertyCookieCollection

The cookies that were passed to the server during the opening handshake.

System_CAPS_pubpropertyHeaders

The HTTP headers that were sent to the server during the opening handshake.

System_CAPS_pubpropertyIsAuthenticated

Whether the WebSocket client is authenticated.

System_CAPS_pubpropertyIsLocal

Whether the WebSocket client connected from the local machine.

System_CAPS_pubpropertyIsSecureConnection

Whether the WebSocket connection is secured using Secure Sockets Layer (SSL).

System_CAPS_pubpropertyOrigin

The value of the Origin HTTP header included in the opening handshake.

System_CAPS_pubpropertyRequestUri

The URI requested by the WebSocket client.

System_CAPS_pubpropertySecWebSocketKey

The value of the SecWebSocketKey HTTP header included in the opening handshake.

System_CAPS_pubpropertySecWebSocketProtocols

The value of the SecWebSocketKey HTTP header included in the opening handshake.

System_CAPS_pubpropertySecWebSocketVersion

The list of subprotocols requested by the WebSocket client.

System_CAPS_pubpropertyUser

An object used to obtain identity, authentication information, and security roles for the WebSocket client.

System_CAPS_pubpropertyWebSocket

The WebSocket instance used to interact (send/receive/close/etc) with the WebSocket connection.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

.NET Framework
Available since 4.5

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

Return to top
Show: