Base class for modules that rely on a config value and could apply to input documents in parallel
(or not) depending on whether the config delegate requires them.
- Namespace
- Statiq
.Common - Interfaces
- Base Types
-
- object
- Module
- Derived Types
graph BT
Type-->Base0["Module"]
click Base0 "/api/Statiq.Common/Module"
Base0-->Base1["object"]
Type-.->Interface0["IModule"]
click Interface0 "/api/Statiq.Common/IModule"
Type-.->Interface1["IParallelModule"]
click Interface1 "/api/Statiq.Common/IParallelModule"
Type["ParallelConfigModule<TValue>"]
class Type type-node
Derived0["ReplaceWithContent"]-->Type
click Derived0 "/api/Statiq.Core/ReplaceWithContent"
Derived1["ExecuteConfig"]-->Type
click Derived1 "/api/Statiq.Core/ExecuteConfig"
Derived2["EnumerateValues"]-->Type
click Derived2 "/api/Statiq.Core/EnumerateValues"
Derived3["ParallelSyncConfigModule<TValue>"]-->Type
click Derived3 "/api/Statiq.Common/ParallelSyncConfigModule_1"
Derived4["SetMetadata"]-->Type
click Derived4 "/api/Statiq.Core/SetMetadata"
Derived5["SetDestination"]-->Type
click Derived5 "/api/Statiq.Core/SetDestination"
Derived6["AppendContent"]-->Type
click Derived6 "/api/Statiq.Core/AppendContent"
Derived7["CopyFiles"]-->Type
click Derived7 "/api/Statiq.Core/CopyFiles"
Derived8["PrependContent"]-->Type
click Derived8 "/api/Statiq.Core/PrependContent"
Derived9["ReadFiles"]-->Type
click Derived9 "/api/Statiq.Core/ReadFiles"
Derived10["ReplaceInContent"]-->Type
click Derived10 "/api/Statiq.Core/ReplaceInContent"
Derived11["GatherHeadings"]-->Type
click Derived11 "/api/Statiq.Core/GatherHeadings"
Syntax
public abstract class ParallelConfigModule<TValue> : Module, IModule, IParallelModuleType Parameters
| Name | Description |
|---|---|
| TValue |
Constructors
| Name | Summary |
|---|---|
| ParallelConfigModule |
Creates a new config module. |
Properties
| Name | Property Type | Summary |
|---|---|---|
| Parallel | bool |
Indicates whether documents will be
processed by this module in parallel.
|
Methods
| Name | Return Value | Summary |
|---|---|---|
| AfterExecution |
void |
Called after each module execution.
Inherited from Module
|
| AfterExecutionAsync |
Task |
Called after each module execution.
Inherited from Module
|
| BeforeExecution |
void |
Called before each module execution.
Inherited from Module
|
| BeforeExecutionAsync |
Task |
Called before each module execution.
Inherited from Module
|
| ExecuteAsync |
Task |
This should not be called directly, instead call
IExecutionContext.Execute() if you need to execute a module from within another module.
Inherited from Module
|
| ExecuteConfigAsync |
Task |
Executes the module for each input document in parallel.
If there aren't any input documents and the config delegate doesn't require documents,
this will be called once with a null input.
|
| ExecuteContextAsync |
Task |
Executes the module once for all input documents.
|
| ExecuteInputAsync |
Task |
Executes the module.
|
| Finally |
void |
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
|
| FinallyAsync |
Task |
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
|
| SetConfig |
ParallelConfigModule |