DispatcherQueue Members

Microsoft Robotics Class Reference

The DispatcherQueue type exposes the following members.

Constructors

	Name	Description
	DispatcherQueue() () () ()	Default constructor
	DispatcherQueue(String)	Constructs an instance of the dispatcher port using the CLR thread pool for task execution
	DispatcherQueue(String, Dispatcher)	Constructs an instance of the dispatcher port using the specified CCR dispatcher
	DispatcherQueue(String, Dispatcher, TaskExecutionPolicy, Double)	Constructs an instance of the dispatcher port using the specified CCR dispatcher
	DispatcherQueue(String, Dispatcher, TaskExecutionPolicy, Int32)	Constructs an instance of the dispatcher port using the specified CCR dispatcher

Methods

	Name	Description
	Dispose() () () ()	Dispose releases resources associated with this instance
	Dispose(Boolean)	Implementation of dispose
	Enqueue	Enqueue ITask instance
	EnqueueTimer	Enqueues a timer registration that will post a DateTime item on the timerPort
	EnqueueTimerUsingClrSystemTimers	Enqueues a timer registration that will post a DateTime item on the timerPort
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	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.)
	Resume	Resumes execution of tasks, including any tasks queued while in paused state
	SignalDispatcher	Signals the Dispatcher instance associated with this queue, so an available thread executes the recently queued task
	Suspend	Suspend scheduling of tasks. Tasks can still be queued
	ToString	Returns a String that represents the current Object. (Inherited from Object.)
	TryDequeue	Atomically removes an ITask instance if the port is non empty

Extension Methods

	Name	Description
	Activate< (Of < <' (T> ) > > )	Submits CCR tasks to the dispatcher port for execution. If the task was a receiver orchestration like join or choice, executing it means registering constraints on ports to guard the execution of user code (Defined by DispatcherQueueExtensions.)
	EmptyHandler< (Of < <' (T> ) > > )	An empty handler implementation that can be used in a receiver to handle a message without side effects (Defined by DispatcherQueueExtensions.)
	Spawn(Handler)	Overloaded. Invoke a message handler asynchronously, supplying any arguments explicitly. (Defined by DispatcherQueueExtensions.)
	Spawn< (Of < <' (T0> ) > > )(T0, Handler< (Of < <' (T0> ) > > ))	Overloaded. Invoke a message handler asynchronously, supplying any arguments explicitly. (Defined by DispatcherQueueExtensions.)
	Spawn< (Of < <' (T0, T1> ) > > )(T0, T1, Handler< (Of < <' (T0, T1> ) > > ))	Overloaded. Invoke a message handler asynchronously, supplying any arguments explicitly. (Defined by DispatcherQueueExtensions.)
	Spawn< (Of < <' (T0, T1, T2> ) > > )(T0, T1, T2, Handler< (Of < <' (T0, T1, T2> ) > > ))	Overloaded. Invoke a message handler asynchronously, supplying any arguments explicitly. (Defined by DispatcherQueueExtensions.)
	SpawnIterator(IteratorHandler)	Overloaded. Invoke an iterator-based message handler asynchronously, supplying any arguments explicitly. (Defined by DispatcherQueueExtensions.)
	SpawnIterator< (Of < <' (T0> ) > > )(T0, IteratorHandler< (Of < <' (T0> ) > > ))	Overloaded. Invoke an iterator-based message handler asynchronously, supplying any arguments explicitly. (Defined by DispatcherQueueExtensions.)
	SpawnIterator< (Of < <' (T0, T1> ) > > )(T0, T1, IteratorHandler< (Of < <' (T0, T1> ) > > ))	Overloaded. Invoke an iterator-based message handler asynchronously, supplying any arguments explicitly. (Defined by DispatcherQueueExtensions.)
	SpawnIterator< (Of < <' (T0, T1, T2> ) > > )(T0, T1, T2, IteratorHandler< (Of < <' (T0, T1, T2> ) > > ))	Overloaded. Invoke an iterator-based message handler asynchronously, supplying any arguments explicitly. (Defined by DispatcherQueueExtensions.)
	TimeoutPort(Int32)	Overloaded. Creates a port to receive a time signal, registers a timeout with the sequencer, supplying the private port. (Defined by DispatcherQueueExtensions.)
	TimeoutPort(TimeSpan)	Overloaded. Creates a port to receive a time signal, registers a timeout with the sequencer, supplying the private port. (Defined by DispatcherQueueExtensions.)

Properties

	Name	Description
	Count	Number of ITask instances currently queued. Remarks The returned value is an estimate and not guaranteed to be accurate.
	CurrentSchedulingRate	Current rate of tasks being scheduled in tasks/second
	Dispatcher	Parent dispatcher managing OS threads that execute tasks queued through this instance
	ExecutionPolicyNotificationPort	Signals execution policy events such as queue limits being exceeded.
	IsDisposed	True if Disposed method has been called (dispose might still be in progress)
	IsSuspended	True if task scheduling is suspended
	IsUsingThreadPool	Indicates if the CLR thread pool is used for task execution, instead of a CCR Dispatcher
	MaximumQueueDepth	Maximum depth of queued tasks
	MaximumSchedulingRate	Upper bound on scheduling rate that determines throttling
	Name	Friendly name for consumer of this dispatcher port
	Policy	Execution policy
	ScheduledTaskCount	Number of tasks scheduled so far
	ThrottlingSleepInterval	Duration of thread sleep when throttling is enforced during an Enqueue operation
	Timescale	Factor multiplied with TimeSpan values to compute absolute time duration for all EnqueueTimer calls
	UnhandledExceptionPort	Gets or sets a port that any unhandled exceptions occuring in tasks running in this DispatcherQueue will be sent to.

Events

	Name	Description
	UnhandledException	This event is raised when an unhandled exception occurs in tasks running in this DispatcherQueue

See Also

DispatcherQueue Class

Microsoft.Ccr.Core Namespace