StormByte::Buffer::HighWater Class Reference

Input occupancy cap for Pumper. More...

#include <StormByte/buffer/pumper.hxx>

Public Member Functions
STORMBYTE_FORCE_INLINE	HighWater (const StormByte::ByteSize value) noexcept
	Store the input cap.
STORMBYTE_FORCE_INLINE StormByte::ByteSize	Value () const noexcept
	Input cap.

Detailed Description

Input occupancy cap for Pumper.

Applies to the read tip only. 0 is an explicit "no Pumper cap". Omitting the knob is not the same as 0: the office then picks 0 for an IO source and a non-IO default defined in the backend.

Constructor & Destructor Documentation

HighWater()

STORMBYTE_FORCE_INLINE StormByte::Buffer::HighWater::HighWater ( const StormByte::ByteSize  value )

inlineexplicitnoexcept

Store the input cap.

Parameters

value

Bytes. 0 disables the Pumper cap.

Member Function Documentation

Value()

STORMBYTE_FORCE_INLINE StormByte::ByteSize StormByte::Buffer::HighWater::Value ( ) const

inlinenoexcept

Input cap.

Returns

Bytes.

---

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

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