Skip to content
Orleans logoMicrosoft Orleans

IQueueCacheCursor Methods

Enumerates the messages in a stream.

GetCurrent(Exception)

abstract
public abstract IBatchContainer GetCurrent(out Exception exception)
Get the current value.

Parameters

exceptionException
The resulting exception.

Returns

Returns the current batch container. If null then the stream has completed or there was a stream error. If there was a stream error, an error exception will be provided in the output.

MoveNext

abstract
public abstract bool MoveNext()
Move to next message in the stream. If it returns false, there are no more messages. The enumerator is still valid however and can be called again when more data has come in on this stream.

Returns

true if there are more items, false otherwise

RecordDeliveryFailure

abstract
public abstract void RecordDeliveryFailure()
Records that delivery of the current event has failed

Refresh(StreamSequenceToken)

abstract
public abstract void Refresh(StreamSequenceToken token)
Refreshes the cache cursor. Called when new data is added into a cache.

Parameters

tokenStreamSequenceToken
The token.