Documentation.

Author: eben-roux

README.md

@@ -9,10 +9,18 @@ Provides various classes and interfaces to facilitate thread-based processing.
 ## ProcessorThreadPool
 
 ``` c#
-public ProcessorThreadPool(string name, int threadCount, IProcessorFactory processorFactory, ProcessorThreadOptions processorThreadOptions);
+public ProcessorThreadPool(
+    string name, 
+    int threadCount, 
+    IServiceScopeFactory serviceScopeFactory,
+    IProcessorFactory processorFactory, 
+    ProcessorThreadOptions processorThreadOptions
+);
 ```
 
-Each thread pool has a `name` used only for identyfing the pool.  The `threadCount` determines the number of `ProcessorThread` instances in the pool.  Each `ProcessorThread` calls the `IProcessor.Execute(CancellationToken)` method, or `IProcessor.ExecuteAsync(CancellationToken)` method if started asynchronously, on the instance provided by the `IProcessorFactory.Create()` method in a loop while the `CancellationToken.IsCancellationRequested` returns `false`.
+Each thread pool has a `name` used only for identyfing the pool.  The `threadCount` determines the number of `ProcessorThread` instances in the pool.  Each `ProcessorThread` calls the `IProcessor.ExecuteAsync(CancellationToken)` method on the instance provided by the `IProcessorFactory.Create()` method in a loop while the `CancellationToken.IsCancellationRequested` returns `false`.
+
+Every call to `IProcessor.ExecuteAsync(ProcessorThreadContext, CancellationToken)` is wrapped in a `ProcessorThreadContext` instance that provides the `State` along with the `IServiceScope` instance created by the `IServiceScopeFactory.CreateScope()` method.
 
 ## ProcessorThreadOptions