Class LockHelper

Namespace

CMS.Base

Assembly

CMS.Base.dll

Class to provide lock objects based on the given key.

public class LockHelper

Inheritance

object

LockHelper

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Methods

Ensure<T>(ref T, Func<T>, object)

Ensures the value of the given variable in a locked context to prevent multiple loads. Uses the loadMethod to initialize the value.

public static T Ensure<T>(ref T variable, Func<T> loadMethod, object lockObject) where T : class

Parameters

variable T

Variable to load

loadMethod Func<T>

Methods that provides the variable value

lockObject object

Object to use for locking context to ensure only one load

Returns

T

Type Parameters

T

Exceptions

ArgumentNullException

Throws when lock object is not defined

Ensure<T>(ref T, object)

Ensures the value of the given variable in a locked context to prevent multiple loads. Uses the default constructor of T to initialize the value.

public static T Ensure<T>(ref T variable, object lockObject) where T : class, new()

Parameters

variable T

Variable to load

lockObject object

Object to use for locking context to ensure only one load

Returns

T

Type Parameters

T

Exceptions

ArgumentNullException

Throws when lock object is not defined

ExecuteOnceInLifetime(Action, object, ref bool)

Ensures that the given action is executed only once

public static bool ExecuteOnceInLifetime(Action action, object lockObject, ref bool executedFlag)

Parameters

action Action

Action to execute

lockObject object

Object to use for locking context to ensure only one load

executedFlag bool

Flag that indicates if the action was already executed

Returns

bool

Exceptions

ArgumentNullException

Throws when lock object is not defined

GetLockObject(string)

Gets the object for lock.

public static LockObject GetLockObject(string key)

Parameters

key string

Lock object key

Returns

LockObject