From b3e8708f8527a57cacd41c0d2c496500c51e6f7b Mon Sep 17 00:00:00 2001 From: sta Date: Fri, 21 Feb 2014 21:20:37 +0900 Subject: [PATCH] Refactored HttpListenerWebSocketContext.cs --- .../HttpListenerWebSocketContext.cs | 91 +++++++------------ .../Net/WebSockets/WebSocketContext.cs | 10 +- 2 files changed, 40 insertions(+), 61 deletions(-) diff --git a/websocket-sharp/Net/WebSockets/HttpListenerWebSocketContext.cs b/websocket-sharp/Net/WebSockets/HttpListenerWebSocketContext.cs index 6be645c2..6eaa5464 100644 --- a/websocket-sharp/Net/WebSockets/HttpListenerWebSocketContext.cs +++ b/websocket-sharp/Net/WebSockets/HttpListenerWebSocketContext.cs @@ -34,8 +34,8 @@ using System.Security.Principal; namespace WebSocketSharp.Net.WebSockets { /// - /// Provides access to the WebSocket connection request information received by - /// the . + /// Provides the properties used for accessing the information in a WebSocket connection request + /// received by the . /// /// /// @@ -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 /// - /// Gets the cookies used in the WebSocket connection request. + /// Gets the HTTP cookies included in the request. /// /// - /// A that contains the - /// cookies. + /// A that contains the cookies. /// public override CookieCollection CookieCollection { get { @@ -87,10 +85,10 @@ namespace WebSocketSharp.Net.WebSockets } /// - /// Gets the HTTP headers used in the WebSocket connection request. + /// Gets the HTTP headers included in the request. /// /// - /// A that contains the HTTP headers. + /// A that contains the headers. /// public override NameValueCollection Headers { get { @@ -99,11 +97,10 @@ namespace WebSocketSharp.Net.WebSockets } /// - /// 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. /// /// - /// A that represents the value of the Host header field. + /// A that represents the value of the Host header. /// public override string Host { get { @@ -124,12 +121,10 @@ namespace WebSocketSharp.Net.WebSockets } /// - /// Gets a value indicating whether the client connected from the local - /// computer. + /// Gets a value indicating whether the client connected from the local computer. /// /// - /// true if the client connected from the local computer; otherwise, - /// false. + /// true if the client connected from the local computer; otherwise, false. /// public override bool IsLocal { get { @@ -141,8 +136,7 @@ namespace WebSocketSharp.Net.WebSockets /// Gets a value indicating whether the WebSocket connection is secured. /// /// - /// true if the WebSocket connection is secured; otherwise, - /// false. + /// true if the connection is secured; otherwise, false. /// public override bool IsSecureConnection { get { @@ -151,12 +145,10 @@ namespace WebSocketSharp.Net.WebSockets } /// - /// Gets a value indicating whether the request is a WebSocket connection - /// request. + /// Gets a value indicating whether the request is a WebSocket connection request. /// /// - /// true if the request is a WebSocket connection request; otherwise, - /// false. + /// true if the request is a WebSocket connection request; otherwise, false. /// public override bool IsWebSocketRequest { get { @@ -165,12 +157,10 @@ namespace WebSocketSharp.Net.WebSockets } /// - /// 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. /// /// - /// A that represents the value of the Origin header - /// field. + /// A that represents the value of the Origin header. /// public override string Origin { get { @@ -179,11 +169,10 @@ namespace WebSocketSharp.Net.WebSockets } /// - /// Gets the absolute path of the requested WebSocket URI. + /// Gets the absolute path of the requested URI. /// /// - /// A that represents the absolute path of the requested - /// WebSocket URI. + /// A that represents the absolute path of the requested URI. /// public override string Path { get { @@ -192,12 +181,10 @@ namespace WebSocketSharp.Net.WebSockets } /// - /// Gets the collection of query string variables used in the WebSocket - /// connection request. + /// Gets the collection of query string variables included in the request. /// /// - /// A that contains the collection of query - /// string variables. + /// A that contains the collection of query string variables. /// public override NameValueCollection QueryString { get { @@ -206,11 +193,10 @@ namespace WebSocketSharp.Net.WebSockets } /// - /// Gets the WebSocket URI requested by the client. + /// Gets the URI requested by the client. /// /// - /// A that represents the WebSocket URI requested by the - /// client. + /// A that represents the requested URI. /// public override Uri RequestUri { get { @@ -219,16 +205,14 @@ namespace WebSocketSharp.Net.WebSockets } /// - /// 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. /// /// - /// 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. /// /// - /// A that represents the value of the Sec-WebSocket-Key - /// header field. + /// A that represents the value of the Sec-WebSocket-Key header. /// public override string SecWebSocketKey { get { @@ -237,15 +221,13 @@ namespace WebSocketSharp.Net.WebSockets } /// - /// 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. /// /// - /// This property represents the subprotocols requested from the client. + /// This property represents the subprotocols requested by the client. /// /// - /// 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. /// public override IEnumerable SecWebSocketProtocols { get { @@ -257,15 +239,13 @@ namespace WebSocketSharp.Net.WebSockets } /// - /// 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. /// /// - /// This property represents the WebSocket protocol version of the connection. + /// This property represents the WebSocket protocol version. /// /// - /// A that represents the value of the - /// Sec-WebSocket-Version header field. + /// A that represents the value of the Sec-WebSocket-Version header. /// public override string SecWebSocketVersion { get { @@ -286,8 +266,7 @@ namespace WebSocketSharp.Net.WebSockets } /// - /// Gets the client information (identity, authentication information and - /// security roles). + /// Gets the client information (identity, authentication, and security roles). /// /// /// A that represents the client information. @@ -311,8 +290,8 @@ namespace WebSocketSharp.Net.WebSockets } /// - /// Gets the WebSocket instance used for two-way communication between client - /// and server. + /// Gets the instance used for two-way communication + /// between client and server. /// /// /// A . diff --git a/websocket-sharp/Net/WebSockets/WebSocketContext.cs b/websocket-sharp/Net/WebSockets/WebSocketContext.cs index 9d8a2bf5..0a55c86e 100644 --- a/websocket-sharp/Net/WebSockets/WebSocketContext.cs +++ b/websocket-sharp/Net/WebSockets/WebSocketContext.cs @@ -119,10 +119,10 @@ namespace WebSocketSharp.Net.WebSockets public abstract string Origin { get; } /// - /// Gets the absolute path of the requested WebSocket URI. + /// Gets the absolute path of the requested URI. /// /// - /// A that represents the absolute path of the requested WebSocket URI. + /// A that represents the absolute path of the requested URI. /// public abstract string Path { get; } @@ -135,10 +135,10 @@ namespace WebSocketSharp.Net.WebSockets public abstract NameValueCollection QueryString { get; } /// - /// Gets the WebSocket URI requested by the client. + /// Gets the URI requested by the client. /// /// - /// A that represents the requested WebSocket URI. + /// A that represents the requested URI. /// 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. /// /// - /// This property represents the subprotocols requested from the client. + /// This property represents the subprotocols requested by the client. /// /// /// An IEnumerable<string> that contains the values of the Sec-WebSocket-Protocol header.