control_inspector_client.hpp

Go to the documentation of this file.

#pragma once
 
#include <pulp/inspect/client.hpp>
#include <pulp/inspect/control_client.hpp>
#include <pulp/inspect/control_grants.hpp>
#include <pulp/inspect/control_identity.hpp>
 
#include <chrono>
#include <filesystem>
#include <functional>
#include <memory>
#include <optional>
#include <string>
#include <string_view>
 
namespace pulp::inspect {

struct InspectorControlSession {
    std::unique_ptr<ControlClientTransport> transport;
    ControlClientId client_id;
    ControlRegistrationId registration_id;
    ControlGrantId grant_id;
    std::string instance_generation;
    InspectorClientTarget target;
    std::uint64_t expected_state_generation = 0;
};

class InspectorControlSessionOpener {
  public:
    virtual ~InspectorControlSessionOpener() = default;
 
    virtual std::optional<InspectorControlSession>
    open(std::chrono::milliseconds timeout) = 0;
    virtual std::optional<InspectorControlSession>
    open_until(std::chrono::steady_clock::time_point deadline) {
        const auto now = std::chrono::steady_clock::now();
        if (now >= deadline)
            return std::nullopt;
        return open(std::chrono::ceil<std::chrono::milliseconds>(deadline - now));
    }
};

std::filesystem::path
installed_control_broker_executable(const std::filesystem::path& client_executable);

std::unique_ptr<InspectorControlSessionOpener>
make_installed_inspector_control_session_opener(
    std::filesystem::path client_executable,
    std::optional<std::string> exact_instance_id = std::nullopt,
    std::string legacy_profile = "develop");

InspectorClientResult
request_control_inspector(InspectorControlSessionOpener& opener, std::string method,
                          std::string params_json = "{}",
                          std::chrono::milliseconds timeout = std::chrono::seconds(3));

InspectorClientResult
request_control_inspector(std::string method, std::string params_json = "{}",
                          std::chrono::milliseconds timeout = std::chrono::seconds(3));
 
namespace detail {
 
struct TraceControlInventorySelection {
    std::string instance_id;
    std::string registration_id;
    std::string publication_id;
    std::string session_id;
};

std::optional<TraceControlInventorySelection> select_trace_control_instance(
    std::string_view inventory_json,
    std::optional<std::string_view> exact_instance_id = std::nullopt);
std::string trace_control_grant_request_json(std::string_view instance_id);
 
using InspectorControlClock =
    std::function<std::chrono::steady_clock::time_point()>;

InspectorClientResult request_control_inspector_with_clock(
    InspectorControlSessionOpener& opener, std::string method,
    std::string params_json, std::chrono::milliseconds timeout,
    InspectorControlClock clock);
 
} // namespace detail
 
} // namespace pulp::inspect