PostSharpAPI ReferencePost­Sharp.​Patterns.​ThreadingActor­Dispatcher
Open sandboxFocus

ActorDispatcher Class

A dispatcher compatible with the ActorThreadingModel threading model, with a message queue based on a ConcurrentQueue The queue itself is processed from the ThreadPool.

Inheritance
ActorDispatcher
Namespace: PostSharp.Patterns.Threading
Assembly: PostSharp.Patterns.Threading.dll
Syntax
public class ActorDispatcher : Object, IActorDispatcher, IDispatcher
Remarks

This implementation will append every action (as a result of the BeginInvoke(SendOrPostCallback, Object) method) into a ConcurrentQueue. If will then create a work item to process the ConcurrentQueue and schedule the work item to the ThreadPool. The same work item will keep running unless the message queue is empty, then will terminate.

You can use a different scheduling mechanism instead of the ThreadPool by deriving the class and overriding the ScheduleProcessQueue() method.

Note that the Invoke(SendOrPostCallback, Object) method of the IDispatcher interface is not supported, because the ActorThreadingModel does not support synchronous calls.

Constructors

Name Description
ActorDispatcher()

Initializes a new ActorDispatcher.

Properties

Name Description
IsQueueEmpty

Determines whether there are work items in the queue.

Methods

Name Description
BeginInvoke(SendOrPostCallback, Object)

Queues an action for asynchronous execution.

CheckAccess()

Determines whether the current thread has access to the current dispatcher.

Invoke(SendOrPostCallback, Object)

Executes an action synchronously.

MustYield(Int32)

Determines whether the ProcessQueue() method should interrupt the processing of the message queue before the queue is empty.

OnQueueEmpty()

Method invoked when the queue becomes empty. The default implementation does not do anything.

ProcessQueue()

Processes the message queue synchronously.

ScheduleProcessQueue()

Schedules the execution of the ProcessQueue(), typically on a worker thread or in the ThreadPool. The default implementation uses the ThreadPool on platforms that have a thread pool, otherwise it schedules a new Task.

Explicit Interface Implementations

Name Description
IActorDispatcher.Initialize()

Indicates that the controller should start enforcing access. Before this method is invoked, the CheckAccess() method should always return true, allowing any access to the object. This mechanism allows the actor constructor to have full access on itself.

IDispatcher.IsInvokeSupported

Determines whether the Invoke(SendOrPostCallback, Object) method is supported.

IDispatcher.SynchronizationContext

Gets the SynchronizationContext associated with the current dispatcher.