CDRIVER-3396 add 64-bit support for wTimeoutMS

Author: alcaeus

src/libmongoc/doc/mongoc_uri_get_option_as_int32.rst

@@ -8,10 +8,10 @@ Synopsis
 
 .. code-block:: c
 
-  int32
+  int32_t
   mongoc_uri_get_option_as_int32 (const mongoc_uri_t *uri,
                                   const char *option,
-                                  int32 fallback);
+                                  int32_t fallback);
 
 Parameters
 ----------
@@ -23,7 +23,7 @@ Parameters
 Description
 -----------
 
-Returns the value of the URI option if it is set and of the correct type (int32). Returns ``fallback`` if the option is not set, set to an invalid type, or zero.
+Returns the value of the URI option if it is set and of the correct type (integer). Returns ``fallback`` if the option is not set, set to an invalid type, or zero.
 
 Zero is considered "unset", so URIs can be constructed like so, and still accept default values:
 
@@ -33,3 +33,9 @@ Zero is considered "unset", so URIs can be constructed like so, and still accept
 
 If ``myvalue`` is non-zero it is the connection timeout; if it is zero the driver uses the default timeout.
 
+When reading an option that is an int64, this function will return the value as ``int32_t``. If the value is outside the range of a 32-bit integer, a warning will be emitted and ``fallback`` is returned instead.
+
+See Also
+--------
+
+* :symbol:`mongoc_uri_get_option_as_int64()`

src/libmongoc/doc/mongoc_uri_get_option_as_int64.rst

@@ -0,0 +1,39 @@
+:man_page: mongoc_uri_get_option_as_int64
+
+mongoc_uri_get_option_as_int64()
+================================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+  int64_t
+  mongoc_uri_get_option_as_int64 (const mongoc_uri_t *uri,
+                                  const char *option,
+                                  int64_t fallback);
+
+Parameters
+----------
+
+* ``uri``: A :symbol:`mongoc_uri_t`.
+* ``option``: The name of an option, case insensitive.
+* ``fallback``: A default value to return.
+
+Description
+-----------
+
+Returns the value of the URI option if it is set and of the correct type (integer). Returns ``fallback`` if the option is not set, set to an invalid type, or zero.
+
+Zero is considered "unset", so URIs can be constructed like so, and still accept default values:
+
+.. code-block:: c
+
+  bson_strdup_printf ("mongodb://localhost/?wTimeoutMS=%" PRId64, myvalue)
+
+If ``myvalue`` is non-zero it is the write concern timeout; if it is zero the driver uses the default timeout.
+
+See Also
+--------
+
+* :symbol:`mongoc_uri_get_option_as_int32()`

src/libmongoc/doc/mongoc_uri_option_is_int32.rst

@@ -19,5 +19,9 @@ Parameters
 Description
 -----------
 
-Returns true if the option is a known MongoDB URI option of integer type. For example, "socketTimeoutMS=100" is a valid MongoDB URI option, so ``mongoc_uri_option_is_int32 ("connectTimeoutMS")`` is true.
+Returns true if the option is a known MongoDB URI option of integer type. For example, "zlibCompressionLevel=5" is a valid integer MongoDB URI option, so ``mongoc_uri_option_is_int32 ("zlibCompressionLevel")`` is true. This will also return true for all 64-bit integer options.
 
+See Also
+--------
+
+* :symbol:`mongoc_uri_option_is_int64()`

src/libmongoc/doc/mongoc_uri_option_is_int64.rst

@@ -0,0 +1,27 @@
+:man_page: mongoc_uri_option_is_int64
+
+mongoc_uri_option_is_int64()
+============================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+  bool
+  mongoc_uri_option_is_int64 (const char *option);
+
+Parameters
+----------
+
+* ``option``: The name of an option, case insensitive.
+
+Description
+-----------
+
+Returns true if the option is a known MongoDB URI option of 64-bit integer type. For example, "wTimeoutMS=100" is a valid 64-bit integer MongoDB URI option, so ``mongoc_uri_option_is_int64 ("wTimeoutMS")`` is true.
+
+See Also
+--------
+
+* :symbol:`mongoc_uri_option_is_int32()`

src/libmongoc/doc/mongoc_uri_set_option_as_int32.rst

@@ -11,7 +11,7 @@ Synopsis
   bool
   mongoc_uri_set_option_as_int32 (const mongoc_uri_t *uri,
                                   const char *option,
-                                  int32 value);
+                                  int32_t value);
 
 Parameters
 ----------
@@ -25,11 +25,16 @@ Description
 
 Sets an individual URI option, after the URI has been parsed from a string.
 
-Only known options of type int32 can be set. Some int32 options, such as :ref:`minHeartbeatFrequencyMS <sdam_uri_options>`, have additional constraints.
+Only known options of type integer can be set. Some integer options, such as :ref:`minHeartbeatFrequencyMS <sdam_uri_options>`, have additional constraints.
 
 Updates the option in-place if already set, otherwise appends it to the URI's :symbol:`bson:bson_t` of options.
 
 Returns
 -------
 
-True if successfully set (the named option is a known option of type int32).
+True if successfully set (the named option is a known option of type int32 or int64).
+
+See Also
+--------
+
+* :symbol:`mongoc_uri_set_option_as_int64()`

src/libmongoc/doc/mongoc_uri_set_option_as_int64.rst

@@ -0,0 +1,41 @@
+:man_page: mongoc_uri_set_option_as_int64
+
+mongoc_uri_set_option_as_int64()
+================================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+  bool
+  mongoc_uri_set_option_as_int64 (const mongoc_uri_t *uri,
+                                  const char *option,
+                                  int64_t value);
+
+Parameters
+----------
+
+* ``uri``: A :symbol:`mongoc_uri_t`.
+* ``option``: The name of an option, case insensitive.
+* ``value``: The new value.
+
+Description
+-----------
+
+Sets an individual URI option, after the URI has been parsed from a string.
+
+Only known options of type int32 or int64 can be set. For 32-bit integer options, the function returns ``false`` when trying to set a 64-bit value that exceeds the range of an ``int32_t``. Values that fit into an ``int32_t`` will be set correctly. In both cases, a warning will be emitted.
+
+Updates the option in-place if already set, otherwise appends it to the URI's :symbol:`bson:bson_t` of options.
+
+Returns
+-------
+
+True if successfully set (the named option is a known option of type int64).
+
+See Also
+--------
+
+* :symbol:`mongoc_uri_option_is_int64()`
+* :symbol:`mongoc_uri_set_option_as_int32()`

src/libmongoc/doc/mongoc_uri_t.rst

@@ -295,6 +295,7 @@ MONGOC_URI_SLAVEOK                         slaveok                           Whe
     mongoc_uri_get_mechanism_properties
     mongoc_uri_get_option_as_bool
     mongoc_uri_get_option_as_int32
+    mongoc_uri_get_option_as_int64
     mongoc_uri_get_option_as_utf8
     mongoc_uri_get_options
     mongoc_uri_get_password
@@ -313,6 +314,7 @@ MONGOC_URI_SLAVEOK                         slaveok                           Whe
     mongoc_uri_new_with_error
     mongoc_uri_option_is_bool
     mongoc_uri_option_is_int32
+    mongoc_uri_option_is_int64
     mongoc_uri_option_is_utf8
     mongoc_uri_set_auth_mechanism
     mongoc_uri_set_auth_source
@@ -321,6 +323,7 @@ MONGOC_URI_SLAVEOK                         slaveok                           Whe
     mongoc_uri_set_mechanism_properties
     mongoc_uri_set_option_as_bool
     mongoc_uri_set_option_as_int32
+    mongoc_uri_set_option_as_int64
     mongoc_uri_set_option_as_utf8
     mongoc_uri_set_password
     mongoc_uri_set_read_concern