Click or drag to resize

Engine Class

IT Hit User File System
Represents custom user file system. Listens to OS file system calls and executes custom user interfcaces methods when data is required.
Inheritance Hierarchy

Namespace:  ITHit.FileSystem
Assembly:  ITHit.FileSystem (in ITHit.FileSystem.dll) Version: 1.4.4298.0
Syntax
public abstract class Engine : ILogger, 
	IDisposable

The Engine type exposes the following members.

Constructors
  NameDescription
Protected methodEngine
Creataes file system with default options.
Top
Properties
  NameDescription
Public propertyLicense
Gets or sets the license text.
Public propertyState
Gets the Engine state.
Top
Methods
  NameDescription
Public methodDispose
Releases all resources used by the Engine
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the Engine and optionally releases the managed resources
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodCode exampleGetFileSystemItemAsync
Gets file or folder object corresponding to path in user file system.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodLogError
Rises Error event.
Public methodLogMessage
Rises Message event.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnError
Rises the Error event.
Protected methodOnMessage
Rises the Message event.
Protected methodOnStateChanged
Rises the StateChanged event.
Public methodRiseError
Rises Error event. Throws an exception if ThrowExceptions is set to [!:true].
Public methodStartAsync
Starts listening and processing file system calls from operating system.
Protected methodStop
Stops listening and processing file system calls from operating system.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventError
Event fired in case of any exceptions in the Engine or user file system implementation code.
Public eventMessage
Event fired when the Engine or user file system implementation code sends an informational message.
Public eventStateChanged
Event fired when the Engine state changes.
Top
Fields
  NameDescription
Public fieldPath
A root folder of your user file system. Your file system tree will be located under this folder.
Public fieldThrowExceptions
Indicates if the Engine must throw exception in case of any errors in the Engine itself or in user code. Default is [!:false].
Top
Remarks

Processes file system calls from operating system and calls user interfcaces, that implement file system, such as IFile, IFolder , etc.

This calss represents a generic file system with features supported on any operating system. To create a file system that provide features supported by a specific operation system use [!:ITHit.FileSystem.Windows.EngineWindows] or other classes derived from this class instead.

See Also