Click or drag to resize

TaskQueueManager Class

Application Task Queue Manager. Manages task assignment and processing via the VaultApplicationTaskOperations interface.
Inheritance Hierarchy
SystemObject
  MFiles.VAF.Common.ApplicationTaskQueueTaskQueueManager

Namespace:  MFiles.VAF.Common.ApplicationTaskQueue
Assembly:  MFiles.VAF (in MFiles.VAF.dll) Version: 2.2.0.9
Syntax
C#
public class TaskQueueManager

The TaskQueueManager type exposes the following members.

Constructors
  NameDescription
Public methodTaskQueueManager
Self initializing task queue manager constructor.
Top
Properties
  NameDescription
Public propertyDelayMsAfterTransactionalBroadcastTaskCreation
The time is milliseconds that is delayed before triggering a new polling cycle, following the creation of an application task that will be used to create a broadcast message (when created using a transactional vault reference).
Protected propertyManagerTokenSource
Cancellation token source for the manager itself. - Requesting a cancellation will cause all queues and all their respective tasks to be cancelled as well.
Protected propertyPersistentVault
Persistent Vault object.
Protected propertyPollingEnabledLock
Lock used to prevent changes to the polling enabled flag while it is locked.
Protected propertyPollingIntervalInSeconds
The current and active polling interval in seconds.
Protected propertyTransactionalBroadcastCreationQueue
When defined and a transactional vault is passed into the creation call of a broadcast message, an ApplicationTask will be created that will be used to create the broadcast message. This ensures that the broadcast message will never be created if the current transaction fails.
Protected propertyTransactionalBroadcastProcessor
Processes the broadcast creation tasks when transactional broadcast creation is enabled.
Top
Methods
  NameDescription
Public methodAddScheduledTask
En-queues the scheduled task into the Multi-Server Mode, AsyncTaskQueue.
Public methodAddTask
En-queues the task into the Multi-Server Mode, AsyncTaskQueue.
Public methodDetachTaskQueue
Detaches a task queue wrapper from task delegation by this task queue manager instance. - Does not modify the task queue in the server. - Un-registers the TaskQueue object and its associated handlers inside the task queue manager.
Public methodDispose
IDisposable implementation.
Public methodEnableTaskPolling
Enables or disables the task queue polling. By default the polling is enabled and starts when the first queue gets opened.
Protected methodGetBroadcastTasks
Resolves a collection of broadcast messages, wrapped as a List{ApplicationTask}.
Public methodGetLatestBroadcastMessageIdentifier
Resolves the latest broadcast id for the passed queue identifier.
Public methodGetLatestBroadcastMessageIdentifiers
Resolves the latest broadcast ids for the passed queue identifiers.
Protected methodGetNewBroadcastMessages
Gets new broadcast messages from the server.
Protected methodGetTaskInfoTasks
Resolves a collection of application task info's, wrapped as a List{ApplicationTask}.
Protected methodOnPollingTimeElapsed
Polling timer handler.
Public methodOpenTaskQueue
Registers a task queue wrapper and opens the task queue in the server. - Opens the task queue in the server. - Registers the TaskQueue object and its associated handlers inside the task queue manager.
Protected methodPollTasks
Polls the server and reserves tasks for processing as well as gets new broadcast messages.
Protected methodReserveTasksForProcessing
Reserve tasks for processing from the server.
Public methodSendBroadcastMessage
Sends a broadcast message to the passed task queue.
Protected methodTransactionalBroadcastJobProcessor
Processes the app task to create a broadcast message.
Public methodTriggerPolling
Triggers polling right away (when enabled).
Public methodUpdateTask
Updates the state and progress values for a task in the server.
Public methodWaitAll
Waits for all Tasks that are still Running to complete.
Public methodWaitAll(TimeSpan)
Waits for all Tasks that are still Running to complete.
Top
Fields
  NameDescription
Public fieldStatic memberDefaultPollingInterval
Default polling interval in seconds.
Protected fieldtaskQueues
The task queues being managed by this class.
Top
See Also