[Modify] Edit it

This commit is contained in:
sta 2017-08-18 14:45:21 +09:00
parent 9a2dc74cbc
commit 3acda8050b

View File

@ -946,19 +946,66 @@ namespace WebSocketSharp.Server
} }
/// <summary> /// <summary>
/// Closes the session with the specified <paramref name="id"/>, <paramref name="code"/>, /// Closes the specified session with <paramref name="code"/> and
/// and <paramref name="reason"/>. /// <paramref name="reason"/>.
/// </summary> /// </summary>
/// <param name="id"> /// <param name="id">
/// A <see cref="string"/> that represents the ID of the session to close. /// A <see cref="string"/> that represents the ID of the session to close.
/// </param> /// </param>
/// <param name="code"> /// <param name="code">
/// One of the <see cref="CloseStatusCode"/> enum values, represents the status code /// <para>
/// indicating the reason for the close. /// One of the <see cref="CloseStatusCode"/> enum values.
/// </para>
/// <para>
/// It represents the status code indicating the reason for the close.
/// </para>
/// </param> /// </param>
/// <param name="reason"> /// <param name="reason">
/// A <see cref="string"/> that represents the reason for the close. /// <para>
/// A <see cref="string"/> that represents the reason for the close.
/// </para>
/// <para>
/// The size must be 123 bytes or less in UTF-8.
/// </para>
/// </param> /// </param>
/// <exception cref="ArgumentNullException">
/// <paramref name="id"/> is <see langword="null"/>.
/// </exception>
/// <exception cref="ArgumentException">
/// <para>
/// <paramref name="id"/> is an empty string.
/// </para>
/// <para>
/// -or-
/// </para>
/// <para>
/// The session could not be found.
/// </para>
/// <para>
/// -or-
/// </para>
/// <para>
/// <paramref name="code"/> is
/// <see cref="CloseStatusCode.MandatoryExtension"/>.
/// </para>
/// <para>
/// -or-
/// </para>
/// <para>
/// <paramref name="code"/> is
/// <see cref="CloseStatusCode.NoStatus"/> and there is
/// <paramref name="reason"/>.
/// </para>
/// <para>
/// -or-
/// </para>
/// <para>
/// <paramref name="reason"/> could not be UTF-8-encoded.
/// </para>
/// </exception>
/// <exception cref="ArgumentOutOfRangeException">
/// The size of <paramref name="reason"/> is greater than 123 bytes.
/// </exception>
public void CloseSession (string id, CloseStatusCode code, string reason) public void CloseSession (string id, CloseStatusCode code, string reason)
{ {
IWebSocketSession session; IWebSocketSession session;