diff --git a/websocket-sharp/Server/IWebSocketSession.cs b/websocket-sharp/Server/IWebSocketSession.cs index 9e06561e..27ec3192 100644 --- a/websocket-sharp/Server/IWebSocketSession.cs +++ b/websocket-sharp/Server/IWebSocketSession.cs @@ -32,18 +32,19 @@ using WebSocketSharp.Net.WebSockets; namespace WebSocketSharp.Server { /// - /// Exposes the access to the session information in the WebSocket service. + /// Exposes the properties used for accessing the information in a session in a WebSocket + /// service. /// public interface IWebSocketSession { #region Properties /// - /// Gets the WebSocket connection request information. + /// Gets the information in the WebSocket connection request. /// /// - /// A that represents the WebSocket connection - /// request information. + /// A that provides the access to the WebSocket connection + /// request. /// WebSocketContext Context { get; } @@ -56,10 +57,11 @@ namespace WebSocketSharp.Server string ID { get; } /// - /// Gets the subprotocol used on the WebSocket connection. + /// Gets the subprotocol of the used in the session. /// /// - /// A that represents the subprotocol if any. + /// A that represents the subprotocol of the used + /// in the session if any. /// string Protocol { get; } @@ -67,17 +69,16 @@ namespace WebSocketSharp.Server /// Gets the time that the session has started. /// /// - /// A that represents the time that the session has - /// started. + /// A that represents the time that the session has started. /// DateTime StartTime { get; } /// - /// Gets the state of the WebSocket connection. + /// Gets the state of the used in the session. /// /// - /// One of the enum values, indicates the state of - /// the WebSocket connection. + /// One of the enum values, indicates the state of the + /// used in the session. /// WebSocketState State { get; } diff --git a/websocket-sharp/Server/WebSocketService.cs b/websocket-sharp/Server/WebSocketService.cs index 859f8bc5..6a5f02c3 100644 --- a/websocket-sharp/Server/WebSocketService.cs +++ b/websocket-sharp/Server/WebSocketService.cs @@ -34,7 +34,7 @@ using WebSocketSharp.Net.WebSockets; namespace WebSocketSharp.Server { /// - /// Provides the basic functions of the WebSocket service provided by the + /// Exposes the methods and properties for a WebSocket service provided by the /// or . /// /// @@ -67,11 +67,10 @@ namespace WebSocketSharp.Server #region Protected Properties /// - /// Gets or sets the logging functions. + /// Gets the logging functions. /// /// - /// If you want to change the current logger to the service own logger, you - /// set this property to a new instance that you created. + /// This property is available after the WebSocket connection has been established. /// /// /// A that provides the logging functions. @@ -82,19 +81,16 @@ namespace WebSocketSharp.Server ? _websocket.Log : null; } - - set { - if (_websocket != null) - _websocket.Log = value; - } } /// - /// Gets the manager of the sessions to the WebSocket service. + /// Gets the access to the sessions in the WebSocket service. /// + /// + /// This property is available after the WebSocket connection has been established. + /// /// - /// A that manages the sessions to the - /// WebSocket service. + /// A that provides the access to the sessions. /// protected WebSocketSessionManager Sessions { get { @@ -107,10 +103,10 @@ namespace WebSocketSharp.Server #region Public Properties /// - /// Gets the WebSocket connection request information. + /// Gets the information in the WebSocket connection request. /// /// - /// A that represents the WebSocket connection + /// A that provides the access to the WebSocket connection /// request. /// public WebSocketContext Context { @@ -120,26 +116,26 @@ namespace WebSocketSharp.Server } /// - /// Gets the unique ID of the current instance. + /// Gets the unique ID of the current session. /// /// - /// A that represents the unique ID of the current - /// instance. + /// A that represents the unique ID of the current session. /// public string ID { get; private set; } /// - /// Gets or sets the subprotocol used on the WebSocket connection. + /// Gets or sets the subprotocol of the used in the current session. /// /// - /// Set operation of this property is available before the connection has - /// been established. + /// Set operation of this property is available before the WebSocket connection has been + /// established. /// /// /// - /// A that represents the subprotocol if any. + /// A that represents the subprotocol of the + /// used in the current session if any. /// /// /// The value to set must be a token defined in @@ -166,12 +162,10 @@ namespace WebSocketSharp.Server } /// - /// Gets the time that the current instance - /// has been started. + /// Gets the time that the current session has started. /// /// - /// A that represents the time that the current - /// instance has been started. + /// A that represents the time that the current session has started. /// public DateTime StartTime { get { @@ -180,11 +174,11 @@ namespace WebSocketSharp.Server } /// - /// Gets the state of the WebSocket connection. + /// Gets the state of the used in the current session. /// /// - /// One of the values that indicate the state of - /// the WebSocket connection. + /// One of the enum values, indicates the state of the + /// used in the current session. /// public WebSocketState State { get { @@ -255,8 +249,7 @@ namespace WebSocketSharp.Server #region Protected Methods /// - /// Calls the method with the specified - /// . + /// Calls the method with the specified . /// /// /// A that represents the error message. @@ -268,49 +261,47 @@ namespace WebSocketSharp.Server } /// - /// Is called when the WebSocket connection has been closed. + /// Called when the WebSocket connection used in the current session has been closed. /// /// - /// A that contains the event data associated - /// with an inner event. + /// A that represents the event data received by + /// a event. /// protected virtual void OnClose (CloseEventArgs e) { } /// - /// Is called when the inner or current - /// gets an error. + /// Called when the current session gets an error. /// /// - /// An that contains the event data associated - /// with an inner event. + /// A that represents the event data received by + /// a event. /// protected virtual void OnError (ErrorEventArgs e) { } /// - /// Is called when the inner receives a data frame. + /// Called when the current session receives a message. /// /// - /// A that contains the event data associated - /// with an inner event. + /// A that represents the event data received by + /// a event. /// protected virtual void OnMessage (MessageEventArgs e) { } /// - /// Is called when the WebSocket connection has been established. + /// Called when the WebSocket connection used in the current session has been established. /// protected virtual void OnOpen () { } /// - /// Sends a binary to the client on the current - /// session in the WebSocket service. + /// Sends a binary to the client on the current session. /// /// /// An array of that represents the binary data to send. @@ -322,8 +313,8 @@ namespace WebSocketSharp.Server } /// - /// Sends the specified as a binary data - /// to the client on the current session in the WebSocket service. + /// Sends the specified as a binary data to the client on the current + /// session. /// /// /// A that represents the file to send. @@ -335,8 +326,7 @@ namespace WebSocketSharp.Server } /// - /// Sends a text to the client on the current - /// session in the WebSocket service. + /// Sends a text to the client on the current session. /// /// /// A that represents the text data to send. @@ -348,8 +338,7 @@ namespace WebSocketSharp.Server } /// - /// Sends a binary asynchronously to the client - /// on the current session in the WebSocket service. + /// Sends a binary asynchronously to the client on the current session. /// /// /// This method doesn't wait for the send to be complete. @@ -358,9 +347,9 @@ namespace WebSocketSharp.Server /// An array of that represents the binary data to send. /// /// - /// An Action<bool> delegate that references the method(s) called when - /// the send is complete. A passed to this delegate is - /// true if the send is complete successfully; otherwise, false. + /// An Action<bool> delegate that references the method(s) called when the send is + /// complete. A passed to this delegate is true if the send is + /// complete successfully; otherwise, false. /// protected void SendAsync (byte [] data, Action completed) { @@ -369,9 +358,8 @@ namespace WebSocketSharp.Server } /// - /// Sends the specified as a binary data - /// asynchronously to the client on the current session in the WebSocket - /// service. + /// Sends the specified as a binary data asynchronously to the client + /// on the current session. /// /// /// This method doesn't wait for the send to be complete. @@ -380,9 +368,9 @@ namespace WebSocketSharp.Server /// A that represents the file to send. /// /// - /// An Action<bool> delegate that references the method(s) called when - /// the send is complete. A passed to this delegate is - /// true if the send is complete successfully; otherwise, false. + /// An Action<bool> delegate that references the method(s) called when the send is + /// complete. A passed to this delegate is true if the send is + /// complete successfully; otherwise, false. /// protected void SendAsync (FileInfo file, Action completed) { @@ -391,8 +379,7 @@ namespace WebSocketSharp.Server } /// - /// Sends a text asynchronously to the client - /// on the current session in the WebSocket service. + /// Sends a text asynchronously to the client on the current session. /// /// /// This method doesn't wait for the send to be complete. @@ -401,9 +388,9 @@ namespace WebSocketSharp.Server /// A that represents the text data to send. /// /// - /// An Action<bool> delegate that references the method(s) called when - /// the send is complete. A passed to this delegate is - /// true if the send is complete successfully; otherwise, false. + /// An Action<bool> delegate that references the method(s) called when the send is + /// complete. A passed to this delegate is true if the send is + /// complete successfully; otherwise, false. /// protected void SendAsync (string data, Action completed) { @@ -412,8 +399,8 @@ namespace WebSocketSharp.Server } /// - /// Sends a binary data from the specified asynchronously - /// to the client on the current session in the WebSocket service. + /// Sends a binary data from the specified asynchronously to the client on + /// the current session. /// /// /// This method doesn't wait for the send to be complete. @@ -425,9 +412,9 @@ namespace WebSocketSharp.Server /// An that represents the number of bytes to send. /// /// - /// An Action<bool> delegate that references the method(s) called when - /// the send is complete. A passed to this delegate is - /// true if the send is complete successfully; otherwise, false. + /// An Action<bool> delegate that references the method(s) called when the send is + /// complete. A passed to this delegate is true if the send is + /// complete successfully; otherwise, false. /// protected void SendAsync (Stream stream, int length, Action completed) { @@ -436,26 +423,23 @@ namespace WebSocketSharp.Server } /// - /// Validates the HTTP Cookies used in the WebSocket connection request. + /// Used to validate the HTTP cookies included in the WebSocket connection request. /// /// - /// This method is called when the inner validates - /// the WebSocket connection request. + /// This method is called when the used in the current session + /// validates the WebSocket connection request. /// /// - /// true if the cookies is valid; otherwise, false. This method - /// returns true as default. + /// true if the cookies are valid; otherwise, false. This method returns + /// true as default. /// /// - /// A that contains the collection of the - /// cookies to validate. + /// A that contains the cookies to validate. /// /// - /// A that receives the cookies to send to the - /// client. + /// A that receives the cookies to send to the client. /// - protected virtual bool ValidateCookies ( - CookieCollection request, CookieCollection response) + protected virtual bool ValidateCookies (CookieCollection request, CookieCollection response) { return true; }