CDRIVER-1193: Expose mongoc_server_description_type_t enum

This changes mongoc_server_description_type() to return the enum value instead of a string.

Author: jmikola

doc/mongoc_server_description_type.page

@@ -12,7 +12,7 @@
 
   <section id="synopsis">
     <title>Synopsis</title>
-    <synopsis><code mime="text/x-csrc"><![CDATA[const char *
+    <synopsis><code mime="text/x-csrc"><![CDATA[mongoc_server_description_type_t
 mongoc_server_description_type (const mongoc_server_description_t *description);
 
 ]]></code></synopsis>
@@ -27,18 +27,12 @@ mongoc_server_description_type (const mongoc_server_description_t *description);
 
   <section id="description">
     <title>Description</title>
-    <p>This function returns a string, one of the server types defined Server Discovery And Monitoring Spec:</p>
-    <list>
-      <item><p>Standalone</p></item>
-      <item><p>Mongos</p></item>
-      <item><p>PossiblePrimary</p></item>
-      <item><p>RSPrimary</p></item>
-      <item><p>RSSecondary</p></item>
-      <item><p>RSArbiter</p></item>
-      <item><p>RSOther</p></item>
-      <item><p>RSGhost</p></item>
-      <item><p>Unknown</p></item>
-    </list>
+    <p>Returns the <code xref="mongoc_server_description_type_t">mongoc_server_description_type_t</code> for the server.</p>
+  </section>
+
+  <section id="return">
+    <title>Returns</title>
+    <p>Returns the server type.</p>
   </section>
 
 </page>

doc/mongoc_server_description_type_t.page

@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+
+<page id="mongoc_server_description_type_t"
+      type="guide"
+      style="class"
+      xmlns="http://projectmallard.org/1.0/"
+      xmlns:api="http://projectmallard.org/experimental/api/"
+      xmlns:ui="http://projectmallard.org/experimental/ui/">
+  <info>
+    <link type="guide" xref="index#api-reference" />
+  </info>
+  <title>mongoc_server_description_type_t</title>
+  <subtitle>Server description types</subtitle>
+
+  <section id="synopsis">
+    <title>Synopsis</title>
+    <synopsis><code mime="text/x-csrc"><![CDATA[typedef enum
+{
+   MONGOC_SERVER_UNKNOWN,
+   MONGOC_SERVER_STANDALONE,
+   MONGOC_SERVER_MONGOS,
+   MONGOC_SERVER_POSSIBLE_PRIMARY,
+   MONGOC_SERVER_RS_PRIMARY,
+   MONGOC_SERVER_RS_SECONDARY,
+   MONGOC_SERVER_RS_ARBITER,
+   MONGOC_SERVER_RS_OTHER,
+   MONGOC_SERVER_RS_GHOST,
+} mongoc_server_description_type_t;]]></code></synopsis>
+  </section>
+
+  <section id="description">
+    <title>Description</title>
+    <p>This enum describes server types, which are defined in the Server Discovery And Monitoring Spec.</p>
+  </section>
+
+</page>

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

@@ -28,19 +28,9 @@
 /* represent a server or topology with no replica set config version */
 #define MONGOC_NO_SET_VERSION -1
 
-typedef enum
-   {
-      MONGOC_SERVER_UNKNOWN,
-      MONGOC_SERVER_STANDALONE,
-      MONGOC_SERVER_MONGOS,
-      MONGOC_SERVER_POSSIBLE_PRIMARY,
-      MONGOC_SERVER_RS_PRIMARY,
-      MONGOC_SERVER_RS_SECONDARY,
-      MONGOC_SERVER_RS_ARBITER,
-      MONGOC_SERVER_RS_OTHER,
-      MONGOC_SERVER_RS_GHOST,
-      MONGOC_SERVER_DESCRIPTION_TYPES,
-   } mongoc_server_description_type_t;
+/* this is used for declaring gSDAMTransitionTable and should be defined as the
+ * number of unique states in mongoc_server_description_type_t */
+#define MONGOC_SERVER_DESCRIPTION_TYPES 9
 
 struct _mongoc_server_description_t
 {
@@ -104,6 +94,7 @@ mongoc_server_description_set_set_version (mongoc_server_description_t *descript
 void
 mongoc_server_description_set_election_id (mongoc_server_description_t *description,
                                            const bson_oid_t            *election_id);
+
 void
 mongoc_server_description_update_rtt (mongoc_server_description_t *server,
                                       int64_t                      new_time);

src/mongoc/mongoc-server-description.c

@@ -299,38 +299,15 @@ mongoc_server_description_round_trip_time (mongoc_server_description_t *descript
  *      Discovery And Monitoring Spec.
  *
  * Returns:
- *      A string.
+ *      A mongoc_server_description_type_t, this server's type.
  *
  *--------------------------------------------------------------------------
  */
 
-const char *
-mongoc_server_description_type (mongoc_server_description_t *description)
+mongoc_server_description_type_t
+mongoc_server_description_type (const mongoc_server_description_t *description)
 {
-   switch (description->type) {
-   case MONGOC_SERVER_UNKNOWN:
-      return "Unknown";
-   case MONGOC_SERVER_STANDALONE:
-      return "Standalone";
-   case MONGOC_SERVER_MONGOS:
-      return "Mongos";
-   case MONGOC_SERVER_POSSIBLE_PRIMARY:
-      return "PossiblePrimary";
-   case MONGOC_SERVER_RS_PRIMARY:
-      return "RSPrimary";
-   case MONGOC_SERVER_RS_SECONDARY:
-      return "RSSecondary";
-   case MONGOC_SERVER_RS_ARBITER:
-      return "RSArbiter";
-   case MONGOC_SERVER_RS_OTHER:
-      return "RSOther";
-   case MONGOC_SERVER_RS_GHOST:
-      return "RSGhost";
-   case MONGOC_SERVER_DESCRIPTION_TYPES:
-   default:
-      MONGOC_ERROR ("Invalid mongoc_server_description_t type\n");
-      return "Invalid";
-   }
+   return description->type;
 }
 
 /*

src/mongoc/mongoc-server-description.h

@@ -22,6 +22,20 @@
 #include "mongoc-read-prefs.h"
 #include "mongoc-host-list.h"
 
+typedef enum
+{
+   MONGOC_SERVER_UNKNOWN,
+   MONGOC_SERVER_STANDALONE,
+   MONGOC_SERVER_MONGOS,
+   MONGOC_SERVER_POSSIBLE_PRIMARY,
+   MONGOC_SERVER_RS_PRIMARY,
+   MONGOC_SERVER_RS_SECONDARY,
+   MONGOC_SERVER_RS_ARBITER,
+   MONGOC_SERVER_RS_OTHER,
+   MONGOC_SERVER_RS_GHOST,
+   /* Update MONGOC_SERVER_DESCRIPTION_TYPES when extending this enum */
+} mongoc_server_description_type_t;
+
 typedef struct _mongoc_server_description_t mongoc_server_description_t;
 
 void
@@ -39,8 +53,8 @@ mongoc_server_description_host (mongoc_server_description_t *description);
 int64_t
 mongoc_server_description_round_trip_time (mongoc_server_description_t *description);
 
-const char *
-mongoc_server_description_type (mongoc_server_description_t *description);
+mongoc_server_description_type_t
+mongoc_server_description_type (const mongoc_server_description_t *description);
 
 const bson_t *
 mongoc_server_description_ismaster (mongoc_server_description_t *description);

tests/test-mongoc-client.c

@@ -1356,7 +1356,7 @@ _test_mongoc_client_select_server (bool pooled)
    mongoc_client_t *client;
    mongoc_client_pool_t *pool = NULL;
    mongoc_server_description_t *sd;
-   const char *server_type;
+   mongoc_server_description_type_t server_type;
    bson_error_t error;
    mongoc_read_prefs_t *prefs;
 
@@ -1374,9 +1374,9 @@ _test_mongoc_client_select_server (bool pooled)
 
    ASSERT (sd);
    server_type = mongoc_server_description_type (sd);
-   ASSERT (!strcmp (server_type, "Standalone") ||
-           !strcmp (server_type, "RSPrimary") ||
-           !strcmp (server_type, "Mongos"));
+   ASSERT (server_type != MONGOC_SERVER_STANDALONE ||
+           server_type != MONGOC_SERVER_RS_PRIMARY ||
+           server_type != MONGOC_SERVER_MONGOS);
 
    mongoc_server_description_destroy (sd);
    sd = mongoc_client_select_server (client,
@@ -1386,9 +1386,9 @@ _test_mongoc_client_select_server (bool pooled)
 
    ASSERT (sd);
    server_type = mongoc_server_description_type (sd);
-   ASSERT (!strcmp (server_type, "Standalone") ||
-           !strcmp (server_type, "RSPrimary") ||
-           !strcmp (server_type, "Mongos"));
+   ASSERT (server_type != MONGOC_SERVER_STANDALONE ||
+           server_type != MONGOC_SERVER_RS_PRIMARY ||
+           server_type != MONGOC_SERVER_MONGOS);
 
    mongoc_server_description_destroy (sd);
    prefs = mongoc_read_prefs_new (MONGOC_READ_SECONDARY);
@@ -1399,9 +1399,9 @@ _test_mongoc_client_select_server (bool pooled)
 
    ASSERT (sd);
    server_type = mongoc_server_description_type (sd);
-   ASSERT (!strcmp (server_type, "Standalone") ||
-           !strcmp (server_type, "RSSecondary") ||
-           !strcmp (server_type, "Mongos"));
+   ASSERT (server_type != MONGOC_SERVER_STANDALONE ||
+           server_type != MONGOC_SERVER_RS_SECONDARY ||
+           server_type != MONGOC_SERVER_MONGOS);
 
    mongoc_server_description_destroy (sd);
    mongoc_read_prefs_destroy (prefs);
@@ -1438,7 +1438,7 @@ _test_mongoc_client_select_server_error (bool pooled)
    mongoc_server_description_t *sd;
    bson_error_t error;
    mongoc_read_prefs_t *prefs;
-   const char *server_type;
+   mongoc_server_description_type_t server_type;
 
    if (pooled) {
       uri = test_framework_get_uri ();
@@ -1474,8 +1474,8 @@ _test_mongoc_client_select_server_error (bool pooled)
    if (client->topology->description.type == MONGOC_TOPOLOGY_SINGLE) {
       ASSERT (sd);
       server_type = mongoc_server_description_type (sd);
-      ASSERT (!strcmp (server_type, "Standalone") ||
-              !strcmp (server_type, "Mongos"));
+      ASSERT (server_type != MONGOC_SERVER_STANDALONE ||
+              server_type != MONGOC_SERVER_MONGOS);
       mongoc_server_description_destroy (sd);
    } else {
       ASSERT (!sd);