Export (0) Print
Expand All

HttpListenerWebSocketContext Class

.NET Framework 4.5

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

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

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

public class HttpListenerWebSocketContext : WebSocketContext

The HttpListenerWebSocketContext type exposes the following members.

  NameDescription
Public propertyCookieCollectionGets the cookies received by the HttpListener object in the WebSocket opening handshake. (Overrides WebSocketContext.CookieCollection.)
Public propertyHeadersGets the HTTP headers received by the HttpListener object in the WebSocket opening handshake. (Overrides WebSocketContext.Headers.)
Public propertyIsAuthenticatedGets a value that indicates if the WebSocket client is authenticated. (Overrides WebSocketContext.IsAuthenticated.)
Public propertyIsLocalGets a value that indicates if the WebSocket client connected from the local machine. (Overrides WebSocketContext.IsLocal.)
Public propertyIsSecureConnectionGets a value that indicates if the WebSocket connection is secured using Secure Sockets Layer (SSL). (Overrides WebSocketContext.IsSecureConnection.)
Public propertyOriginGets the value of the Origin HTTP header included in the WebSocket opening handshake. (Overrides WebSocketContext.Origin.)
Public propertyRequestUriGets the URI requested by the WebSocket client. (Overrides WebSocketContext.RequestUri.)
Public propertySecWebSocketKeyGets the value of the SecWebSocketKey HTTP header included in the WebSocket opening handshake. (Overrides WebSocketContext.SecWebSocketKey.)
Public propertySecWebSocketProtocolsGets the list of the Secure WebSocket protocols included in the WebSocket opening handshake. (Overrides WebSocketContext.SecWebSocketProtocols.)
Public propertySecWebSocketVersionGets the list of sub-protocols requested by the WebSocket client. (Overrides WebSocketContext.SecWebSocketVersion.)
Public propertyUserGets an object used to obtain identity, authentication information, and security roles for the WebSocket client. (Overrides WebSocketContext.User.)
Public propertyWebSocketGets the WebSocket instance used to send and receive data over the WebSocket connection. (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

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012

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