Class GameInstallerBase

Namespace: CmlLib.Core.Installers
Assembly: CmlLib.Core.dll

public abstract class GameInstallerBase : IGameInstaller

Inheritance

object ← GameInstallerBase

Derived

BasicGameInstaller, ParallelGameInstaller

Implements

IGameInstaller

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

Constructors

GameInstallerBase(HttpClient)

public GameInstallerBase(HttpClient httpClient)

Parameters

httpClient HttpClient

Properties

CheckFileChecksum

public bool CheckFileChecksum { get; set; }

Property Value

bool

CheckFileSize

public bool CheckFileSize { get; set; }

Property Value

bool

ExcludeFiles

public IEnumerable<string> ExcludeFiles { get; set; }

Property Value

IEnumerable<string>

Methods

Download(GameFile, IProgress<ByteProgress>?, CancellationToken)

protected virtual Task Download(GameFile file, IProgress<ByteProgress>? progress, CancellationToken cancellationToken)

Parameters

file GameFile

progress IProgress<ByteProgress>?

cancellationToken CancellationToken

Returns

Task

FireByteProgress(ByteProgress)

protected void FireByteProgress(ByteProgress progress)

Parameters

progress ByteProgress

FireFileProgress(int, int, string?, InstallerEventType)

protected void FireFileProgress(int totalTasks, int progressedTasks, string? name, InstallerEventType type)

Parameters

totalTasks int

progressedTasks int

name string?

type InstallerEventType

Install(IEnumerable<GameFile>, IProgress<InstallerProgressChangedEventArgs>?, IProgress<ByteProgress>?, CancellationToken)

public ValueTask Install(IEnumerable<GameFile> gameFiles, IProgress<InstallerProgressChangedEventArgs>? fileProgress, IProgress<ByteProgress>? byteProgress, CancellationToken cancellationToken)

Parameters

gameFiles IEnumerable<GameFile>

fileProgress IProgress<InstallerProgressChangedEventArgs>?

byteProgress IProgress<ByteProgress>?

cancellationToken CancellationToken

Returns

ValueTask

Install(IEnumerable<GameFile>, CancellationToken)

protected abstract ValueTask Install(IEnumerable<GameFile> gameFiles, CancellationToken cancellationToken)

Parameters

gameFiles IEnumerable<GameFile>

cancellationToken CancellationToken

Returns

ValueTask

IsExcludedPath(string)

protected bool IsExcludedPath(string path)

Parameters

path string

Returns

bool

NeedUpdate(GameFile)

protected bool NeedUpdate(GameFile file)

Parameters

file GameFile

Returns

bool