#include <scratch_store.hpp>

Data Structures
struct	State

Public Member Functions
	CommandScratchStore (ScratchStoreConfig config, ScratchBacking *backing) noexcept

	~CommandScratchStore () noexcept override

	CommandScratchStore (const CommandScratchStore &)=delete

CommandScratchStore &	operator= (const CommandScratchStore &)=delete

	CommandScratchStore (CommandScratchStore &&)=delete

CommandScratchStore &	operator= (CommandScratchStore &&)=delete

ScratchStatus	status () const noexcept

const ReportScratchIoError *	carried_failure () const noexcept override

std::size_t	page_size () const noexcept override

std::uint64_t	record_count () const noexcept override

bool	transaction_active () const noexcept

bool	has_io_observer () const noexcept

ScratchStatus	begin () noexcept

ScratchStatus	put (const ScratchByteSource &key, const ScratchByteSource &value, ScratchHandle &result) noexcept

ScratchStatus	erase (ScratchHandle) noexcept

ScratchStatus	commit (ScratchDurability durability) noexcept

ScratchStatus	rollback () noexcept

ScratchStatus	point (ScratchHandle, ScratchRecordInfo &) const noexcept override

ScratchStatus	read (ScratchHandle, ScratchField, std::uint64_t offset, ScratchBuffer destination) const noexcept override

ScratchStatus	visit (ScratchHandle, ScratchBuffer page, ScratchChunkVisitor, void *context) const noexcept override

ScratchStatus	for_each (ScratchBuffer page, ScratchRecordVisitor, void *context) const noexcept override

ScratchStatus	first (ScratchHandle &result) const noexcept

ScratchStatus	next (ScratchHandle current, ScratchHandle &result) const noexcept

ScratchStatus	lower_bound (const ScratchByteSource &probe, ScratchHandle &result) const noexcept

ScratchStatus	ordered_digest (ScratchBuffer page, std::uint64_t &result) const noexcept

ScratchStatus	state_digest (ScratchBuffer page, std::uint64_t &result) const noexcept

ScratchStoreStats	stats () const noexcept

ScratchStatus	advance_handles (std::uint64_t count) noexcept

Public Member Functions inherited from pineforge::detail::ScratchReadback
virtual	~ScratchReadback () noexcept=default

Detailed Description

Definition at line 66 of file scratch_store.hpp.

Constructor & Destructor Documentation

◆ CommandScratchStore() [1/3]

pineforge::detail::CommandScratchStore::CommandScratchStore	(	ScratchStoreConfig	config,
		ScratchBacking *	backing )

inlinenoexcept

Definition at line 1777 of file scratch_store_impl.hpp.

References pineforge::detail::CommandScratchStore::State::allocation_failed(), pineforge::detail::scratch_impl::Core::geometry_ok(), and pineforge::detail::scratch_impl::Core::required_bytes().

Referenced by CommandScratchStore(), CommandScratchStore(), operator=(), and operator=().

◆ ~CommandScratchStore()

pineforge::detail::CommandScratchStore::~CommandScratchStore ( )

inlineoverridenoexcept

Definition at line 1790 of file scratch_store_impl.hpp.

References pineforge::detail::CommandScratchStore::State::allocation_failed().

◆ CommandScratchStore() [2/3]

pineforge::detail::CommandScratchStore::CommandScratchStore ( const CommandScratchStore & )

delete

References CommandScratchStore().

◆ CommandScratchStore() [3/3]

pineforge::detail::CommandScratchStore::CommandScratchStore ( CommandScratchStore && )

delete

References CommandScratchStore().

Member Function Documentation

◆ operator=() [1/2]

CommandScratchStore & pineforge::detail::CommandScratchStore::operator= ( const CommandScratchStore & )

delete

References CommandScratchStore().

◆ operator=() [2/2]

CommandScratchStore & pineforge::detail::CommandScratchStore::operator= ( CommandScratchStore && )

delete

◆ status()

ScratchStatus pineforge::detail::CommandScratchStore::status ( ) const

inlinenoexcept

Definition at line 1797 of file scratch_store_impl.hpp.

References pineforge::detail::CommandScratchStore::State::allocation_failed(), pineforge::detail::io_error, and pineforge::detail::programming_error.

Referenced by pineforge::source::PineExecutionAdapter::bind_exit_scratch(), and pineforge::source::PineStrategyHost::set_trade_scratch().

◆ carried_failure()

const ReportScratchIoError * pineforge::detail::CommandScratchStore::carried_failure ( ) const

inlineoverridevirtualnoexcept

Reimplemented from pineforge::detail::ScratchReadback.

Definition at line 1801 of file scratch_store_impl.hpp.

References pineforge::detail::CommandScratchStore::State::allocation_failed(), and pineforge::detail::scratch_out_of_memory_failure().

Referenced by pineforge::source::detail::exit_scratch_edit_failure(), and operator=().

◆ page_size()

std::size_t pineforge::detail::CommandScratchStore::page_size ( ) const

inlineoverridevirtualnoexcept

Implements pineforge::detail::ScratchReadback.

Definition at line 1805 of file scratch_store_impl.hpp.

Referenced by operator=().

◆ record_count()

std::uint64_t pineforge::detail::CommandScratchStore::record_count ( ) const

inlineoverridevirtualnoexcept

Implements pineforge::detail::ScratchReadback.

Definition at line 1806 of file scratch_store_impl.hpp.

References pineforge::detail::ok.

Referenced by operator=(), and pineforge::source::PineStrategyHost::set_trade_scratch().

◆ transaction_active()

bool pineforge::detail::CommandScratchStore::transaction_active ( ) const

inlinenoexcept

Definition at line 1809 of file scratch_store_impl.hpp.

References pineforge::detail::ok.

Referenced by pineforge::source::PineExecutionAdapter::bind_exit_scratch(), operator=(), and pineforge::source::PineStrategyHost::set_trade_scratch().

◆ has_io_observer()

bool pineforge::detail::CommandScratchStore::has_io_observer ( ) const

inlinenoexcept

Definition at line 1812 of file scratch_store_impl.hpp.

Referenced by operator=().

◆ begin()

ScratchStatus pineforge::detail::CommandScratchStore::begin ( )

inlinenoexcept

Definition at line 1816 of file scratch_store_impl.hpp.

References pineforge::detail::programming_error.

Referenced by pineforge::source::detail::exit_scratch_edit(), and operator=().

◆ put()

ScratchStatus pineforge::detail::CommandScratchStore::put	(	const ScratchByteSource &	key,
		const ScratchByteSource &	value,
		ScratchHandle &	result )

inlinenoexcept

Definition at line 1819 of file scratch_store_impl.hpp.

References pineforge::detail::key, pineforge::detail::programming_error, and pineforge::detail::value.

Referenced by operator=().

◆ erase()

ScratchStatus pineforge::detail::CommandScratchStore::erase ( ScratchHandle handle )

inlinenoexcept

Definition at line 1823 of file scratch_store_impl.hpp.

References pineforge::detail::programming_error.

Referenced by operator=().

◆ commit()

ScratchStatus pineforge::detail::CommandScratchStore::commit ( ScratchDurability durability )

inlinenoexcept

Definition at line 1826 of file scratch_store_impl.hpp.

References pineforge::detail::programming_error.

Referenced by pineforge::source::detail::exit_scratch_edit(), pineforge::source::detail::ExitScratchRows< T, ExitScratchRowMode::bounded_batch >::finish(), and operator=().

◆ rollback()

ScratchStatus pineforge::detail::CommandScratchStore::rollback ( )

inlinenoexcept

Definition at line 1829 of file scratch_store_impl.hpp.

References pineforge::detail::programming_error.

Referenced by pineforge::source::detail::exit_scratch_edit_failure(), and operator=().

◆ point()

ScratchStatus pineforge::detail::CommandScratchStore::point	(	ScratchHandle	handle,
		ScratchRecordInfo &	info ) const

inlineoverridevirtualnoexcept

Implements pineforge::detail::ScratchReadback.

Definition at line 1832 of file scratch_store_impl.hpp.

References pineforge::detail::programming_error.

Referenced by operator=().

◆ read()

ScratchStatus pineforge::detail::CommandScratchStore::read	(	ScratchHandle	handle,
		ScratchField	field,
		std::uint64_t	offset,
		ScratchBuffer	destination ) const

inlineoverridevirtualnoexcept

Implements pineforge::detail::ScratchReadback.

Definition at line 1835 of file scratch_store_impl.hpp.

References pineforge::detail::programming_error.

Referenced by pineforge::source::detail::exit_scratch_words(), operator=(), pineforge::source::detail::ExitScratchValue< T >::read(), and pineforge::source::detail::ExitScratchValue< native_order::RequestHandle >::read().

◆ visit()

ScratchStatus pineforge::detail::CommandScratchStore::visit	(	ScratchHandle	handle,
		ScratchBuffer	page,
		ScratchChunkVisitor	visitor,
		void *	context ) const

inlineoverridevirtualnoexcept

Implements pineforge::detail::ScratchReadback.

Definition at line 1839 of file scratch_store_impl.hpp.

References pineforge::detail::programming_error.

Referenced by operator=().

◆ for_each()

ScratchStatus pineforge::detail::CommandScratchStore::for_each	(	ScratchBuffer	page,
		ScratchRecordVisitor	visitor,
		void *	context ) const

inlineoverridevirtualnoexcept

Implements pineforge::detail::ScratchReadback.

Definition at line 1843 of file scratch_store_impl.hpp.

References pineforge::detail::programming_error.

Referenced by operator=().

◆ first()

ScratchStatus pineforge::detail::CommandScratchStore::first ( ScratchHandle & result ) const

inlinenoexcept

Definition at line 1847 of file scratch_store_impl.hpp.

References pineforge::detail::programming_error.

Referenced by operator=().

◆ next()

ScratchStatus pineforge::detail::CommandScratchStore::next	(	ScratchHandle	current,
		ScratchHandle &	result ) const

inlinenoexcept

Definition at line 1850 of file scratch_store_impl.hpp.

References pineforge::detail::programming_error.

Referenced by operator=(), and pineforge::source::detail::ExitScratchRows< T, ExitScratchRowMode::bounded_batch >::ordered_text().

◆ lower_bound()

ScratchStatus pineforge::detail::CommandScratchStore::lower_bound	(	const ScratchByteSource &	probe,
		ScratchHandle &	result ) const

inlinenoexcept

Definition at line 1853 of file scratch_store_impl.hpp.

References pineforge::detail::programming_error.

Referenced by pineforge::source::detail::exit_scratch_seek(), and operator=().

◆ ordered_digest()

ScratchStatus pineforge::detail::CommandScratchStore::ordered_digest	(	ScratchBuffer	page,
		std::uint64_t &	result ) const

inlinenoexcept

Definition at line 1856 of file scratch_store_impl.hpp.

References pineforge::detail::programming_error.

Referenced by operator=().

◆ state_digest()

ScratchStatus pineforge::detail::CommandScratchStore::state_digest	(	ScratchBuffer	page,
		std::uint64_t &	result ) const

inlinenoexcept

Definition at line 1859 of file scratch_store_impl.hpp.

References pineforge::detail::programming_error.

Referenced by operator=().

◆ stats()

ScratchStoreStats pineforge::detail::CommandScratchStore::stats ( ) const

inlinenoexcept

Definition at line 1862 of file scratch_store_impl.hpp.

Referenced by operator=().

◆ advance_handles()

ScratchStatus pineforge::detail::CommandScratchStore::advance_handles ( std::uint64_t count )

inlinenoexcept

Definition at line 1866 of file scratch_store_impl.hpp.

References pineforge::detail::programming_error.

Referenced by operator=().

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

Data Structures

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CommandScratchStore() [1/3]

◆ ~CommandScratchStore()

◆ CommandScratchStore() [2/3]

◆ CommandScratchStore() [3/3]

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ status()

◆ carried_failure()

◆ page_size()

◆ record_count()

◆ transaction_active()

◆ has_io_observer()

◆ begin()

◆ put()

◆ erase()

◆ commit()

◆ rollback()

◆ point()

◆ read()

◆ visit()

◆ for_each()

◆ first()

◆ next()

◆ lower_bound()

◆ ordered_digest()

◆ state_digest()

◆ stats()

◆ advance_handles()