Skip to content

SimpleQueueCacheCursor Methods

Cursor into a simple queue cache.

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

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.