Page last modified 21:57, 29 Apr 2010 by arnec
MindTouch Community Portal > MindTouch Community Portal > Reference > MindTouch DReAM Framework > MindTouch.Collections > TransactionalQueue<T> Class > Dequeue Method
Table of contents
- 1. Dequeue()
- 1.1. Remarks
- 1.2. Parameters
- 1.3. Returns
- 2. Dequeue(TimeSpan commitTimeout)
- 2.1. Remarks
- 2.2. Parameters
- 2.3. Returns
| Table of Contents
|
Dequeue()
public virtual ITransactionalQueueEntry<T> Dequeue();
Get the next available item from the queue. Must call TransactionalQueue<T>.CommitDequeue(long id) to fully take possession or the item. Uses TransactionalQueue<T>.DefaultCommitTimeout.
Remarks
Phase 1 of the two-phase dequeue. TransactionalQueue<T>.CommitDequeue(long id) within TransactionalQueue<T>.DefaultCommitTimeout completes the dequeue, while waiting for the timeout to expire or calling TransactionalQueue<T>.RollbackDequeue(long id) aborts the dequeue.
Parameters
| Name | Type | Description |
|---|
Returns
Type: ITransactionalQueueEntry<T>
An instance of MindTouch.Collections.ITransactionalQueueEntry<T> wrapping the dequeued value and item id for use with TransactionalQueue<T>.CommitDequeue(long id) or TransactionalQueue<T>.RollbackDequeue(long id). null if the queue is empty.
Dequeue(TimeSpan commitTimeout)
public virtual ITransactionalQueueEntry<T> Dequeue(TimeSpan commitTimeout);
Get the next available item from the queue. Must call TransactionalQueue<T>.CommitDequeue(long id) to fully take possession or the item.
Remarks
Phase 1 of the two-phase dequeue. TransactionalQueue<T>.CommitDequeue(long id) within commitTimeout completes the dequeue, while waiting for the timeout to expire or calling TransactionalQueue<T>.RollbackDequeue(long id) aborts the dequeue.
Parameters
| Name | Type | Description |
|---|---|---|
| commitTimeout | TimeSpan | Time before an uncommitted dequeue is considered abandoned and automatically rolled back |
Returns
Type: ITransactionalQueueEntry<T>
An instance of MindTouch.Collections.ITransactionalQueueEntry<T> wrapping the dequeued value and item id for use with TransactionalQueue<T>.CommitDequeue(long id) or TransactionalQueue<T>.RollbackDequeue(long id). null if the queue is empty.
- Was this page helpful?
- Tag page
- What links here
| Images 0 | ||
|---|---|---|
| No images to display in the gallery. |
You must login to post a comment.
Copyright © 2011 MindTouch, Inc. Powered by