HttpListenerWebSocketContext Class

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Provides access to information received by the HttpListener class when accepting WebSocket connections.

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

System.Object
  System.Net.WebSockets.WebSocketContext
    System.Net.WebSockets.HttpListenerWebSocketContext

type HttpListenerWebSocketContext = 
    class
        inherit WebSocketContext
    end

NameDescription
System_CAPS_pubpropertyCookieCollection

Gets the cookies received by the HttpListener object in the WebSocket opening handshake.(Overrides WebSocketContext.CookieCollection.)

System_CAPS_pubpropertyHeaders

Gets the HTTP headers received by the HttpListener object in the WebSocket opening handshake.(Overrides WebSocketContext.Headers.)

System_CAPS_pubpropertyIsAuthenticated

Gets a value that indicates if the WebSocket client is authenticated.(Overrides WebSocketContext.IsAuthenticated.)

System_CAPS_pubpropertyIsLocal

Gets a value that indicates if the WebSocket client connected from the local machine.(Overrides WebSocketContext.IsLocal.)

System_CAPS_pubpropertyIsSecureConnection

Gets a value that indicates if the WebSocket connection is secured using Secure Sockets Layer (SSL).(Overrides WebSocketContext.IsSecureConnection.)

System_CAPS_pubpropertyOrigin

Gets the value of the Origin HTTP header included in the WebSocket opening handshake.(Overrides WebSocketContext.Origin.)

System_CAPS_pubpropertyRequestUri

Gets the URI requested by the WebSocket client.(Overrides WebSocketContext.RequestUri.)

System_CAPS_pubpropertySecWebSocketKey

Gets the value of the SecWebSocketKey HTTP header included in the WebSocket opening handshake.(Overrides WebSocketContext.SecWebSocketKey.)

System_CAPS_pubpropertySecWebSocketProtocols

Gets the list of the Secure WebSocket protocols included in the WebSocket opening handshake.(Overrides WebSocketContext.SecWebSocketProtocols.)

System_CAPS_pubpropertySecWebSocketVersion

Gets the list of sub-protocols requested by the WebSocket client.(Overrides WebSocketContext.SecWebSocketVersion.)

System_CAPS_pubpropertyUser

Gets an object used to obtain identity, authentication information, and security roles for the WebSocket client.(Overrides WebSocketContext.User.)

System_CAPS_pubpropertyWebSocket

Gets the WebSocket instance used to send and receive data over the WebSocket connection.(Overrides WebSocketContext.WebSocket.)

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: