Export (0) Print
Expand All

2.2.3.30 CPMGetRowsetNotifyOut

The CPMGetRowsetNotifyOut message replies to CPMGetRowsetNotifyIn message with oldest available rowset event. The format of the CPMGetRowsetNotifyOut message that follows the header is shown in the following diagram.


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

wid

A

eventType

rowsetItemState

changedItemState

rowsetEvent

rowsetEventData1

...

rowsetEventData2

...

wid (4 bytes): A 32-bit unsigned integer containing the document identifier that the event is for. This value MUST be zero if eventType is PROPAGATE_NONE or PROPAGATE_ROWSET.

A - moreEvents (1 bit): A single bit that is set to 1 only if there are additional rowset events remaining on the server.

eventType (7 bits): A 7 bit unsigned integer that MUST be one of the following values, indicating the type of event this message represents.

Value

Meaning

PROPAGATE_NONE

0

This response indicates that there were no available rowset events waiting on the server.

PROPAGATE_ADD

1

This response indicates that an item was added to the index that could be relevant to the query originating the rowset.

PROPAGATE_DELETE

2

This response indicates that an item was deleted from the index that could be relevant to the query originating the rowset.

PROPAGATE_MODIFY

3

This response indicates that an item was re-indexed that could be relevant to the query originating the rowset.

PROPAGATE_ROWSET

4

This response is a rowset specific notification whose meaning is interpreted by the rowsetEvent field of this message.

rowsetItemState (1 byte): An 8 bit unsigned integer that MUST be one of the following values if eventType is PROPAGATE_ADD, PROPAGATE_DELETE, or PROPAGATE_MODIFY. This number indicates the state of the document identifier specified by wid within the originating rowset. For other eventType values this value MUST be set to zero.

Value

Meaning

ROWSETEVENT_ITEMSTATE_NOTINROWSET

0

The document identifier specified by wid MUST not have been contained within the originating rowset.

ROWSETEVENT_ITEMSTATE_INROWSET

1

The document identifier speicified by wid MUST be contained within the originating rowset.

ROWSETEVENT_ITEMSTATE_UNKNOWN

2

The document identifier speicifed by wid's containment within the originating rowset has not been specified.

changedItemState (1 byte): An 8 bit unsigned integer that MUST be one of the following values if eventType is PROPAGATE_MODIFY. This number indicates the state of the document identifier specified by wid within the originating rowset if the same query were to be run again following the change. For other eventType values this value MUST be set to zero.

Value

Meaning

ROWSETEVENT_ITEMSTATE_NOTINROWSET

0

The document identifier specified by wid would NOT be contained within a subsequent query.

ROWSETEVENT_ITEMSTATE_INROWSET

1

The document identifier speicified by wid would be contained within a subsequent query.

ROWSETEVENT_ITEMSTATE_UNKNOWN

2

Whether or not the document identifier speicifed by wid would be contained within a subsequent query has not been specified.

rowsetEvent (1 byte): An 8 bit unsigned integer that MUST be one of the following values if eventType is PROPAGATE_ROWSET. This number indicates the type of rowset event that this message represents. For other eventType values this value MUST be set to zero.

Value

Meaning

ROWSETEVENT_TYPE_DATAEXPIRED

0

The data backing the rowset is no longer valid.

RowsetEventData1 and RowsetEventData2 MUST be set to zero.

ROWSETEVENT_TYPE_FOREGROUNDLOST

1

The rowset no longer has foreground priority and has been reverted to high priority. Items that apply to this query will be indexed at a decreased rate. See section 2.2.3.34 for meaning of foreground and high priority.

RowsetEventData1 and RowsetEventData2 MUST be set to zero.

ROWSETEVENT_TYPE_SCOPESTATISTICS

2

The number of indexed items, number of items that need to be indexed, or number of items that need to be re-indexed has changed.

RowsetEventData1's high 32 bits contain a 32-bit unsigned integer indicating the number of items that need to be indexed that could be relevant to the originating rowset.

RowsetEventData1's low 32 bits contain a 32-bit unsigned integer indicating the number of items that need to be re-indexed that could be relevant to the originating rowset.

RowsetEventData2's high 32 bits MUST be set to zero.

RowsetEventData2's low 32 bits contain a 32-bit unsigned integer indicating the number of indexed items that could be relevant to the originating rowset.

rowsetEventData1 (8 bytes): A 64 bit unsigned number whose meaning is dependent on rowsetEvent. Undefined unless eventType is PROPAGATE_ROWSET.

rowsetEventData2 (8 bytes): A 64 bit unsigned number whose meaning is dependent on rowsetEvent. Undefined unless eventType is PROPAGATE_ROWSET.

Show:
© 2016 Microsoft