control_execution.hpp

Go to the documentation of this file.

#pragma once
 
#include <pulp/inspect/control_admission.hpp>
#include <pulp/inspect/control_artifacts.hpp>
 
#include <chrono>
#include <cstdint>
#include <functional>
#include <span>
#include <string>
 
namespace pulp::inspect {
 
struct ControlExecutionOutcome {
    ControlReceiptState terminal_state = ControlReceiptState::Completed;
    ControlOperationResult result;
    bool deferred = false;
};
 
using ControlProgressReporter =
    std::function<bool(std::uint64_t current, std::uint64_t total, std::string detail_json)>;
using ControlExecutionGuard = std::function<ControlExecutionCheckpoint()>;
using ControlDeferredCompletion = std::function<void(ControlExecutionOutcome)>;
 
struct ControlArtifactPublication {
    std::string content_type;
    ControlArtifactSensitivity sensitivity = ControlArtifactSensitivity::Sensitive;
    ControlArtifactRedactionState redaction_state = ControlArtifactRedactionState::Original;
    std::chrono::milliseconds lifetime = std::chrono::hours{1};
};
 
using ControlArtifactPublisher = std::function<ControlArtifactStoreResult(
    std::span<const std::uint8_t>, ControlArtifactPublication)>;
 
struct ControlExecutionContext {
    ControlProgressReporter report_progress;
    ControlExecutionGuard checkpoint;
    ControlDeferredCompletion complete_deferred;
    std::size_t maximum_artifact_bytes = 0;
    ControlArtifactPublisher publish_artifact;
};

using ControlOperationExecutor = std::function<ControlExecutionOutcome(
    const ControlAdmissionPlan&, const ControlRequestEnvelope&, const ControlExecutionContext&)>;
 
} // namespace pulp::inspect