Interface IChangeNotificationQueue
IChangeNotificationQueue describes a backing store for the change notification system.
Inherited Members
System.IDisposable.Dispose()
Namespace: EPiServer.Events.ChangeNotification.EventQueue
Assembly: EPiServer.Events.dll
Version: 8.11.0Syntax
public interface IChangeNotificationQueue : IDisposableRemarks
For internal use only.
Methods
Connect()
Opens a connection the queue, if not already open.
Declaration
void Connect()GetStatus()
Gets the current status and queue size of a processor from the queue.
Declaration
QueueStatus GetStatus()Returns
| Type | Description |
|---|---|
| QueueStatus | The current status and queue size of the processor. |
HeartBeat()
Notifies the queue that the change notification system is still running. Expected to be called regularly.
Declaration
void HeartBeat()SetInvalid()
Invalidates the queue.
Declaration
void SetInvalid()TrySetRecovering()
Sets the queue status to Recovering, if the current status is Invalid; otherwise, does nothing.
Declaration
bool TrySetRecovering()Returns
| Type | Description |
|---|---|
| System.Boolean | True if the status is change from Invalid to Recovering; otherwise, false. |
TrySetValid()
Sets the queue status to Valid, if the current status is Recovering; otherwise, does nothing.
Declaration
bool TrySetValid()Returns
| Type | Description |
|---|---|
| System.Boolean | True if the status is changed from Recovering to Valid; otherwise, false. |
