Class DelayAction

Namespace

Ecng.Serialization

Assembly

Ecng.Serialization.dll

Provides delayed action execution with batching support.

public class DelayAction : Disposable, IDisposable

Inheritance

object

Disposable

DelayAction

Implements

IDisposable

Inherited Members

Disposable.Dispose()

Disposable.DisposeManaged()

Disposable.DisposeNative()

Disposable.ThrowIfDisposeStarted()

Disposable.ThrowIfDisposed()

Disposable.IsDisposed

Disposable.IsDisposeStarted

Disposable.Disposed

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

AsyncHelper.FromResult<TValue>(TValue)

AsyncHelper.ToCompleteSource<TValue>(TValue)

CompareHelper.IsDefault<T>(T)

CompareHelper.IsRuntimeDefault<T>(T)

Converter.TypedTo<TFrom, TTo>(TFrom)

DelegateHelper.AddDelegate<TDelegate>(TDelegate, TDelegate)

DelegateHelper.GetInvocationList<TDelegate>(TDelegate)

DelegateHelper.RemoveAllDelegates<TDelegate>(TDelegate)

DelegateHelper.RemoveDelegate<TDelegate>(TDelegate, TDelegate)

DisposableHelper.MakeDisposable<T>(T, Action<T>)

Enumerator.IsDefined<T>(T)

Enumerator.SplitMask<T>(T)

NullableHelper.Convert<T, TResult>(T, Func<T, TResult>, Func<TResult>)

NullableHelper.IsNull<T>(T)

NullableHelper.IsNull<T>(T, bool)

TupleHelper.ToValues<T>(T)

TypeHelper.CheckOnNull<T>(T, string)

TypeHelper.DoDispose<TSource>(TSource)

TypeHelper.ToScope<T>(T, bool)

NetworkHelper.Format<T>(T, bool)

PersistableHelper.TrySerialize<T>(T, out SettingsStorage)

XamlHelper.CopyToClipboard<T>(T)

Paths.SerializeToString<T>(T, bool)

Paths.Serialize<T>(T, bool)

Paths.Serialize<T>(T, string, bool)

CompareHelper.Compare(object, object)

Converter.To(object, Type)

Converter.To<T>(object)

Enumerator.GetAttributeOfType<TAttribute>(object)

Enumerator.IsEnumBrowsable(object)

Enumerator.SplitMask2(object)

TypeHelper.HasProperty(object, string)

EntityPropertyHelper.GetPropValue(object, string, Func<object, string, object>, IDictionary<string, object>)

Extensions.GetBasicProperties(object, int)

Extensions.GetDisplayName(object)

Extensions.GetFieldDescription(object)

Extensions.GetFieldDisplayName(object)

Extensions.GetFieldIcon(object)

JsonHelper.ToJson(object, bool)

JsonHelper.ToJson(object, bool, JsonSerializerSettings)

PersistableHelper.ToStorage(object, bool)

EditorExtensions.ToItemsSource(object, Type, bool?, ListSortDirection?, Func<IItemsSourceItem, bool>, Func<object, string>, Func<object, string>)

XamlHelper.EnsureUIThread(object)

XamlHelper.ShowModel<TWindow>(object, DependencyObject)

XamlHelper.WpfCast<T>(object)

VirtualPropertyRegistry.TryGetVirtualValue(object, string, out object)

Constructors

DelayAction(Action<Exception>)

Initializes a new instance of the DelayAction class.

public DelayAction(Action<Exception> errorHandler)

Parameters

errorHandler Action<Exception>

A delegate to handle errors that occur during execution.

Properties

DefaultGroup

Gets the default group for delayed actions.

public DelayAction.IGroup DefaultGroup { get; }

Property Value

DelayAction.IGroup

FlushInterval

Gets or sets the flush interval for batching actions.

public TimeSpan FlushInterval { get; set; }

Property Value

TimeSpan

MaxBatchSize

Gets or sets the maximum number of actions in a single batch.

public int MaxBatchSize { get; set; }

Property Value

int

Methods

BeginBatch(IGroup)

Begins a new batch for the specified group.

protected virtual IBatchContext BeginBatch(DelayAction.IGroup group)

Parameters

group DelayAction.IGroup

The group for which to begin the batch.

Returns

IBatchContext

An IBatchContext representing the batch operation.

CreateGroup<T>(Func<T>)

Creates a new group of delayed actions with a specific state.

public DelayAction.IGroup<T> CreateGroup<T>(Func<T> init) where T : IDisposable

Parameters

init Func<T>

A function to initialize the group state. If null, a dummy state is used.

Returns

DelayAction.IGroup<T>

A new group for handling delayed actions.

Type Parameters

T

The type of the group state, which implements IDisposable.

DeleteGroup(IGroup)

Deletes a previously created group of delayed actions.

public void DeleteGroup(DelayAction.IGroup group)

Parameters

group DelayAction.IGroup

The group to delete.

OnFlush()

Flushes all queued actions by executing them in batches.

public void OnFlush()

WaitFlush(bool)

Waits until all queued actions are flushed and optionally disposes the DelayAction instance.

public void WaitFlush(bool dispose)

Parameters

dispose bool

If set to true, disposes the DelayAction instance after flushing.