Five New Optimizely Certifications are Here! Validate your expertise and advance your career with our latest certification exams. Click here to find out more

AI OnAI Off

Interface IChangeProcessor

A non-generic wrapper for IChangeProcessor{TQueuedData}.

Namespace: EPiServer.Events.ChangeNotification
Assembly: EPiServer.Events.dll
Version: 12.0.3
Syntax
public interface IChangeProcessor

Properties

Listeners

Gets the change listeners associated with the processor.

Declaration
IEnumerable<IChangeListener> Listeners { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<IChangeListener>
Remarks

All change listener implementations must have a queued data type parameter that matches the processor's queued data type parameter exactly.

This value is expected to be constant. This property will only be enumerated once, and the IChangeNotificationManager will not notice any subsequent changes to value of this property.

MaxBatchSize

Gets the maximum number of items that will be passed to ProcessItems in a single call.

Declaration
int MaxBatchSize { get; }
Property Value
Type Description
System.Int32

MaxRetryCount

Gets the maximum number of times that ProcessItems will be retried if it returns false, after which the queue will be invalidated.

Declaration
int MaxRetryCount { get; }
Property Value
Type Description
System.Int32

Name

Gets the display name of the processor.

Declaration
string Name { get; }
Property Value
Type Description
System.String

ProcessorId

Gets a unique identifier for the processor. This identifier should persist over all instantiations, identifying the implementation of the event processor in persistent storage.

Declaration
Guid ProcessorId { get; }
Property Value
Type Description
System.Guid
Remarks

This value is expected to be constant. This property will only be accessed once, and the IChangeNotificationManager will not notice any subsequent changes to value of this property.

RetryInterval

Gets the interval between retries if ProcessItems returns false and MaxRetryCount permits a retry.

Declaration
TimeSpan RetryInterval { get; }
Property Value
Type Description
System.TimeSpan

Methods

RecoverConsistency(IRecoveryContext)

Recovers consistency when the eventual consistency has become invalid.

Declaration
bool RecoverConsistency(IRecoveryContext recoveryContext)
Parameters
Type Name Description
IRecoveryContext recoveryContext

An object for communication between the recovery process and the event manager.
Returns
Type Description
System.Boolean

True if consistency is retored to any point in time at or after the call to RecoverConsistency; otherwise, false.

Extension Methods