TaskQueueManagerOpenTaskQueue Method |
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.
Namespace:
MFiles.VAF.Common.ApplicationTaskQueue
Assembly:
MFiles.VAF (in MFiles.VAF.dll) Version: 2.3.623.2
Syntaxpublic void OpenTaskQueue(
string queueName,
MFTaskQueueProcessingBehavior processingBehavior,
TaskQueueManagerTaskType taskType,
IApplicationTaskProcessor taskProcessor,
int maximumPollingIntervalInSeconds = 30,
string lastBroadcastId = "",
bool throwIfAlreadyExists = false
)
Public Sub OpenTaskQueue (
queueName As String,
processingBehavior As MFTaskQueueProcessingBehavior,
taskType As TaskQueueManagerTaskType,
taskProcessor As IApplicationTaskProcessor,
Optional maximumPollingIntervalInSeconds As Integer = 30,
Optional lastBroadcastId As String = "",
Optional throwIfAlreadyExists As Boolean = false
)
public:
void OpenTaskQueue(
String^ queueName,
MFTaskQueueProcessingBehavior processingBehavior,
TaskQueueManagerTaskType taskType,
IApplicationTaskProcessor^ taskProcessor,
int maximumPollingIntervalInSeconds = 30,
String^ lastBroadcastId = L"",
bool throwIfAlreadyExists = false
)
Parameters
- queueName
- Type: SystemString
Task queue name / identifier. - processingBehavior
- Type: MFTaskQueueProcessingBehavior
Processing behavior type. - taskType
- Type: MFiles.VAF.Common.ApplicationTaskQueueTaskQueueManagerTaskType
Defines the type of tasks that can be processed by this task queue. - taskProcessor
- Type: MFiles.VAF.Common.ApplicationTaskQueueIApplicationTaskProcessor
Task processor for this queue. - maximumPollingIntervalInSeconds (Optional)
- Type: SystemInt32
The max time in seconds that can pass before a polling cycle is ran for this queue.
- lastBroadcastId (Optional)
- Type: SystemString
The last processed broadcast id, defaults to empty string. - throwIfAlreadyExists (Optional)
- Type: SystemBoolean
When true, the already exists error will be thrown if the task queue is already open.
See Also