CDRIVER-3535 add awaited to heartbeat events (#621)

Currently always false, but after streamable ismaster, it will be true
for awaitable isMaster commands.

Author: kevinAlbs

src/libmongoc/doc/mongoc_apm_server_heartbeat_failed_get_awaited.rst

@@ -0,0 +1,31 @@
+:man_page: mongoc_apm_server_heartbeat_failed_get_awaited
+
+mongoc_apm_server_heartbeat_failed_get_awaited()
+================================================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+  bool
+  mongoc_apm_server_heartbeat_failed_get_awaited (
+     const mongoc_apm_server_heartbeat_failed_t *event);
+
+Returns whether this event came from an awaitable isMaster.
+
+Parameters
+----------
+
+* ``event``: A :symbol:`mongoc_apm_server_heartbeat_failed_t`.
+
+Returns
+-------
+
+A bool indicating whether the heartbeat event came from an awaitable isMaster.
+
+See Also
+--------
+
+:doc:`Introduction to Application Performance Monitoring <application-performance-monitoring>`
+

src/libmongoc/doc/mongoc_apm_server_heartbeat_failed_t.rst

@@ -24,6 +24,7 @@ See Also
     :titlesonly:
     :maxdepth: 1
 
+    mongoc_apm_server_heartbeat_failed_get_awaited
     mongoc_apm_server_heartbeat_failed_get_context
     mongoc_apm_server_heartbeat_failed_get_duration
     mongoc_apm_server_heartbeat_failed_get_error

src/libmongoc/doc/mongoc_apm_server_heartbeat_started_get_awaited.rst

@@ -0,0 +1,31 @@
+:man_page: mongoc_apm_server_heartbeat_started_get_awaited
+
+mongoc_apm_server_heartbeat_started_get_awaited()
+=================================================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+  bool
+  mongoc_apm_server_heartbeat_started_get_awaited (
+     const mongoc_apm_server_heartbeat_started_t *event);
+
+Returns whether this event came from an awaitable isMaster.
+
+Parameters
+----------
+
+* ``event``: A :symbol:`mongoc_apm_server_heartbeat_started_t`.
+
+Returns
+-------
+
+A bool indicating whether the heartbeat event came from an awaitable isMaster.
+
+See Also
+--------
+
+:doc:`Introduction to Application Performance Monitoring <application-performance-monitoring>`
+

src/libmongoc/doc/mongoc_apm_server_heartbeat_started_t.rst

@@ -24,6 +24,7 @@ See Also
     :titlesonly:
     :maxdepth: 1
 
+    mongoc_apm_server_heartbeat_started_get_awaited
     mongoc_apm_server_heartbeat_started_get_context
     mongoc_apm_server_heartbeat_started_get_host
 

src/libmongoc/doc/mongoc_apm_server_heartbeat_succeeded_get_awaited.rst

@@ -0,0 +1,31 @@
+:man_page: mongoc_apm_server_heartbeat_succeeded_get_awaited
+
+mongoc_apm_server_heartbeat_succeeded_get_awaited()
+===================================================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+  bool
+  mongoc_apm_server_heartbeat_succeeded_get_awaited (
+     const mongoc_apm_server_heartbeat_succeeded_t *event);
+
+Returns whether this event came from an awaitable isMaster.
+
+Parameters
+----------
+
+* ``event``: A :symbol:`mongoc_apm_server_heartbeat_succeeded_t`.
+
+Returns
+-------
+
+A bool indicating whether the heartbeat event came from an awaitable isMaster.
+
+See Also
+--------
+
+:doc:`Introduction to Application Performance Monitoring <application-performance-monitoring>`
+

src/libmongoc/doc/mongoc_apm_server_heartbeat_succeeded_t.rst

@@ -24,6 +24,7 @@ See Also
     :titlesonly:
     :maxdepth: 1
 
+    mongoc_apm_server_heartbeat_succeeded_get_awaited
     mongoc_apm_server_heartbeat_succeeded_get_context
     mongoc_apm_server_heartbeat_succeeded_get_duration
     mongoc_apm_server_heartbeat_succeeded_get_host

src/libmongoc/src/mongoc/mongoc-apm-private.h

@@ -125,20 +125,23 @@ struct _mongoc_apm_topology_closed_t {
 struct _mongoc_apm_server_heartbeat_started_t {
    const mongoc_host_list_t *host;
    void *context;
+   bool awaited;
 };
 
 struct _mongoc_apm_server_heartbeat_succeeded_t {
    int64_t duration_usec;
    const bson_t *reply;
    const mongoc_host_list_t *host;
    void *context;
+   bool awaited;
 };
 
 struct _mongoc_apm_server_heartbeat_failed_t {
    int64_t duration_usec;
    const bson_error_t *error;
    const mongoc_host_list_t *host;
    void *context;
+   bool awaited;
 };
 
 void

src/libmongoc/src/mongoc/mongoc-apm.c

@@ -570,6 +570,13 @@ mongoc_apm_server_heartbeat_started_get_context (
    return event->context;
 }
 
+bool
+mongoc_apm_server_heartbeat_started_get_awaited (
+   const mongoc_apm_server_heartbeat_started_t *event)
+{
+   return event->awaited;
+}
+
 
 /* heartbeat-succeeded event fields */
 
@@ -604,6 +611,13 @@ mongoc_apm_server_heartbeat_succeeded_get_context (
    return event->context;
 }
 
+bool
+mongoc_apm_server_heartbeat_succeeded_get_awaited (
+   const mongoc_apm_server_heartbeat_succeeded_t *event)
+{
+   return event->awaited;
+}
+
 
 /* heartbeat-failed event fields */
 
@@ -638,6 +652,12 @@ mongoc_apm_server_heartbeat_failed_get_context (
    return event->context;
 }
 
+bool
+mongoc_apm_server_heartbeat_failed_get_awaited (
+   const mongoc_apm_server_heartbeat_failed_t *event)
+{
+   return event->awaited;
+}
 
 /*
  * registering callbacks

src/libmongoc/src/mongoc/mongoc-apm.h

@@ -238,6 +238,9 @@ mongoc_apm_server_heartbeat_started_get_host (
 MONGOC_EXPORT (void *)
 mongoc_apm_server_heartbeat_started_get_context (
    const mongoc_apm_server_heartbeat_started_t *event);
+MONGOC_EXPORT (bool)
+mongoc_apm_server_heartbeat_started_get_awaited (
+   const mongoc_apm_server_heartbeat_started_t *event);
 
 /* heartbeat-succeeded event fields */
 
@@ -253,6 +256,9 @@ mongoc_apm_server_heartbeat_succeeded_get_host (
 MONGOC_EXPORT (void *)
 mongoc_apm_server_heartbeat_succeeded_get_context (
    const mongoc_apm_server_heartbeat_succeeded_t *event);
+MONGOC_EXPORT (bool)
+mongoc_apm_server_heartbeat_succeeded_get_awaited (
+   const mongoc_apm_server_heartbeat_succeeded_t *event);
 
 /* heartbeat-failed event fields */
 
@@ -268,6 +274,9 @@ mongoc_apm_server_heartbeat_failed_get_host (
 MONGOC_EXPORT (void *)
 mongoc_apm_server_heartbeat_failed_get_context (
    const mongoc_apm_server_heartbeat_failed_t *event);
+MONGOC_EXPORT (bool)
+mongoc_apm_server_heartbeat_failed_get_awaited (
+   const mongoc_apm_server_heartbeat_failed_t *event);
 
 
 /*

src/libmongoc/src/mongoc/mongoc-topology-scanner.c

@@ -1205,6 +1205,7 @@ _mongoc_topology_scanner_monitor_heartbeat_started (
       mongoc_apm_server_heartbeat_started_t event;
       event.host = host;
       event.context = ts->apm_context;
+      event.awaited = false;
       ts->apm_callbacks.server_heartbeat_started (&event);
    }
 }
@@ -1229,6 +1230,7 @@ _mongoc_topology_scanner_monitor_heartbeat_succeeded (
       event.context = ts->apm_context;
       event.reply = reply;
       event.duration_usec = duration_usec;
+      event.awaited = false;
       ts->apm_callbacks.server_heartbeat_succeeded (&event);
 
       bson_destroy (&ismaster_redacted);
@@ -1249,6 +1251,7 @@ _mongoc_topology_scanner_monitor_heartbeat_failed (
       event.context = ts->apm_context;
       event.error = error;
       event.duration_usec = duration_usec;
+      event.awaited = false;
       ts->apm_callbacks.server_heartbeat_failed (&event);
    }
 }