$Cache.Lock

Overview

Tries to acquire a lock for the enclosure key until the lock is retrieved.

string $Cache.Lock(key: string)

Tries to acquire a lock for shared key, until lock has acquired or timeout.

string $Cache.Lock(key: string, blockingTimeout: string)

Arguments

string key

Lock key. Key is a unique identifier for shared access. Required.

string blockingTimeout

Duration of waiting timeout in hh:mm:ss format. Default value is 60 second.

Returns

Acquired lock token if successful. Otherwise returns null.

Remarks

This method automatically enters to wait state for shared key is set to free until timeout is reached. If you do not want to wait please use the $Cache.TryLock method instead.

Acquired lock always must be released with $Cache.ReleaseLock method with generated token value. Otherwise lock is kept for long period until it's expire. (Default 5 min)

Example

$Cache.Set('myint', 4);
var tokenValue = $Cache.Lock('myint');
// Locked code block
$Cache.ReleaseLock('myint',tokenValue);