pulp::timeline::WriterCapabilityMask Struct Reference

Fixed authority of one writer over command classes and retained size. More...

#include <document_session.hpp>

Public Attributes
std::uint64_t	allowed
	One bit per class/intent pair, indexed by capability_bit.
std::size_t	max_transaction_retained_bytes = std::numeric_limits<std::size_t>::max()
	Largest retained size a single transaction from this writer may carry.
std::size_t	max_session_retained_bytes = std::numeric_limits<std::size_t>::max()
	Largest cumulative retained size this writer may commit to the session.

Detailed Description

Fixed authority of one writer over command classes and retained size.

A default-constructed mask denies every destructive intent and imposes no quota. The no-argument registration overload explicitly uses unrestricted_capabilities() so existing trusted callers retain their prior authority. Quotas use the complete envelope-aware retained_size(const Transaction&) estimate. A commandless End/Cancel may close only the ephemeral gesture lifecycle without document publication, journaling, capability admission, or quota charge.

Member Data Documentation

allowed

std::uint64_t pulp::timeline::WriterCapabilityMask::allowed

Initial value:

= [] {
        auto value = kAllCommandAuthorities;
        for (std::size_t index = 0; index < kCommandClassCount; ++index)
            value &= ~capability_bit(
                {static_cast<CommandClass>(index), CommandIntent::Remove});
        return value;
    }()

One bit per class/intent pair, indexed by capability_bit.

max_session_retained_bytes

std::size_t pulp::timeline::WriterCapabilityMask::max_session_retained_bytes = std::numeric_limits<std::size_t>::max()

Largest cumulative retained size this writer may commit to the session.

max_transaction_retained_bytes

std::size_t pulp::timeline::WriterCapabilityMask::max_transaction_retained_bytes = std::numeric_limits<std::size_t>::max()

Largest retained size a single transaction from this writer may carry.

---

The documentation for this struct was generated from the following file:

• /home/runner/work/pulp/pulp/core/timeline/include/pulp/timeline/document_session.hpp