Was this page helpful?

ITransactionalQueue<T> Interface

    Table of contents
    1. 1. Remarks
    2. 2. Generic Parameters
      1. 2.1. Parameter T
    3. 3. Members
      1. 3.1. Properties
      2. 3.2. Methods
    Table of Contents
    public abstract interface ITransactionalQueue<T>
    Namespace: MindTouch.Collections
    Assembly: mindtouch.dream
    Type Hierarchy:
    • ITransactionalQueue<T>
    Implements:
    • IDisposable
    Implementors:
    A specialized queue that uses a two-phase dequeue to retrieve items

    Remarks

    Items dequeued are invisible to other users of the queue, but are not permanently removed until the dequeue is either committed, or rolled back, the latter action making the item availabe for dequeuing again

    Generic Parameters

    Parameter T

    Type of entries in the queue
    Constraints:
    none

    Members

    Properties

    Visibility Description
    Public DefaultCommitTimeout The default timeout used for a dequeued item before the item is considered abandoned and automatically rolled back
    Public Count The current count of items available for ITransactionalQueue<T>.Dequeue()

    Methods

    Visibility Description
    Public Clear() Clear out the queue and drop all items.
    Public Enqueue(T item) Put an item into the queue
    Public Dequeue() Get the next available item from the queue. Must call ITransactionalQueue<T>.CommitDequeue(long id) to fully take possession or the item. Uses ITransactionalQueue<T>.DefaultCommitTimeout.
    Public Dequeue(TimeSpan commitTimeout) Get the next available item from the queue. Must call ITransactionalQueue<T>.CommitDequeue(long id) to fully take possession or the item.
    Public CommitDequeue(long id) Completes the two-phase ITransactionalQueue<T>.Dequeue().
    Public RollbackDequeue(long id) Undo ITransactionalQueue<T>.Dequeue() and return item back to the queue.
    Was this page helpful?
    Tag page
    You must login to post a comment.

    Copyright © 2011 MindTouch, Inc. Powered by