Skip to content

Commit 01c04a9

Browse files
committed
add timeout_ms
1 parent c6cbcf2 commit 01c04a9

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

source/connect/connection-options.txt

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,8 @@ Timeouts
120120
| **Connection URI Example**: ``connectTimeoutMS=10000``
121121

122122
* - **:socket_timeout**
123-
- | The number of seconds to wait for an operation to execute on
123+
- | *Deprecated as of v2.21: Use ``timeout_ms`` instead*
124+
| The number of seconds to wait for an operation to execute on
124125
a socket before raising an exception.
125126
|
126127
| ``nil`` and ``0`` mean no timeout. Client creation will fail
@@ -132,8 +133,22 @@ Timeouts
132133
| **Client Example**: ``socket_timeout: 5.0``
133134
| **Connection URI Example**: ``socketTimeoutMS=5000``
134135

136+
* - **:timeout_ms**
137+
- | The number of milliseconds to wait for an operation to execute
138+
before raising an exception.
139+
|
140+
| ``0`` means no timeout. Client creation will fail
141+
with an error if an invalid timeout value is passed
142+
(such as a negative value or a non-numeric value).
143+
|
144+
| **Data Type**: ``Integer``
145+
| **Default**: none
146+
| **Client Example**: ``timeout_ms: 5000``
147+
| **Connection URI Example**: ``timeoutMS=5000``
148+
135149
* - **:wait_queue_timeout**
136-
- | The number of seconds to wait for a connection in the
150+
- | *Deprecated as of v2.21: Use ``timeout_ms`` instead*
151+
The number of seconds to wait for a connection in the
137152
connection pool to become available.
138153
|
139154
| **Data Type**: ``Float``

0 commit comments

Comments
 (0)