Coveo Knowledge Base – Information Article – 060331-1

Mutex Object Reference

The information in this technical note applies to:

Coveo Enterprise Search 4

Summary

This document contains complementary information about the Mutex scripting object.

Definition
Overview
Methods

Definition

The Mutex scripting object is an utility object that allows to serialize the process. It is mainly used when an external conversion utility is not reentrant (does not allow you to run more than one object at a time).

Overview

This is a list of all Mutex properties and methods.

·          Properties: No properties.

·          Methods: AcquireLock, ReleaseLock

Methods

Name

Type

Description

Parameters

AcquireLock

 

Asks for the right of proceed. Script can not process unless another authority releases the Mutex.

p_MutexName (String): The unique name of the mutex.

ReleaseLock

 

Releases the Mutex. If a script does not release the Mutex, the system automatically releases it at the end of script.

 

 

See Conversion Script Objects Reference to get a complete list of all available conversion script objects.