pulp::host::BackgroundScanner Class Reference

#include <background_scanner.hpp>

Public Member Functions
	BackgroundScanner ()=default
	~BackgroundScanner ()
	BackgroundScanner (const BackgroundScanner &)=delete
BackgroundScanner &	operator= (const BackgroundScanner &)=delete
bool	start (ScanWorkerFn worker, ScanProgressCallback progress, ScanCompletionCallback completion)
	Start a scan. Returns false if a scan is already running.
void	cancel ()
	Request the running scan cancel.
bool	is_running () const
	True while the worker thread is active.
void	join ()
	Block until the worker thread finishes. Safe to call when idle.

Constructor & Destructor Documentation

BackgroundScanner() [1/2]

pulp::host::BackgroundScanner::BackgroundScanner ( )

default

~BackgroundScanner()

pulp::host::BackgroundScanner::~BackgroundScanner ( )

inline

BackgroundScanner() [2/2]

pulp::host::BackgroundScanner::BackgroundScanner ( const BackgroundScanner & )

delete

Member Function Documentation

cancel()

void pulp::host::BackgroundScanner::cancel

(

)

Request the running scan cancel.

No-op if nothing is running. The completion callback still fires (with cancelled = true).

is_running()

bool pulp::host::BackgroundScanner::is_running ( ) const

inline

True while the worker thread is active.

join()

void pulp::host::BackgroundScanner::join

(

)

Block until the worker thread finishes. Safe to call when idle.

operator=()

BackgroundScanner & pulp::host::BackgroundScanner::operator= ( const BackgroundScanner & )

delete

start()

bool pulp::host::BackgroundScanner::start	(	ScanWorkerFn	worker,
		ScanProgressCallback	progress,
		ScanCompletionCallback	completion )

Start a scan. Returns false if a scan is already running.

---

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

• /home/runner/work/pulp/pulp/core/host/include/pulp/host/background_scanner.hpp