AspNetWebSocketContext Class

.NET Framework (current version)

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

Provides a base class that represents contextual details about an individual AspNetWebSocket request.

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

Inheritance Hierarchy

System.Object
System.Net.WebSockets.WebSocketContext
System.Web.WebSockets.AspNetWebSocketContext

Syntax

C++

[<AbstractClass>]
type AspNetWebSocketContext = 
    class
        inherit WebSocketContext
    end

Constructors

	Name	Description
	AspNetWebSocketContext()	When implemented in a derived class, initializes a new instance of the AspNetWebSocketContext class.

Properties

	Name	Description
	AnonymousID	Gets the anonymous-user identifier for the current AspNetWebSocket connection.
	Application	Gets the HttpApplicationState object for the host ASP.NET application.
	ApplicationPath	Gets the root virtual path of the host ASP.NET application.
	Cache	Gets the Cache object for the current application domain.
	ClientCertificate	Gets the certificate that a remote client issues in response to the server's request for the client's identity.
	ConnectionCount	Gets the number of active WebSocket connections.
	CookieCollection	Returns the Cookies collection typed as a CookieCollection for Windows applications that use cookies based on the Cookie class (such as WCF server applications).(Overrides WebSocketContext.CookieCollection.)
	Cookies	Gets the collection of cookies that was sent by a remote client in an AspNetWebSocket message.
	FilePath	Gets the virtual path of the requested file.
	Headers	Gets the collection of headers that was sent by a remote client.(Overrides WebSocketContext.Headers.)
	IsAuthenticated	Gets a value that indicates whether a message from a remote client has been authenticated.(Overrides WebSocketContext.IsAuthenticated.)
	IsClientConnected	Gets a value that indicates whether the client is connected to the server.
	IsDebuggingEnabled	Gets a value that indicates whether the application that hosts the current AspNetWebSocket connection is running in ASP.NET debug mode.
	IsLocal	Gets a value that indicates whether an AspNetWebSocket message was sent from the local computer.(Overrides WebSocketContext.IsLocal.)
	IsSecureConnection	Gets a value that indicates whether the AspNetWebSocket connection uses the WebSocket Secure protocol (WSS).(Overrides WebSocketContext.IsSecureConnection.)
	Items	When overridden in a derived class, gets a key/value collection that can be used to share data between a module and a handler during an AspNetWebSocket request.
	LogonUserIdentity	Gets the security token for the current user.
	Origin	Gets the origin of the WebSocket connection.(Overrides WebSocketContext.Origin.)
	Path	Gets the virtual path of the requested resource.
	PathInfo	Gets additional path information for a resource that has a URL extension.
	Profile	Gets an object that contains user profile data.
	QueryString	Gets the collection of query string variables from an AspNetWebSocket message that was sent by the client.
	RawUrl	Gets the portion of a URL that follows the website name in an AspNetWebSocket message that was sent by the client.
	RequestUri	Gets the original Uniform Resource Identifier (URI) of an AspNetWebSocket message that was sent by the client.(Overrides WebSocketContext.RequestUri.)
	SecWebSocketKey	Gets the encrypted key that is sent in the handshake request to establish an AspNetWebSocket connection.(Overrides WebSocketContext.SecWebSocketKey.)
	SecWebSocketProtocols	Gets a list of application-level protocols (subprotocols) that a client can use to send messages using an AspNetWebSocket connection.(Overrides WebSocketContext.SecWebSocketProtocols.)
	SecWebSocketVersion	Gets the version of the WebSocket protocol that an AspNetWebSocket connection must use.(Overrides WebSocketContext.SecWebSocketVersion.)
	Server	Gets the HttpServerUtility object that provides methods that are used in processing requests.
	ServerVariables	Gets a name/value collection of variables that provide information about the web server and about the current AspNetWebSocket connection.
	Timestamp	Gets the timestamp of an AspNetWebSocket message that was sent by the client.
	Unvalidated	Gets unvalidated versions of one or more field values that are submitted in an AspNetWebSocket message.
	UrlReferrer	Gets a collection of URI data about the message that was sent by the client prior to the current message.
	User	Gets an object that represents the security context of the user for the current AspNetWebSocket connection.(Overrides WebSocketContext.User.)
	UserAgent	Gets the name of the remote client.
	UserHostAddress	Gets the IP address of the remote client.
	UserHostName	Gets the DNS name of the remote client.
	UserLanguages	Gets the collection of language preferences for the remote client.
	WebSocket	Gets a reference to the current AspNetWebSocket instance.(Overrides WebSocketContext.WebSocket.)

Methods

	Name	Description
	Equals(Object)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

Version Information

.NET Framework
Available since 4.5

Thread Safety

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