pulp::audio::FrameReaderStopToken Class Reference

Cooperative cancellation signal passed to a streaming frame reader. More...

#include <streaming_sample_source.hpp>

Public Member Functions
	FrameReaderStopToken () noexcept=default
	FrameReaderStopToken (const std::atomic< bool > &stop_requested) noexcept
bool	stop_requested () const noexcept

Detailed Description

Cooperative cancellation signal passed to a streaming frame reader.

Copies remain valid only for the duration of the reader invocation.

Constructor & Destructor Documentation

FrameReaderStopToken() [1/2]

pulp::audio::FrameReaderStopToken::FrameReaderStopToken ( )

defaultnoexcept

FrameReaderStopToken() [2/2]

pulp::audio::FrameReaderStopToken::FrameReaderStopToken ( const std::atomic< bool > & stop_requested )

inlineexplicitnoexcept

Member Function Documentation

stop_requested()

bool pulp::audio::FrameReaderStopToken::stop_requested ( ) const

inlinenoexcept

---

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

• /home/runner/work/pulp/pulp/core/audio/include/pulp/audio/streaming_sample_source.hpp