IRingbuffer(T).ReadManyAsync Method

IRingbufferTReadManyAsync Method

Hazelcast .Net Client Class Library

Reads a batch of items from the Ringbuffer.

Namespace: Hazelcast.Core
Assembly: Hazelcast.Net (in Hazelcast.Net.dll) Version: 3.6.1.0

Syntax

Task<IList<T>> ReadManyAsync(
	long startSequence,
	int minCount,
	int maxCount
)

Function ReadManyAsync ( 
	startSequence As Long,
	minCount As Integer,
	maxCount As Integer
) As Task(Of IList(Of T))

Task<IList<T>^>^ ReadManyAsync(
	long long startSequence, 
	int minCount, 
	int maxCount
)

abstract ReadManyAsync : 
        startSequence : int64 * 
        minCount : int * 
        maxCount : int -> Task<IList<'T>>

Parameters

startSequence: Type: SystemInt64
the startSequence of the first item to read.
minCount: Type: SystemInt32
the minimum number of items to read.
maxCount: Type: SystemInt32
the maximum number of items to read.

Return Value

Type: TaskIListT
a future containing the items read.

Exceptions

Exception	Condition
ArgumentException	if startSequence is smaller than 0 or if startSequence larger than TailSequence or if minCount smaller than 0 or if minCount larger than maxCount, or if maxCount larger than the capacity of the ringbuffer or if maxCount larger than 1000 (to prevent overload)

Remarks

Reads a batch of items from the Ringbuffer. If the number of available items after the first read item is smaller than the maxCount, these items are returned. So it could be the number of items read is smaller than the maxCount. If there are less items available than minCount, then this call blocks. Reading a batch of items is likely to perform better because less overhead is involved.

Reference

IRingbufferT Interface

Hazelcast.Core Namespace