IQueueCacheCursor.GetCurrent(Exception) Method

  • Reference

Definition

Namespace:
Orleans.Streams
Assembly:
Orleans.dll
Assembly:
Orleans.Core.dll
Assembly:
Orleans.Streaming.dll
Package:
Microsoft.Orleans.Core v1.5.10
Package:
Microsoft.Orleans.Core v2.4.5
Package:
Microsoft.Orleans.Core v3.6.5
Package:
Microsoft.Orleans.Streaming v7.2.5
Package:
Microsoft.Orleans.Streaming v8.0.0
Package:
Microsoft.Orleans.Streaming v8.1.0
Package:
Microsoft.Orleans.Streaming v8.2.0
Source:
IQueueCacheCursor.cs

Get the current value.

public Orleans.Streams.IBatchContainer GetCurrent (out Exception exception);
abstract member GetCurrent : Exception -> Orleans.Streams.IBatchContainer
Public Function GetCurrent (ByRef exception As Exception) As IBatchContainer

Parameters

exception
Exception

The resulting exception.

Returns

IBatchContainer

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.

Applies to