A module that processes documents in parallel (with the option to process sequentially).
- 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["ParallelSyncModule"]
class Type type-node
Derived0["ParseYaml"]-->Type
click Derived0 "/api/Statiq.Yaml/ParseYaml"
Derived1["SetContentType"]-->Type
click Derived1 "/api/Statiq.Web.Modules/SetContentType"
Derived2["RenderCsvAsMarkdown"]-->Type
click Derived2 "/api/Statiq.Tables/RenderCsvAsMarkdown"
Derived3["MutateImage"]-->Type
click Derived3 "/api/Statiq.Images/MutateImage"
Derived4["ConvertExcelToCsv"]-->Type
click Derived4 "/api/Statiq.Tables/ConvertExcelToCsv"
Derived5["ReadYouTube"]-->Type
click Derived5 "/api/Statiq.YouTube/ReadYouTube"
Derived6["RenderCsvAsHtml"]-->Type
click Derived6 "/api/Statiq.Tables/RenderCsvAsHtml"
Syntax
public abstract class ParallelSyncModule : Module, IModule, IParallelModuleProperties
| 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
|
| ExecuteContextAsync |
Task |
Executes the module once for all input documents.
|
| ExecuteInput |
IEnumerable |
Executes the module.
|
| 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
|