shutdown

shutdown closes the current websocket connection for this blaze::session. It is a transport/session-lifecycle method, not a Blazeauth packet usecase, so it does not return blaze::status.

Function variantsCopy Anchor Link

void shutdown();
void shutdown(std::error_code& ec) noexcept;
void async_shutdown(std::function<void(std::error_code)> callback);
blaze::coro::awaitable_result<void> co_shutdown();

ResultCopy Anchor Link

void

Behavior notesCopy Anchor Link

• shutdown can be called after connect, even if the session was never initialized or authorized.
• Explicit shutdown does not send a Blazeauth API packet and does not return any API-level status.
• shutdown is idempotent. Repeating it after the session is already closed is treated as a successful no-op.
• Pending API operations that have not completed yet are finished with blaze::errc::shutdown.
• If on_shutdown(...) is registered, explicit shutdown invokes it too. For client-initiated shutdown, close_message.code is typically blaze::close_code::none and reason is usually not set.
• After shutdown, the blaze::session object is still reusable. Call connect again to start a fresh connection.
• Sync overloads use the session timeout configured in the constructor or via with_timeout(...).
• Coroutine overloads are available only when the library is built with coroutine support.

ExampleCopy Anchor Link

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

int main() {
  blaze::session session;

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

    session.shutdown();
    std::cout << "Session shutdown completed\n";
  } catch (const std::system_error& e) {
    print_error_code("Shutdown 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
• Common pitfalls