DispatcherQueue Methods

Microsoft Robotics Class Reference

The DispatcherQueue type exposes the following members.

Methods

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

Extension Methods

  Name Description
Public Extension Method 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.)
Public Extension Method EmptyHandler< (Of < <' (T> ) > > )
An empty handler implementation that can be used in a receiver to handle a message without side effects
(Defined by DispatcherQueueExtensions.)
Public Extension Method Spawn(Handler) Overloaded.
Invoke a message handler asynchronously, supplying any arguments explicitly.
(Defined by DispatcherQueueExtensions.)
Public Extension Method Spawn< (Of < <' (T0> ) > > )(T0, Handler< (Of < <' (T0> ) > > )) Overloaded.
Invoke a message handler asynchronously, supplying any arguments explicitly.
(Defined by DispatcherQueueExtensions.)
Public Extension Method Spawn< (Of < <' (T0, T1> ) > > )(T0, T1, Handler< (Of < <' (T0, T1> ) > > )) Overloaded.
Invoke a message handler asynchronously, supplying any arguments explicitly.
(Defined by DispatcherQueueExtensions.)
Public Extension Method 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.)
Public Extension Method SpawnIterator(IteratorHandler) Overloaded.
Invoke an iterator-based message handler asynchronously, supplying any arguments explicitly.
(Defined by DispatcherQueueExtensions.)
Public Extension Method SpawnIterator< (Of < <' (T0> ) > > )(T0, IteratorHandler< (Of < <' (T0> ) > > )) Overloaded.
Invoke an iterator-based message handler asynchronously, supplying any arguments explicitly.
(Defined by DispatcherQueueExtensions.)
Public Extension Method 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.)
Public Extension Method 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.)
Public Extension Method TimeoutPort(Int32) Overloaded.
Creates a port to receive a time signal, registers a timeout with the sequencer, supplying the private port.
(Defined by DispatcherQueueExtensions.)
Public Extension Method TimeoutPort(TimeSpan) Overloaded.
Creates a port to receive a time signal, registers a timeout with the sequencer, supplying the private port.
(Defined by DispatcherQueueExtensions.)

See Also

DispatcherQueue Class

Microsoft.Ccr.Core Namespace