Skip to content

Commit 6e9931c

Browse files
committed
docs: fix gossipTimeout default value and unit
The documentation stated the default as 5 seconds, and the Javadoc listed it as 3. The actual code default is 3000 milliseconds. Updated both locations to reflect the correct value and unit.
1 parent 0320714 commit 6e9931c

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

docs/api/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ There are a number of query parameters that can be used in the connection string
8484
| `connectionName` | Any string | None | Connection name |
8585
| `maxDiscoverAttempts` | Number | `10` | Number of attempts to discover the cluster. |
8686
| `discoveryInterval` | Number | `100` | Cluster discovery polling interval in milliseconds. |
87-
| `gossipTimeout` | Number | `5` | Gossip timeout in seconds, when the gossip call times out, it will be retried. |
87+
| `gossipTimeout` | Number | `3000` | Gossip timeout in milliseconds, when the gossip call times out, it will be retried. |
8888
| `nodePreference` | `leader`, `follower`, `random`, `readOnlyReplica` | `leader` | Preferred node role. When creating a client for write operations, always use `leader`. |
8989
| `tlsVerifyCert` | `true`, `false` | `true` | In secure mode, set to `true` when using an untrusted connection to the node if you don't have the CA file available. Don't use in production. |
9090
| `tlsCaFile` | String, file path | None | Path to the CA file when connecting to a secure cluster with a certificate that's not signed by a trusted CA. |

src/main/java/io/kurrent/dbclient/KurrentDBClientSettings.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
* <ul>
1717
* <li>maxDiscoverAttempts: 3</li>
1818
* <li>discoveryInterval: 500</li>
19-
* <li>gossipTimeout: 3</li>
19+
* <li>gossipTimeout: 3000</li>
2020
* <li>nodePreference: leader</li>
2121
* <li>tls: true</li>
2222
* <li>tlsVerifyCert: true</li>

0 commit comments

Comments
 (0)