Skip to content

Commit c0058d2

Browse files
committed
Expand description of ConnectionTimeout.
1 parent 2e08a60 commit c0058d2

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

src/MySqlConnector/MySql.Data.MySqlClient/MySqlConnection.cs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -401,9 +401,11 @@ private SchemaProvider GetSchemaProvider()
401401
#endif
402402

403403
/// <summary>
404-
/// Gets the time (in seconds) to wait while trying to establish a connection
405-
/// before terminating the attempt and generating an error. The default value is 15 seconds.
406-
/// </summary>
404+
/// Gets the time (in seconds) to wait while trying to establish a connection
405+
/// before terminating the attempt and generating an error. This value
406+
/// is controlled by <see cref="MySqlConnectionStringBuilder.ConnectionTimeout"/>,
407+
/// which defaults to 15 seconds.
408+
/// </summary>
407409
public override int ConnectionTimeout => GetConnectionSettings().ConnectionTimeout;
408410

409411
public event MySqlInfoMessageEventHandler? InfoMessage;

src/MySqlConnector/MySql.Data.MySqlClient/MySqlConnectionStringBuilder.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,10 @@ public string? CharacterSet
208208
set => MySqlConnectionStringOption.CharacterSet.SetValue(this, value);
209209
}
210210

211+
/// <summary>
212+
/// The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error.
213+
/// The default value is 15.
214+
/// </summary>
211215
public uint ConnectionTimeout
212216
{
213217
get => MySqlConnectionStringOption.ConnectionTimeout.GetValue(this);

0 commit comments

Comments
 (0)