1MONGOC_CLIENT_GET_SERVER_STATUS(3) libmongocMONGOC_CLIENT_GET_SERVER_STATUS(3)
2
3
4
6 Deprecated since version 1.10.0: This function is deprecated and
7 should not be used in new code.
8
9 Run the serverStatus command directly with
10 mongoc_client_read_command_with_opts() instead.
11
12
14 bool
15 mongoc_client_get_server_status (mongoc_client_t *client,
16 mongoc_read_prefs_t *read_prefs,
17 bson_t *reply,
18 bson_error_t *error) BSON_GNUC_DEPRECATED;
19
20 Queries the server for the current server status. The result is stored
21 in reply.
22
23 reply is always initialized, even in the case of failure. Always call
24 bson_destroy() to release it.
25
27 • client: A mongoc_client_t.
28
29 • read_prefs: A mongoc_read_prefs_t.
30
31 • reply: A location for the result bson_t.
32
33 • error: An optional location for a bson_error_t or NULL.
34
36 Errors are propagated via the error parameter.
37
39 Returns true if successful. Returns false and sets error if there are
40 invalid arguments or a server or network error.
41
43 MongoDB, Inc
44
46 2017-present, MongoDB, Inc
47
48
49
50
511.25.1 Nov 08, 2023MONGOC_CLIENT_GET_SERVER_STATUS(3)