gSROCrate.h

Go to the documentation of this file.

#pragma once
 
#include "gSROPlugin.h"
 
#include <functional>
#include <exception>
#include <memory>

struct GSROCrateLimits
{
    std::size_t queue_messages = 1024;
    std::size_t queue_bytes = 4 * 1024 * 1024;
    std::size_t pending_payloads = 65536;
    std::size_t pending_bytes = 64 * 1024 * 1024;
};

struct GSROCrateResources
{
    std::unique_ptr<GSROFrameSink> sink;
    std::unique_ptr<GSROCratePlugin> plugin;
};

class GSROCrate
{
public:
    using ResourceFactory = std::function<GSROCrateResources()>;
    using DeliveryCallback = std::function<void(GSROEventId, std::uint64_t)>;
    using FailureCallback = std::function<void(std::exception_ptr)>;
 
    GSROCrate(GSROCrateId crate_id, ResourceFactory make_resources,
              GSROCrateLimits limits = {}, DeliveryCallback on_delivery = {}, FailureCallback on_failure = {});
    ~GSROCrate();
 
    GSROCrate(const GSROCrate&) = delete;
    GSROCrate& operator=(const GSROCrate&) = delete;
    GSROCrate(GSROCrate&&) = delete;
    GSROCrate& operator=(GSROCrate&&) = delete;

    void enqueue_payload(GSROPayload payload);

    void advance_time(GSROTime safe_time);

    void request_finish(GSROEndContext context);

    void cancel(std::exception_ptr error);

    void finish_and_join(GSROEndContext context);

    void rethrow_if_failed() const;
 
private:
    class Impl;
    std::unique_ptr<Impl> impl;
};