24#ifndef A11_STORES_CHUNK_STORE_READER_H_
25#define A11_STORES_CHUNK_STORE_READER_H_
35#include <absl/status/status.h>
36#include <absl/status/statusor.h>
37#include <absl/time/time.h>
44class ReferenceResolver;
45class LogicalChunkStoreReader;
48 std::shared_ptr<ChunkStore>
store;
56 virtual absl::StatusOr<ResolvedReference>
Resolve(
122 static absl::StatusOr<std::shared_ptr<ChunkStoreReader>>
Create(
124 std::shared_ptr<ReferenceResolver> resolver =
nullptr);
172 absl::Duration
timeout = absl::InfiniteDuration());
198 size_t limit, absl::Duration
timeout = absl::InfiniteDuration());
201 absl::Duration
timeout = absl::InfiniteDuration());
204 size_t limit, absl::Duration
timeout = absl::InfiniteDuration());
209 [[nodiscard]] std::shared_ptr<ChunkStore>
store()
const;
220 absl::StatusOr<std::shared_ptr<LogicalChunkStoreReader>> GetLogical();
222 void CancelLogical();
223 absl::Status GetLogicalStatus()
const;
224 std::optional<data::NodeFragment> TryTakeSimpleBuffered();
227 : state_(std::move(state)) {}
229 std::shared_ptr<State> state_;
230 std::shared_ptr<ReferenceResolver> resolver_;
231 std::atomic<LogicalHolder*> logical_holder_ =
nullptr;
237 static absl::StatusOr<std::shared_ptr<LogicalChunkStoreReader>>
Create(
239 std::shared_ptr<ReferenceResolver> resolver =
nullptr);
245 absl::Duration
timeout = absl::InfiniteDuration());
247 size_t limit, absl::Duration
timeout = absl::InfiniteDuration());
251 std::shared_ptr<ChunkStoreReader::LogicalState> state)
252 : state_(std::move(state)) {}
254 std::shared_ptr<ChunkStoreReader::LogicalState> state_;
std::shared_ptr< stores::ChunkStore > store
Definition async_node.cc:55
A11's pluggable storage interface for streamed node data: an ordered, appendable log of fragments key...
An ordered, buffered read cursor over a ChunkStore.
Definition chunk_store_reader.h:108
ChunkStoreReaderOptions options() const
Definition chunk_store_reader.cc:816
size_t buffer_size() const
Definition chunk_store_reader.cc:820
static absl::StatusOr< std::shared_ptr< ChunkStoreReader > > Create(std::shared_ptr< ChunkStore > store, ChunkStoreReaderOptions options={}, std::shared_ptr< ReferenceResolver > resolver=nullptr)
Create a reader over store.
Definition chunk_store_reader.cc:709
a11::Future< std::optional< data::NodeFragment > > NextLogical(absl::Duration timeout=absl::InfiniteDuration())
Read a leaf fragment after following references with this reader's policy.
Definition chunk_store_reference_reader.cc:419
void EnsureStarted()
Start the background read pump if it is not already running.
Definition chunk_store_reader.cc:733
a11::Future< std::vector< std::optional< data::NodeFragment > > > NextMany(size_t limit, absl::Duration timeout=absl::InfiniteDuration())
Get up to limit fragments in one await.
Definition chunk_store_reader.cc:769
bool LogicalSawFinal() const
Whether the logical source has supplied a final raw fragment.
Definition chunk_store_reference_reader.cc:406
a11::Task Done() const
Await completion of the background read pump.
Definition chunk_store_reader.cc:751
a11::Future< std::optional< data::NodeFragment > > Next(absl::Duration timeout=absl::InfiniteDuration())
Get the next fragment from the store.
Definition chunk_store_reader.cc:755
std::shared_ptr< ChunkStore > store() const
Definition chunk_store_reader.cc:812
~ChunkStoreReader()
Definition chunk_store_reference_reader.cc:344
a11::Future< std::vector< std::optional< data::NodeFragment > > > NextLogicalMany(size_t limit, absl::Duration timeout=absl::InfiniteDuration())
Read available logical leaf fragments without waiting to fill the batch.
Definition chunk_store_reference_reader.cc:461
absl::Status GetStatus() const
Get the reader's current status.
Definition chunk_store_reader.cc:742
void Cancel()
Stop the background read pump.
Definition chunk_store_reader.cc:737
Logical read cursor backed by one raw reader and a reference traversal.
Definition chunk_store_reader.h:235
void Cancel()
Definition chunk_store_reference_reader.cc:332
a11::Future< std::vector< std::optional< data::NodeFragment > > > NextMany(size_t limit, absl::Duration timeout=absl::InfiniteDuration())
Definition chunk_store_reference_reader.cc:479
bool SawFinal() const
Definition chunk_store_reference_reader.cc:340
static absl::StatusOr< std::shared_ptr< LogicalChunkStoreReader > > Create(std::shared_ptr< ChunkStore > store, ChunkStoreReaderOptions options, std::shared_ptr< ReferenceResolver > resolver=nullptr)
Definition chunk_store_reference_reader.cc:309
absl::Status GetStatus() const
Definition chunk_store_reference_reader.cc:336
a11::Future< std::optional< data::NodeFragment > > Next(absl::Duration timeout=absl::InfiniteDuration())
Definition chunk_store_reference_reader.cc:432
Supplies a target store and the target's own resolution context.
Definition chunk_store_reader.h:53
virtual ~ReferenceResolver()=default
virtual absl::StatusOr< ResolvedReference > Resolve(const data::NodeRef &reference)=0
Completion values used by every asynchronous A11 operation.
std::optional< absl::Duration > timeout
Definition main.cc:146
stores::ChunkStoreReaderOptions options
Definition runtime_streams.cc:31
A reference to a (slice of a) logical node, in lieu of inline data.
Definition types.h:311
Tunables controlling how a ChunkStoreReader delivers and buffers fragments.
Definition chunk_store_reader.h:69
std::uint32_t max_ref_depth
Maximum active reference edges.
Definition chunk_store_reader.h:77
bool ordered
Whether fragments are delivered strictly in sequence order.
Definition chunk_store_reader.h:81
std::uint32_t offset
Sequence number at which reading begins.
Definition chunk_store_reader.h:75
bool pop_chunks
Whether fragments are removed from the store as they are read.
Definition chunk_store_reader.h:83
std::optional< std::uint64_t > max_chunks_to_read
Optional cap on the total number of fragments to read.
Definition chunk_store_reader.h:73
absl::Status Validate() const
Validate that the options are internally consistent.
Definition chunk_store_reader.cc:48
bool follow_node_refs
Expand references in logical chunk and value reads.
Definition chunk_store_reader.h:87
std::uint32_t max_ref_breadth
Maximum sibling followers prefetched at one level.
Definition chunk_store_reader.h:79
std::uint64_t num_chunks_to_buffer
Maximum number of fragments to prefetch into the buffer.
Definition chunk_store_reader.h:71
bool sticky_mimetype
Whether ordered reads inherit the last explicitly set chunk mimetype.
Definition chunk_store_reader.h:85
Definition chunk_store_reference_reader.cc:303
Definition chunk_store_reference_reader.cc:39
Definition chunk_store_reader.cc:68
Definition chunk_store_reader.h:47
std::shared_ptr< ReferenceResolver > resolver
Definition chunk_store_reader.h:49
std::shared_ptr< ChunkStore > store
Definition chunk_store_reader.h:48
A11's core wire value types: chunks, node fragments and messages.