scan_worker.hpp

1. Overview

The scan_worker.hpp file executes device or image scans asynchronously and publishes progress and final reports.

This is an interface and data-contract file. It declares the public and internal types used by this subsystem, allowing implementation files and callers to share a stable compile-time contract.

Its paired source or interface file is scan_worker.cpp.

Primary responsibilities:

  • Start scanner work outside the UI thread
  • Forward progress updates
  • Support cancellation or lifecycle control
  • Deliver completed ScanReport objects

2. File Identity and Scope

  • Source path: src/scan_worker.hpp
  • Language: C++
  • File role: interface and data-contract file
  • Physical lines: 33
  • Non-empty lines: 25
  • SHA-256: 538dce36719e8c911a265354624e1c9a99e73e9c6eb18fc575377c4973975aed

The declarations in this file use the global namespace.

3. Dependencies

3.1 Project Headers

  • models.hpp

3.2 Standard and External Headers

  • atomic
  • functional
  • string
  • thread

These dependencies define the file’s compile-time integration with the recovery engine, GTK interface, on-disk format decoders, operating-system services, or C++ standard library.

4. Declared Types

  • class ScanWorker.

5. Constants and Configuration Values

No preprocessor or compile-time constants were detected as top-level declarations in this file.

6. Data Members and Persistent State

The interface declares the following state-bearing members:

  • ProgressCallback progress_cb={})
  • std::atomic<bool> running_{false}
  • std::atomic<bool> cancel_requested_{false}
  • std::thread thread_

These members hold configuration, parser context, UI widgets, source references, progress state, recovered metadata, or temporary resources according to the owning type.

7. API and Function Inventory

The following callable interfaces or definitions were detected:

  • ~ScanWorker() – Destroys the object and releases resources owned by the instance.
  • bool running()const – Implements the operation identified by this API and updates or returns the associated state.
  • void join() – Implements the operation identified by this API and updates or returns the associated state.
  • void request_cancel() – Implements the operation identified by this API and updates or returns the associated state.
  • bool cancel_requested()const – Implements the operation identified by this API and updates or returns the associated state.

8. Operational Flow

The subsystem represented by this file normally participates in the following flow:

  1. Start scanner work outside the UI thread.
  2. Forward progress updates.
  3. Support cancellation or lifecycle control.
  4. Deliver completed ScanReport objects.
  5. Expose or execute the detected APIs: ~ScanWorker, running, join, request_cancel, cancel_requested.
  6. Return explicit results, progress data, recovered records, or diagnostics to the calling layer.

9. Validation and Error Handling

  • Input and output paths require existence checks, permission handling and safe destination construction.

10. Runtime, Concurrency, and Resource Management

  • Concurrency: the file contains worker-thread or synchronization primitives; UI updates and shared state must remain thread-safe.

11. Security and Data-Recovery Considerations

  • Recovery code should prefer read-only source access and avoid writing to the original damaged medium.
  • Raw devices and image files are treated as untrusted binary input; every offset and length must remain bounded by the source size.

12. Implementation Considerations

  • Changes to public declarations can affect every translation unit that includes this header and should preserve binary and source compatibility where required.
  • State-bearing members should have explicit ownership and initialization semantics, especially for references, pointers, file descriptors and GTK widgets.

13. Integration with the Recovery Pipeline

  • The file belongs to the orchestration layer between the UI and low-level parsers.
  • It aggregates progress, results and diagnostics from multiple modules.
  • It should preserve cancellation and completion semantics across thread boundaries.

14. Licensing and Provenance

No explicit copyright or software-license statement was detected in the opening section of this individual file. Distribution terms should therefore be verified against the project-level license and repository metadata.

The SHA-256 value in this document can be used to associate the generated documentation with the exact source version analyzed.

Published on:
Last updated on: