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.181-beta

Syntax

public sealed class FileProcessor : IDisposable

Public NotInheritable Class FileProcessor
	Implements IDisposable

public ref class FileProcessor sealed : IDisposable

[<SealedAttribute>]
type FileProcessor = 
    class
        interface IDisposable
    end

GSF.IO.FileProcessor = function();

Type.createClass(
	'GSF.IO.FileProcessor',
	null,
	IDisposable);

The FileProcessor type exposes the following members.

Constructors

	Name	Description
	FileProcessor	Creates a new instance of the FileProcessor class.

Properties

	Name	Description
	ActivelyEnumeratedPaths	Gets the list of paths that are being actively enumerated.
	EnumerationStrategy	Gets or sets the strategy to use to enumerate files in the watch directories.
	Filter	Gets or sets the filter used to determine whether a file should be processed.
	FolderExclusion	Gets or sets the pattern used to determine whether a folder should be excluded from enumeration.
	InternalBufferSize	Gets or sets the internal buffer size of each of the SafeFileWatchers instantiated by this file processor.
	IsEnumerating	Gets the flag indicating if the file processor is actively enumerating.
	MaxThreadCount	Gets or sets the maximum number of threads used for file processing and enumeration.
	OrderedEnumeration	Gets or sets the flag that determines whether the file enumeration process should sort files and directories before raising events for enumerated files.
	ProcessedFileCount	Gets the number of files processed by the file processor.
	RequeuedFileCount	Gets the number of times files that are being requeued by the file processor.
	SkippedFileCount	Gets the number of files skipped by the file processor.
	TrackChanges	Gets or sets a flag that determines whether files should be processed on change.
	TrackedDirectories	Gets the list of directories currently being tracked by the FileProcessor.

Methods

	Name	Description
	AddTrackedDirectory	Adds a directory to the list of directories tracked by this FileProcessor.
	ClearTrackedDirectories	Empties the list of directories tracked by this FileProcessor.
	Dispose	Releases all the resources used by the FileProcessor object.
	EnumerateWatchDirectories	Forces enumeration of directories currently being watched.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MatchesFilter	Determines if the given file matches the filter string provided through the Filter property.
	MatchesFolderExclusion	Determines if the given folder matches the exclusion string provided through the FolderExclusion property.
	RemoveTrackedDirectory	Removes a directory from the list of directories tracked by this FileProcessor.
	ResetIndexAndStatistics	Resets the internal file index so all files can be reprocessed.
	StopEnumeration	Stops all enumeration operations that are currently running.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Events

	Name	Description
	Error	Event triggered when an unexpected error occurs during normal operation of the FileProcessor.
	Processing	Event triggered when a file is to be processed.

Fields

	Name	Description
	DefaultEnumerationStrategy	Default value for the EnumerationStrategy property.
	DefaultFilter	Default value for the Filter property.
	DefaultFolderExclusion	Default value for the FolderExclusion property.
	DefaultInternalBufferSize	Default value for the InternalBufferSize property.
	DefaultTrackChanges	Default value for the TrackChanges property.

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)