Definition
Assembly: CloudNimble.SimpleMessageBus.Dispatch.FileSystem.dll Namespace: CloudNimble.SimpleMessageBus.Dispatch.Triggers Inheritance: System.ObjectSyntax
Summary
Default file processor used by FileTriggerAttribute.Constructors
.ctor
Constructs a new instance.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
context | CloudNimble.SimpleMessageBus.Dispatch.Triggers.SimpleMessageBusFileProcessorFactoryContext | The SimpleMessageBusFileProcessorFactoryContext to use. |
.ctor Inherited
Inherited from
objectSyntax
Properties
InstanceId Virtual
Gets the current role instance ID. In Azure WebApps, this will be the WEBSITE_INSTANCE_ID. In non Azure scenarios, this will default to the Process ID.Syntax
Property Value
Type:string
MaxDegreeOfParallelism Virtual
Gets the maximum degree of parallelism that will be used when processing files concurrently.Syntax
Property Value
Type:int
Remarks
Files are added to an internal processing queue as file events are detected, and they’re processed in parallel based on this setting.MaxProcessCount Virtual
Gets the maximum number of times file processing will be attempted for a file.Syntax
Property Value
Type:int
MaxQueueSize Virtual
Gets the bounds on the maximum number of files that can be queued up for processing at one time. When set to -1, the work queue is unbounded.Syntax
Property Value
Type:int
StatusFileExtension Virtual
Gets the file extension that will be used for the status files that are created for processed files.Syntax
Property Value
Type:string
Methods
Cleanup Virtual
Perform any required cleanup. This includes deleting processed files (when AutoDelete is True).Syntax
CleanupProcessedFiles Virtual
Clean up any files that have been fully processedSyntax
Equals Inherited Virtual
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
obj | object? | - |
Returns
Type:bool
Equals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
GetHashCode Inherited Virtual
Inherited from
objectSyntax
Returns
Type:int
GetType Inherited
Inherited from
objectSyntax
Returns
Type:System.Type
MemberwiseClone Inherited
Inherited from
objectSyntax
Returns
Type:object
ProcessFileAsync Virtual
Process the file indicated by the specified FileSystemEventArgs.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
eventArgs | System.IO.FileSystemEventArgs | The FileSystemEventArgs indicating the file to process. |
cancellationToken | System.Threading.CancellationToken | The CancellationToken to use. |
Returns
Type:System.Threading.Tasks.Task<bool>
A Task that returns true if the file was processed successfully, false otherwise.
ReferenceEquals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
ShouldProcessFile Virtual
Determines whether the specified file should be processed.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
filePath | string | The candidate file for processing. |
Returns
Type:bool
True if the file should be processed, false otherwise.
ToString Inherited Virtual
Inherited from
objectSyntax
Returns
Type:string?