FileSystem MembersNFX Class Library

[This is preliminary documentation and is subject to change.]

The FileSystem type exposes the following members.
Constructors

  NameDescription
Protected methodFileSystem
Initializes a new instance of the FileSystem class
Back to Top
Methods

  NameDescription
Protected method__setComponentDirector (Inherited from ApplicationComponent.)
Public methodStatic memberAutoStartSystems
Automatically starts systems designated in config with auto-start attribute
Public methodCombinePaths
Combines two or more path segments joining them using primary file system path separator. This method is thread-safe
Public methodConfigure
Configures file system. This method is a part of lifecycle management and is intended to be called only by creating thread (not thread-safe)
Protected methodDestructor (Overrides ApplicationComponent Destructor .)
Public methodDispose
Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead
(Inherited from DisposableObject.)
Protected methodDoBeginTransaction
Override in particular file systems that support transactions to begin transaction in specified session. This method may be called by miltiple threads
Protected methodDoBeginTransactionAsync
Async version of DoBeginTransaction(FileSystemSession). This base/default implementation just synchronously calls DoBeginTransaction(FileSystemSession) and returns already completed Task with result returned by DoBeginTransaction(FileSystemSession)
Protected methodDoCheckCanChange
Override in particular file systems to see if item can change, i.e. for file systems that support versioning throw exception if item is in session which "looks" at a sealed/closed version and can not change. This method may be called by miltiple threads
Protected methodDoCheckCanChangeAsync
Async version of DoCheckCanChange(FileSystemSessionItem). This base/default implementation just synchronously calls DoCheckCanChange(FileSystemSessionItem) and returns already completed Task with result returned by DoCheckCanChange(FileSystemSessionItem)
Protected methodDoCommitTransaction
Override in particular file systems that support transactions to commit transaction in specified session. This method may be called by miltiple threads
Protected methodDoCommitTransactionAsync
Async version of DoCommitTransaction(FileSystemSession). This base/default implementation just synchronously calls DoCommitTransaction(FileSystemSession) and returns already completed Task with result returned by DoCommitTransaction(FileSystemSession)
Protected methodDoConfigure
Override to perform custom configuration
Protected methodDoCreateDirectory
Override to create a directory. This method may be called by miltiple threads
Protected methodDoCreateDirectoryAsync
Async version of DoCreateDirectory(FileSystemDirectory, String). This base/default implementation just synchronously calls DoCreateDirectory(FileSystemDirectory, String) and returns already completed Task with result returned by DoCreateDirectory(FileSystemDirectory, String)
Protected methodDoCreateFile(FileSystemDirectory, String, Int32)
Override to create a file. This method may be called by miltiple threads
Protected methodDoCreateFile(FileSystemDirectory, String, String, Boolean)
Override to create a file from local file. This method may be called by miltiple threads
Protected methodDoCreateFileAsync(FileSystemDirectory, String, Int32)
Async version of DoCreateFile(FileSystemDirectory, String, Int32). This base/default implementation just synchronously calls DoCreateFile(FileSystemDirectory, String, Int32) and returns already completed Task with result returned by DoCreateFile(FileSystemDirectory, String, Int32)
Protected methodDoCreateFileAsync(FileSystemDirectory, String, String, Boolean)
Async version of DoCreateFile(FileSystemDirectory, String, String, Boolean). This base/default implementation just synchronously calls DoCreateFile(FileSystemDirectory, String, String, Boolean) and returns already completed Task with result returned by DoCreateFile(FileSystemDirectory, String, String, Boolean)
Protected methodDoDeleteItem
Override to delete item. This method may be called by miltiple threads
Protected methodDoDeleteItemAsync
Async version of DoDeleteItem(FileSystemSessionItem). This base/default implementation just synchronously calls DoDeleteItem(FileSystemSessionItem) and returns already completed Task with result returned by DoDeleteItem(FileSystemSessionItem)
Protected methodDoDirectoryDeepCopyAsync
Implements asynchronous deep copy of folders where destination folder may belong to a different file system. The specifics of implementation may be dictated by particular file systems, i.e.: asynchronous strategies for getting file lists may depend on the particular system.
Protected methodDoFlushAsync
Protected methodDoGetCreationTimestamp
Override to get item creation timestamp. This method may be called by miltiple threads
Protected methodDoGetCreationUser
Override in particular file systems to get user who created item. This method may be called by miltiple threads
Protected methodDoGetCreationUserAsync
Async version of DoGetCreationUser(FileSystemSessionItem). This base/default implementation just synchronously calls DoGetCreationUser(FileSystemSessionItem) and returns already completed Task with result returned by DoGetCreationUser(FileSystemSessionItem)
Protected methodDoGetFileNames
Override to get file names in directory. If directory is null then root is assumed. This method may be called by miltiple threads
Protected methodDoGetFileNamesAsync
Async version of DoGetFileNames(FileSystemDirectory, Boolean). This base/default implementation just synchronously calls DoGetFileNames(FileSystemDirectory, Boolean) and returns already completed Task with result returned by DoGetFileNames(FileSystemDirectory, Boolean)
Protected methodDoGetFileStream
Override to get file stream. This method may be called by miltiple threads
Protected methodDoGetFileStreamAsync
Protected methodDoGetItemSize
Override to get the byte size of item (directory or file). This method may be called by miltiple threads
Protected methodDoGetItemSizeAsync
Async version of DoGetItemSize(FileSystemSessionItem). This base/default implementation just synchronously calls DoGetItemSize(FileSystemSessionItem) and returns already completed Task with result returned by DoGetItemSize(FileSystemSessionItem)
Protected methodDoGetLastAccessTimestamp
Override to get item last access timestamp. This method may be called by miltiple threads
Protected methodDoGetLastAccessUser
Override in particular file systems to get user who was the last user accessing the item. This method may be called by miltiple threads
Protected methodDoGetLastAccessUserAsync
Async version of DoGetLastAccessUser(FileSystemSessionItem). This base/default implementation just synchronously calls DoGetLastAccessUser(FileSystemSessionItem) and returns already completed Task with result returned by DoGetLastAccessUser(FileSystemSessionItem)
Protected methodDoGetLatestVersion
Override in particular file systems that support versioning to get latest version object that this session can work with. This method may be called by miltiple threads
Protected methodDoGetLatestVersionAsync
Async version of DoGetLatestVersion(FileSystemSession). This base/default implementation just synchronously calls DoGetLatestVersion(FileSystemSession) and returns already completed Task with result returned by DoGetLatestVersion(FileSystemSession)
Protected methodDoGetMetadataStream
Override to get metadata stream for item (directory or file). This method may be called by miltiple threads
Protected methodDoGetMetadataStreamAsync
Protected methodDoGetModificationTimestamp
Override to get item modification timestamp. This method may be called by miltiple threads
Protected methodDoGetModificationUser
Override in particular file systems to get user who was the last user modifying the item. This method may be called by miltiple threads
Protected methodDoGetModificationUserAsync
Async version of DoGetModificationUser(FileSystemSessionItem). This base/default implementation just synchronously calls DoGetModificationUser(FileSystemSessionItem) and returns already completed Task with result returned by DoGetModificationUser(FileSystemSessionItem)
Protected methodDoGetPermissionsStream
Override to get permissions stream for item (directory or file). This method may be called by miltiple threads
Protected methodDoGetPermissionsStreamAsync
Protected methodDoGetReadOnly
Override to get item readonly status. This method may be called by miltiple threads
Protected methodDoGetSubDirectoryNames
Override to get subdirectory names of directory. If directory is null then root is assumed. This method may be called by miltiple threads
Protected methodDoGetSubDirectoryNamesAsync
Async version of DoGetSubDirectoryNames(FileSystemDirectory, Boolean). This base/default implementation just synchronously calls DoGetSubDirectoryNames(FileSystemDirectory, Boolean) and returns already completed Task with result returned by DoGetSubDirectoryNames(FileSystemDirectory, Boolean)
Protected methodDoGetVersion
Override in particular file systems that support versioning to get version object for session. This method may be called by miltiple threads
Protected methodDoGetVersionAsync
Async version of DoGetVersion(FileSystemSession). This base/default implementation just synchronously calls DoGetVersion(FileSystemSession) and returns already completed Task with result returned by DoGetVersion(FileSystemSession)
Protected methodDoNavigate
Override to get file or directory from specified path. Return null if item does not exist. This method may be called by miltiple threads
Protected methodDoNavigateAsync
Async version of DoNavigate(FileSystemSession, String). This base/default implementation just synchronously calls DoNavigate(FileSystemSession, String) and returns already completed Task with result returned by DoNavigate(FileSystemSession, String)
Protected methodDoReadAsync
Protected methodDoRefresh
Override to refresh item state, i.e. re-fetch remote information. This method may be called by miltiple threads
Protected methodDoRefreshAsync
Async version of DoRefreshAsync(FileSystemSessionItem). This base/default implementation just synchronously calls DoRefreshAsync(FileSystemSessionItem) and returns already completed Task with result returned by DoRefreshAsync(FileSystemSessionItem)
Protected methodDoRenameItem
Override to rename item return true on success. This method may be called by miltiple threads
Protected methodDoRenameItemAsync
Async version of DoRenameItem(FileSystemSessionItem, String). This base/default implementation just synchronously calls DoRenameItem(FileSystemSessionItem, String) and returns already completed Task with result returned by DoRenameItem(FileSystemSessionItem, String)
Protected methodDoRollbackTransaction
Override in particular file systems that support transactions to rollback transaction in specified session. This method may be called by miltiple threads
Protected methodDoRollbackTransactionAsync
Async version of DoRollbackTransaction(FileSystemSession). This base/default implementation just synchronously calls DoRollbackTransaction(FileSystemSession) and returns already completed Task with result returned by DoRollbackTransaction(FileSystemSession)
Protected methodDoSetCreationTimestamp
Override to set item creation timestamp. This method may be called by miltiple threads
Protected methodDoSetCreationTimestampAsync
Async version of DoSetCreationTimestamp(FileSystemSessionItem, DateTime). This base/default implementation just synchronously calls DoSetCreationTimestamp(FileSystemSessionItem, DateTime) and returns already completed Task with result returned by DoSetCreationTimestamp(FileSystemSessionItem, DateTime)
Protected methodDoSetLastAccessTimestamp
Override to set item last access timestamp. This method may be called by miltiple threads
Protected methodDoSetLastAccessTimestampAsync
Async version of DoSetLastAccessTimestamp(FileSystemSessionItem, DateTime). This base/default implementation just synchronously calls DoSetLastAccessTimestamp(FileSystemSessionItem, DateTime) and returns already completed Task with result returned by DoSetLastAccessTimestamp(FileSystemSessionItem, DateTime)
Protected methodDoSetModificationTimestamp
Override to set item modification timestamp. This method may be called by miltiple threads
Protected methodDoSetModificationTimestampAsync
Async version of DoSetModificationTimestamp(FileSystemSessionItem, DateTime). This base/default implementation just synchronously calls DoSetModificationTimestamp(FileSystemSessionItem, DateTime) and returns already completed Task with result returned by DoSetModificationTimestamp(FileSystemSessionItem, DateTime)
Protected methodDoSetReadOnly
Override to set item readonly status. This method may be called by miltiple threads
Protected methodDoSetReadOnlyAsync
Async version of DoSetReadOnly(FileSystemSessionItem, Boolean). This base/default implementation just synchronously calls DoSetReadOnly(FileSystemSessionItem, Boolean) and returns already completed Task with result returned by DoSetReadOnly(FileSystemSessionItem, Boolean)
Protected methodDoSetVersion
Override in particular file systems that support versioning to set seesion to specific version. This method may be called by miltiple threads
Protected methodDoSetVersionAsync
Async version of DoSetVersion(FileSystemSession, IFileSystemVersion). This base/default implementation just synchronously calls DoSetVersion(FileSystemSession, IFileSystemVersion) and returns already completed Task with result returned by DoSetVersion(FileSystemSession, IFileSystemVersion)
Protected methodDoWriteAsync
Public methodEnsureObjectNotDisposed
Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called
(Inherited from DisposableObject.)
Public methodOnlineEquals
Determines whether the specified object is equal to the current object.
(Inherited from OnlineObject.)
Protected methodFinalize (Inherited from DisposableObject.)
Public methodOnlineGetHashCode
Serves as the default hash function.
(Inherited from OnlineObject.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodStatic memberMake TParam (IConfigSectionNode)
Public methodStatic memberMake TParam (String, String)
Protected methodMakeSessionConfigParams
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodStartSession
Creates a new session for the user. This method is thread-safe, however the returned FileSystemSession object is not. Every thread must obtain its own session via this method
Public methodToString (Overrides OnlineObject ToString .)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodAsBool (Defined by ObjectValueConversion.)
Public Extension MethodAsByte (Defined by ObjectValueConversion.)
Public Extension MethodAsChar (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime(DateTime, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID(GDID, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsInt (Defined by ObjectValueConversion.)
Public Extension MethodAsJSONConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLaconicConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNonNullOrEmptyString (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableBool (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableChar (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDateTime (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDIDSymbol (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableShort (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableTimeSpan (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableULong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsShort (Defined by ObjectValueConversion.)
Public Extension MethodAsString (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan(TimeSpan, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsULong (Defined by ObjectValueConversion.)
Public Extension MethodAsUri (Defined by ObjectValueConversion.)
Public Extension MethodAsUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsXMLConfig (Defined by ObjectValueConversion.)
Public Extension MethodToErlObject Overloaded.
Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible
(Defined by ErlObject.)
Public Extension MethodToErlObject(ErlTypeOrder, Boolean)Overloaded.
Try to convert .NET native object type to corresponding Erlang term of given type. Throw exception if conversion is not possible
(Defined by ErlObject.)
Public Extension MethodToJSON(JSONWritingOptions)Overloaded.
Serializes object into JSON string
(Defined by JSONExtensions.)
Public Extension MethodToJSON(TextWriter, JSONWritingOptions)Overloaded.
Serializes object into JSON format using provided TextWriter
(Defined by JSONExtensions.)
Public Extension MethodToJSON(Stream, JSONWritingOptions, Encoding)Overloaded.
Serializes object into JSON format using provided stream and optional encoding
(Defined by JSONExtensions.)
Back to Top
Fields

  NameDescription
Public fieldStatic memberCONFIG_AUTO_START_ATTR
Public fieldStatic memberCONFIG_DEFAULT_SESSION_CONNECT_PARAMS_SECTION
Public fieldStatic memberCONFIG_FILESYSTEM_SECTION
Public fieldStatic memberCONFIG_FILESYSTEMS_SECTION
Public fieldStatic memberCONFIG_NAME_ATTR
Protected fieldm_Name
Protected fieldm_Sessions
Back to Top
Properties

  NameDescription
Public propertyComponentCommonName
Returns the common name used to identify the component, for example "Glue" for various IGlue implementations. This name is searched-by some management tools that allow to find component by this name that does not change between application restarts like ComponentSID does. Subordinate (non-root) components return null
(Inherited from ApplicationComponent.)
Public propertyComponentDirector
Returns a reference to an object that this app component services/operates under, or null
(Inherited from ApplicationComponent.)
Public propertyComponentSID
Returns process/instance unique app component system id
(Inherited from ApplicationComponent.)
Public propertyComponentStartTime
Returns local computer time of component start (not from application container time)
(Inherited from ApplicationComponent.)
Protected propertyDefaultSessionConnectParams
Public propertyDisposed
Indicates whether this object was already disposed - the Dispose() has finished
(Inherited from DisposableObject.)
Public propertyDisposeStarted
Indicates whether this object Dispose() has been called and dispose started but not finished yet
(Inherited from DisposableObject.)
Public propertyGeneralCapabilities
Returns capabilities for this file system in general
Public propertyInstanceCapabilities
Returns capabilities for this file system instance, that may or may not be the same as GeneralCapabilities
Public propertyStatic memberInstances
Returns the read-only registry view of file systems currently activated
Public propertyName
Provides name for file system instance
Public propertySessions
Returns a list of sessions. This accessor is thread-safe
Back to Top
See Also