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

Class EventMessageValidator

Inheritance
System.Object
EventMessageValidator
Implements
System.IDisposable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Events.Providers
Assembly: EPiServer.Events.dll
Version: 9.12.2
Syntax
[ServiceConfiguration(typeof(IEventMessageValidator))]
public class EventMessageValidator : IEventMessageValidator, IDisposable

Constructors

EventMessageValidator(IEventSiteRegistry)

Declaration
public EventMessageValidator(IEventSiteRegistry siteRegistry)
Parameters
Type Name Description
IEventSiteRegistry siteRegistry

EventMessageValidator(IEventSiteRegistry, ServiceAccessor<ITimer>)

Declaration
public EventMessageValidator(IEventSiteRegistry siteRegistry, ServiceAccessor<ITimer> sequenceCheckTimerFactory)
Parameters
Type Name Description
IEventSiteRegistry siteRegistry
ServiceAccessor<ITimer> sequenceCheckTimerFactory

Properties

EventTimeout

Gets or sets a value indicating how long this EventMessageValidator should wait before considering an event as missing.

Declaration
public virtual TimeSpan EventTimeout { get; set; }
Property Value
Type Description
System.TimeSpan

Methods

Dispose()

Declaration
public void Dispose()

Dispose(Boolean)

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

OnEventMissed(EventMissedEventArgs)

Raises the EventMissed event.

Declaration
protected virtual void OnEventMissed(EventMissedEventArgs args)
Parameters
Type Name Description
EventMissedEventArgs args

The EventMissedEventArgs instance containing the event data.

Validate(EventMessage, Boolean)

Validates a received message and verifies that an event should be raised for it.

Declaration
public virtual bool Validate(EventMessage message, bool validateMessageIntegrity)
Parameters
Type Name Description
EventMessage message

The message that should be validated.
System.Boolean validateMessageIntegrity

if set to true the message integrity should be validated.
Returns
Type Description
System.Boolean

true if an event should be raised for the message; otherwise false.
Remarks

Calling this method will also trigger a message sequence validation.

Events

MessageMissed

Occurs if the IEventMessageValidator discovers that an event message has been not been received.

Declaration
public event EventHandler<EventMissedEventArgs> MessageMissed
Event Type
Type Description
System.EventHandler<EventMissedEventArgs>

Implements

System.IDisposable

Extension Methods