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

Page drain high watermark. More...

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

Public Member Functions

 WriteThreshold (StormByte::ByteSize value) noexcept
 Store the drain high watermark.
 WriteThreshold (const WriteThreshold &other) noexcept=default
 Copy the watermark.
 WriteThreshold (WriteThreshold &&other) noexcept=default
 Move the watermark.
 ~WriteThreshold () noexcept=default
 Destroy the non-owning watermark.
WriteThreshold & operator= (const WriteThreshold &other) noexcept=default
 Replace the watermark.
WriteThreshold & operator= (WriteThreshold &&other) noexcept=default
 Move-assign the watermark.
StormByte::ByteSize Value () const noexcept
 Requested high watermark.

Detailed Description

Page drain high watermark.

Zero drains only under memory pressure.

Constructor & Destructor Documentation

◆ WriteThreshold() [1/3]

StormByte::Buffer::IO::WriteThreshold::WriteThreshold ( StormByte::ByteSize value)
inlineexplicitnoexcept

Store the drain high watermark.

Parameters
valuePending bytes; zero means memory pressure only.

◆ WriteThreshold() [2/3]

StormByte::Buffer::IO::WriteThreshold::WriteThreshold ( const WriteThreshold & other)
defaultnoexcept

Copy the watermark.

Parameters
otherSource.

◆ WriteThreshold() [3/3]

StormByte::Buffer::IO::WriteThreshold::WriteThreshold ( WriteThreshold && other)
defaultnoexcept

Move the watermark.

Parameters
otherSource.

◆ ~WriteThreshold()

StormByte::Buffer::IO::WriteThreshold::~WriteThreshold ( )
defaultnoexcept

Destroy the non-owning watermark.

Member Function Documentation

◆ operator=() [1/2]

WriteThreshold & StormByte::Buffer::IO::WriteThreshold::operator= ( const WriteThreshold & other)
defaultnoexcept

Replace the watermark.

Parameters
otherSource.
Returns
This knob.

◆ operator=() [2/2]

WriteThreshold & StormByte::Buffer::IO::WriteThreshold::operator= ( WriteThreshold && other)
defaultnoexcept

Move-assign the watermark.

Parameters
otherSource.
Returns
This knob.

◆ Value()

StormByte::ByteSize StormByte::Buffer::IO::WriteThreshold::Value ( ) const
inlinenoexcept

Requested high watermark.

Returns
Bytes, or zero for memory pressure only.

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