Contents

SushiEngine::Logging::SpscByteRing

read

std::size_t read(void *destination, std::size_t capacity) noexcept

Parameters

NameType
destinationvoid *
capacitystd::size_t

Returns

std::size_t

The record's size, or 0 when the ring is empty or capacity is smaller than the oldest record; the ring is left unchanged then.

Description

Copies the oldest record into destination and removes it.

Precondition

Called only from the consumer thread.