StormByte::Buffer::IO::BufferedReader::Parameters Class Reference

Reader knobs. More...

#include <StormByte/buffer/io/buffered_reader.hxx>

Inheritance diagram for StormByte::Buffer::IO::BufferedReader::Parameters:

Collaboration diagram for StormByte::Buffer::IO::BufferedReader::Parameters:

Public Member Functions
STORMBYTE_FORCE_INLINE	ReaderParameters () noexcept=default
	No knobs.
template<typename... Knobs>
STORMBYTE_FORCE_INLINE	ReaderParameters (Knobs... knobs)
	Engage the listed knobs.
Public Member Functions inherited from StormByte::Buffer::IO::ReaderParameters
STORMBYTE_FORCE_INLINE	ReaderParameters () noexcept=default
	No knobs.
template<typename... Knobs>
STORMBYTE_FORCE_INLINE	ReaderParameters (Knobs... knobs)
	Engage the listed knobs.
STORMBYTE_FORCE_INLINE const std::optional< StormByte::ByteSize > &	ReadAhead () const noexcept
	Prefetch length when the caller set it.
STORMBYTE_FORCE_INLINE const std::optional< StormByte::ByteSize > &	MaxMemory () const noexcept
	Cache cap when the caller set it.
STORMBYTE_FORCE_INLINE const std::optional< std::chrono::milliseconds > &	MaxWait () const noexcept
	Wait cap when the caller set it.

Detailed Description

Reader knobs.

A missing field keeps the base default (0 / 0 ms).

Header-only. The variadic list is applied in the caller (STORMBYTE_FORCE_INLINE). This module never instantiates Parameters.

Member Function Documentation

ReaderParameters() [1/2]

STORMBYTE_FORCE_INLINE StormByte::Buffer::IO::ReaderParameters::ReaderParameters ( )

defaultnoexcept

No knobs.

Every field is absent.

ReaderParameters() [2/2]

template<typename... Knobs>

STORMBYTE_FORCE_INLINE StormByte::Buffer::IO::ReaderParameters::ReaderParameters ( Knobs...  knobs )

inline

Engage the listed knobs.

Unknown types do not compile.

Template Parameters

Knobs

ReadAhead, MaxMemory and/or MaxWait.

Parameters

knobs

Values to store.

---

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

• lib/public/StormByte/buffer/io/buffered_reader.hxx