DuxReiNummariae 1.0.0-alpha.23
Simple and powerful budgeting application
 
Loading...
Searching...
No Matches
drn::updating::UpdateChecker Class Referencefinal

This class is responsible for checking and notifying about software updates. More...

#include <UpdateChecker.hpp>

Inheritance diagram for drn::updating::UpdateChecker:
Collaboration diagram for drn::updating::UpdateChecker:

Signals

void finishedCheck ()
 Triggered when the completion of the application update check process.
 
void updateReleased (const drn::updating::SemanticVersion &latest)
 Triggered when a new version has been released relative to the built version.
 

Public Member Functions

 UpdateChecker (networking::NotifyingSender &sender, const foundation::QtPtr<::QObject > &parent)
 Full initialisation constructor that manages the update fetching operations. It initialises itself with a given NotifyingSender for sending network requests, and a parent QObject to maintain the lifespan of this object within an existing object hierarchy.
 
void check ()
 Begins the process of checking if there is an application update.
 

Detailed Description

This class is responsible for checking and notifying about software updates.

Constructor & Destructor Documentation

◆ UpdateChecker()

drn::updating::UpdateChecker::UpdateChecker ( networking::NotifyingSender & sender,
const foundation::QtPtr<::QObject > & parent )

Full initialisation constructor that manages the update fetching operations. It initialises itself with a given NotifyingSender for sending network requests, and a parent QObject to maintain the lifespan of this object within an existing object hierarchy.

Parameters
senderReference to the object responsible for sending network requests.
parentA Qt smart pointer to a QObject that acts as the parent of this instance. It ensures the object is properly managed within Qt's ownership model.

Member Function Documentation

◆ check()

void drn::updating::UpdateChecker::check ( )

Begins the process of checking if there is an application update.

◆ finishedCheck

void drn::updating::UpdateChecker::finishedCheck ( )
signal

Triggered when the completion of the application update check process.

This signal is emitted after the update checking operation concludes, regardless of whether a new update was found, no updates were available, or an error occurred during the process. It serves as a notification that the check operation has finished and ensures any dependent resources or operations can proceed accordingly.

Usage: This signal is commonly connected to a slot or lambda to handle any clean-up, logging, or subsequent actions once the update check is complete. For example, it is often used to signal that the UpdateChecker instance can be safely deleted to release resources.

◆ updateReleased

void drn::updating::UpdateChecker::updateReleased ( const drn::updating::SemanticVersion & latest)
signal

Triggered when a new version has been released relative to the built version.

Usage:

  • Connect to this signal in your application to receive updates when a new version is detected.
Parameters
latestThe newest version of the software available.