WorkflowQueue Class

Reference

Definition

Namespace:: System.Workflow.Runtime

Assembly:: System.Workflow.Runtime.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

The System.Workflow.* types are deprecated. Instead, please use the new types from System.Activities.*

Represents a workflow queue.

public ref class WorkflowQueue

public class WorkflowQueue

[System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]
public class WorkflowQueue

type WorkflowQueue = class

[<System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")>]
type WorkflowQueue = class

Public Class WorkflowQueue

Inheritance: Object
WorkflowQueue

Attributes: ObsoleteAttribute

Examples

The following code example demonstrates how you can create a WorkflowQueue by calling the WorkflowQueuingService.GetWorkflowQueue method. It also uses the Count property to determine whether any messages exist in the current queue. Finally, the code uses the Dequeue method to remove and return the first object in the queue.

This code example is part of the File Watcher Activity SDK Sample from the FileSystemEvent.cs file. For more information, see File System Watcher Activity.

private bool ProcessQueueItem(ActivityExecutionContext context)
{
    WorkflowQueuingService qService = context.GetService<WorkflowQueuingService>();
    if (!qService.Exists(this.QueueName))
    {
        return false;
    }

    WorkflowQueue queue = qService.GetWorkflowQueue(this.QueueName);

    // If the queue has messages, then process the first one
    if (queue.Count == 0)
    {
        return false;
    }

    FileWatcherEventArgs e = (FileWatcherEventArgs)queue.Dequeue();

    // Raise the FileSystemEvent
    base.RaiseGenericEvent<FileWatcherEventArgs>(FileSystemEvent.FileWatcherEventHandlerEvent, this, e);

    DoUnsubscribe(context, this);
    DeleteQueue(context);
    return true;
}

Private Function ProcessQueueItem(ByVal context As ActivityExecutionContext) As Boolean

    Dim qService As WorkflowQueuingService = context.GetService(Of WorkflowQueuingService)()

    If Not qService.Exists(Me.QueueName) Then
        Return False
    End If

    Dim Queue As WorkflowQueue = qService.GetWorkflowQueue(Me.QueueName)

    ' If the queue has messages, then process the first one
    If Queue.Count = 0 Then
        Return False
    End If

    Dim e As FileWatcherEventArgs = CType(Queue.Dequeue(), FileWatcherEventArgs)

    ' Raise the FileSystemEvent
    MyBase.RaiseGenericEvent(Of FileWatcherEventArgs)(FileSystemEvent.FileWatcherEventHandlerEvent, Me, e)
    DoUnsubscribe(context, Me)
    DeleteQueue(context)
    Return True
End Function

Remarks

Note

This material discusses types and namespaces that are obsolete. For more information, see Deprecated Types in Windows Workflow Foundation 4.5.

Workflow queues are used to pass messages between a host or host services and activities in a workflow. Any activity can create a WorkflowQueue by calling WorkflowQueuingService.CreateWorkflowQueue, and a host, a service, or another activity can call Enqueue to add an item to that WorkflowQueue. You can subscribe to the QueueItemAvailable event to be notified when an item arrives on the WorkflowQueue. You can use Peek to examine an item at the beginning of the WorkflowQueue and Dequeue to remove an item from the WorkflowQueue. Each WorkflowQueue is associated with a WorkflowQueuingService that you can use to perform other management operations on the WorkflowQueue, such as deleting the queue. QueuingService exposes the WorkflowQueuingService associated with this WorkflowQueue.

Properties

Count	Gets the number of items contained in the WorkflowQueue.
Enabled	Gets or sets a value that specifies whether the WorkflowQueue is enabled.
QueueName	Gets the name of the workflow queue.
QueuingService	Gets the queuing service associated with this WorkflowQueue.

Methods

Dequeue()	Removes and returns the object at the beginning of the WorkflowQueue.
Enqueue(Object)	Adds an object to the end of the WorkflowQueue.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (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)
Peek()	Returns the object at the beginning of the WorkflowQueue without removing it.
RegisterForQueueItemArrived(IActivityEventListener<QueueEventArgs>)	Registers a subscriber to the QueueItemArrived event.
RegisterForQueueItemAvailable(IActivityEventListener<QueueEventArgs>, String)	Registers a subscriber to the QueueItemAvailable event.
RegisterForQueueItemAvailable(IActivityEventListener<QueueEventArgs>)	Registers a subscriber to the QueueItemAvailable event.
ToString()	Returns a string that represents the current object. (Inherited from Object)
UnregisterForQueueItemArrived(IActivityEventListener<QueueEventArgs>)	Unregisters a subscriber to the QueueItemArrived event.
UnregisterForQueueItemAvailable(IActivityEventListener<QueueEventArgs>)	Unregisters a subscriber to the QueueItemAvailable event.

Events

QueueItemArrived	Occurs when an item is delivered on this WorkflowQueue.
QueueItemAvailable	Occurs when an item is available on this WorkflowQueue.

Applies to

Dela via