DevWiki/websocket-sharp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Modify] Edit it

Browse Source
This commit is contained in:
sta 2017-11-08 16:32:18 +09:00
parent d022eba6a1
commit f3751d6e00
1 changed files with 30 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
websocket-sharp/WebSocket.cs
View File

@ -3749,30 +3749,45 @@ namespace WebSocketSharp
} }
/// <summary> /// <summary>
/// Sets a pair of <paramref name="username"/> and <paramref name="password"/> for /// Sets the credentials for the HTTP authentication (Basic/Digest).
/// the HTTP authentication (Basic/Digest).
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// This method is not available in a server. /// <para>
/// The credentials are initialized if <paramref name="username"/> is
/// <see langword="null"/> or an empty string.
/// </para>
/// <para>
/// This method does nothing if the connection has already been
/// established or it is closing.
/// </para>
/// </remarks> /// </remarks>
/// <param name="username"> /// <param name="username">
/// <para> /// A <see cref="string"/> that represents the username associated with
/// A <see cref="string"/> that represents the user name used to authenticate. /// the credentials.
/// </para>
/// <para>
/// If <paramref name="username"/> is <see langword="null"/> or empty,
/// the credentials will be initialized and not be sent.
/// </para>
/// </param> /// </param>
/// <param name="password"> /// <param name="password">
/// A <see cref="string"/> that represents the password for /// A <see cref="string"/> that represents the password for the username
/// <paramref name="username"/> used to authenticate. /// associated with the credentials.
/// </param> /// </param>
/// <param name="preAuth"> /// <param name="preAuth">
/// <c>true</c> if the <see cref="WebSocket"/> sends the credentials for /// <c>true</c> if this instance sends the credentials for the Basic
/// the Basic authentication with the first handshake request to the server; /// authentication with the first handshake request before receiving
/// otherwise, <c>false</c>. /// an authentication challenge; otherwise, <c>false</c>.
/// </param> /// </param>
/// <exception cref="InvalidOperationException">
/// This instance is not a client.
/// </exception>
/// <exception cref="ArgumentException">
/// <para>
/// <paramref name="username"/> contains an invalid character.
/// </para>
/// <para>
/// -or-
/// </para>
/// <para>
/// <paramref name="password"/> contains an invalid character.
/// </para>
/// </exception>
public void SetCredentials (string username, string password, bool preAuth) public void SetCredentials (string username, string password, bool preAuth)
{ {
string msg = null; string msg = null;