ProcessMonitor

Tracks the state, progress, and completion of a long-running process. Supports timeout monitoring, cancellation, and both synchronous and asynchronous waiting.

The ProcessMonitor can be used for Init, Load, and Index. Using the ProcessMonitor allows you to run loading and indexing in parallel.

Init, Load and LoadAllFilters put the work on a background thread and return immediately; the monitor is already running by the time they return, so it is safe to poll or wait on the very next line. Index runs on the calling thread.

Pick one way to wait — they are alternatives, not steps.

Poll for progress:

var monitor = new ProcessMonitor();
monitor.TimeoutSeconds = 120;

engine.Load(fstream, monitor);

while (monitor.IsRunning)
{
    Console.WriteLine(
quot;Progress: {monitor.ProgressPercent}%");
    Thread.Sleep(200);
}

if (!monitor.Succeeded)
    Console.WriteLine(
quot;Error: {monitor.ErrorMessage}");

Wait synchronously:

engine.Load(fstream, monitor);
monitor.WaitForCompletion();          // returns false on timeout

if (!monitor.Succeeded)
    Console.WriteLine(
quot;Error: {monitor.ErrorMessage}");

Wait asynchronously:

engine.Load(fstream, monitor);
await monitor.WaitForCompletionAsync();

if (!monitor.Succeeded)
    Console.WriteLine(
quot;Error: {monitor.ErrorMessage}");

One monitor per operation. Reusing an instance while it is still running throws; wait for it first. And note that WaitForCompletionAsync on a monitor that was never handed to an operation completes immediately — it reports "nothing to wait for", not "finished successfully", so always check Succeeded.

Properties

Methods

ThreadPriority

Allows clients to set priority on the threads executing the process.

monitor.ThreadPriority = ThreadPriority.Normal; // default

// Options:
// ThreadPriority.Lowest
// ThreadPriority.BelowNormal
// ThreadPriority.Normal
// ThreadPriority.AboveNormal
// ThreadPriority.Highest