SimpleQueueCacheCursor Methods

Cursor into a simple queue cache.

Dispose(bool)

virtual

protected virtual void Dispose(bool disposing)

Clean up cache data when done

Parameters

disposingbool: true if the instance is being disposed; false if it is being called from a finalizer.

Dispose

View source

public void Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

GetCurrent(Exception?)

virtual

View source

public virtual 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

virtual

View source

[System.Obsolete(Use MoveNextWithResult instead.)]
public virtual 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

Exceptions

Orleans.Streams.QueueCacheMissException: The cursor position is older than the messages retained by the cache.

MoveNextWithResult

virtual

View source

public virtual QueueCacheCursorMoveResult MoveNextWithResult()

Attempts to move to the next message in the stream.

Returns

A successful result when the cursor has a current item, QueueCacheCursorMoveResultKind when no item is available, or a cache-miss result containing the unavailable position and cache bounds.

RecordDeliveryFailure

View source

public void RecordDeliveryFailure()

Records that delivery of the current event has failed

Refresh(StreamSequenceToken)

virtual

View source

public virtual void Refresh(StreamSequenceToken sequenceToken)

Refreshes the cache cursor. Called when new data is added into a cache.

Parameters

sequenceTokenStreamSequenceToken: The token.

ToString

override

View source

public override string ToString()

Returns a string that represents the current object.

Returns

A string that represents the current object.