A11 (C++ runtime)
Native C++ implementation of the A11 streaming action runtime
Loading...
Searching...
No Matches
a11::stores::ChunkStoreReaderOptions Struct Reference

Tunables controlling how a ChunkStoreReader delivers and buffers fragments. More...

#include <cpp/a11/stores/chunk_store_reader.h>

Public Member Functions

absl::Status Validate () const
 Validate that the options are internally consistent.
 

Public Attributes

std::uint64_t num_chunks_to_buffer = 32
 Maximum number of fragments to prefetch into the buffer.
 
std::optional< std::uint64_t > max_chunks_to_read = {}
 Optional cap on the total number of fragments to read.
 
std::uint32_t offset = 0
 Sequence number at which reading begins.
 
std::uint32_t max_ref_depth = 8
 Maximum active reference edges.
 
std::uint32_t max_ref_breadth = 2
 Maximum sibling followers prefetched at one level.
 
bool ordered = true
 Whether fragments are delivered strictly in sequence order.
 
bool pop_chunks = false
 Whether fragments are removed from the store as they are read.
 
bool sticky_mimetype = false
 Whether ordered reads inherit the last explicitly set chunk mimetype.
 
bool follow_node_refs = true
 Expand references in logical chunk and value reads.
 

Detailed Description

Tunables controlling how a ChunkStoreReader delivers and buffers fragments.

Configures ordering, prefetch depth, the starting offset, whether fragments are removed from the store as they are read, an optional cap on the total number read, and whether ordered reads expand sticky mimetypes.

Member Function Documentation

◆ Validate()

absl::Status a11::stores::ChunkStoreReaderOptions::Validate ( ) const

Validate that the options are internally consistent.

Returns
OK if the options are valid, otherwise an error status.

Member Data Documentation

◆ follow_node_refs

bool a11::stores::ChunkStoreReaderOptions::follow_node_refs = true

Expand references in logical chunk and value reads.

◆ max_chunks_to_read

std::optional<std::uint64_t> a11::stores::ChunkStoreReaderOptions::max_chunks_to_read = {}

Optional cap on the total number of fragments to read.

◆ max_ref_breadth

std::uint32_t a11::stores::ChunkStoreReaderOptions::max_ref_breadth = 2

Maximum sibling followers prefetched at one level.

◆ max_ref_depth

std::uint32_t a11::stores::ChunkStoreReaderOptions::max_ref_depth = 8

Maximum active reference edges.

◆ num_chunks_to_buffer

std::uint64_t a11::stores::ChunkStoreReaderOptions::num_chunks_to_buffer = 32

Maximum number of fragments to prefetch into the buffer.

◆ offset

std::uint32_t a11::stores::ChunkStoreReaderOptions::offset = 0

Sequence number at which reading begins.

◆ ordered

bool a11::stores::ChunkStoreReaderOptions::ordered = true

Whether fragments are delivered strictly in sequence order.

◆ pop_chunks

bool a11::stores::ChunkStoreReaderOptions::pop_chunks = false

Whether fragments are removed from the store as they are read.

◆ sticky_mimetype

bool a11::stores::ChunkStoreReaderOptions::sticky_mimetype = false

Whether ordered reads inherit the last explicitly set chunk mimetype.


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