Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

AspNetWebSocketContext Class

.NET Framework 4.5

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

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

Namespace:  System.Web.WebSockets
Assembly:  System.Web (in System.Web.dll)
public abstract class AspNetWebSocketContext : WebSocketContext

The AspNetWebSocketContext type exposes the following members.

  NameDescription
Protected methodAspNetWebSocketContextWhen implemented in a derived class, initializes a new instance of the AspNetWebSocketContext class.
Top
  NameDescription
Public propertyAnonymousIDGets the anonymous-user identifier for the current AspNetWebSocket connection.
Public propertyApplicationGets the HttpApplicationState object for the host ASP.NET application.
Public propertyApplicationPathGets the root virtual path of the host ASP.NET application.
Public propertyCacheGets the Cache object for the current application domain.
Public propertyClientCertificateGets the certificate that a remote client issues in response to the server's request for the client's identity.
Public propertyStatic memberConnectionCountGets the number of active WebSocket connections.
Public propertyCookieCollectionReturns 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.)
Public propertyCookiesGets the collection of cookies that was sent by a remote client in an AspNetWebSocket message.
Public propertyFilePathGets the virtual path of the requested file.
Public propertyHeadersGets the collection of headers that was sent by a remote client. (Overrides WebSocketContext.Headers.)
Public propertyIsAuthenticatedGets a value that indicates whether a message from a remote client has been authenticated. (Overrides WebSocketContext.IsAuthenticated.)
Public propertyIsClientConnectedGets a value that indicates whether the client is connected to the server.
Public propertyIsDebuggingEnabledGets a value that indicates whether the application that hosts the current AspNetWebSocket connection is running in ASP.NET debug mode.
Public propertyIsLocalGets a value that indicates whether an AspNetWebSocket message was sent from the local computer. (Overrides WebSocketContext.IsLocal.)
Public propertyIsSecureConnectionGets a value that indicates whether the AspNetWebSocket connection uses the WebSocket Secure protocol (WSS). (Overrides WebSocketContext.IsSecureConnection.)
Public propertyItemsWhen 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.
Public propertyLogonUserIdentityGets the security token for the current user.
Public propertyOriginGets the origin of the WebSocket connection. (Overrides WebSocketContext.Origin.)
Public propertyPathGets the virtual path of the requested resource.
Public propertyPathInfoGets additional path information for a resource that has a URL extension.
Public propertyProfileGets an object that contains user profile data.
Public propertyQueryStringGets the collection of query string variables from an AspNetWebSocket message that was sent by the client.
Public propertyRawUrlGets the portion of a URL that follows the website name in an AspNetWebSocket message that was sent by the client.
Public propertyRequestUriGets the original Uniform Resource Identifier (URI) of an AspNetWebSocket message that was sent by the client. (Overrides WebSocketContext.RequestUri.)
Public propertySecWebSocketKeyGets the encrypted key that is sent in the handshake request to establish an AspNetWebSocket connection. (Overrides WebSocketContext.SecWebSocketKey.)
Public propertySecWebSocketProtocolsGets a list of application-level protocols (subprotocols) that a client can use to send messages using an AspNetWebSocket connection. (Overrides WebSocketContext.SecWebSocketProtocols.)
Public propertySecWebSocketVersionGets the version of the WebSocket protocol that an AspNetWebSocket connection must use. (Overrides WebSocketContext.SecWebSocketVersion.)
Public propertyServerGets the HttpServerUtility object that provides methods that are used in processing requests.
Public propertyServerVariablesGets a name/value collection of variables that provide information about the web server and about the current AspNetWebSocket connection.
Public propertyTimestampGets the timestamp of an AspNetWebSocket message that was sent by the client.
Public propertyUnvalidatedGets unvalidated versions of one or more field values that are submitted in an AspNetWebSocket message.
Public propertyUrlReferrerGets a collection of URI data about the message that was sent by the client prior to the current message.
Public propertyUserGets an object that represents the security context of the user for the current AspNetWebSocket connection. (Overrides WebSocketContext.User.)
Public propertyUserAgentGets the name of the remote client.
Public propertyUserHostAddressGets the IP address of the remote client.
Public propertyUserHostNameGets the DNS name of the remote client.
Public propertyUserLanguagesGets the collection of language preferences for the remote client.
Public propertyWebSocketGets a reference to the current AspNetWebSocket instance. (Overrides WebSocketContext.WebSocket.)
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.5.1, 4.5

Windows Phone 8.1, Windows Phone 8, 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.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.