CDRIVER-1541 add const to return of mongoc_server_description_host (#1915)

Author: kevinAlbs

NEWS

@@ -7,6 +7,7 @@ Unreleased (2.0.0)
   now applies `batchSize:0` to the `aggregate` command. Useful to request an immediate cursor. Previously the value
   was ignored.
 * `bson_oid_init_sequence` is removed. Use `bson_oid_init` instead.
+* `mongoc_server_description_host` changes the return type from `mongoc_host_list_t *` to `const mongoc_host_list_t *`.
 
 ## Removals
 

src/libmongoc/doc/mongoc_server_description_host.rst

@@ -8,7 +8,7 @@ Synopsis
 
 .. code-block:: c
 
-  mongoc_host_list_t *
+  const mongoc_host_list_t *
   mongoc_server_description_host (const mongoc_server_description_t *description);
 
 Parameters
@@ -24,5 +24,7 @@ Return the server's host and port. This object is owned by the server descriptio
 Returns
 -------
 
-A reference to the server description's :symbol:`mongoc_host_list_t`, which you must not modify or free.
+.. versionchanged:: 2.0.0 The return type changed from ``mongoc_host_list_t *`` to ``const mongoc_host_list_t *``.
+
+A reference to the server description's :symbol:`mongoc_host_list_t`.
 

src/libmongoc/src/mongoc/mongoc-server-description.c

@@ -287,13 +287,12 @@ mongoc_server_description_id (const mongoc_server_description_t *description)
  *      Return a reference to the host associated with this server description.
  *
  * Returns:
- *      This server description's host, a mongoc_host_list_t * you must
- *      not modify or free.
+ *      This server description's host, a const mongoc_host_list_t *.
  *
  *--------------------------------------------------------------------------
  */
 
-mongoc_host_list_t *
+const mongoc_host_list_t *
 mongoc_server_description_host (const mongoc_server_description_t *description)
 {
    return &((mongoc_server_description_t *) description)->host;

src/libmongoc/src/mongoc/mongoc-server-description.h

@@ -38,7 +38,7 @@ mongoc_server_description_new_copy (const mongoc_server_description_t *descripti
 MONGOC_EXPORT (uint32_t)
 mongoc_server_description_id (const mongoc_server_description_t *description);
 
-MONGOC_EXPORT (mongoc_host_list_t *)
+MONGOC_EXPORT (const mongoc_host_list_t *)
 mongoc_server_description_host (const mongoc_server_description_t *description);
 
 MONGOC_EXPORT (int64_t)

src/libmongoc/tests/test-mongoc-sdam.c

@@ -533,7 +533,7 @@ test_topology_discovery (void *ctx)
    mongoc_client_t *client;
    mongoc_read_prefs_t *prefs;
    mongoc_server_description_t *sd_secondary;
-   mongoc_host_list_t *hl_secondary;
+   const mongoc_host_list_t *hl_secondary;
    mongoc_collection_t *collection;
    bson_t doc = BSON_INITIALIZER;
    bson_t reply;
@@ -597,7 +597,7 @@ test_direct_connection (void *ctx)
    mongoc_client_t *client;
    mongoc_read_prefs_t *prefs;
    mongoc_server_description_t *sd_secondary;
-   mongoc_host_list_t *hl_secondary;
+   const mongoc_host_list_t *hl_secondary;
    mongoc_collection_t *collection;
    bson_t doc = BSON_INITIALIZER;
    bson_t reply;
@@ -662,7 +662,7 @@ test_existing_behavior (void *ctx)
    mongoc_client_t *client;
    mongoc_read_prefs_t *prefs;
    mongoc_server_description_t *sd_secondary;
-   mongoc_host_list_t *hl_secondary;
+   const mongoc_host_list_t *hl_secondary;
    mongoc_collection_t *collection;
    bson_t doc = BSON_INITIALIZER;
    bson_t reply;