Class BaseUpdaterComponent

Namespace

CarinaStudio.AutoUpdate

Assembly

CarinaStudio.AppBase.AutoUpdate.dll

Base implementation of IUpdaterComponent.

public abstract class BaseUpdaterComponent : BaseDisposableApplicationObject, IApplicationObject, IUpdaterComponent, IDisposable, INotifyPropertyChanged, IThreadDependent, ISynchronizable

Inheritance

object

BaseApplicationObject

BaseDisposableApplicationObject

BaseUpdaterComponent

Implements

IApplicationObject

IUpdaterComponent

IDisposable

INotifyPropertyChanged

IThreadDependent

ISynchronizable

Derived

BasePackageInstaller

BasePackageResolver

Inherited Members

BaseDisposableApplicationObject.Dispose()

BaseDisposableApplicationObject.IsDisposed

BaseDisposableApplicationObject.VerifyDisposed()

BaseApplicationObject.Application

BaseApplicationObject.CheckAccess()

BaseApplicationObject.PersistentState

BaseApplicationObject.Settings

BaseApplicationObject.SynchronizationContext

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

DisposableExtensions.DisposeAndReturnNull<T>(T?)

DisposableExtensions.ExchangeAsync<T, R>(T, Func<T, Task<R?>>)

DisposableExtensions.ExchangeAsync<T, R>(T, Func<Task<R?>>)

DisposableExtensions.Exchange<T, R>(T, Func<T, R?>)

DisposableExtensions.Exchange<T, R>(T, Func<R?>)

DisposableExtensions.SetupAsync<T>(T, Func<T, Task>)

DisposableExtensions.SetupAsync<T>(T, Func<Task>)

DisposableExtensions.Setup<T>(T, Action)

DisposableExtensions.Setup<T>(T, Action<T>)

DisposableExtensions.UseAsync<T>(T, Func<T, Task>)

DisposableExtensions.UseAsync<T, R>(T, Func<T, Task<R>>)

DisposableExtensions.Use<T>(T, Action<T>)

DisposableExtensions.Use<T, R>(T, RefOutFunc<T, R>)

DisposableExtensions.Use<T, R>(T, Func<T, R>)

ObjectExtensions.AddWeakEventHandler<TObject>(TObject, string, Action)

ObjectExtensions.AddWeakEventHandler<TObject>(TObject, string, EventHandler)

ObjectExtensions.AddWeakEventHandler<TObject, TArg>(TObject, string, Action<TArg>)

ObjectExtensions.AddWeakEventHandler<TObject, TArgs>(TObject, string, EventHandler<TArgs>)

ObjectExtensions.AddWeakEventHandler<TObject, TArg1, TArg2>(TObject, string, Action<TArg1, TArg2>)

ObjectExtensions.AddWeakEventHandler<TObject, TArg1, TArg2, TArg3>(TObject, string, Action<TArg1, TArg2, TArg3>)

ObjectExtensions.AlsoAsync<T>(T, Func<T, Task>)

ObjectExtensions.Also<T>(T, Action<T>)

ObjectExtensions.AsNonNull<T>(T?)

ObjectExtensions.LetAsync<T>(T, Func<T, Task>)

ObjectExtensions.LetAsync<T, R>(T, Func<T, Task<R>>)

ObjectExtensions.Let<T>(T, Action<T>)

ObjectExtensions.Let<T, R>(T, RefOutFunc<T, R>)

ObjectExtensions.Let<T, R>(T, Func<T, R>)

ObjectExtensions.LockAsync<T>(T, Func<T, Task>)

ObjectExtensions.LockAsync<T>(T, Func<Task>)

ObjectExtensions.LockAsync<T, R>(T, Func<T, Task<R>>)

ObjectExtensions.LockAsync<T, R>(T, Func<Task<R>>)

ObjectExtensions.Lock<T>(T, Action)

ObjectExtensions.Lock<T>(T, Action<T>)

ObjectExtensions.Lock<T, R>(T, RefOutFunc<T, R>)

ObjectExtensions.Lock<T, R>(T, RefOutFunc<R>)

ObjectExtensions.Lock<T, R>(T, Func<T, R>)

ObjectExtensions.Lock<T, R>(T, Func<R>)

UpdaterComponentExtensions.IsCompletedOrCancelled(IUpdaterComponent)

UpdaterComponentExtensions.IsInitializing(IUpdaterComponent)

UpdaterComponentExtensions.IsStartedOrCancelling(IUpdaterComponent)

UpdaterComponentExtensions.StartAndWaitAsync(IUpdaterComponent)

UpdaterComponentExtensions.StartAndWaitAsync(IUpdaterComponent, CancellationToken)

ThreadDependentExtensions.VerifyAccess(IThreadDependent)

NotifyPropertyChangedExtensions.AddWeakPropertyChangedEventHandler(INotifyPropertyChanged, PropertyChangedEventHandler)

NotifyPropertyChangedExtensions.WaitForPropertyAsync(INotifyPropertyChanged, string, object?, int, CancellationToken?)

ObjectExtensions.TryCastAndRunAsync<T>(object?, Func<T, Task>)

ObjectExtensions.TryCastAndRunAsync<T, R>(object?, Func<T, Task<R>>)

ObjectExtensions.TryCastAndRun<T>(object?, Action<T>)

ObjectExtensions.TryCastAndRun<T, R>(object?, Func<T, R>)

Constructors

BaseUpdaterComponent(IApplication)

Initialize new BaseUpdaterComponent instance.

protected BaseUpdaterComponent(IApplication app)

Parameters

app IApplication

Application.

Properties

Exception

Get Exception occurred when performing operation.

public Exception? Exception { get; }

Property Value

Exception

Logger

Get logger.

protected ILogger Logger { get; }

Property Value

ILogger

Progress

Get progress of operation performed by this component. The range is [0.0, 1.0] or NaN if progress is unknown.

public double Progress { get; }

Property Value

double

State

Get current state.

public UpdaterComponentState State { get; }

Property Value

UpdaterComponentState

Methods

Cancel()

Cancel the operation performed by this component.

public bool Cancel()

Returns

bool

True if operation cancelled successfully.

Dispose(bool)

Dispose the instance.

protected override void Dispose(bool disposing)

Parameters

disposing bool

True to dispose managed resources.

OnCompletedOrCancelled(Exception?)

Called when operation completed or cancelled.

protected virtual void OnCompletedOrCancelled(Exception? ex)

Parameters

ex Exception

Exception occurred while performing operation.

OnPropertyChanged(string)

Raise PropertyChanged event.

protected virtual void OnPropertyChanged(string propertyName)

Parameters

propertyName string

Name of changed property.

PerformOperationAsync(CancellationToken)

Perform operation asynchronously.

protected abstract Task PerformOperationAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task

Task of performing operation.

ReportProgress(double)

Report progress of operation.

protected void ReportProgress(double progress)

Parameters

progress double

Progress.

Remarks

You can call this method from any thread.

Start()

Start performing operation.

public bool Start()

Returns

bool

True if operation started successfully.

ValidateParametersToStart()

Validate parameters to start performing operation.

protected virtual bool ValidateParametersToStart()

Returns

bool

True if all parameters are valid.

VerifyInitializing()

Throw InvalidOperationException if current state is not Initializing.

protected void VerifyInitializing()

Events

PropertyChanged

Raise when property changed.

public event PropertyChangedEventHandler? PropertyChanged

Event Type

PropertyChangedEventHandler