mongoc_client_get_server_status3
Usage
bool
mongoc_client_get_server_status (mongoc_client_t *client,
mongoc_read_prefs_t *read_prefs,
bson_t *reply,
bson_error_t *error);
Queries the server for the current server status. The result is stored in reply.
reply is always initialized, even in the case of failure. Always call bson_destroy() to release it.
WARNING:
Deprecated since version 1.10.0: Run the serverStatus command directly with mongoc_client_read_command_with_opts() instead.
Parameters
- •
-
client: A mongoc_client_t.
- •
-
read_prefs: A mongoc_read_prefs_t.
- •
-
reply: A maybe-NULL pointer to overwritable storage for a bson_t to contain the results.
- •
-
error: An optional location for a bson_error_t or NULL.
Errors
Errors are propagated via the error parameter.
Returns
Returns true if successful. Returns false and sets error if there are invalid arguments or a server or network error.
Releases
5 releases since Debian 9 (Stretch); the text changed 4 times.