View Source

Class DatabaseServerMessenger

An IServerMessenger that works by storing messages in the database.

Inheritance

System.Object

ServerMessengerBase

Namespace: Umbraco.Cms.Infrastructure.Sync

Assembly: Umbraco.Infrastructure.dll

Syntax

public abstract class DatabaseServerMessenger : ServerMessengerBase, IServerMessenger

Constructors

DatabaseServerMessenger(IMainDom, CacheRefresherCollection, IServerRoleAccessor, ILogger<DatabaseServerMessenger>, Boolean, ISyncBootStateAccessor, IHostingEnvironment, ICacheInstructionService, IJsonSerializer, LastSyncedFileManager, IOptionsMonitor<GlobalSettings>)

Initializes a new instance of the DatabaseServerMessenger class.

Declaration

protected DatabaseServerMessenger(IMainDom mainDom, CacheRefresherCollection cacheRefreshers, IServerRoleAccessor serverRoleAccessor, ILogger<DatabaseServerMessenger> logger, bool distributedEnabled, ISyncBootStateAccessor syncBootStateAccessor, IHostingEnvironment hostingEnvironment, ICacheInstructionService cacheInstructionService, IJsonSerializer jsonSerializer, LastSyncedFileManager lastSyncedFileManager, IOptionsMonitor<GlobalSettings> globalSettings)

Parameters

Type	Name	Description
IMainDom	mainDom
CacheRefresherCollection	cacheRefreshers
IServerRoleAccessor	serverRoleAccessor
ILogger<DatabaseServerMessenger>	logger
System.Boolean	distributedEnabled
ISyncBootStateAccessor	syncBootStateAccessor
IHostingEnvironment	hostingEnvironment
ICacheInstructionService	cacheInstructionService
IJsonSerializer	jsonSerializer
LastSyncedFileManager	lastSyncedFileManager
IOptionsMonitor<GlobalSettings>	globalSettings

Properties

CacheInstructionService

Declaration

protected ICacheInstructionService CacheInstructionService { get; }

Property Value

Type	Description
ICacheInstructionService

GlobalSettings

Declaration

public GlobalSettings GlobalSettings { get; }

Property Value

Type	Description
GlobalSettings

JsonSerializer

Declaration

protected IJsonSerializer JsonSerializer { get; }

Property Value

Type	Description
IJsonSerializer

LocalIdentity

Gets the unique local identity of the executing AppDomain.

Declaration

protected string LocalIdentity { get; }

Property Value

Type	Description
System.String

Remarks

It is not only about the "server" (machine name and appDomainappId), but also about an AppDomain, within a Process, on that server - because two AppDomains running at the same time on the same server (eg during a restart) are, practically, a LB setup.

Practically, all we really need is the guid, the other infos are here for information and debugging purposes.

Logger

Declaration

protected ILogger<DatabaseServerMessenger> Logger { get; }

Property Value

Type	Description
ILogger<DatabaseServerMessenger>

Methods

DeliverRemote(ICacheRefresher, MessageType, Nullable<IEnumerable<Object>>, String)

Declaration

protected override void DeliverRemote(ICacheRefresher refresher, MessageType messageType, IEnumerable<object>? ids = null, string json = null)

Parameters

Type	Name	Description
ICacheRefresher	refresher
MessageType	messageType
System.Nullable<IEnumerable<System.Object>>	ids
System.String	json

Dispose()

Dispose

Declaration

public void Dispose()

Dispose(Boolean)

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

EnsureInitialized()

Returns true if initialization was successfull (i.e. Is MainDom)

Declaration

protected bool EnsureInitialized()

Returns

Type	Description
System.Boolean

RequiresDistributed(ICacheRefresher, MessageType)

Declaration

protected override bool RequiresDistributed(ICacheRefresher refresher, MessageType dispatchType)

Parameters

Type	Name	Description
ICacheRefresher	refresher
MessageType	dispatchType

Returns

Type	Description
System.Boolean

Sync()

Synchronize the server (throttled).

Declaration

public override void Sync()