From 720bdd4982ce6fba556d121e6857638083444388 Mon Sep 17 00:00:00 2001 From: norareidy Date: Mon, 25 Mar 2024 14:50:25 -0400 Subject: [PATCH] rest of apm methods --- ...mongoc_apm_server_opening_get_context.txt} | 3 +- ...=> mongoc_apm_server_opening_get_host.txt} | 11 ++++--- ...oc_apm_server_opening_get_topology_id.txt} | 9 ++--- ..._t.rst => mongoc_apm_server_opening_t.txt} | 6 ++-- ...t => mongoc_apm_set_command_failed_cb.txt} | 16 +++++---- ... => mongoc_apm_set_command_started_cb.txt} | 16 +++++---- ...> mongoc_apm_set_command_succeeded_cb.txt} | 14 ++++---- ...t => mongoc_apm_set_server_changed_cb.txt} | 16 +++++---- ...st => mongoc_apm_set_server_closed_cb.txt} | 19 ++++++----- ...oc_apm_set_server_heartbeat_failed_cb.txt} | 11 ++++--- ...oc_apm_set_server_heartbeat_started_cb.rst | 29 ---------------- ...oc_apm_set_server_heartbeat_started_cb.txt | 32 ++++++++++++++++++ ..._apm_set_server_heartbeat_succeeded_cb.rst | 29 ---------------- ..._apm_set_server_heartbeat_succeeded_cb.txt | 32 ++++++++++++++++++ .../mongoc_apm_set_server_opening_cb.rst | 29 ---------------- .../mongoc_apm_set_server_opening_cb.txt | 32 ++++++++++++++++++ .../mongoc_apm_set_topology_changed_cb.rst | 29 ---------------- .../mongoc_apm_set_topology_changed_cb.txt | 33 +++++++++++++++++++ .../mongoc_apm_set_topology_closed_cb.rst | 29 ---------------- .../mongoc_apm_set_topology_closed_cb.txt | 32 ++++++++++++++++++ ...=> mongoc_apm_set_topology_opening_cb.txt} | 13 ++++---- ...ngoc_apm_topology_changed_get_context.txt} | 9 ++--- ..._topology_changed_get_new_description.txt} | 12 ++++--- ...logy_changed_get_previous_description.txt} | 12 ++++--- ..._apm_topology_changed_get_topology_id.txt} | 9 ++--- ....rst => mongoc_apm_topology_changed_t.txt} | 6 ++-- ...ongoc_apm_topology_closed_get_context.txt} | 3 +- ...c_apm_topology_closed_get_topology_id.txt} | 9 ++--- ...t.rst => mongoc_apm_topology_closed_t.txt} | 6 ++-- ...ngoc_apm_topology_opening_get_context.txt} | 9 ++--- ..._apm_topology_opening_get_topology_id.txt} | 9 ++--- ....rst => mongoc_apm_topology_opening_t.txt} | 15 +++++---- 32 files changed, 295 insertions(+), 244 deletions(-) rename source/docs-libmongoc/application-performance-monitoring/{mongoc_apm_server_opening_get_context.rst => mongoc_apm_server_opening_get_context.txt} (87%) rename source/docs-libmongoc/application-performance-monitoring/{mongoc_apm_server_opening_get_host.rst => mongoc_apm_server_opening_get_host.txt} (53%) rename source/docs-libmongoc/application-performance-monitoring/{mongoc_apm_server_opening_get_topology_id.rst => mongoc_apm_server_opening_get_topology_id.txt} (68%) rename source/docs-libmongoc/application-performance-monitoring/{mongoc_apm_server_opening_t.rst => mongoc_apm_server_opening_t.txt} (78%) rename source/docs-libmongoc/application-performance-monitoring/{mongoc_apm_set_command_failed_cb.rst => mongoc_apm_set_command_failed_cb.txt} (55%) rename source/docs-libmongoc/application-performance-monitoring/{mongoc_apm_set_command_started_cb.rst => mongoc_apm_set_command_started_cb.txt} (53%) rename source/docs-libmongoc/application-performance-monitoring/{mongoc_apm_set_command_succeeded_cb.rst => mongoc_apm_set_command_succeeded_cb.txt} (61%) rename source/docs-libmongoc/application-performance-monitoring/{mongoc_apm_set_server_changed_cb.rst => mongoc_apm_set_server_changed_cb.txt} (58%) rename source/docs-libmongoc/application-performance-monitoring/{mongoc_apm_set_server_closed_cb.rst => mongoc_apm_set_server_closed_cb.txt} (51%) rename source/docs-libmongoc/application-performance-monitoring/{mongoc_apm_set_server_heartbeat_failed_cb.rst => mongoc_apm_set_server_heartbeat_failed_cb.txt} (66%) delete mode 100644 source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_started_cb.rst create mode 100644 source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_started_cb.txt delete mode 100644 source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_succeeded_cb.rst create mode 100644 source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_succeeded_cb.txt delete mode 100644 source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_opening_cb.rst create mode 100644 source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_opening_cb.txt delete mode 100644 source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_topology_changed_cb.rst create mode 100644 source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_topology_changed_cb.txt delete mode 100644 source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_topology_closed_cb.rst create mode 100644 source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_topology_closed_cb.txt rename source/docs-libmongoc/application-performance-monitoring/{mongoc_apm_set_topology_opening_cb.rst => mongoc_apm_set_topology_opening_cb.txt} (62%) rename source/docs-libmongoc/application-performance-monitoring/{mongoc_apm_topology_changed_get_context.rst => mongoc_apm_topology_changed_get_context.txt} (71%) rename source/docs-libmongoc/application-performance-monitoring/{mongoc_apm_topology_changed_get_new_description.rst => mongoc_apm_topology_changed_get_new_description.txt} (58%) rename source/docs-libmongoc/application-performance-monitoring/{mongoc_apm_topology_changed_get_previous_description.rst => mongoc_apm_topology_changed_get_previous_description.txt} (57%) rename source/docs-libmongoc/application-performance-monitoring/{mongoc_apm_topology_changed_get_topology_id.rst => mongoc_apm_topology_changed_get_topology_id.txt} (68%) rename source/docs-libmongoc/application-performance-monitoring/{mongoc_apm_topology_changed_t.rst => mongoc_apm_topology_changed_t.txt} (78%) rename source/docs-libmongoc/application-performance-monitoring/{mongoc_apm_topology_closed_get_context.rst => mongoc_apm_topology_closed_get_context.txt} (87%) rename source/docs-libmongoc/application-performance-monitoring/{mongoc_apm_topology_closed_get_topology_id.rst => mongoc_apm_topology_closed_get_topology_id.txt} (68%) rename source/docs-libmongoc/application-performance-monitoring/{mongoc_apm_topology_closed_t.rst => mongoc_apm_topology_closed_t.txt} (76%) rename source/docs-libmongoc/application-performance-monitoring/{mongoc_apm_topology_opening_get_context.rst => mongoc_apm_topology_opening_get_context.txt} (71%) rename source/docs-libmongoc/application-performance-monitoring/{mongoc_apm_topology_opening_get_topology_id.rst => mongoc_apm_topology_opening_get_topology_id.txt} (68%) rename source/docs-libmongoc/application-performance-monitoring/{mongoc_apm_topology_opening_t.rst => mongoc_apm_topology_opening_t.txt} (61%) diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_get_context.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_get_context.txt similarity index 87% rename from source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_get_context.rst rename to source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_get_context.txt index db1350f6..c691490b 100644 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_get_context.rst +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_get_context.txt @@ -1,5 +1,6 @@ -.. _mongoc_apm_server_opening_get_context +.. _mongoc_apm_server_opening_get_context: +======================================= mongoc_apm_server_opening_get_context() ======================================= diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_get_host.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_get_host.txt similarity index 53% rename from source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_get_host.rst rename to source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_get_host.txt index 11b9a99d..b826c873 100644 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_get_host.rst +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_get_host.txt @@ -1,5 +1,6 @@ -.. _mongoc_apm_server_opening_get_host +.. _mongoc_apm_server_opening_get_host: +==================================== mongoc_apm_server_opening_get_host() ==================================== @@ -8,10 +9,12 @@ Synopsis .. code-block:: c - const mongoc_host_list_t * - mongoc_apm_server_opening_get_host (const mongoc_apm_server_opening_t *event); + const mongoc_host_list_t * + mongoc_apm_server_opening_get_host (const mongoc_apm_server_opening_t *event); -Returns this event's host. This :ref:`mongoc_host_list_t` is *not- part of a linked list, it is solely the server for this event. The data is only valid in the scope of the callback that receives this event; copy it if it will be accessed after the callback returns. +Returns this event's host. This :ref:`mongoc_host_list_t` is *not* part of a linked list, +it is solely the server for this event. The data is only valid in the scope of the callback +that receives this event; copy it if it will be accessed after the callback returns. Parameters ---------- diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_get_topology_id.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_get_topology_id.txt similarity index 68% rename from source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_get_topology_id.rst rename to source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_get_topology_id.txt index 7ff3581d..9ae99137 100644 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_get_topology_id.rst +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_get_topology_id.txt @@ -1,5 +1,6 @@ -.. _mongoc_apm_server_opening_get_topology_id +.. _mongoc_apm_server_opening_get_topology_id: +=========================================== mongoc_apm_server_opening_get_topology_id() =========================================== @@ -8,9 +9,9 @@ Synopsis .. code-block:: c - void - mongoc_apm_server_opening_get_topology_id ( - const mongoc_apm_server_opening_t *event, bson_oid_t *topology_id); + void + mongoc_apm_server_opening_get_topology_id ( + const mongoc_apm_server_opening_t *event, bson_oid_t *topology_id); Returns this event's topology id. diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_t.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_t.txt similarity index 78% rename from source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_t.rst rename to source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_t.txt index 683967a0..fff8d697 100644 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_t.rst +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_server_opening_t.txt @@ -1,5 +1,6 @@ -.. _mongoc_apm_server_opening_t +.. _mongoc_apm_server_opening_t: +=========================== mongoc_apm_server_opening_t =========================== @@ -8,7 +9,8 @@ Server-opening event Synopsis -------- -An event notification sent when the driver adds a :ref:`mongoc_server_description_t` for a new server it was not monitoring before. +An event notification sent when the driver adds a :ref:`mongoc_server_description_t` for a new +server it was not monitoring before. .. seealso:: diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_command_failed_cb.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_command_failed_cb.txt similarity index 55% rename from source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_command_failed_cb.rst rename to source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_command_failed_cb.txt index 4f202586..8fc75715 100644 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_command_failed_cb.rst +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_command_failed_cb.txt @@ -1,5 +1,6 @@ -.. _mongoc_apm_set_command_failed_cb +.. _mongoc_apm_set_command_failed_cb: +================================== mongoc_apm_set_command_failed_cb() ================================== @@ -8,12 +9,12 @@ Synopsis .. code-block:: c - typedef void (*mongoc_apm_command_failed_cb_t) ( - const mongoc_apm_command_failed_t *event); + typedef void (*mongoc_apm_command_failed_cb_t) ( + const mongoc_apm_command_failed_t *event); - void - mongoc_apm_set_command_failed_cb (mongoc_apm_callbacks_t *callbacks, - mongoc_apm_command_failed_cb_t cb); + void + mongoc_apm_set_command_failed_cb (mongoc_apm_callbacks_t *callbacks, + mongoc_apm_command_failed_cb_t cb); Receive an event notification whenever the driver fails to execute a MongoDB operation. @@ -21,7 +22,8 @@ Parameters ---------- - ``callbacks``: A :ref:`mongoc_apm_callbacks_t`. -- ``cb``: A function to call with a :ref:`mongoc_apm_command_failed_t` whenever a MongoDB operation fails. +- ``cb``: A function to call with a :ref:`mongoc_apm_command_failed_t` whenever a MongoDB + operation fails. .. seealso:: diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_command_started_cb.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_command_started_cb.txt similarity index 53% rename from source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_command_started_cb.rst rename to source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_command_started_cb.txt index c5cef340..73c0de38 100644 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_command_started_cb.rst +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_command_started_cb.txt @@ -1,5 +1,6 @@ -.. _mongoc_apm_set_command_started_cb +.. _mongoc_apm_set_command_started_cb: +=================================== mongoc_apm_set_command_started_cb() =================================== @@ -8,12 +9,12 @@ Synopsis .. code-block:: c - typedef void (*mongoc_apm_command_started_cb_t) ( - const mongoc_apm_command_started_t *event); + typedef void (*mongoc_apm_command_started_cb_t) ( + const mongoc_apm_command_started_t *event); - void - mongoc_apm_set_command_started_cb (mongoc_apm_callbacks_t *callbacks, - mongoc_apm_command_started_cb_t cb); + void + mongoc_apm_set_command_started_cb (mongoc_apm_callbacks_t *callbacks, + mongoc_apm_command_started_cb_t cb); Receive an event notification whenever the driver starts a MongoDB operation. @@ -21,7 +22,8 @@ Parameters ---------- - ``callbacks``: A :ref:`mongoc_apm_callbacks_t`. -- ``cb``: A function to call with a :ref:`mongoc_apm_command_started_t` whenever the driver begins a MongoDB operation. +- ``cb``: A function to call with a :ref:`mongoc_apm_command_started_t` whenever the driver + begins a MongoDB operation. .. seealso:: diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_command_succeeded_cb.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_command_succeeded_cb.txt similarity index 61% rename from source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_command_succeeded_cb.rst rename to source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_command_succeeded_cb.txt index c6bddb7a..8118fbc1 100644 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_command_succeeded_cb.rst +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_command_succeeded_cb.txt @@ -1,5 +1,6 @@ -.. _mongoc_apm_set_command_succeeded_cb +.. _mongoc_apm_set_command_succeeded_cb: +===================================== mongoc_apm_set_command_succeeded_cb() ===================================== @@ -8,11 +9,11 @@ Synopsis .. code-block:: c - typedef void (*mongoc_apm_command_succeeded_cb_t) ( - const mongoc_apm_command_succeeded_t *event); + typedef void (*mongoc_apm_command_succeeded_cb_t) ( + const mongoc_apm_command_succeeded_t *event); - void - mongoc_apm_set_command_succeeded_cb (mongoc_apm_callbacks_t *callbacks, + void + mongoc_apm_set_command_succeeded_cb (mongoc_apm_callbacks_t *callbacks, mongoc_apm_command_succeeded_cb_t cb); Receive an event notification whenever the driver completes a MongoDB operation. @@ -21,7 +22,8 @@ Parameters ---------- - ``callbacks``: A :ref:`mongoc_apm_callbacks_t`. -- ``cb``: A function to call with a :ref:`mongoc_apm_command_succeeded_t` whenever the driver completes a MongoDB operation. +- ``cb``: A function to call with a :ref:`mongoc_apm_command_succeeded_t` whenever the driver + completes a MongoDB operation. .. seealso:: diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_changed_cb.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_changed_cb.txt similarity index 58% rename from source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_changed_cb.rst rename to source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_changed_cb.txt index ed40b274..bdefdf35 100644 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_changed_cb.rst +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_changed_cb.txt @@ -1,5 +1,6 @@ -.. _mongoc_apm_set_server_changed_cb +.. _mongoc_apm_set_server_changed_cb: +================================== mongoc_apm_set_server_changed_cb() ================================== @@ -8,14 +9,15 @@ Synopsis .. code-block:: c - typedef void (*mongoc_apm_server_changed_cb_t) ( - const mongoc_apm_server_changed_t *event); + typedef void (*mongoc_apm_server_changed_cb_t) ( + const mongoc_apm_server_changed_t *event); - void - mongoc_apm_set_server_changed_cb (mongoc_apm_callbacks_t *callbacks, - mongoc_apm_server_changed_cb_t cb); + void + mongoc_apm_set_server_changed_cb (mongoc_apm_callbacks_t *callbacks, + mongoc_apm_server_changed_cb_t cb); -Receive an event notification whenever the driver observes a change in status of a server it is connected to. +Receive an event notification whenever the driver observes a change in status of a server +it is connected to. Parameters ---------- diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_closed_cb.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_closed_cb.txt similarity index 51% rename from source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_closed_cb.rst rename to source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_closed_cb.txt index 48a03022..63d10465 100644 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_closed_cb.rst +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_closed_cb.txt @@ -1,5 +1,6 @@ -.. _mongoc_apm_set_server_closed_cb +.. _mongoc_apm_set_server_closed_cb: +================================= mongoc_apm_set_server_closed_cb() ================================= @@ -8,20 +9,22 @@ Synopsis .. code-block:: c - typedef void (*mongoc_apm_server_closed_cb_t) ( - const mongoc_apm_server_closed_t *event); + typedef void (*mongoc_apm_server_closed_cb_t) ( + const mongoc_apm_server_closed_t *event); - void - mongoc_apm_set_server_closed_cb (mongoc_apm_callbacks_t *callbacks, - mongoc_apm_server_closed_cb_t cb); + void + mongoc_apm_set_server_closed_cb (mongoc_apm_callbacks_t *callbacks, + mongoc_apm_server_closed_cb_t cb); -Receive an event notification whenever the driver stops monitoring a server and removes its :ref:`mongoc_server_description_t`. +Receive an event notification whenever the driver stops monitoring a server and removes +its :ref:`mongoc_server_description_t`. Parameters ---------- - ``callbacks``: A :ref:`mongoc_apm_callbacks_t`. -- ``cb``: A function to call with a :ref:`mongoc_apm_server_closed_t` whenever the driver stops monitoring a server and removes its :ref:`mongoc_server_description_t`. +- ``cb``: A function to call with a :ref:`mongoc_apm_server_closed_t` whenever the driver + stops monitoring a server and removes its :ref:`mongoc_server_description_t`. .. seealso:: diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_failed_cb.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_failed_cb.txt similarity index 66% rename from source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_failed_cb.rst rename to source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_failed_cb.txt index db70d1cc..ab09b93b 100644 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_failed_cb.rst +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_failed_cb.txt @@ -1,5 +1,6 @@ -.. _mongoc_apm_set_server_heartbeat_failed_cb +.. _mongoc_apm_set_server_heartbeat_failed_cb: +=========================================== mongoc_apm_set_server_heartbeat_failed_cb() =========================================== @@ -8,12 +9,12 @@ Synopsis .. code-block:: c - typedef void (*mongoc_apm_server_heartbeat_failed_cb_t) ( + typedef void (*mongoc_apm_server_heartbeat_failed_cb_t) ( const mongoc_apm_server_heartbeat_failed_t *event); - void - mongoc_apm_set_server_heartbeat_failed_cb (mongoc_apm_callbacks_t *callbacks, - mongoc_apm_server_heartbeat_failed_cb_t cb); + void + mongoc_apm_set_server_heartbeat_failed_cb (mongoc_apm_callbacks_t *callbacks, + mongoc_apm_server_heartbeat_failed_cb_t cb); Receive an event notification whenever the driver fails to send a "hello" command to check the status of a server. diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_started_cb.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_started_cb.rst deleted file mode 100644 index 3fbc6803..00000000 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_started_cb.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. _mongoc_apm_set_server_heartbeat_started_cb - -mongoc_apm_set_server_heartbeat_started_cb() -============================================ - -Synopsis --------- - -.. code-block:: c - - typedef void (*mongoc_apm_server_heartbeat_started_cb_t) ( - const mongoc_apm_server_heartbeat_started_t *event); - - void - mongoc_apm_set_server_heartbeat_started_cb (mongoc_apm_callbacks_t *callbacks, - mongoc_apm_server_heartbeat_started_cb_t cb); - -Receive an event notification whenever the driver begins executing a "hello" command to check the status of a server. - -Parameters ----------- - -- ``callbacks``: A :ref:`mongoc_apm_callbacks_t`. -- ``cb``: A function to call with a :ref:`mongoc_apm_server_heartbeat_started_t` whenever the driver begins executing a "hello" command to check the status of a server. - -.. seealso:: - - | :ref:`Introduction to Application Performance Monitoring ` - diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_started_cb.txt b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_started_cb.txt new file mode 100644 index 00000000..07ad9c9c --- /dev/null +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_started_cb.txt @@ -0,0 +1,32 @@ +.. _mongoc_apm_set_server_heartbeat_started_cb: + +============================================ +mongoc_apm_set_server_heartbeat_started_cb() +============================================ + +Synopsis +-------- + +.. code-block:: c + + typedef void (*mongoc_apm_server_heartbeat_started_cb_t) ( + const mongoc_apm_server_heartbeat_started_t *event); + + void + mongoc_apm_set_server_heartbeat_started_cb (mongoc_apm_callbacks_t *callbacks, + mongoc_apm_server_heartbeat_started_cb_t cb); + +Receive an event notification whenever the driver begins executing a "hello" command to check +the status of a server. + +Parameters +---------- + +- ``callbacks``: A :ref:`mongoc_apm_callbacks_t`. +- ``cb``: A function to call with a :ref:`mongoc_apm_server_heartbeat_started_t` whenever the + driver begins executing a "hello" command to check the status of a server. + +.. seealso:: + + | :ref:`Introduction to Application Performance Monitoring ` + diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_succeeded_cb.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_succeeded_cb.rst deleted file mode 100644 index f1c8cab7..00000000 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_succeeded_cb.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. _mongoc_apm_set_server_heartbeat_succeeded_cb - -mongoc_apm_set_server_heartbeat_succeeded_cb() -============================================== - -Synopsis --------- - -.. code-block:: c - - typedef void (*mongoc_apm_server_heartbeat_succeeded_cb_t) ( - const mongoc_apm_server_heartbeat_succeeded_t *event); - - void - mongoc_apm_set_server_heartbeat_succeeded_cb (mongoc_apm_callbacks_t *callbacks, - mongoc_apm_server_heartbeat_succeeded_cb_t cb); - -Receive an event notification whenever the driver completes a "hello" command to check the status of a server. - -Parameters ----------- - -- ``callbacks``: A :ref:`mongoc_apm_callbacks_t`. -- ``cb``: A function to call with a :ref:`mongoc_apm_server_heartbeat_succeeded_t` whenever the driver completes a "hello" command to check the status of a server. - -.. seealso:: - - | :ref:`Introduction to Application Performance Monitoring ` - diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_succeeded_cb.txt b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_succeeded_cb.txt new file mode 100644 index 00000000..4d3b2157 --- /dev/null +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_succeeded_cb.txt @@ -0,0 +1,32 @@ +.. _mongoc_apm_set_server_heartbeat_succeeded_cb: + +============================================== +mongoc_apm_set_server_heartbeat_succeeded_cb() +============================================== + +Synopsis +-------- + +.. code-block:: c + + typedef void (*mongoc_apm_server_heartbeat_succeeded_cb_t) ( + const mongoc_apm_server_heartbeat_succeeded_t *event); + + void + mongoc_apm_set_server_heartbeat_succeeded_cb (mongoc_apm_callbacks_t *callbacks, + mongoc_apm_server_heartbeat_succeeded_cb_t cb); + +Receive an event notification whenever the driver completes a "hello" command to check the +status of a server. + +Parameters +---------- + +- ``callbacks``: A :ref:`mongoc_apm_callbacks_t`. +- ``cb``: A function to call with a :ref:`mongoc_apm_server_heartbeat_succeeded_t` whenever the +- driver completes a "hello" command to check the status of a server. + +.. seealso:: + + | :ref:`Introduction to Application Performance Monitoring ` + diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_opening_cb.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_opening_cb.rst deleted file mode 100644 index c9a242d9..00000000 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_opening_cb.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. _mongoc_apm_set_server_opening_cb - -mongoc_apm_set_server_opening_cb() -================================== - -Synopsis --------- - -.. code-block:: c - - typedef void (*mongoc_apm_server_opening_cb_t) ( - const mongoc_apm_server_opening_t *event); - - void - mongoc_apm_set_server_opening_cb (mongoc_apm_callbacks_t *callbacks, - mongoc_apm_server_opening_cb_t cb); - -Receive an event notification whenever the driver adds a :ref:`mongoc_server_description_t` for a new server it was not monitoring before. - -Parameters ----------- - -- ``callbacks``: A :ref:`mongoc_apm_callbacks_t`. -- ``cb``: A function to call with a :ref:`mongoc_apm_server_opening_t` whenever the driver adds a :ref:`mongoc_server_description_t` for a new server it was not monitoring before. - -.. seealso:: - - | :ref:`Introduction to Application Performance Monitoring ` - diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_opening_cb.txt b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_opening_cb.txt new file mode 100644 index 00000000..ac8fd38c --- /dev/null +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_server_opening_cb.txt @@ -0,0 +1,32 @@ +.. _mongoc_apm_set_server_opening_cb: + +================================== +mongoc_apm_set_server_opening_cb() +================================== + +Synopsis +-------- + +.. code-block:: c + + typedef void (*mongoc_apm_server_opening_cb_t) ( + const mongoc_apm_server_opening_t *event); + + void + mongoc_apm_set_server_opening_cb (mongoc_apm_callbacks_t *callbacks, + mongoc_apm_server_opening_cb_t cb); + +Receive an event notification whenever the driver adds a :ref:`mongoc_server_description_t` +for a new server it was not monitoring before. + +Parameters +---------- + +- ``callbacks``: A :ref:`mongoc_apm_callbacks_t`. +- ``cb``: A function to call with a :ref:`mongoc_apm_server_opening_t` whenever the driver adds + a :ref:`mongoc_server_description_t` for a new server it was not monitoring before. + +.. seealso:: + + | :ref:`Introduction to Application Performance Monitoring ` + diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_topology_changed_cb.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_topology_changed_cb.rst deleted file mode 100644 index 4591444f..00000000 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_topology_changed_cb.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. _mongoc_apm_set_topology_changed_cb - -mongoc_apm_set_topology_changed_cb() -==================================== - -Synopsis --------- - -.. code-block:: c - - typedef void (*mongoc_apm_topology_changed_cb_t) ( - const mongoc_apm_topology_changed_t *event); - - void - mongoc_apm_set_topology_changed_cb (mongoc_apm_callbacks_t *callbacks, - mongoc_apm_topology_changed_cb_t cb); - -Receive an event notification whenever the driver observes a change in any of the servers it is connected to or a change in the overall server topology. - -Parameters ----------- - -- ``callbacks``: A :ref:`mongoc_apm_callbacks_t`. -- ``cb``: A function to call with a :ref:`mongoc_apm_topology_changed_t` whenever the driver observes a change in any of the servers it is connected to or a change in the overall server topology. - -.. seealso:: - - | :ref:`Introduction to Application Performance Monitoring ` - diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_topology_changed_cb.txt b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_topology_changed_cb.txt new file mode 100644 index 00000000..da7606f1 --- /dev/null +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_topology_changed_cb.txt @@ -0,0 +1,33 @@ +.. _mongoc_apm_set_topology_changed_cb: + +==================================== +mongoc_apm_set_topology_changed_cb() +==================================== + +Synopsis +-------- + +.. code-block:: c + + typedef void (*mongoc_apm_topology_changed_cb_t) ( + const mongoc_apm_topology_changed_t *event); + + void + mongoc_apm_set_topology_changed_cb (mongoc_apm_callbacks_t *callbacks, + mongoc_apm_topology_changed_cb_t cb); + +Receive an event notification whenever the driver observes a change in any of the +servers it is connected to or a change in the overall server topology. + +Parameters +---------- + +- ``callbacks``: A :ref:`mongoc_apm_callbacks_t`. +- ``cb``: A function to call with a :ref:`mongoc_apm_topology_changed_t` whenever the driver + observes a change in any of the servers it is connected to or a change in the overall server + topology. + +.. seealso:: + + | :ref:`Introduction to Application Performance Monitoring ` + diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_topology_closed_cb.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_topology_closed_cb.rst deleted file mode 100644 index 67ce7e19..00000000 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_topology_closed_cb.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. _mongoc_apm_set_topology_closed_cb - -mongoc_apm_set_topology_closed_cb() -=================================== - -Synopsis --------- - -.. code-block:: c - - typedef void (*mongoc_apm_topology_closed_cb_t) ( - const mongoc_apm_topology_closed_t *event); - - void - mongoc_apm_set_topology_closed_cb (mongoc_apm_callbacks_t *callbacks, - mongoc_apm_topology_closed_cb_t cb); - -Receive an event notification whenever the driver stops monitoring a server topology and destroys its :ref:`mongoc_topology_description_t`. - -Parameters ----------- - -- ``callbacks``: A :ref:`mongoc_apm_callbacks_t`. -- ``cb``: A function to call with a :ref:`mongoc_apm_topology_closed_t` whenever the driver stops monitoring a server topology and destroys its :ref:`mongoc_topology_description_t`. - -.. seealso:: - - | :ref:`Introduction to Application Performance Monitoring ` - diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_topology_closed_cb.txt b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_topology_closed_cb.txt new file mode 100644 index 00000000..c6140658 --- /dev/null +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_topology_closed_cb.txt @@ -0,0 +1,32 @@ +.. _mongoc_apm_set_topology_closed_cb: + +=================================== +mongoc_apm_set_topology_closed_cb() +=================================== + +Synopsis +-------- + +.. code-block:: c + + typedef void (*mongoc_apm_topology_closed_cb_t) ( + const mongoc_apm_topology_closed_t *event); + + void + mongoc_apm_set_topology_closed_cb (mongoc_apm_callbacks_t *callbacks, + mongoc_apm_topology_closed_cb_t cb); + +Receive an event notification whenever the driver stops monitoring a server topology +and destroys its :ref:`mongoc_topology_description_t`. + +Parameters +---------- + +- ``callbacks``: A :ref:`mongoc_apm_callbacks_t`. +- ``cb``: A function to call with a :ref:`mongoc_apm_topology_closed_t` whenever the driver + stops monitoring a server topology and destroys its :ref:`mongoc_topology_description_t`. + +.. seealso:: + + | :ref:`Introduction to Application Performance Monitoring ` + diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_topology_opening_cb.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_topology_opening_cb.txt similarity index 62% rename from source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_topology_opening_cb.rst rename to source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_topology_opening_cb.txt index 3849daaa..7eb69ebe 100644 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_topology_opening_cb.rst +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_set_topology_opening_cb.txt @@ -1,5 +1,6 @@ -.. _mongoc_apm_set_topology_opening_cb +.. _mongoc_apm_set_topology_opening_cb: +==================================== mongoc_apm_set_topology_opening_cb() ==================================== @@ -8,12 +9,12 @@ Synopsis .. code-block:: c - typedef void (*mongoc_apm_topology_opening_cb_t) ( - const mongoc_apm_topology_opening_t *event); + typedef void (*mongoc_apm_topology_opening_cb_t) ( + const mongoc_apm_topology_opening_t *event); - void - mongoc_apm_set_topology_opening_cb (mongoc_apm_callbacks_t *callbacks, - mongoc_apm_topology_opening_cb_t cb); + void + mongoc_apm_set_topology_opening_cb (mongoc_apm_callbacks_t *callbacks, + mongoc_apm_topology_opening_cb_t cb); Receive an event notification whenever the driver initializes a :ref:`mongoc_topology_description_t`. diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_context.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_context.txt similarity index 71% rename from source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_context.rst rename to source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_context.txt index 117a3830..f671a155 100644 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_context.rst +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_context.txt @@ -1,5 +1,6 @@ -.. _mongoc_apm_topology_changed_get_context +.. _mongoc_apm_topology_changed_get_context: +========================================= mongoc_apm_topology_changed_get_context() ========================================= @@ -8,9 +9,9 @@ Synopsis .. code-block:: c - void * - mongoc_apm_topology_changed_get_context ( - const mongoc_apm_topology_changed_t *event); + void * + mongoc_apm_topology_changed_get_context ( + const mongoc_apm_topology_changed_t *event); Returns this event's context. diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_new_description.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_new_description.txt similarity index 58% rename from source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_new_description.rst rename to source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_new_description.txt index f04f588b..ada8e95d 100644 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_new_description.rst +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_new_description.txt @@ -1,5 +1,6 @@ -.. _mongoc_apm_topology_changed_get_new_description +.. _mongoc_apm_topology_changed_get_new_description: +================================================= mongoc_apm_topology_changed_get_new_description() ================================================= @@ -8,11 +9,12 @@ Synopsis .. code-block:: c - const mongoc_topology_description_t * - mongoc_apm_topology_changed_get_new_description ( - const mongoc_apm_topology_changed_t *event); + const mongoc_topology_description_t * + mongoc_apm_topology_changed_get_new_description ( + const mongoc_apm_topology_changed_t *event); -Returns this event's new description. The data is only valid in the scope of the callback that receives this event; copy it if it will be accessed after the callback returns. +Returns this event's new description. The data is only valid in the scope of the callback +that receives this event; copy it if it will be accessed after the callback returns. Parameters ---------- diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_previous_description.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_previous_description.txt similarity index 57% rename from source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_previous_description.rst rename to source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_previous_description.txt index bc93c8ee..bbc1b08a 100644 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_previous_description.rst +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_previous_description.txt @@ -1,5 +1,6 @@ -.. _mongoc_apm_topology_changed_get_previous_description +.. _mongoc_apm_topology_changed_get_previous_description: +====================================================== mongoc_apm_topology_changed_get_previous_description() ====================================================== @@ -8,11 +9,12 @@ Synopsis .. code-block:: c - const mongoc_topology_description_t * - mongoc_apm_topology_changed_get_previous_description ( - const mongoc_apm_topology_changed_t *event); + const mongoc_topology_description_t * + mongoc_apm_topology_changed_get_previous_description ( + const mongoc_apm_topology_changed_t *event); -Returns this event's previous description. The data is only valid in the scope of the callback that receives this event; copy it if it will be accessed after the callback returns. +Returns this event's previous description. The data is only valid in the scope of the callback +that receives this event; copy it if it will be accessed after the callback returns. Parameters ---------- diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_topology_id.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_topology_id.txt similarity index 68% rename from source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_topology_id.rst rename to source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_topology_id.txt index 65532a41..3ba1960d 100644 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_topology_id.rst +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_get_topology_id.txt @@ -1,5 +1,6 @@ -.. _mongoc_apm_topology_changed_get_topology_id +.. _mongoc_apm_topology_changed_get_topology_id: +============================================= mongoc_apm_topology_changed_get_topology_id() ============================================= @@ -8,9 +9,9 @@ Synopsis .. code-block:: c - void - mongoc_apm_topology_changed_get_topology_id ( - const mongoc_apm_topology_changed_t *event, bson_oid_t *topology_id); + void + mongoc_apm_topology_changed_get_topology_id ( + const mongoc_apm_topology_changed_t *event, bson_oid_t *topology_id); Returns this event's topology id. diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_t.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_t.txt similarity index 78% rename from source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_t.rst rename to source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_t.txt index 88c1e017..99e03fa5 100644 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_t.rst +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_changed_t.txt @@ -1,5 +1,6 @@ -.. _mongoc_apm_topology_changed_t +.. _mongoc_apm_topology_changed_t: +============================= mongoc_apm_topology_changed_t ============================= @@ -8,7 +9,8 @@ Topology-changed event Synopsis -------- -An event notification sent when the driver observes a change in any of the servers it is connected to or a change in the overall server topology. +An event notification sent when the driver observes a change in any of the servers it is +connected to or a change in the overall server topology. .. seealso:: diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_closed_get_context.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_closed_get_context.txt similarity index 87% rename from source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_closed_get_context.rst rename to source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_closed_get_context.txt index 789c5813..07cb6fa2 100644 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_closed_get_context.rst +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_closed_get_context.txt @@ -1,5 +1,6 @@ -.. _mongoc_apm_topology_closed_get_context +.. _mongoc_apm_topology_closed_get_context: +======================================== mongoc_apm_topology_closed_get_context() ======================================== diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_closed_get_topology_id.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_closed_get_topology_id.txt similarity index 68% rename from source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_closed_get_topology_id.rst rename to source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_closed_get_topology_id.txt index 789fb9e1..546593e2 100644 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_closed_get_topology_id.rst +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_closed_get_topology_id.txt @@ -1,5 +1,6 @@ -.. _mongoc_apm_topology_closed_get_topology_id +.. _mongoc_apm_topology_closed_get_topology_id: +============================================ mongoc_apm_topology_closed_get_topology_id() ============================================ @@ -8,9 +9,9 @@ Synopsis .. code-block:: c - void - mongoc_apm_topology_closed_get_topology_id ( - const mongoc_apm_topology_closed_t *event, bson_oid_t *topology_id); + void + mongoc_apm_topology_closed_get_topology_id ( + const mongoc_apm_topology_closed_t *event, bson_oid_t *topology_id); Returns this event's topology id. diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_closed_t.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_closed_t.txt similarity index 76% rename from source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_closed_t.rst rename to source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_closed_t.txt index 2a400348..2ca8b20e 100644 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_closed_t.rst +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_closed_t.txt @@ -1,5 +1,6 @@ -.. _mongoc_apm_topology_closed_t +.. _mongoc_apm_topology_closed_t: +============================ mongoc_apm_topology_closed_t ============================ @@ -8,7 +9,8 @@ Topology-closed event Synopsis -------- -An event notification sent when the driver stops monitoring a server topology and destroys its :ref:`mongoc_topology_description_t`. +An event notification sent when the driver stops monitoring a server topology and destroys +its :ref:`mongoc_topology_description_t`. .. seealso:: diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_opening_get_context.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_opening_get_context.txt similarity index 71% rename from source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_opening_get_context.rst rename to source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_opening_get_context.txt index edd1245b..90c0db57 100644 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_opening_get_context.rst +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_opening_get_context.txt @@ -1,5 +1,6 @@ -.. _mongoc_apm_topology_opening_get_context +.. _mongoc_apm_topology_opening_get_context: +========================================= mongoc_apm_topology_opening_get_context() ========================================= @@ -8,9 +9,9 @@ Synopsis .. code-block:: c - void * - mongoc_apm_topology_opening_get_context ( - const mongoc_apm_topology_opening_t *event); + void * + mongoc_apm_topology_opening_get_context ( + const mongoc_apm_topology_opening_t *event); Returns this event's context. diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_opening_get_topology_id.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_opening_get_topology_id.txt similarity index 68% rename from source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_opening_get_topology_id.rst rename to source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_opening_get_topology_id.txt index febe87f3..42ee2469 100644 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_opening_get_topology_id.rst +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_opening_get_topology_id.txt @@ -1,5 +1,6 @@ -.. _mongoc_apm_topology_opening_get_topology_id +.. _mongoc_apm_topology_opening_get_topology_id: +============================================= mongoc_apm_topology_opening_get_topology_id() ============================================= @@ -8,9 +9,9 @@ Synopsis .. code-block:: c - void - mongoc_apm_topology_opening_get_topology_id ( - const mongoc_apm_topology_opening_t *event, bson_oid_t *topology_id); + void + mongoc_apm_topology_opening_get_topology_id ( + const mongoc_apm_topology_opening_t *event, bson_oid_t *topology_id); Returns this event's topology id. diff --git a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_opening_t.rst b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_opening_t.txt similarity index 61% rename from source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_opening_t.rst rename to source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_opening_t.txt index b00cbbee..8f97c92e 100644 --- a/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_opening_t.rst +++ b/source/docs-libmongoc/application-performance-monitoring/mongoc_apm_topology_opening_t.txt @@ -1,5 +1,6 @@ -.. _mongoc_apm_topology_opening_t +.. _mongoc_apm_topology_opening_t: +============================= mongoc_apm_topology_opening_t ============================= @@ -15,12 +16,12 @@ An event notification sent when the driver initializes a :ref:`mongoc_topology_d | :ref:`Introduction to Application Performance Monitoring ` Functions - --------- +--------- - .. toctree:: - :titlesonly: - :maxdepth: 1 +.. toctree:: + :titlesonly: + :maxdepth: 1 - mongoc_apm_topology_opening_get_context - mongoc_apm_topology_opening_get_topology_id + mongoc_apm_topology_opening_get_context + mongoc_apm_topology_opening_get_topology_id