WorkDispatcher Class

Spotfire 14.2 API Reference
Base class for typed work dispatchers.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Framework.ThreadingWorkDispatcher
    Spotfire.Dxp.Framework.ThreadingWorkDispatcherTItem

Namespace:  Spotfire.Dxp.Framework.Threading
Assembly:  Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 64.0.19329.3263 (64.0.19329.3263)
Syntax

C#
public abstract class WorkDispatcher : IDisposable

The WorkDispatcher type exposes the following members.

Properties

  NameDescription
Public propertyAutoCancel
Gets or sets a value indicating whether worker model changes should automatically cancel added work items. The default value is true.
Public propertyAutoDisposeItems
Gets or sets a value indicating whether work items should be automatically disposed. The default value is true. Manipulating this flag should be avoided whenever possible. Instead use work item handlers to make sure that work items are not disposed too early.
Public propertyIsDisposed
Gets a value indicating whether this instance has been disposed.
Public propertyMaxQueueSize
Gets or sets the maximum allowed number of items waiting to be dispatched. Before new items are added, items at the back of the queue will be canceled to make room.
Top
Methods

  NameDescription
Public methodCancelAll
Cancel all work items.
Public methodDispose
Cancels all work items and frees up resources.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference