EventQueueSummary Complex Type
The EventQueueSummary type provides summary information about the event queue.
Syntax
<EventQueueSummary>
<SequenceNumber />
<LastModifiedTime />
<Count />
<EventSources />
</EventQueueSummary>
Complex Type Elements
| Element | Data type | Description |
|---|---|---|
SequenceNumber |
|
The sequence number of the last event in the queue. The sequence number represents the current high water mark of the queue. You can compare the SequenceNumber between consecutive reads to determine if there are any new messages in the queue. The sequence number is returned by GrooveEvents.ReadSummary and GrooveEvents.ReadExtended. |
LastModifiedTime |
|
The time that the last event was added to or deleted from the queue. Specified as a UTC date-time with a precision of milliseconds. |
Count |
|
The total number of events in the queue at the start of the ReadExtended operation. This number does not reflect any deletions resulting from the read. |
EventSources |
Array of |
Zero or more event sources that have events in the queue. Each event source is identified by a Groove Web Service URI of the tool or other object that fired the event. This list is returned only if the IncludeSources input parameter is set to True. |
Remarks
Note
If the event queue is empty, a call to ReadExtended returns no events. In this case, the EventList and the EventQueueSummary.EventSources elements are returned as nulls rather than as 0-length arrays. Consequently, an application should check if these elements are defined before accessing them. Alternatively, an application can check if EventQueueSummary.Count is greater than zero before accessing EventList.