C++ APISession methods
get_online_users_count
Returns current online users count for the initialized application.
get_online_users_count() returns blaze::online_users_count for the current
initialized application.
Function variants
blaze::online_users_count get_online_users_count();
blaze::online_users_count get_online_users_count(std::error_code& ec) noexcept;
void async_get_online_users_count(std::function<void(std::error_code, blaze::online_users_count)> callback);
blaze::coro::awaitable_result<blaze::online_users_count> co_get_online_users_count();Status vs error
online_users_count.status is the API result. std::error_code and
std::system_error are used for transport/runtime failures only.
Result
struct online_users_count {
std::uint32_t users;
blaze::status status;
};Prop
Type
Checking returned fields
If the server omits count data, the library returns a default value.
| Field | Practical check |
|---|---|
result.users | Check result.status == blaze::status::ok before using it. 0 is valid on success and is also the default when the count is omitted on non-success statuses. |
Behavior notes
- Call
get_online_users_countonly after successfulconnectandinitialize. - This operation does not require an authorized license or account context.
- On success,
users == 0means the application currently has no connected sessions. - On non-success statuses,
usersfalls back to0, so do not use it as an error check by itself.
Example
Compilation note
Synchronous and Asynchronous examples compile in the same form from C++17
to C++26.
#include "blazeauth/api/api.hpp"
#include <iostream>
#include <string>
#include <system_error>
void print_error_code(const std::string& context, const std::error_code& ec) {
std::cout << context << ": " << ec.message() << " ("
<< ec.value() << " : " << ec.category().name() << ")\n";
}
std::string read_line(const std::string& label) {
std::string value;
std::cout << label << ": ";
std::getline(std::cin, value);
return value;
}
void print_status(const std::string& context, blaze::status status) {
std::cout << context << ": "
<< static_cast<unsigned int>(status)
<< " (" << blaze::to_string(status) << ")\n";
}
int main() {
const std::string websocket_api_key = read_line("Websocket API key");
const std::string client_id = read_line("Client ID");
blaze::session session;
try {
const blaze::api_server server = session.connect();
std::cout << "Connected to server location: " << server.location << '\n';
const blaze::application app = session.initialize(websocket_api_key, client_id);
if (!app.good()) {
print_status("Initialize returned status", app.status);
return 1;
}
const blaze::online_users_count result = session.get_online_users_count();
if (result.status != blaze::status::ok) {
print_status("Get-online-users-count returned status", result.status);
return 1;
}
std::cout << "Online users: " << result.users << '\n';
session.shutdown();
} catch (const std::system_error& e) {
print_error_code("Get-online-users-count failed", e.code());
return 1;
}
return 0;
}Get-online-users-count statuses
| Value | Status | Returned when |
|---|---|---|
1 | ok | Current online users count was returned successfully. |
6 | internal_server_error | Server could not read the current online users count because of an internal error. |
Connection-level shutdowns
Normal get-online-users-count results are returned
in result.status. The websocket may still be closed by session-level guards:
| Close code | Meaning | When it can happen |
|---|---|---|
4200 | not_initialized | get_online_users_count was called before a successful initialize. |
4201 | rate_limited | Session or IP rate limiting closed the websocket around this operation. |