CBFS Connect 2020 Node.js Edition

Questions / Feedback?

MetadataCacheEnabled Property

Whether the metadata cache should be used.

Syntax

 cbfs.getMetadataCacheEnabled([callback])
 cbfs.setMetadataCacheEnabled( metadataCacheEnabled, [callback])

Default Value

TRUE

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getMetadataCacheEnabled([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setMetadataCacheEnabled([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property controls whether the file metadata cache is enabled for a virtual drive. The size of the file metadata cache can be controlled using the MetadataCacheSize property.

When enabled, the class caches file information obtained via EnumerateDirectory and GetFileInfo events and uses the cached metadata to serve operating system requests, thus reducing how often the GetFileInfo events fire.

While a file or directory is open, its metadata is kept available in a special record called a File Control Block, regardless of whether the metadata cache is enabled.

For closed files and directories, the metadata is kept in the cache for the time, defined by the UnusedMetadataLifetime configuration setting.

Please refer to the Caching topic for more information.

Note: This property cannot be changed within events.

This property is not available at design time.

Data Type

Boolean

Copyright (c) 2022 Callback Technologies, Inc. - All rights reserved.
CBFS Connect 2020 Node.js Edition - Version 20.0 [Build 8164]