Base module
AsyncDiagnostic
Asynchronous diagnostic information collector.
AsyncDiagnostic
#include <icy/diagnosticmanager.h>class AsyncDiagnosticDefined in src/base/include/icy/diagnosticmanager.h:124
Inherits:
IDiagnostic,Runnable
Asynchronous diagnostic information collector.
List of all members
| Name | Kind | Owner |
|---|---|---|
~AsyncDiagnostic | function | Declared here |
run | function | Declared here |
check | function | Declared here |
_thread | variable | Declared here |
name | variable | Inherited from IDiagnostic |
description | variable | Inherited from IDiagnostic |
summary | variable | Inherited from IDiagnostic |
SummaryUpdated | variable | Inherited from IDiagnostic |
IDiagnostic | function | Inherited from IDiagnostic |
~IDiagnostic | function | Inherited from IDiagnostic |
check | function | Inherited from IDiagnostic |
reset | function | Inherited from IDiagnostic |
complete | function | Inherited from IDiagnostic |
passed | function | Inherited from IDiagnostic |
failed | function | Inherited from IDiagnostic |
run | function | Inherited from IDiagnostic |
pass | function | Inherited from IDiagnostic |
fail | function | Inherited from IDiagnostic |
addSummary | function | Inherited from IDiagnostic |
StateChange | variable | Inherited from Stateful |
Stateful | function | Inherited from Stateful |
~Stateful | function | Inherited from Stateful |
stateEquals | function | Inherited from Stateful |
stateBetween | function | Inherited from Stateful |
state | function | Inherited from Stateful |
state | function | Inherited from Stateful |
_state | variable | Inherited from Stateful |
beforeStateChange | function | Inherited from Stateful |
onStateChange | function | Inherited from Stateful |
setState | function | Inherited from Stateful |
setState | function | Inherited from Stateful |
Runnable | function | Inherited from Runnable |
~Runnable | function | Inherited from Runnable |
run | function | Inherited from Runnable |
cancel | function | Inherited from Runnable |
cancelled | function | Inherited from Runnable |
exit | variable | Inherited from Runnable |
Inherited from IDiagnostic
| Kind | Name | Description |
|---|---|---|
variable | name | The name of the diagnostic. |
variable | description | The diagnostic description. |
variable | summary | The diagnostic summary, maybe including troubleshooting information on failure. |
variable | SummaryUpdated | Signals when a new text item is added to the summary. |
function | IDiagnostic | |
function | ~IDiagnostic virtual | |
function | check virtual | Resets state to None and invokes run() to perform the diagnostic check. |
function | reset virtual | Clears the summary and resets state to None. |
function | complete virtual const | Returns true if the diagnostic has reached a terminal state (Passed or Failed). |
function | passed virtual const | Returns true if the diagnostic state is Passed. |
function | failed virtual const | Returns true if the diagnostic state is Failed. |
function | run virtual | Override to implement diagnostic logic. |
function | pass virtual | Transitions the state to Passed. |
function | fail virtual | Transitions the state to Failed. |
function | addSummary virtual | Appends text to the summary list and emits SummaryUpdated. |
Inherited from Stateful
| Kind | Name | Description |
|---|---|---|
variable | StateChange | Signals when the state changes. |
function | Stateful inline | |
function | ~Stateful virtual inline | |
function | stateEquals virtual const inline | Returns true if the current state ID equals the given ID. |
function | stateBetween virtual const inline | Returns true if the current state ID is in the inclusive range [lid, rid]. |
function | state virtual inline | Returns a mutable reference to the current state. |
function | state virtual const inline | Returns a copy of the current state. |
variable | _state | |
function | beforeStateChange virtual inline | Override to handle pre state change logic. Return false to prevent state change. |
function | onStateChange virtual inline | Override to handle post state change logic. |
function | setState virtual inline | Sets the state and sends the state signal if the state change was successful. |
function | setState virtual inline | Sets the state and sends the state signal if the state change was successful. |
Inherited from Runnable
| Kind | Name | Description |
|---|---|---|
function | Runnable inline | |
function | ~Runnable virtual | Defaulted destructor. |
function | run virtual | The run method will be called by the asynchronous context. |
function | cancel virtual inline | Cancel the current task. The run() method should return ASAP. |
function | cancelled virtual const inline | Returns true when the task has been cancelled. |
variable | exit |
Public Methods
| Return | Name | Description |
|---|---|---|
void | run virtual override | Override to implement diagnostic logic. |
void | check virtual inline override | Resets the diagnostic and launches run() on a background thread. |
run
virtual override
virtual void run() overrideDefined in src/base/include/icy/diagnosticmanager.h:130
Override to implement diagnostic logic.
The StateChange signal will dispatch diagnostic test results to delegates.
Reimplements
check
virtual inline override
virtual inline void check() overrideDefined in src/base/include/icy/diagnosticmanager.h:133
Resets the diagnostic and launches run() on a background thread.
Reimplements
Protected Attributes
| Return | Name | Description |
|---|---|---|
Thread | _thread |
_thread
Thread _thread