Interface IBatch<T>
Represents a queue of elements, which are processed in batches, automatically or on demand.
public interface IBatch<T>Type Parameters
TElement type.
- Extension Methods
Properties
AutoFlushCount
Specifies the number of enqueued elements, which acts as a threshold that, when reached while adding new elements, will cause this batch to automatically Flush() itself.
int AutoFlushCount { get; }Property Value
Count
Specifies the number of elements currently waiting for processing in this batch.
int Count { get; }Property Value
QueueOverflowStrategy
Specifies the strategy to use when handling overflow of enqueued elements.
BatchQueueOverflowStrategy QueueOverflowStrategy { get; }Property Value
Remarks
See QueueSizeLimitHint and BatchQueueOverflowStrategy for more details.
QueueSizeLimitHint
Specifies the maximum number of enqueued elements that, when exceeded while adding new elements, will cause this batch to react according to its QueueOverflowStrategy.
int QueueSizeLimitHint { get; }Property Value
Remarks
See BatchQueueOverflowStrategy for more details.
Methods
Add(T)
Adds the provided element to this batch's queue.
bool Add(T item)Parameters
itemTElement to enqueue.
Returns
- bool
true when element was enqueued successfully, otherwise false.
AddRange(IEnumerable<T>)
Adds the provided range of elements to this batch's queue.
bool AddRange(IEnumerable<T> items)Parameters
itemsIEnumerable<T>Range of elements to enqueue.
Returns
- bool
true when elements were enqueued successfully, otherwise false.
AddRange(ReadOnlySpan<T>)
Adds the provided range of elements to this batch's queue.
bool AddRange(ReadOnlySpan<T> items)Parameters
itemsReadOnlySpan<T>Range of elements to enqueue.
Returns
- bool
true when elements were enqueued successfully, otherwise false.
Flush()
Signals this batch to dequeue all of its elements, in an attempt to process them.
bool Flush()Returns
- bool
true when operation was initiated successfully, otherwise false.