Interface IWorkProgress

Namespace

RDCore.SDK.Server.Progress

Assembly

RDCore.SDK.dll

Work that reports its progress to the client while it is done (LSP 3.17 §Work Done Progress): it reports each step it takes, and it is completed when it is done - which is reported, whatever the work came to.

public interface IWorkProgress : IProgress<WorkProgressStep>, IDisposable

Inherited Members

IProgress<WorkProgressStep>.Report(WorkProgressStep)

IDisposable.Dispose()

Remarks

The work is an IProgress<T>, which is what the code that does it is given: it needs to know nothing of LSP, and reports to whatever it is given, which can report to nothing. Disposing of it completes it, so that work that throws completes as surely as work that does not.

Methods

Complete(string?)

Completes the work, which says so to the client - with message, when there is one - and reports nothing more of it.

void Complete(string? message = null)

Parameters

message string

What the work came to, in a few words.