ScanWorker Class Reference

#include <scan_worker.hpp>

Public Types
using	CompletionCallback = std::function<void(const ScanReport&)>
using	ProgressCallback = std::function<void(const ScanProgress&)>

Public Member Functions
	ScanWorker ()
	~ScanWorker ()
void	start (const std::string &path, CompletionCallback cb, ProgressCallback progress_cb={})
bool	running () const
void	join ()
void	request_cancel ()
bool	cancel_requested () const

Private Attributes
std::atomic< bool >	running_ {false}
std::atomic< bool >	cancel_requested_ {false}
std::thread	thread_

Detailed Description

Definition at line 9 of file scan_worker.hpp.

Member Typedef Documentation

CompletionCallback

using ScanWorker::CompletionCallback = std::function<void(const ScanReport&)>

Definition at line 11 of file scan_worker.hpp.

ProgressCallback

using ScanWorker::ProgressCallback = std::function<void(const ScanProgress&)>

Definition at line 12 of file scan_worker.hpp.

Constructor & Destructor Documentation

ScanWorker()

ScanWorker::ScanWorker ( )

default

References ScanWorker(), and start().

Referenced by ScanWorker().

~ScanWorker()

ScanWorker::~ScanWorker

(

)

Definition at line 8 of file scan_worker.cpp.

{
    request_cancel();
    join();
}

References join(), and request_cancel().

Member Function Documentation

cancel_requested()

bool ScanWorker::cancel_requested

(

)

const

Definition at line 81 of file scan_worker.cpp.

{
    return cancel_requested_;
}

References cancel_requested_.

join()

void ScanWorker::join

(

)

Definition at line 70 of file scan_worker.cpp.

{
    if (thread_.joinable())
        thread_.join();
}

References thread_.

Referenced by ~ScanWorker().

request_cancel()

void ScanWorker::request_cancel

(

)

Definition at line 76 of file scan_worker.cpp.

{
    cancel_requested_ = true;
}

References cancel_requested_.

Referenced by ~ScanWorker().

running()

bool ScanWorker::running

(

)

const

Definition at line 65 of file scan_worker.cpp.

{
    return running_;
}

References running_.

Referenced by AppWindow::on_scan_clicked(), MainWindow::on_scan_now(), and MainWindow::update_action_controls().

start()

void ScanWorker::start	(	const std::string &	path,
		CompletionCallback	cb,
		ProgressCallback	progress_cb = {} )

Definition at line 14 of file scan_worker.cpp.

{
    if (running_)
        return;
 
    cancel_requested_ = false;
    running_ = true;
 
    thread_ = std::thread([this, path, cb, progress_cb]()
    {
        ScanReport report;
 
        try
        {
            ScannerEngine engine;
 
            report = engine.run_scan(
                path,
                [this, progress_cb](const ScanProgress& p)
                {
                    if (cancel_requested_)
                        return;
 
                    if (progress_cb)
                        progress_cb(p);
                },
                [this]()
                {
                    return cancel_requested_.load();
                }
            );
        }
        catch (const std::exception& e)
        {
            report.logs.push_back(
                std::string("ScanWorker exception: ") + e.what());
        }
        catch (...)
        {
            report.logs.push_back("ScanWorker unknown exception");
        }
 
        running_ = false;
 
        if (!cancel_requested_ && cb)
            cb(report);
    });
}

References cancel_requested_, ScanReport::logs, ScannerEngine::run_scan(), running_, and thread_.

Referenced by AppWindow::on_scan_clicked(), MainWindow::on_scan_now(), and ScanWorker().

Member Data Documentation

cancel_requested_

std::atomic<bool> ScanWorker::cancel_requested_ {false}

private

Definition at line 30 of file scan_worker.hpp.

Referenced by cancel_requested(), request_cancel(), and start().

running_

std::atomic<bool> ScanWorker::running_ {false}

private

Definition at line 29 of file scan_worker.hpp.

Referenced by running(), and start().

thread_

std::thread ScanWorker::thread_

private

Definition at line 32 of file scan_worker.hpp.

Referenced by join(), and start().

---

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

• BastionGuard/thirdparty/bastionguard-recovery-data/src/scan_worker.hpp
• BastionGuard/thirdparty/bastionguard-recovery-data/src/scan_worker.cpp