Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

OfficeImageExportBatchProcessor

Namespace OfficeIMO.Drawing
Assembly OfficeIMO.Core
Modifiers static

Bounded, ordered batch processing shared by document image adapters.

Inheritance

  • Object
  • OfficeImageExportBatchProcessor

Methods

public static OfficeImageExportAsyncConsumer CreateGuardedAsyncConsumer(OfficeImageExportOptions options, OfficeImageExportAsyncConsumer consumer, CancellationToken cancellationToken = default) #
Returns: OfficeImageExportAsyncConsumer

Wraps an asynchronous consumer with cancellation, diagnostic policy, and aggregate batch-budget enforcement. Consumer callbacks are serialized. Direct synchronous callback reentry is supported; forked or deferred reentry is rejected so inherited execution context cannot bypass serialization.

Parameters

options OfficeIMO.Drawing.OfficeImageExportOptions requiredposition: 0
consumer OfficeIMO.Drawing.OfficeImageExportAsyncConsumer requiredposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2
public static OfficeImageExportConsumer CreateGuardedConsumer(OfficeImageExportOptions options, OfficeImageExportConsumer consumer, CancellationToken cancellationToken = default) #
Returns: OfficeImageExportConsumer

Wraps a consumer with cancellation, diagnostic policy, and aggregate batch-budget enforcement.

Parameters

options OfficeIMO.Drawing.OfficeImageExportOptions requiredposition: 0
consumer OfficeIMO.Drawing.OfficeImageExportConsumer requiredposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2
public static Void ForEachOrdered<T>(IReadOnlyList<T> items, Int32 maximumDegreeOfParallelism, Func<T, Int32, CancellationToken, OfficeImageExportResult> render, OfficeImageExportConsumer consumer, CancellationToken cancellationToken = default, OfficeImageExportOptions options = null) #
Returns: Void

Renders items in bounded parallel windows and emits results in source order. A degree of one is strictly sequential.

Type Parameters

T

Parameters

items System.Collections.Generic.IReadOnlyList{``0} requiredposition: 0
maximumDegreeOfParallelism System.Int32 requiredposition: 1
render System.Func{``0,System.Int32,System.Threading.CancellationToken,OfficeIMO.Drawing.OfficeImageExportResult} requiredposition: 2
consumer OfficeIMO.Drawing.OfficeImageExportConsumer requiredposition: 3
cancellationToken System.Threading.CancellationToken = default optionalposition: 4
options OfficeIMO.Drawing.OfficeImageExportOptions = null optionalposition: 5
public static Void Run(OfficeImageExportOptions options, Action<OfficeImageExportConsumer, CancellationToken> producer, OfficeImageExportConsumer consumer, CancellationToken cancellationToken = default, Nullable<Int32> expectedOutputCount = null) #
Returns: Void

Executes a streaming batch under one render deadline and one aggregate budget tracker. When expectedOutputCount is known, the count budget is checked before the producer starts so no partial output is emitted for a predictably oversized batch.

Parameters

options OfficeIMO.Drawing.OfficeImageExportOptions requiredposition: 0
producer System.Action{OfficeIMO.Drawing.OfficeImageExportConsumer,System.Threading.CancellationToken} requiredposition: 1
consumer OfficeIMO.Drawing.OfficeImageExportConsumer requiredposition: 2
cancellationToken System.Threading.CancellationToken = default optionalposition: 3
expectedOutputCount System.Nullable{System.Int32} = null optionalposition: 4
public static async Task RunAsync(OfficeImageExportOptions options, Func<OfficeImageExportAsyncConsumer, CancellationToken, Task> producer, OfficeImageExportAsyncConsumer consumer, CancellationToken cancellationToken = default, Nullable<Int32> expectedOutputCount = null) #
Returns: Task

Executes an asynchronous streaming batch under one render deadline and one aggregate budget tracker. When expectedOutputCount is known, the count budget is checked before the producer starts so no partial output is emitted for a predictably oversized batch.

Parameters

options OfficeIMO.Drawing.OfficeImageExportOptions requiredposition: 0
producer System.Func{OfficeIMO.Drawing.OfficeImageExportAsyncConsumer,System.Threading.CancellationToken,System.Threading.Tasks.Task} requiredposition: 1
consumer OfficeIMO.Drawing.OfficeImageExportAsyncConsumer requiredposition: 2
cancellationToken System.Threading.CancellationToken = default optionalposition: 3
expectedOutputCount System.Nullable{System.Int32} = null optionalposition: 4