Provides access to a queue within MemoryStore. A queue is a data structure
that provides temporary storage for arbitrary items (up to the maximum item
size -- see
MemoryStore Limits).
Each queue item has a numeric priority: MemoryStore retrieves items with
higher priority from the queue first, and it retrieves Items with the same
priority in order of addition.
Items in the queue can optionally be set to expire after a certain amount of
time. Expired items simply disappear from the queue as if they were never
added.
Adds an item to the queue with the given priority and expiration. Items
with a higher priority are retrieved from the queue before items with a
lower priority, and items with the same priority are retrieved in the
order they were added; priority defaults to 0. The expiration value,
in seconds, sets how long the item remains in the queue before it is
automatically removed. This method yields until the item has been added.
This function yields. It will block the calling thread until completion.
Returns the number of items currently in the queue. By default the
returned count includes invisible items -- items that have been read with
MemoryStoreQueue:ReadAsync() but not yet removed and whose
invisibility timeout has not expired. Set the excludeInvisible parameter
to true to omit these items from the count; it defaults to false. This
method yields until the size is retrieved.
This function yields. It will block the calling thread until completion.
Reads one or more items from the queue as a single atomic operation.
This method does not automatically delete the returned items from the
queue but makes them invisible to other ReadAsync calls for the period of
the invisibility timeout. The items must be explicitly removed from the
queue with MemoryStoreQueue:RemoveAsync() before the invisibility
timeout expires. The invisibility timeout defaults to 30 seconds unless a
different value was provided in MemoryStoreService:GetQueue().
This function yields. It will block the calling thread until completion.
Removes an item or items previously read from the queue. This method uses
the identifier returned by MemoryStoreQueue:ReadAsync() to
identify the items to remove. If called after the invisibility timeout has
expired, the call has no effect.
This function yields. It will block the calling thread until completion.