Class ServerMessengerBase

Provides a base class for all implementations.

Inheritance

System.Object

Namespace: Umbraco.Cms.Infrastructure.Sync

Assembly: cs.temp.dll.dll

Syntax

public abstract class ServerMessengerBase : IServerMessenger

Constructors

ServerMessengerBase(Boolean)

Declaration

protected ServerMessengerBase(bool distributedEnabled)

Parameters

Type	Name	Description
System.Boolean	distributedEnabled

Properties

DistributedEnabled

Declaration

protected bool DistributedEnabled { get; set; }

Property Value

Type	Description
System.Boolean

Methods

Deliver(ICacheRefresher, MessageType, 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.Collections.Generic.IEnumerable<System.Object>	ids
System.String	json

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

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
System.Func<T, System.Object>	getId
System.Collections.Generic.IEnumerable<T>	instances

Type Parameters

Name	Description
T

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

Executes the non strongly typed 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.Collections.Generic.IEnumerable<System.Object>	ids
System.String	json

Remarks

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

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

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

Executes the strongly typed 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
System.Func<T, System.Object>	getId
System.Collections.Generic.IEnumerable<T>	instances

Type Parameters

Name	Description
T

Remarks

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

DeliverRemote(ICacheRefresher, MessageType, 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.Collections.Generic.IEnumerable<System.Object>	ids
System.String	json

GetArrayType(IEnumerable<Object>, out Type)

Declaration

protected static bool GetArrayType(IEnumerable<object> ids, out Type arrayType)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Object>	ids
System.Type	arrayType

Returns

Type	Description
System.Boolean

PerformRefresh(ICacheRefresher, String)

Declaration

public void PerformRefresh(ICacheRefresher refresher, string jsonPayload)

Parameters

Type	Name	Description
ICacheRefresher	refresher
System.String	jsonPayload

QueueRefresh(ICacheRefresher, Guid[])

Declaration

public void QueueRefresh(ICacheRefresher refresher, params Guid[] guidIds)

Parameters

Type	Name	Description
ICacheRefresher	refresher
System.Guid[]	guidIds

QueueRefresh(ICacheRefresher, Int32[])

Declaration

public void QueueRefresh(ICacheRefresher refresher, params int[] numericIds)

Parameters

Type	Name	Description
ICacheRefresher	refresher
System.Int32[]	numericIds

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

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
System.Func<T, System.Guid>	getGuidId
T[]	instances

Type Parameters

Name	Description
T

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
System.Func<T, System.Int32>	getNumericId
T[]	instances

Type Parameters

Name	Description
T

QueueRefreshAll(ICacheRefresher)

Declaration

public void QueueRefreshAll(ICacheRefresher refresher)

Parameters

Type	Name	Description
ICacheRefresher	refresher

QueueRemove(ICacheRefresher, Int32[])

Declaration

public void QueueRemove(ICacheRefresher refresher, params int[] numericIds)

Parameters

Type	Name	Description
ICacheRefresher	refresher
System.Int32[]	numericIds

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
System.Func<T, System.Int32>	getNumericId
T[]	instances

Type Parameters

Name	Description
T

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.

SendMessages()

Declaration

public abstract void SendMessages()

Sync()

Declaration

public abstract void Sync()