View Source

Class ServerMessengerBase

Provides a base class for all IServerMessenger implementations.

Inheritance
System.Object
Namespace: Umbraco.Cms.Infrastructure.Sync
Assembly: Umbraco.Infrastructure.dll
Syntax
public abstract class ServerMessengerBase : IServerMessenger

Constructors

View Source

ServerMessengerBase(Boolean)

Declaration
protected ServerMessengerBase(bool distributedEnabled)
Parameters
Type Name Description
System.Boolean distributedEnabled

Properties

View Source

DistributedEnabled

Declaration
protected bool DistributedEnabled { get; set; }
Property Value
Type Description
System.Boolean

Methods

View Source

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

Declaration
protected virtual void Deliver(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
View Source

Deliver<TPayload>(ICacheRefresher, TPayload[])

Declaration
protected virtual void Deliver<TPayload>(ICacheRefresher refresher, TPayload[] payload)
Parameters
Type Name Description
ICacheRefresher refresher
TPayload[] payload
Type Parameters
Name Description
TPayload
View Source

Deliver<T>(ICacheRefresher, MessageType, Func<T, Object>, IEnumerable<T>)

Declaration
protected virtual void Deliver<T>(ICacheRefresher refresher, MessageType messageType, Func<T, object> getId, IEnumerable<T> instances)
Parameters
Type Name Description
ICacheRefresher refresher
MessageType messageType
Func<T, System.Object> getId
IEnumerable<T> instances
Type Parameters
Name Description
T
View Source

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

Executes the non strongly typed ICacheRefresher on the local/current server

Declaration
protected void DeliverLocal(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
Remarks

Since this is only for non strongly typed ICacheRefresher it will throw for message types that by instance

View Source

DeliverLocal<TPayload>(ICacheRefresher, TPayload[])

Declaration
protected void DeliverLocal<TPayload>(ICacheRefresher refresher, TPayload[] payload)
Parameters
Type Name Description
ICacheRefresher refresher
TPayload[] payload
Type Parameters
Name Description
TPayload
View Source

DeliverLocal<T>(ICacheRefresher, MessageType, Func<T, Object>, IEnumerable<T>)

Executes the strongly typed ICacheRefresher<T> on the local/current server

Declaration
protected void DeliverLocal<T>(ICacheRefresher refresher, MessageType messageType, Func<T, object> getId, IEnumerable<T> instances)
Parameters
Type Name Description
ICacheRefresher refresher
MessageType messageType
Func<T, System.Object> getId
IEnumerable<T> instances
Type Parameters
Name Description
T
Remarks

Since this is only for strongly typed ICacheRefresher<T> it will throw for message types that are not by instance

View Source

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

Declaration
protected abstract 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
View Source

GetArrayType(Nullable<IEnumerable<Object>>, out Nullable<Type>)

Declaration
protected static bool GetArrayType(IEnumerable<object>? ids, out Type? arrayType)
Parameters
Type Name Description
System.Nullable<IEnumerable<System.Object>> ids
System.Nullable<Type> arrayType
Returns
Type Description
System.Boolean
View Source

PerformRefresh(ICacheRefresher, String)

Declaration
public void PerformRefresh(ICacheRefresher refresher, string jsonPayload)
Parameters
Type Name Description
ICacheRefresher refresher
System.String jsonPayload
View Source

QueueRefresh(ICacheRefresher, Guid[])

Declaration
public void QueueRefresh(ICacheRefresher refresher, params Guid[] guidIds)
Parameters
Type Name Description
ICacheRefresher refresher
Guid[] guidIds
View Source

QueueRefresh(ICacheRefresher, Int32[])

Declaration
public void QueueRefresh(ICacheRefresher refresher, params int[] numericIds)
Parameters
Type Name Description
ICacheRefresher refresher
System.Int32[] numericIds
View Source

QueueRefresh<TPayload>(ICacheRefresher, TPayload[])

Declaration
public void QueueRefresh<TPayload>(ICacheRefresher refresher, TPayload[] payload)
Parameters
Type Name Description
ICacheRefresher refresher
TPayload[] payload
Type Parameters
Name Description
TPayload
View Source

QueueRefresh<T>(ICacheRefresher, Func<T, Guid>, T[])

Declaration
public void QueueRefresh<T>(ICacheRefresher refresher, Func<T, Guid> getGuidId, params T[] instances)
Parameters
Type Name Description
ICacheRefresher refresher
Func<T, Guid> getGuidId
T[] instances
Type Parameters
Name Description
T
View Source

QueueRefresh<T>(ICacheRefresher, Func<T, Int32>, T[])

Declaration
public void QueueRefresh<T>(ICacheRefresher refresher, Func<T, int> getNumericId, params T[] instances)
Parameters
Type Name Description
ICacheRefresher refresher
Func<T, System.Int32> getNumericId
T[] instances
Type Parameters
Name Description
T
View Source

QueueRefreshAll(ICacheRefresher)

Declaration
public void QueueRefreshAll(ICacheRefresher refresher)
Parameters
Type Name Description
ICacheRefresher refresher
View Source

QueueRemove(ICacheRefresher, Int32[])

Declaration
public void QueueRemove(ICacheRefresher refresher, params int[] numericIds)
Parameters
Type Name Description
ICacheRefresher refresher
System.Int32[] numericIds
View Source

QueueRemove<T>(ICacheRefresher, Func<T, Int32>, T[])

Declaration
public void QueueRemove<T>(ICacheRefresher refresher, Func<T, int> getNumericId, params T[] instances)
Parameters
Type Name Description
ICacheRefresher refresher
Func<T, System.Int32> getNumericId
T[] instances
Type Parameters
Name Description
T
View Source

RequiresDistributed(ICacheRefresher, MessageType)

Determines whether to make distributed calls when messaging a cache refresher.

Declaration
protected virtual bool RequiresDistributed(ICacheRefresher refresher, MessageType messageType)
Parameters
Type Name Description
ICacheRefresher refresher

The cache refresher.
MessageType messageType

The message type.
Returns
Type Description
System.Boolean

true if distributed calls are required; otherwise, false, all we have is the local server.
View Source

SendMessages()

Declaration
public abstract void SendMessages()
View Source

Sync()

Declaration
public abstract void Sync()