Overview

Blazeauth API libraries wrap the WebSocket protocol into language-native APIs. Each library section documents the public surface of that client API, not the raw JSON packet format.

Available libraries

What to expect from library docs

• Public function overloads and result types.
• Session-level hooks for resumption, shutdown, exceptions, reconnect, and server events.
• API status tables for operations that return blaze::status.
• Clear separation between API-level statuses and transport/runtime errors.

C++ entry points

The C++ reference currently includes connection, session-lifecycle, account, server-event, file, moderation, application-metrics, variable, and session-data entry points:

• connect opens the websocket connection and selects a server.
• with_timeout(std::chrono::milliseconds timeout) returns a session copy with a different timeout for synchronous operations.
• get_io_thread_id() returns the internal I/O thread ID used by the current session object.
• is_connected() reports current transport-level connection state.
• last_operation_took() returns the cached duration of the most recently measured operation.
• shutdown() closes the current websocket connection and ends the current connection lifecycle.
• ping measures websocket ping/pong round-trip time for the current session.
• initialize binds the connected session to your application and client identity.
• create_account(account_credentials) creates a new application account.
• authorize(std::string license) authorizes the initialized session with a license key.
• authorize(account_credentials credentials) authorizes the initialized session with account credentials.
• link_license(std::string license) links a license to the current authorized account.
• logout() clears the current authorization context while keeping the session connected.
• get_current_license() reads the current in-session license authorization context.
• get_current_account() reads the current in-session account authorization context.
• blacklist(std::string comment = "") blacklists the current session identity context.
• get_online_users_count() returns the current connected sessions count for the application.
• get_variable(std::string name) returns application variable content by name.
• set_session_value(std::string key, std::string content, std::chrono::seconds ttl) writes a session-scoped cache entry.
• get_session_value(std::string key) reads a session-scoped cache entry.
• delete_session_value(std::string key) removes a session-scoped cache entry.
• enable_panel_events(bool enable) enables or disables server-sent panel events for the current initialized session.
• transfer_file(std::string filename, resume_at from_where = resume_at{0}) transfers file content from the server.
• stop_file_transfer(std::string filename) requests termination of an active file transfer.
• get_file_metadata(std::string filename) returns stored metadata for an application file.