Skip to content

Commit 016daf8

Browse files
Add unit of measure and default to ConnectionTimeout
The summary is what is shown by consumers when using autocomplete. This change allows consumers to easily see the unit of measure (seconds) as well as the default value when using autocomplete/code completion. I'm proposing this change because it wasn't clear to me if the timeout was in seconds or milliseconds. Also, i had no idea what the default is/was until I added a breakpoint in my code that was consuming this. Signed-off-by: Amalfitano, Joseph <[email protected]> ~ ~
1 parent 4bf3d69 commit 016daf8

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -400,6 +400,10 @@ private SchemaProvider GetSchemaProvider()
400400
SchemaProvider? m_schemaProvider;
401401
#endif
402402

403+
/// <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>
403407
public override int ConnectionTimeout => GetConnectionSettings().ConnectionTimeout;
404408

405409
public event MySqlInfoMessageEventHandler? InfoMessage;

0 commit comments

Comments
 (0)