Click or drag to resize

FileProcessor Class

Tracks files processed in a list of directories, and notifies when new files become available to be processed.
Inheritance Hierarchy
SystemObject
  GSF.IOFileProcessor

Namespace: GSF.IO
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.207-beta+1781b796b2aa7a54013a031eb432fe4ccee31867
Syntax
public sealed class FileProcessor : IDisposable
View Source

The FileProcessor type exposes the following members.

Constructors
 NameDescription
Public methodFileProcessor Creates a new instance of the FileProcessor class.
Top
Properties
 NameDescription
Public propertyActivelyEnumeratedPaths Gets the list of paths that are being actively enumerated.
Public propertyEnumerationStrategy Gets or sets the strategy to use to enumerate files in the watch directories.
Public propertyFilter Gets or sets the filter used to determine whether a file should be processed.
Public propertyFolderExclusion Gets or sets the pattern used to determine whether a folder should be excluded from enumeration.
Public propertyInternalBufferSize Gets or sets the internal buffer size of each of the SafeFileWatchers instantiated by this file processor.
Public propertyIsEnumerating Gets the flag indicating if the file processor is actively enumerating.
Public propertyMaxThreadCount Gets or sets the maximum number of threads used for file processing and enumeration.
Public propertyOrderedEnumeration Gets or sets the flag that determines whether the file enumeration process should sort files and directories before raising events for enumerated files.
Public propertyProcessedFileCount Gets the number of files processed by the file processor.
Public propertyRequeuedFileCount Gets the number of times files that are being requeued by the file processor.
Public propertySkippedFileCount Gets the number of files skipped by the file processor.
Public propertyTrackChanges Gets or sets a flag that determines whether files should be processed on change.
Public propertyTrackedDirectories Gets the list of directories currently being tracked by the FileProcessor.
Top
Methods
 NameDescription
Public methodAddTrackedDirectory Adds a directory to the list of directories tracked by this FileProcessor.
Public methodClearTrackedDirectories Empties the list of directories tracked by this FileProcessor.
Public methodDispose Releases all the resources used by the FileProcessor object.
Public methodEnumerateWatchDirectories Forces enumeration of directories currently being watched.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodMatchesFilter Determines if the given file matches the filter string provided through the Filter property.
Public methodMatchesFolderExclusion Determines if the given folder matches the exclusion string provided through the FolderExclusion property.
Public methodRemoveTrackedDirectory Removes a directory from the list of directories tracked by this FileProcessor.
Public methodResetIndexAndStatistics Resets the internal file index so all files can be reprocessed.
Public methodStopEnumeration Stops all enumeration operations that are currently running.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventError Event triggered when an unexpected error occurs during normal operation of the FileProcessor.
Public eventProcessing Event triggered when a file is to be processed.
Top
Fields
 NameDescription
Public fieldStatic memberDefaultEnumerationStrategy Default value for the EnumerationStrategy property.
Public fieldStatic memberDefaultFilter Default value for the Filter property.
Public fieldStatic memberDefaultFolderExclusion Default value for the FolderExclusion property.
Public fieldStatic memberDefaultInternalBufferSize Default value for the InternalBufferSize property.
Public fieldStatic memberDefaultTrackChanges Default value for the TrackChanges property.
Top
Extension Methods
 NameDescription
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Top
See Also