Ens.Queue

class Ens.Queue

Method Inventory

Methods

classmethod AbortItem(pQueueName As %String = "", pPriority As %Integer = 0, pIndex As %Integer = 0) as %Status

classmethod AbortQueue(pQueueName As %String = "") as %Status

classmethod ClearEventDevice(pQueueName, pOldDevice) as %Status

classmethod Create(pQueueName As %String = $job) as %Status

classmethod DeQueue(pQueueName As %String = $job, ByRef pMsg As Ens.MessageHeader, pTimeout As %Numeric = -1, Output pIsTimedOut As %Boolean, pHonorQuiescent As %Boolean = 0, pMinPriority As %Integer = $$$eMessagePriorityAsync) as %Status

classmethod Delete(pQueueName As %String, pJob As %String) as %Status

classmethod DeleteAllQueuesForJob(pJob As %String = $Job, pRemoveJobsInProcQueues As %Boolean = 0) as %Status

pRemoveJobsInProcQueues allows deleting non empty queues invoked by this service InProc as well - they will have this job as second : piece of the queue name.

classmethod EnQueue(pMsg As Ens.MessageHeader, pReverseOrder As %Boolean = 0) as %Status

classmethod EnumerateClose(ByRef qHandle As %Binary) as %Status

classmethod EnumerateExecute(ByRef qHandle As %Binary) as %Status

classmethod EnumerateFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status

classmethod EnumerateItemClose(ByRef qHandle As %Binary) as %Status

classmethod EnumerateItemExecute(ByRef qHandle As %Binary, pQueueName As %String, pPriorKey As %String = "") as %Status

classmethod EnumerateItemFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status

classmethod EventName(pQueueName As %String) as %String

classmethod Exists(pQueueName As %String = $job) as %Boolean

classmethod ExistsInQueue(pMsg As Ens.MessageHeader = "") as %Boolean

classmethod GetCount(pQueueName As %String) as %Integer

Return the count of messages in the named queue. Return empty string if queue does not exist.

classmethod GetJobList(pJobList)

classmethod PutBackToQueue(pMsg As Ens.MessageHeader) as %Status

classmethod SetEventDevice(pQueueName, pDevice="") as %Status

classmethod SignalAllJobs(pJob="", Output pSignalledQueues As %String) as %Status

This method signals all queues - once per each job registered with that queue.
If pJob is specified then only those queues to which pJob is registered will be signalled - once per each job registered with that queue.
Queues in pSignalledQueues will be skipped. Any queue that is signalled will be recorded as part of the output pSignalledQueues

classmethod deleteEvent(pEventName As %String) as %Status

Queries

query Enumerate()

Selects Name As %String, Count As %Integer, Created As %String

List the known queues and their current counters

query EnumerateItem(QueueName As %String, PriorKey As %String = "")

Selects Priority As %Integer, Index As %Integer, MessageId As %String

PriorKey is a concatenated string that consists of the Priority, "|", and the Index.