Ens.Queue.FIFOMessageGroup
persistent class Ens.Queue.FIFOMessageGroup extends %Library.Persistent, Ens.Queue.FIFOMessageGroup.Data, %XML.Adaptor, %JSON.Adaptor
SQL Table Name: Ens_Queue.FIFOMessageGroup
This class defines the FIFO Message Group dataProperty Inventory
Method Inventory
Properties
property QueuedWaitingOnRelease as %String [ Calculated , Transient ];
This is a calculated property to identify the message header
that is being processed (in flight) and is responsible for
this current message header being left in the queue until released.
Property methods: QueuedWaitingOnReleaseDisplayToLogical(), QueuedWaitingOnReleaseIsValid(), QueuedWaitingOnReleaseLogicalToDisplay(), QueuedWaitingOnReleaseLogicalToOdbc(), QueuedWaitingOnReleaseNormalize()
property StartHeader as %String);
HeaderId that started this particular message group processing
Property methods: StartHeaderDisplayToLogical(), StartHeaderGet(), StartHeaderGetStored(), StartHeaderIsValid(), StartHeaderLogicalToDisplay(), StartHeaderLogicalToOdbc(), StartHeaderNormalize(), StartHeaderSet()
property StartQueue as %String (MAXLEN = 128);
Starting queue for Message Group
Property methods: StartQueueDisplayToLogical(), StartQueueGet(), StartQueueGetStored(), StartQueueIsValid(), StartQueueLogicalToDisplay(), StartQueueLogicalToOdbc(), StartQueueNormalize(), StartQueueSet()
Methods
classmethod IsMessageGroupInPipeline(pMsgHdr As Ens.MessageHeader, Output pInPipelineInfo As %String) as %Boolean
Information method to advise if for a message group identifier and scope there is a header in the
pipeline
Does not scan the preceding queue entries so unable to account for preceding same group that has a dependency preventing release
It accounts for the header having the fail safe Single Thread Identifier but as it does not scan the preceding queue entries it does not report if an entry is waiting on a fail safe Single Thread Identifier
Does not scan the preceding queue entries so unable to account for preceding same group that has a dependency preventing release
It accounts for the header having the fail safe Single Thread Identifier but as it does not scan the preceding queue entries it does not report if an entry is waiting on a fail safe Single Thread Identifier
classmethod ReleaseHoldByHeaderId(pMsgHeaderId As %String, pSignalQueue As %Boolean = 1) as %Status [ SQLProc = FIFOMessageGroup_ReleaseHoldByHeaderId ]
Projected as the stored procedure: FIFOMessageGroup_ReleaseHoldByHeaderId
Method used to clear the hold on the particular
FIFO MessageGroup of the message header id of pMsgHeaderId
Optional pSignalQueue parameter that defaults to true
Optional pSignalQueue parameter that defaults to true
classmethod ReleaseHoldForAll(pQueueName As %String, pOnlyCompletedSessions As %Boolean = 1) as %Status [ SQLProc = FIFOMessageGroup_ReleaseHoldForAll ]
Projected as the stored procedure: FIFOMessageGroup_ReleaseHoldForAll
This API will loop through all message Headers in a queue that are marked as being active in the
FIFO Message Group pipeline and clear them.
This API takes a snap shot of what is currently marked as being in the pipeline
The order of clearing will be in canonical order of the FIFO Message Group Identifier.
The default is to only clear those headers that belong to sessions that are considered Complete - each message header in the session has a status of either Completed, Aborted, Errored or Discarded
The second parameter can be used to clear those irrespective of whether the associated session is considered complete by passing in 0.
This API takes a snap shot of what is currently marked as being in the pipeline
The order of clearing will be in canonical order of the FIFO Message Group Identifier.
The default is to only clear those headers that belong to sessions that are considered Complete - each message header in the session has a status of either Completed, Aborted, Errored or Discarded
The second parameter can be used to clear those irrespective of whether the associated session is considered complete by passing in 0.
Indexes
index (GIdx on Identifier);
Index methods: GIdxExists()
index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
index (SHIdx on StartHeader);
Index methods: SHIdxExists()
index (SQIdx on StartQueue);
Index methods: SQIdxExists()
Inherited Members
Inherited Properties
Inherited Methods
- %%CLASSNAMELogicalToStorage()
- %%CLASSNAMEStorageToLogical()
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %BuildIndicesAsync()
- %BuildIndicesAsyncResponse()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %ComposeOid()
- %ConstructClone()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetLock()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %InitExtentData()
- %InsertBatch()
- %IsA()
- %IsModified()
- %IsNull()
- %JSONExport()
- %JSONExportToStream()
- %JSONExportToString()
- %JSONImport()
- %JSONNew()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDeleteFinally()
- %OnDetermineClass()
- %OnOpenFinally()
- %OnSaveFinally()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- %ValidateTable()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
Storage
Storage Model: Storage (Ens.Queue.FIFOMessageGroup)
^Ens.Queue.FIFOMessageGroupD(ID) |
= | %%CLASSNAME
Identifier
CompletionHosts
Dependencies
StartHeader
StartQueue
|