CBFS Filter 2020 Node.js Edition

Questions / Feedback?

SerializeEvents Property

Whether events should be fired on a single worker thread, or many.

Syntax

 cbregistry.getSerializeEvents([callback])
 cbregistry.setSerializeEvents( serializeEvents, [callback])

Default Value

FALSE

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 getSerializeEvents([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 setSerializeEvents([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 fire all events serially on a single worker thread, or concurrently on multiple worker threads. When this property is disabled (default), the MinWorkerThreadCount and MaxWorkerThreadCount configuration settings control how many worker threads are used to fire events.

Please refer to the Threading and Concurrency topic for more information.

Note: This property cannot be changed when Active is true, and cannot be changed within events.

Data Type

Boolean

 
 
Copyright (c) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Filter 2020 Node.js Edition - Version 20.0 [Build 7917]