StormByte::Buffer::Pumper::Parameters Class Reference

Optional Pumper knobs. More...

#include <StormByte/buffer/pumper.hxx>

Public Member Functions
STORMBYTE_FORCE_INLINE	Parameters () noexcept=default
	No knobs.
template<typename... Knobs>
STORMBYTE_FORCE_INLINE	Parameters (Knobs... knobs)
	Engage the listed knobs.
STORMBYTE_FORCE_INLINE const std::optional< StormByte::ByteSize > &	Chunk () const noexcept
	Cycle size when the caller set it.
STORMBYTE_FORCE_INLINE const std::optional< StormByte::ByteSize > &	HighWater () const noexcept
	Input cap when the caller set it.

Detailed Description

Optional Pumper knobs.

A missing field keeps the office default.

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

Constructor & Destructor Documentation

Parameters() [1/2]

STORMBYTE_FORCE_INLINE StormByte::Buffer::Pumper::Parameters::Parameters ( )

defaultnoexcept

No knobs.

Every field is absent.

Parameters() [2/2]

template<typename... Knobs>

STORMBYTE_FORCE_INLINE StormByte::Buffer::Pumper::Parameters::Parameters ( Knobs...  knobs )

inline

Engage the listed knobs.

Unknown types do not compile.

Template Parameters

Knobs

Chunk and/or HighWater.

Parameters

knobs

Values to store.

Member Function Documentation

Chunk()

STORMBYTE_FORCE_INLINE const std::optional< StormByte::ByteSize > & StormByte::Buffer::Pumper::Parameters::Chunk ( ) const

inlinenoexcept

Cycle size when the caller set it.

Returns

Empty when the caller omitted Chunk.

HighWater()

STORMBYTE_FORCE_INLINE const std::optional< StormByte::ByteSize > & StormByte::Buffer::Pumper::Parameters::HighWater ( ) const

inlinenoexcept

Input cap when the caller set it.

Returns

Empty when the caller omitted HighWater.

---

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

• lib/public/StormByte/buffer/pumper.hxx