MONGOC_CLIENT_GET_SERVER_STATUS(3)

📦
version 1.30.13 · 13 versions
, in fedora 43

✨ hey bestie, it's mongoc_client_get_server_status ✨

so like. this is a page from libmongoc, and the function we're talking about is mongoc_client_get_server_status. 💅

⚠️ WARNING, and I mean it: this one is deprecated since version 1.10.0. the glow-up replacement is to run the serverStatus command directly with mongoc_client_read_command_with_opts() instead. ok? ok. 🫶

📜 SYNOPSIS

bool
mongoc_client_get_server_status (mongoc_client_t *client,
                                 mongoc_read_prefs_t *read_prefs,
                                 bson_t *reply,
                                 bson_error_t *error);

🌸 DESCRIPTION

okay so what this does is it queries the server for its current server status, and the result gets dropped into reply. that's the whole vibe. 🦋

and listen, this part matters: reply is always initialized, even when things go sideways and it fails. so always call bson_destroy() to release it. always. no exceptions, bestie, we do not leak memory in this house. 😭

🎀 PARAMETERS

  • client — a mongoc_client_t. your client. the main character. 👑
  • read_prefs — a mongoc_read_prefs_t. the read prefs, doing their read prefs thing.
  • reply — a maybe-NULL pointer to overwritable storage for a bson_t, which is where the results are gonna live. ✨
  • error — an optional location for a bson_error_t, or NULL if you're feeling unbothered. 🙈

💀 ERRORS

errors get propagated via the error parameter. that's the pipeline. that's how you find out. 🔥

⭐ RETURNS

  • returns true if it's successful. slay. 💖
  • returns false and sets error if there are invalid arguments, or if there's a server or network error. not slay, but at least you know. 😭

🧚 AUTHOR

MongoDB, Inc

2009-present, MongoDB, Inc.

ok that's the whole page, mwah 💋 — this was libmongoc 1.30.13, dated Oct 09, 2024. go forth and maybe use the non-deprecated one, i'm just saying. 🫶✨

📦 where this page comes from