Class LatestBackgroundResult<T>

Namespace

NanoByte.Common.Threading

Assembly

NanoByte.Common.dll

Manages a single background computation, exposing only the most recent result thread-safely.

public sealed class LatestBackgroundResult<T> where T : class

Type Parameters

T

The type of result produced by the calculation.

Inheritance

object

LatestBackgroundResult<T>

Extension Methods

BinaryStorage.SaveBinary<T>(T, Stream)

BinaryStorage.SaveBinary<T>(T, string)

JsonStorage.SaveJson<T>(T, Stream)

JsonStorage.SaveJson<T>(T, string)

JsonStorage.ToJsonString<T>(T)

XmlStorage.SaveXml<T>(T, Stream, string?)

XmlStorage.SaveXml<T>(T, string, string?)

XmlStorage.ToXmlString<T>(T, string?)

UpdateUtils.To<T>(T, ref T, Action)

UpdateUtils.To<T>(T, ref T, ref bool)

UpdateUtils.To<T>(T, ref T, ref bool, ref bool)

UpdateUtils.To<TIn, TOut>(TIn, Func<TIn, TOut>)

ConversionUtils.ConvertToString<TType>(TType)

JsonStorage.ReparseAsJson<T>(object)

JsonStorage.ReparseAsJson<T>(object, T)

Remarks

Starting a new computation automatically cancels and discards any in-progress one.

Properties

Result

The most recent successfully completed result, or null if no result is available yet.

public T? Result { get; }

Property Value

T

Methods

Cancel()

Cancels any in-progress computation and discards the current result.

public void Cancel()

ConsumeResult()

Atomically reads and clears the latest result. Returns null if no result is available.

public T? ConsumeResult()

Returns

T

Run(Func<CancellationToken, T>)

Cancels any in-progress computation and starts computation on a background thread. The result becomes available via Result or ConsumeResult() once complete.

public void Run(Func<CancellationToken, T> computation)

Parameters

computation Func<CancellationToken, T>

Remarks

If the computation is canceled before it finishes, the result is silently discarded.