ping

ping measures transport-level websocket latency for the current blaze::session. Unlike API operations such as initialize or authorize, it does not return blaze::status and does not depend on application initialization state.

Function variantsCopy Anchor Link

std::chrono::milliseconds ping();
std::chrono::milliseconds ping(std::error_code& ec) noexcept;
void async_ping(std::function<void(std::error_code, std::chrono::milliseconds)> callback);
blaze::coro::awaitable_result<std::chrono::milliseconds> co_ping();

ResultCopy Anchor Link

std::chrono::milliseconds

Behavior notesCopy Anchor Link

• Call ping after a successful connect.
• ping does not require initialize.
• The returned value measures websocket transport round-trip time, not Blazeauth packet handler execution time.
• ping participates in the same session send-rate limiting as other outgoing operations.
• Sync overloads use the session timeout configured in the constructor or via with_timeout(...).

ExampleCopy Anchor Link

#include "blazeauth/api/api.hpp"

#include <chrono>
#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";
}

int main() {
  blaze::session session;

  try {
    const blaze::api_server server = session.connect();
    std::cout << "Connected to server location: " << server.location << '\n';

    const std::chrono::milliseconds rtt = session.ping();
    std::cout << "Ping RTT: " << rtt.count() << " ms\n";

    session.shutdown();
  } catch (const std::system_error& e) {
    print_error_code("Ping failed", e.code());
    return 1;
  }

  return 0;
}

Error handlingCopy Anchor Link

You can match generic failures against blaze::errc, for example: if (ec == blaze::errc::connection_lost).

Related pagesCopy Anchor Link

• connect
• initialize