CBFS Connect 2020 Node.js Edition

Questions / Feedback?

SerializeAccess Property

Whether non-intersecting operations against the same file should execute serially or in parallel.

Syntax

 cbfs.getSerializeAccess([callback])
 cbfs.setSerializeAccess( serializeAccess, [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 getSerializeAccess([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 setSerializeAccess([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 specifies whether the class should force non-intersecting operations against a single file or directory to execute serially (default), or allow them to execute in parallel.

Parallel processing can speed up operations, to a certain extent. When this property is disabled, and two or more requests (which don't change filesystem information) are made against the same file or directory, those requests are surfaced in parallel via the appropriate events (assuming that there are enough worker threads available to service them at the time). By default this property is enabled, and such requests are serialized. Please refer to the Threading and Concurrency topic for more information.

Please note that in order for parallel processing to work, the SerializeEvents property must be disabled, and the MinWorkerThreadCount and MaxWorkerThreadCount configuration settings must be set such that parallel processing can actually occur.

Note: This property cannot be changed after a virtual drive is created, and cannot be changed within events.

Data Type

Boolean

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