Refactored HttpListenerWebSocketContext.cs
This commit is contained in:
sta
parent
6575f56ed0
commit
b3e8708f85
@ -34,8 +34,8 @@ using System.Security.Principal;
|
||||
namespace WebSocketSharp.Net.WebSockets
|
||||
{
|
||||
/// <summary>
|
||||
/// Provides access to the WebSocket connection request information received by
|
||||
/// the <see cref="HttpListener"/>.
|
||||
/// Provides the properties used for accessing the information in a WebSocket connection request
|
||||
/// received by the <see cref="HttpListener"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// </remarks>
|
||||
@ -51,8 +51,7 @@ namespace WebSocketSharp.Net.WebSockets
|
||||
|
||||
#region Internal Constructors
|
||||
|
||||
internal HttpListenerWebSocketContext (
|
||||
HttpListenerContext context, Logger logger)
|
||||
internal HttpListenerWebSocketContext (HttpListenerContext context, Logger logger)
|
||||
{
|
||||
_context = context;
|
||||
_stream = WsStream.CreateServerStream (context);
|
||||
@ -74,11 +73,10 @@ namespace WebSocketSharp.Net.WebSockets
|
||||
#region Public Properties
|
||||
|
||||
/// <summary>
|
||||
/// Gets the cookies used in the WebSocket connection request.
|
||||
/// Gets the HTTP cookies included in the request.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// A <see cref="WebSocketSharp.Net.CookieCollection"/> that contains the
|
||||
/// cookies.
|
||||
/// A <see cref="WebSocketSharp.Net.CookieCollection"/> that contains the cookies.
|
||||
/// </value>
|
||||
public override CookieCollection CookieCollection {
|
||||
get {
|
||||
@ -87,10 +85,10 @@ namespace WebSocketSharp.Net.WebSockets
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the HTTP headers used in the WebSocket connection request.
|
||||
/// Gets the HTTP headers included in the request.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// A <see cref="NameValueCollection"/> that contains the HTTP headers.
|
||||
/// A <see cref="NameValueCollection"/> that contains the headers.
|
||||
/// </value>
|
||||
public override NameValueCollection Headers {
|
||||
get {
|
||||
@ -99,11 +97,10 @@ namespace WebSocketSharp.Net.WebSockets
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the value of the Host header field used in the WebSocket connection
|
||||
/// request.
|
||||
/// Gets the value of the Host header included in the request.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// A <see cref="string"/> that represents the value of the Host header field.
|
||||
/// A <see cref="string"/> that represents the value of the Host header.
|
||||
/// </value>
|
||||
public override string Host {
|
||||
get {
|
||||
@ -124,12 +121,10 @@ namespace WebSocketSharp.Net.WebSockets
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether the client connected from the local
|
||||
/// computer.
|
||||
/// Gets a value indicating whether the client connected from the local computer.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// <c>true</c> if the client connected from the local computer; otherwise,
|
||||
/// <c>false</c>.
|
||||
/// <c>true</c> if the client connected from the local computer; otherwise, <c>false</c>.
|
||||
/// </value>
|
||||
public override bool IsLocal {
|
||||
get {
|
||||
@ -141,8 +136,7 @@ namespace WebSocketSharp.Net.WebSockets
|
||||
/// Gets a value indicating whether the WebSocket connection is secured.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// <c>true</c> if the WebSocket connection is secured; otherwise,
|
||||
/// <c>false</c>.
|
||||
/// <c>true</c> if the connection is secured; otherwise, <c>false</c>.
|
||||
/// </value>
|
||||
public override bool IsSecureConnection {
|
||||
get {
|
||||
@ -151,12 +145,10 @@ namespace WebSocketSharp.Net.WebSockets
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether the request is a WebSocket connection
|
||||
/// request.
|
||||
/// Gets a value indicating whether the request is a WebSocket connection request.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// <c>true</c> if the request is a WebSocket connection request; otherwise,
|
||||
/// <c>false</c>.
|
||||
/// <c>true</c> if the request is a WebSocket connection request; otherwise, <c>false</c>.
|
||||
/// </value>
|
||||
public override bool IsWebSocketRequest {
|
||||
get {
|
||||
@ -165,12 +157,10 @@ namespace WebSocketSharp.Net.WebSockets
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the value of the Origin header field used in the WebSocket
|
||||
/// connection request.
|
||||
/// Gets the value of the Origin header included in the request.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// A <see cref="string"/> that represents the value of the Origin header
|
||||
/// field.
|
||||
/// A <see cref="string"/> that represents the value of the Origin header.
|
||||
/// </value>
|
||||
public override string Origin {
|
||||
get {
|
||||
@ -179,11 +169,10 @@ namespace WebSocketSharp.Net.WebSockets
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the absolute path of the requested WebSocket URI.
|
||||
/// Gets the absolute path of the requested URI.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// A <see cref="string"/> that represents the absolute path of the requested
|
||||
/// WebSocket URI.
|
||||
/// A <see cref="string"/> that represents the absolute path of the requested URI.
|
||||
/// </value>
|
||||
public override string Path {
|
||||
get {
|
||||
@ -192,12 +181,10 @@ namespace WebSocketSharp.Net.WebSockets
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the collection of query string variables used in the WebSocket
|
||||
/// connection request.
|
||||
/// Gets the collection of query string variables included in the request.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// A <see cref="NameValueCollection"/> that contains the collection of query
|
||||
/// string variables.
|
||||
/// A <see cref="NameValueCollection"/> that contains the collection of query string variables.
|
||||
/// </value>
|
||||
public override NameValueCollection QueryString {
|
||||
get {
|
||||
@ -206,11 +193,10 @@ namespace WebSocketSharp.Net.WebSockets
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the WebSocket URI requested by the client.
|
||||
/// Gets the URI requested by the client.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// A <see cref="Uri"/> that represents the WebSocket URI requested by the
|
||||
/// client.
|
||||
/// A <see cref="Uri"/> that represents the requested URI.
|
||||
/// </value>
|
||||
public override Uri RequestUri {
|
||||
get {
|
||||
@ -219,16 +205,14 @@ namespace WebSocketSharp.Net.WebSockets
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the value of the Sec-WebSocket-Key header field used in the
|
||||
/// WebSocket connection request.
|
||||
/// Gets the value of the Sec-WebSocket-Key header included in the request.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This property provides a part of the information used by the server to
|
||||
/// prove that it received a valid WebSocket connection request.
|
||||
/// This property provides a part of the information used by the server to prove that it
|
||||
/// received a valid WebSocket connection request.
|
||||
/// </remarks>
|
||||
/// <value>
|
||||
/// A <see cref="string"/> that represents the value of the Sec-WebSocket-Key
|
||||
/// header field.
|
||||
/// A <see cref="string"/> that represents the value of the Sec-WebSocket-Key header.
|
||||
/// </value>
|
||||
public override string SecWebSocketKey {
|
||||
get {
|
||||
@ -237,15 +221,13 @@ namespace WebSocketSharp.Net.WebSockets
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the values of the Sec-WebSocket-Protocol header field used in the
|
||||
/// WebSocket connection request.
|
||||
/// Gets the values of the Sec-WebSocket-Protocol header included in the request.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This property represents the subprotocols requested from the client.
|
||||
/// This property represents the subprotocols requested by the client.
|
||||
/// </remarks>
|
||||
/// <value>
|
||||
/// An IEnumerable<string> that contains the values of the
|
||||
/// Sec-WebSocket-Protocol header field.
|
||||
/// An IEnumerable<string> that contains the values of the Sec-WebSocket-Protocol header.
|
||||
/// </value>
|
||||
public override IEnumerable<string> SecWebSocketProtocols {
|
||||
get {
|
||||
@ -257,15 +239,13 @@ namespace WebSocketSharp.Net.WebSockets
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the value of the Sec-WebSocket-Version header field used in the
|
||||
/// WebSocket connection request.
|
||||
/// Gets the value of the Sec-WebSocket-Version header included in the request.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This property represents the WebSocket protocol version of the connection.
|
||||
/// This property represents the WebSocket protocol version.
|
||||
/// </remarks>
|
||||
/// <value>
|
||||
/// A <see cref="string"/> that represents the value of the
|
||||
/// Sec-WebSocket-Version header field.
|
||||
/// A <see cref="string"/> that represents the value of the Sec-WebSocket-Version header.
|
||||
/// </value>
|
||||
public override string SecWebSocketVersion {
|
||||
get {
|
||||
@ -286,8 +266,7 @@ namespace WebSocketSharp.Net.WebSockets
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the client information (identity, authentication information and
|
||||
/// security roles).
|
||||
/// Gets the client information (identity, authentication, and security roles).
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// A <see cref="IPrincipal"/> that represents the client information.
|
||||
@ -311,8 +290,8 @@ namespace WebSocketSharp.Net.WebSockets
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the WebSocket instance used for two-way communication between client
|
||||
/// and server.
|
||||
/// Gets the <see cref="WebSocketSharp.WebSocket"/> instance used for two-way communication
|
||||
/// between client and server.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// A <see cref="WebSocketSharp.WebSocket"/>.
|
||||
|
||||
@ -119,10 +119,10 @@ namespace WebSocketSharp.Net.WebSockets
|
||||
public abstract string Origin { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the absolute path of the requested WebSocket URI.
|
||||
/// Gets the absolute path of the requested URI.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// A <see cref="string"/> that represents the absolute path of the requested WebSocket URI.
|
||||
/// A <see cref="string"/> that represents the absolute path of the requested URI.
|
||||
/// </value>
|
||||
public abstract string Path { get; }
|
||||
|
||||
@ -135,10 +135,10 @@ namespace WebSocketSharp.Net.WebSockets
|
||||
public abstract NameValueCollection QueryString { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the WebSocket URI requested by the client.
|
||||
/// Gets the URI requested by the client.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// A <see cref="Uri"/> that represents the requested WebSocket URI.
|
||||
/// A <see cref="Uri"/> that represents the requested URI.
|
||||
/// </value>
|
||||
public abstract Uri RequestUri { get; }
|
||||
|
||||
@ -158,7 +158,7 @@ namespace WebSocketSharp.Net.WebSockets
|
||||
/// Gets the values of the Sec-WebSocket-Protocol header included in the request.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This property represents the subprotocols requested from the client.
|
||||
/// This property represents the subprotocols requested by the client.
|
||||
/// </remarks>
|
||||
/// <value>
|
||||
/// An IEnumerable<string> that contains the values of the Sec-WebSocket-Protocol header.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user