[Modify] Edit it

This commit is contained in:
sta 2017-08-18 14:24:44 +09:00
parent 189d8b38ec
commit 0254b00b9e

View File

@ -865,18 +865,75 @@ 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">
/// A <see cref="ushort"/> that represents the status code indicating the reason for the close. /// <para>
/// A <see cref="ushort"/> that represents the status code indicating
/// the reason for the close.
/// </para>
/// <para>
/// The status codes are defined in
/// <see href="http://tools.ietf.org/html/rfc6455#section-7.4">
/// Section 7.4</see> of RFC 6455.
/// </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 1010 (mandatory extension).
/// </para>
/// <para>
/// -or-
/// </para>
/// <para>
/// <paramref name="code"/> is 1005 (no status) 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">
/// <para>
/// <paramref name="code"/> is less than 1000 or greater than 4999.
/// </para>
/// <para>
/// -or-
/// </para>
/// <para>
/// The size of <paramref name="reason"/> is greater than 123 bytes.
/// </para>
/// </exception>
public void CloseSession (string id, ushort code, string reason) public void CloseSession (string id, ushort code, string reason)
{ {
IWebSocketSession session; IWebSocketSession session;