Dispatcher Members
Microsoft Robotics Class Reference
The Dispatcher type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
Dispatcher() () () () |
Constructs a Dispatcher instance using the default number of threads and no friendly tag
|
|
Dispatcher(Int32, String) |
Constructs a Dispatcher instance. The instance is usable only after AddPort is called at least once
|
|
Dispatcher(Int32, ThreadPriority, DispatcherOptions, String) |
Constructs a Dispatcher instance. The instance is usable only after AddPort is called at least once
|
|
Dispatcher(Int32, ThreadPriority, Boolean, String) |
Constructs a Dispatcher instance. The instance is usable only after AddPort is called at least once
|
|
Dispatcher(Int32, ThreadPriority, DispatcherOptions, ApartmentState, String) |
Constructs a Dispatcher instance. The instance is usable only after AddPort is called at least once
|
|
Dispatcher(Int32, ThreadPriority, DispatcherOptions, ApartmentState, Int32, String) |
Constructs a Dispatcher instance. The instance is usable only after AddPort is called at least once
|
Methods
| Name | Description | |
|---|---|---|
.gif "Static member") |
AddCausality |
Adds a causality to the current thread causality stack
|
|
AddCausalityBreak |
Adds a causality with BreakOnReceive = true to the current thread causality stack. In a debug build, if a debugger is attached this will cause the debugger to break just before the any task in this causality is executed.
|
|
ClearCausalities |
Removes all causalities from current thread context
|
|
Dispose |
Stops all scheduling and disposes this dispatcher instance
|
|
Equals | (Inherited from Object.) |
.gif "Protected method") |
Finalize |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) |
|
GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) |
|
GetType |
Gets the Type of the current instance.
(Inherited from Object.) |
|
MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
|
RemoveCausality(String) |
Removes a causality from the current thread context
|
|
RemoveCausality(ICausality) |
Removes a causality from the current thread context
|
|
ToString | (Inherited from Object.) |
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
ActiveCausalities |
Retrieves a collection of all the bottom of the stack causalities that would be responsible for capturing exceptions in the current context
|
|
DispatcherQueues |
Collection of task ports associated with this dispatcher instance
|
|
HasActiveCausalities |
True indicates that one or more causality is active on the current thread context
|
|
Name |
Friendly name associated with this dispatcher instance
|
|
Options |
Dispatcher configuration options
|
|
PendingTaskCount |
Number of pending tasks across all dispatcher ports associated to this dispatcher
|
|
ProcessedTaskCount |
Monotonically increasing counter indicating total number of task processed so far
|
|
ThreadsPerCpu |
Number of threads per Cpu, if threads are not specified when initializing the dispatcher
|
|
UnhandledExceptionPort |
Gets or sets a port that any unhandled exceptions occuring in tasks running in threads owned by this dispatcher will be sent to.
|
|
WorkerThreadCount |
Number of worker threads processing tasks across all dispatcher ports associated with this dispatcher
|
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
UnhandledException |
This event is raised when an unhandled exception occurs in tasks running in threads owned by this dispatcher.
|