WorkflowQueue Class

Definition

Namespace:

System.Workflow.Runtime

Assembly:

System.Workflow.Runtime.dll

Caution

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

Represents a workflow queue.

public ref class WorkflowQueue

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

[<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

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.