FUSE Class

Properties   Methods   Events   Configuration Settings   Errors  

The FUSE class gives applications the ability to create a virtual filesystem using FUSE-like API.

Syntax

class cbfsfuse.FUSE

Remarks

The FUSE class is used to create a virtual filesystem whose contents are stored and exposed in an application-defined manner. The FUSE class offers applications an API similar to the one used by the FUSE library on Linux.

Getting Started

Each FUSE class instance controls a single virtual filesystem, and therefore a single virtual drive. Applications can use multiple instances of the FUSE class if their use-case requires the creation of multiple virtual drives; the class's tag property can be used to distinguish between instances during event handlers.

Here's how to get up and running:

1. If the system driver hasn't been installed yet, call the install method to do so. This only needs to be done once.
   • In production, the system driver can be installed (or updated) ahead-of-time by the application's installation script using the Installer DLL. Please refer to the Driver Installation topic for more information.
2. Call the initialize method to initialize the FUSE class. This must be done each time the application starts (if the application is using multiple FUSE class instances, only the first instance created should be used to call initialize).
3. Ensure that all of the necessary event handlers have been implemented. Some event handlers, such as on_open, on_read, on_get_attr, on_read_dir, etc; are mandatory and must be implemented by all applications (note that this is not an exhaustive list). Others are optional, and only need to be implemented when certain features are enabled. Please refer to the events' documentation for more information.
4. Create a virtual drive by calling the mount method. This operation incorporates several steps, such as creation of the virtual disk, mounting a "storage media" and adding a mounting point. A mounting point can be a drive letter, a UNC path, or a directory on an existing NTFS-formatted drive (see Mounting Points for details).
5. Later, the application can unmount the "media" from the virtual drive using the unmount method.
6. To uninstall the system driver, call the uninstall method. This should not be done as part of the driver upgrade process.
   • In production, the system driver can be uninstalled by the application's uninstallation script using the Installer DLL. Please refer to the Driver Installation topic for more information.