View Source

Interface ICacheInstructionService

Namespace: Umbraco.Cms.Core.Services

Assembly: Umbraco.Core.dll

Syntax

public interface ICacheInstructionService

Methods

DeliverInstructions(IEnumerable<RefreshInstruction>, string)

Creates a cache instruction record from a set of individual instructions and saves it.

Declaration

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

Parameters

Type	Name	Description
IEnumerable<RefreshInstruction>	instructions
string	localIdentity

DeliverInstructionsInBatches(IEnumerable<RefreshInstruction>, string)

Creates one or more cache instruction records based on the configured batch size from a set of individual instructions and saves them.

Declaration

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

Parameters

Type	Name	Description
IEnumerable<RefreshInstruction>	instructions
string	localIdentity

GetMaxInstructionId()

Gets the most recent cache instruction record Id.

Declaration

int GetMaxInstructionId()

Returns

Type	Description
int

IsColdBootRequired(int)

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

bool IsColdBootRequired(int lastId)

Parameters

Type	Name	Description
int	lastId

Returns

Type	Description
bool

IsInstructionCountOverLimit(int, int, out int)

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

Declaration

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

Parameters

Type	Name	Description
int	lastId
int	limit
int	count

Returns

Type	Description
bool

ProcessAllInstructions(CacheRefresherCollection, CancellationToken, string)

Processes all pending database cache instructions using the provided cache refreshers.

Declaration

ProcessInstructionsResult ProcessAllInstructions(CacheRefresherCollection cacheRefreshers, CancellationToken cancellationToken, string localIdentity)

Parameters

Type	Name	Description
CacheRefresherCollection	cacheRefreshers	The collection of cache refreshers to use for processing instructions.
CancellationToken	cancellationToken	A token to monitor for cancellation requests.
string	localIdentity	The local identity of the executing AppDomain.

Returns

Type	Description
ProcessInstructionsResult	The result of processing all instructions.

ProcessInstructions(CacheRefresherCollection, CancellationToken, string, int)

Processes pending database cache instructions.

Declaration

ProcessInstructionsResult ProcessInstructions(CacheRefresherCollection cacheRefreshers, CancellationToken cancellationToken, string localIdentity, int lastId)

Parameters

Type	Name	Description
CacheRefresherCollection	cacheRefreshers	Cache refreshers.
CancellationToken	cancellationToken	Cancellation token.
string	localIdentity	Local identity of the executing AppDomain.
int	lastId	Id of the latest processed instruction.

Returns

Type	Description
ProcessInstructionsResult	The processing result.

ProcessInternalInstructions(CacheRefresherCollection, CancellationToken, string)

Processes pending cache instructions from the database for the internal (repository) caches.

Declaration

ProcessInstructionsResult ProcessInternalInstructions(CacheRefresherCollection cacheRefreshers, CancellationToken cancellationToken, string localIdentity)

Parameters

Type	Name	Description
CacheRefresherCollection	cacheRefreshers	The collection of cache refreshers to use for processing instructions.
CancellationToken	cancellationToken	A token to monitor for cancellation requests.
string	localIdentity	The local identity of the executing AppDomain.

Returns

Type	Description
ProcessInstructionsResult	The result of processing the internal instructions.