StormByte-Buffer 4.0.0
C++26 buffer module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Buffer::Pumper::Parameters Class Reference

Optional Pumper knobs. More...

#include <StormByte/buffer/pumper.hxx>

Public Member Functions

 Parameters ()=default
 No knobs.
 Parameters (const Parameters &other)=default
 Copy provider-owned knob values; may allocate and throw.
 Parameters (Parameters &&other) noexcept=default
 Transfer provider-owned knob values.
 ~Parameters () noexcept=default
 Release knobs through their provider callbacks.
Parameters & operator= (const Parameters &other)=default
 Copy provider-owned knob values; may allocate and throw.
Parameters & operator= (Parameters &&other) noexcept=default
 Transfer provider-owned knob values.
template<typename... Knobs>
 Parameters (Knobs... knobs)
 Engage the listed knobs.
const StormByte::Safe::Optional< StormByte::ByteSize > & Chunk () const noexcept
 Cycle size when the caller set it.
const StormByte::Safe::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 bag with Safe provider-owned optional values.

Note
Construction, copying and knob assignment may allocate and throw.

Constructor & Destructor Documentation

◆ Parameters() [1/4]

StormByte::Buffer::Pumper::Parameters::Parameters ( )
default

No knobs.

Every field is absent.

◆ Parameters() [2/4]

StormByte::Buffer::Pumper::Parameters::Parameters ( const Parameters & other)
default

Copy provider-owned knob values; may allocate and throw.

Parameters
otherSource parameters.

◆ Parameters() [3/4]

StormByte::Buffer::Pumper::Parameters::Parameters ( Parameters && other)
defaultnoexcept

Transfer provider-owned knob values.

Parameters
otherSource parameters.

◆ ~Parameters()

StormByte::Buffer::Pumper::Parameters::~Parameters ( )
defaultnoexcept

Release knobs through their provider callbacks.

◆ Parameters() [4/4]

template<typename... Knobs>
StormByte::Buffer::Pumper::Parameters::Parameters ( Knobs... knobs)
inline

Engage the listed knobs.

Unknown types do not compile.

Template Parameters
KnobsChunk and/or HighWater.
Parameters
knobsValues to store.

Member Function Documentation

◆ Chunk()

const StormByte::Safe::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()

const StormByte::Safe::Optional< StormByte::ByteSize > & StormByte::Buffer::Pumper::Parameters::HighWater ( ) const
inlinenoexcept

Input cap when the caller set it.

Returns
Empty when the caller omitted HighWater.

◆ operator=() [1/2]

Parameters & StormByte::Buffer::Pumper::Parameters::operator= ( const Parameters & other)
default

Copy provider-owned knob values; may allocate and throw.

Parameters
otherSource parameters.
Returns
This instance.

◆ operator=() [2/2]

Parameters & StormByte::Buffer::Pumper::Parameters::operator= ( Parameters && other)
defaultnoexcept

Transfer provider-owned knob values.

Parameters
otherSource parameters.
Returns
This instance.

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