View Source

Class MainDom

Provides the full implementation of IMainDom.

Inheritance

object

Namespace: Umbraco.Cms.Core.Runtime

Assembly: Umbraco.Core.dll

Syntax

public class MainDom : IMainDom, IRegisteredObject

Remarks

When an AppDomain starts, it tries to acquire the main domain status.

When an AppDomain stops (eg the application is restarting) it should release the main domain status.

Constructors

MainDom(ILogger<MainDom>, IMainDomLock)

Declaration

public MainDom(ILogger<MainDom> logger, IMainDomLock systemLock)

Parameters

Type	Name	Description
ILogger<MainDom>	logger
IMainDomLock	systemLock

Properties

IsMainDom

Gets a value indicating whether the current domain is the main domain.

Declaration

public bool IsMainDom { get; }

Property Value

Type	Description
bool

Remarks

Acquire must be called first else this will always return false

Methods

Acquire(IApplicationShutdownRegistry)

Tries to acquire the MainDom, returns true if successful else false

Declaration

public bool Acquire(IApplicationShutdownRegistry hostingEnvironment)

Parameters

Type	Name	Description
IApplicationShutdownRegistry	hostingEnvironment

Returns

Type	Description
bool

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

Dispose(bool)

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

GetMainDomId(IHostingEnvironment)

Declaration

public static string GetMainDomId(IHostingEnvironment hostingEnvironment)

Parameters

Type	Name	Description
IHostingEnvironment	hostingEnvironment

Returns

Type	Description
string

Register(Action?, Action?, int)

Registers a resource that requires the current AppDomain to be the main domain to function.

Declaration

public bool Register(Action? install = null, Action? release = null, int weight = 100)

Parameters

Type	Name	Description
Action	install	An action to execute when registering.
Action	release	An action to execute before the AppDomain releases the main domain status.
int	weight	An optional weight (lower goes first).

Returns

Type	Description
bool	A value indicating whether it was possible to register.

Remarks

If registering is successful, then the install action is guaranteed to execute before the AppDomain releases the main domain status.