Class DispatcherSynchronizationContext

Namespace

CarinaStudio.Threading

Assembly

CarinaStudio.AppBase.Avalonia.dll

Implementation of SynchronizationContext based-on Dispatcher.

public class DispatcherSynchronizationContext : SynchronizationContext

Inheritance

object

SynchronizationContext

DispatcherSynchronizationContext

Inherited Members

SynchronizationContext.CreateCopy()

SynchronizationContext.IsWaitNotificationRequired()

SynchronizationContext.OperationCompleted()

SynchronizationContext.OperationStarted()

SynchronizationContext.SetSynchronizationContext(SynchronizationContext)

SynchronizationContext.SetWaitNotificationRequired()

SynchronizationContext.Wait(IntPtr[], bool, int)

SynchronizationContext.WaitHelper(IntPtr[], bool, int)

SynchronizationContext.Current

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

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>)

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>)

SynchronizationContextExtensions.CancelDelayed(SynchronizationContext, object)

SynchronizationContextExtensions.Post(SynchronizationContext, Action)

SynchronizationContextExtensions.PostDelayed(SynchronizationContext, Action, int)

SynchronizationContextExtensions.PostDelayed(SynchronizationContext, Action, TimeSpan)

SynchronizationContextExtensions.PostDelayed(SynchronizationContext, SendOrPostCallback, object?, int)

SynchronizationContextExtensions.PostDelayed(SynchronizationContext, SendOrPostCallback, object?, TimeSpan)

SynchronizationContextExtensions.Send(SynchronizationContext, Action)

SynchronizationContextExtensions.SendAsync(SynchronizationContext, Action, CancellationToken)

SynchronizationContextExtensions.SendAsync(SynchronizationContext, Func<Task>, CancellationToken)

SynchronizationContextExtensions.SendAsync<R>(SynchronizationContext, Func<Task<R>>, CancellationToken)

SynchronizationContextExtensions.SendAsync<R>(SynchronizationContext, Func<R>, CancellationToken)

SynchronizationContextExtensions.Send<R>(SynchronizationContext, Func<R>)

Constructors

DispatcherSynchronizationContext(Dispatcher)

Initialize new DispatcherSynchronizationContext instance.

public DispatcherSynchronizationContext(Dispatcher dispatcher)

Parameters

dispatcher Dispatcher

Dispatcher.

Properties

Dispatcher

Get Dispatcher which is related to this instance.

public Dispatcher Dispatcher { get; }

Property Value

Dispatcher

UIThread

Get DispatcherSynchronizationContext instance for UI thread with Avalonia.Threading.DispatcherPriority.Normal priority.

public static DispatcherSynchronizationContext UIThread { get; }

Property Value

DispatcherSynchronizationContext

DispatcherSynchronizationContext.

Methods

CancelDelayed(object)

Cancel posted delayed call-back.

public bool CancelDelayed(object token)

Parameters

token object

Token returned from PostDelayed(SendOrPostCallback, object?, DispatcherPriority, int) or PostDelayed(Action, DispatcherPriority, int).

Returns

bool

True if call-back cancelled successfully.

Post(Action, DispatcherPriority)

Post action with given priority.

public void Post(Action action, DispatcherPriority priority)

Parameters

action Action

Action.

priority DispatcherPriority

Priority.

Post(SendOrPostCallback, object?)

When overridden in a derived class, dispatches an asynchronous message to a synchronization context.

public override void Post(SendOrPostCallback d, object? state)

Parameters

d SendOrPostCallback

The SendOrPostCallback delegate to call.

state object

The object passed to the delegate.

Post(SendOrPostCallback, object?, DispatcherPriority)

Post call-back with given priority.

public void Post(SendOrPostCallback d, object? state, DispatcherPriority priority)

Parameters

d SendOrPostCallback

Call-back.

state object

State.

priority DispatcherPriority

Priority.

PostDelayed(Action, DispatcherPriority, int)

Post delayed call-back.

public object PostDelayed(Action callback, DispatcherPriority priority, int delayMillis)

Parameters

callback Action

Call-back.

priority DispatcherPriority

Priority.

delayMillis int

Delayed time in milliseconds.

Returns

object

Token of posted delayed call-back.

PostDelayed(SendOrPostCallback, object?, DispatcherPriority, int)

Post delayed call-back.

public object PostDelayed(SendOrPostCallback callback, object? state, DispatcherPriority priority, int delayMillis)

Parameters

callback SendOrPostCallback

Call-back.

state object

Custom state pass to call-back.

priority DispatcherPriority

Priority.

delayMillis int

Delayed time in milliseconds.

Returns

object

Token of posted delayed call-back.

Send(Action, DispatcherPriority)

Send action with given priority and wait for completion.

public void Send(Action action, DispatcherPriority priority)

Parameters

action Action

Action.

priority DispatcherPriority

Priority.

Send(SendOrPostCallback, object?)

When overridden in a derived class, dispatches a synchronous message to a synchronization context.

public override void Send(SendOrPostCallback d, object? state)

Parameters

d SendOrPostCallback

The SendOrPostCallback delegate to call.

state object

The object passed to the delegate.

Exceptions

NotSupportedException

The method was called in a Windows Store app. The implementation of SynchronizationContext for Windows Store apps does not support the Send(SendOrPostCallback, object) method.

Send(SendOrPostCallback, object?, DispatcherPriority)

Send call-back with given priority and wait for completion.

public void Send(SendOrPostCallback d, object? state, DispatcherPriority priority)

Parameters

d SendOrPostCallback

Call-back.

state object

State.

priority DispatcherPriority

Priority.