MPD: PeakBuffer Class Reference

MPD 0.20.18

Public Member Functions
PeakBuffer Class Reference

A FIFO-like buffer that will allocate more memory on demand to allow large peaks. More...

`#include <PeakBuffer.hxx>`

## Public Member Functions
| PeakBuffer (size_t _normal_size, size_t _peak_size)
| PeakBuffer (PeakBuffer &&other)
| ~PeakBuffer ()
| PeakBuffer (const PeakBuffer &)=delete
PeakBuffer & | operator= (const PeakBuffer &)=delete
gcc_pure bool | IsEmpty () const noexcept
gcc_pure WritableBuffer< void > | Read () const noexcept
void | Consume (size_t length) noexcept
bool | Append (const void *data, size_t length)

## Detailed Description

A FIFO-like buffer that will allocate more memory on demand to allow large peaks.

This second buffer will be given back to the kernel when it has been consumed.

Definition at line 36 of file PeakBuffer.hxx.

## Constructor & Destructor Documentation

## ◆ PeakBuffer() [1/3]

PeakBuffer::PeakBuffer | ( | size_t | _normal_size,
|  | size_t | _peak_size
| ) |  |
| inline

Definition at line 42 of file PeakBuffer.hxx.

## ◆ PeakBuffer() [2/3]

PeakBuffer::PeakBuffer | ( | PeakBuffer && | other | ) |
| inline

Definition at line 46 of file PeakBuffer.hxx.

## ◆ ~PeakBuffer()

PeakBuffer::~PeakBuffer | ( |  | ) |

## ◆ PeakBuffer() [3/3]

PeakBuffer::PeakBuffer | ( | const PeakBuffer & |  | ) |
| delete

## Member Function Documentation

## ◆ Append()

bool PeakBuffer::Append | ( | const void * | data,
|  | size_t | length
| ) |  |

## ◆ Consume()

void PeakBuffer::Consume | ( | size_t | length | ) |
| noexcept

## ◆ IsEmpty()

gcc_pure bool PeakBuffer::IsEmpty | ( |  | ) | const
| noexcept

## ◆ operator=()

PeakBuffer& PeakBuffer::operator= | ( | const PeakBuffer & |  | ) |
| delete

## ◆ Read()

gcc_pure WritableBuffer<void> PeakBuffer::Read | ( |  | ) | const
| noexcept

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

- util/PeakBuffer.hxx