blacklist

Adds the current session identity context to blacklist and returns the API result.

blacklist(std::string comment = "") adds the current session identity context to blacklist and returns blaze::status.

Function variants

blaze::status blacklist(std::string comment = "");
blaze::status blacklist(std::string comment, std::error_code& ec) noexcept;
void async_blacklist(std::string comment, std::function<void(std::error_code, blaze::status)> callback);
blaze::coro::awaitable_result<blaze::status> co_blacklist(std::string comment);

Status vs error

The returned blaze::status is the API result. std::error_code and std::system_error are used for transport/runtime failures only.

Parameters

Prop

Type

Result

blaze::status

Use direct comparison, for example:

if (status == blaze::status::ok) {
  // success
}

Behavior notes

Call blacklist only after successful connect and initialize.
comment is optional. If it is empty, the field is omitted from the request.
On blaze::status::ok, the server accepts the blacklist operation and then closes the websocket with blaze::close_code::session_blacklisted.
On non-success statuses, the operation returns a regular API result and the session remains usable unless another session-level guard closes it.
If you need to observe the server-initiated disconnect, set set_shutdown_callback(...) before calling blacklist.

Example

Compilation note

Synchronous and Asynchronous examples compile in the same form from C++14 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");
  const std::string blacklist_comment = read_line("Blacklist comment (optional)");

  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::status blacklist_status = session.blacklist(blacklist_comment);
    if (blacklist_status != blaze::status::ok) {
      print_status("Blacklist returned status", blacklist_status);
      return 1;
    }

    std::cout << "Blacklist accepted. Server will close the session.\n";
  } catch (const std::system_error& e) {
    print_error_code("Blacklist failed", e.code());
    return 1;
  }

  return 0;
}

#include "blazeauth/api/api.hpp"

#include <future>
#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");
  const std::string blacklist_comment = read_line("Blacklist comment (optional)");

  blaze::session session;

  std::promise<int> completion;
  std::future<int> result = completion.get_future();

  session.async_connect(
    [&session, &completion, websocket_api_key, client_id, blacklist_comment](std::error_code connect_ec, blaze::api_server server) {
      if (connect_ec) {
        print_error_code("Connect failed", connect_ec);
        completion.set_value(1);
        return;
      }

      std::cout << "Connected to server location: " << server.location << '\n';

      session.async_initialize(websocket_api_key, client_id,
        [&session, &completion, blacklist_comment](std::error_code init_ec, blaze::application app) {
          if (init_ec) {
            print_error_code("Initialize failed", init_ec);
            completion.set_value(1);
            return;
          }

          if (!app.good()) {
            print_status("Initialize returned status", app.status);
            completion.set_value(1);
            return;
          }

          session.async_blacklist(blacklist_comment,
            [&completion](std::error_code blacklist_ec, blaze::status blacklist_status) {
              if (blacklist_ec) {
                print_error_code("Blacklist failed", blacklist_ec);
                completion.set_value(1);
                return;
              }

              if (blacklist_status != blaze::status::ok) {
                print_status("Blacklist returned status", blacklist_status);
                completion.set_value(1);
                return;
              }

              std::cout << "Blacklist accepted. Server will close the session.\n";
              completion.set_value(0);
            });
        });
    });

  return result.get();
}

Project must be built with C++20 support and with coroutine support available both in the language mode and in the standard library implementation for this example to compile correctly.

#include "blazeauth/api/api.hpp"

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

#if BLAZEAUTH_HAS_COROUTINES

blaze::coro::task<std::error_code> run_example(
  blaze::session& session,
  const std::string& websocket_api_key,
  const std::string& client_id,
  const std::string& blacklist_comment
) {
  const auto [connect_ec, server] = co_await session.co_connect();
  if (connect_ec) {
    co_return connect_ec;
  }

  std::cout << "Connected to server location: " << server.location << '\n';

  const auto [init_ec, app] = co_await session.co_initialize(websocket_api_key, client_id);
  if (init_ec) {
    co_return init_ec;
  }

  if (!app.good()) {
    co_return blaze::make_error_code(app.status);
  }

  const auto [blacklist_ec, blacklist_status] = co_await session.co_blacklist(blacklist_comment);
  if (blacklist_ec) {
    co_return blacklist_ec;
  }

  if (blacklist_status != blaze::status::ok) {
    co_return blaze::make_error_code(blacklist_status);
  }

  std::cout << "Blacklist accepted. Server will close the session.\n";
  co_return {};
}

int main() {
  const std::string websocket_api_key = read_line("Websocket API key");
  const std::string client_id = read_line("Client ID");
  const std::string blacklist_comment = read_line("Blacklist comment (optional)");

  blaze::session session;

  std::promise<std::error_code> completion;
  std::future<std::error_code> result = completion.get_future();

  blaze::coro::co_spawn([&session, &completion, websocket_api_key, client_id, blacklist_comment]() -> blaze::coro::task<void> {
    const std::error_code ec = co_await run_example(session, websocket_api_key, client_id, blacklist_comment);
    completion.set_value(ec);
    co_return;
  }());

  const std::error_code ec = result.get();
  if (ec) {
    print_error_code("Blacklist failed", ec);
    return 1;
  }

  return 0;
}

#else

int main() {
  std::cout << "This example requires coroutine support in the Blazeauth library build.\n";
  return 0;
}

#endif

Blacklist statuses

Value	Status	Returned when
`1`	`ok`	Blacklist operation was accepted successfully.
`6`	`internal_server_error`	Server could not complete blacklist processing because of an internal error.
`604`	`app_blacklists_quota_exceeded`	Application blacklist quota was reached.

Connection-level shutdowns

Normal blacklist results are returned as blaze::status. A successful blacklist also leads to a server-initiated close:

Close code	Meaning	When it can happen
`4200`	`not_initialized`	`blacklist` was called before a successful `initialize`.
`4201`	`rate_limited`	Session or IP rate limiting closed the websocket around this operation.
`4203`	`session_blacklisted`	Blacklist succeeded and the server terminated the session.

blacklist

On this page