[Modify] Edit it

This commit is contained in:
sta 2017-11-10 17:57:46 +09:00
parent 7a9899e064
commit 9127a42c43

View File

@ -3816,38 +3816,83 @@ namespace WebSocketSharp
} }
/// <summary> /// <summary>
/// Sets the HTTP proxy server URL to connect through, and if necessary, /// Sets the HTTP proxy server URL through which to connect and
/// a pair of <paramref name="username"/> and <paramref name="password"/> for /// the credentials for the HTTP authentication (Basic/Digest) by
/// the proxy server authentication (Basic/Digest). /// the proxy server.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// This method is not available in a server. /// This method does nothing if the connection has already been
/// established or it is closing.
/// </remarks> /// </remarks>
/// <param name="url"> /// <param name="url">
/// <para> /// <para>
/// A <see cref="string"/> that represents the HTTP proxy server URL to /// A <see cref="string"/> that represents the proxy server URL through
/// connect through. The syntax must be http://&lt;host&gt;[:&lt;port&gt;]. /// which to connect.
/// </para> /// </para>
/// <para> /// <para>
/// If <paramref name="url"/> is <see langword="null"/> or empty, /// The syntax is http://&lt;host&gt;[:&lt;port&gt;].
/// the url and credentials for the proxy will be initialized,
/// and the <see cref="WebSocket"/> will not use the proxy to
/// connect through.
/// </para> /// </para>
/// </param> /// </param>
/// <param name="username"> /// <param name="username">
/// <para> /// <para>
/// A <see cref="string"/> that represents the user name used to authenticate. /// A <see cref="string"/> that represents the username associated with
/// the credentials.
/// </para> /// </para>
/// <para> /// <para>
/// If <paramref name="username"/> is <see langword="null"/> or empty, /// <see langword="null"/> or an empty string if the credentials are not
/// the credentials for the proxy will be initialized and not be sent. /// necessary.
/// </para> /// </para>
/// </param> /// </param>
/// <param name="password"> /// <param name="password">
/// A <see cref="string"/> that represents the password for /// <para>
/// <paramref name="username"/> used to authenticate. /// A <see cref="string"/> that represents the password for the username
/// associated with the credentials.
/// </para>
/// <para>
/// <see langword="null"/> or an empty string if not necessary.
/// </para>
/// </param> /// </param>
/// <exception cref="InvalidOperationException">
/// This instance is not a client.
/// </exception>
/// <exception cref="ArgumentNullException">
/// <paramref name="url"/> is <see langword="null"/>.
/// </exception>
/// <exception cref="ArgumentException">
/// <para>
/// <paramref name="url"/> is an empty string.
/// </para>
/// <para>
/// -or-
/// </para>
/// <para>
/// <paramref name="url"/> is not an absolute URI string.
/// </para>
/// <para>
/// -or-
/// </para>
/// <para>
/// The scheme of <paramref name="url"/> is not http.
/// </para>
/// <para>
/// -or-
/// </para>
/// <para>
/// <paramref name="url"/> includes the path segments.
/// </para>
/// <para>
/// -or-
/// </para>
/// <para>
/// <paramref name="username"/> contains an invalid character.
/// </para>
/// <para>
/// -or-
/// </para>
/// <para>
/// <paramref name="password"/> contains an invalid character.
/// </para>
/// </exception>
public void SetProxy (string url, string username, string password) public void SetProxy (string url, string username, string password)
{ {
string msg = null; string msg = null;