View Source

Class CacheInstructionService

Implements ICacheInstructionService providing a service for retrieving and saving cache instructions.

Inheritance

System.Object

RepositoryService

Namespace: Umbraco.Cms.Infrastructure.Services

Assembly: Umbraco.Infrastructure.dll

Syntax

public class CacheInstructionService : RepositoryService, IService, ICacheInstructionService

Constructors

CacheInstructionService(ICoreScopeProvider, ILoggerFactory, IEventMessagesFactory, ICacheInstructionRepository, IProfilingLogger, ILogger<CacheInstructionService>, IOptions<GlobalSettings>)

Initializes a new instance of the CacheInstructionService class.

Declaration

public CacheInstructionService(ICoreScopeProvider provider, ILoggerFactory loggerFactory, IEventMessagesFactory eventMessagesFactory, ICacheInstructionRepository cacheInstructionRepository, IProfilingLogger profilingLogger, ILogger<CacheInstructionService> logger, IOptions<GlobalSettings> globalSettings)

Parameters

Type	Name	Description
ICoreScopeProvider	provider
ILoggerFactory	loggerFactory
IEventMessagesFactory	eventMessagesFactory
ICacheInstructionRepository	cacheInstructionRepository
IProfilingLogger	profilingLogger
ILogger<CacheInstructionService>	logger
IOptions<GlobalSettings>	globalSettings

Methods

DeliverInstructions(IEnumerable<RefreshInstruction>, String)

Declaration

public void DeliverInstructions(IEnumerable<RefreshInstruction> instructions, string localIdentity)

Parameters

Type	Name	Description
IEnumerable<RefreshInstruction>	instructions
System.String	localIdentity

DeliverInstructionsInBatches(IEnumerable<RefreshInstruction>, String)

Declaration

public void DeliverInstructionsInBatches(IEnumerable<RefreshInstruction> instructions, string localIdentity)

Parameters

Type	Name	Description
IEnumerable<RefreshInstruction>	instructions
System.String	localIdentity

GetMaxInstructionId()

Gets the most recent cache instruction record Id.

Declaration

public int GetMaxInstructionId()

Returns

Type	Description
System.Int32

IsColdBootRequired(Int32)

Checks to see if a cold boot is required, either because instructions exist and none have been synced or because the last recorded synced instruction can't be found in the database.

Declaration

public bool IsColdBootRequired(int lastId)

Parameters

Type	Name	Description
System.Int32	lastId

Returns

Type	Description
System.Boolean

IsInstructionCountOverLimit(Int32, Int32, out Int32)

Checks to see if the number of pending instructions are over the configured limit.

Declaration

public bool IsInstructionCountOverLimit(int lastId, int limit, out int count)

Parameters

Type	Name	Description
System.Int32	lastId
System.Int32	limit
System.Int32	count

Returns

Type	Description
System.Boolean

ProcessInstructions(CacheRefresherCollection, ServerRole, CancellationToken, String, DateTime, Int32)

Declaration

public ProcessInstructionsResult ProcessInstructions(CacheRefresherCollection cacheRefreshers, ServerRole serverRole, CancellationToken cancellationToken, string localIdentity, DateTime lastPruned, int lastId)

Parameters

Type	Name	Description
CacheRefresherCollection	cacheRefreshers
ServerRole	serverRole
CancellationToken	cancellationToken
System.String	localIdentity
DateTime	lastPruned
System.Int32	lastId

Returns

Type	Description
ProcessInstructionsResult