[Modify] Edit it

This commit is contained in:
sta 2017-07-26 15:03:58 +09:00
parent 4cbec28379
commit a02b212d74

View File

@ -2533,23 +2533,69 @@ namespace WebSocketSharp
} }
/// <summary> /// <summary>
/// Closes the WebSocket connection with the specified <paramref name="code"/> and /// Closes the connection with the specified <paramref name="code"/> and
/// <paramref name="reason"/>, and releases all associated resources. /// <paramref name="reason"/>.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// This method does nothing if the current state of the connection is /// This method does nothing if the current state of the connection is
/// Closing or Closed. /// Closing or Closed.
/// </remarks> /// </remarks>
/// <param name="code"> /// <param name="code">
/// A <see cref="ushort"/> that represents the status code indicating /// <para>
/// the reason for the close. The status codes are defined in /// A <see cref="ushort"/> that represents the status code
/// <see href="http://tools.ietf.org/html/rfc6455#section-7.4"> /// indicating the reason for the close.
/// Section 7.4</see> of RFC 6455. /// </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>
/// The size must be 123 bytes or less. /// 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="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>
/// <exception cref="ArgumentException">
/// <para>
/// <paramref name="code"/> is 1011 (server error).
/// It cannot be used by clients.
/// </para>
/// <para>
/// -or-
/// </para>
/// <para>
/// <paramref name="code"/> is 1010 (mandatory extension).
/// It cannot be used by servers.
/// </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>
public void Close (ushort code, string reason) public void Close (ushort code, string reason)
{ {
if (!code.IsCloseStatusCode ()) { if (!code.IsCloseStatusCode ()) {