EdgeEvent Class

Article
04/29/2016

Defines methods and properties that allow adapters and user-defined operators to create and access edge events.

Namespace: Microsoft.ComplexEventProcessing
Assembly: Microsoft.ComplexEventProcessing (in Microsoft.ComplexEventProcessing.dll)

Inheritance Hierarchy

System.Object
Microsoft.ComplexEventProcessing.EventInstance
Microsoft.ComplexEventProcessing.UntypedEvent
Microsoft.ComplexEventProcessing.EdgeEvent

Syntax

public sealed class EdgeEvent : UntypedEvent

public ref class EdgeEvent sealed : UntypedEvent

[<Sealed>]
type EdgeEvent = 
    class
        inherit UntypedEvent
    end

Public NotInheritable Class EdgeEvent
    Inherits UntypedEvent

Properties

	Name	Description
	EdgeType	Gets the edge type.
	EndTime	Gets or sets the end time of the event. This value is ignored if this is a Start edge event.
	EventKind	Gets the event kind for the event.(Overrides UntypedEvent.EventKind.)
	StartTime	Gets or sets the valid start time of the event.

Methods

	Name	Description
	CreateCti<TPayload>(DateTimeOffset)	Creates a CTI in a stream of edge events.
	CreateEnd<TPayload>(DateTimeOffset, DateTimeOffset, TPayload)	Creates an edge end event with the specified payload.
	CreateStart<TPayload>(DateTimeOffset, TPayload)	Creates an edge start event with the specified payload.
	Equals(Object)	(Inherited from Object.)
	GetField<T>(Int32)	Gets a field value by its ordinal.(Inherited from UntypedEvent.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	SetField(Int32, Object)	Sets the value of the specified field, regardless of its type.(Inherited from UntypedEvent.)
	SetField<T>(Int32, T)	Sets the field value specified by its ordinal.(Inherited from UntypedEvent.)
	ToString()	(Inherited from Object.)

Remarks

An edge event represents either the start or end of a CEP event. As opposed to single interval events, which are fully specified in terms of their start and end time, edge events need to be given in pairs. An edge event of type Start indicates the beginning of the event lifetime, and a matching End event indicates the end of the event lifetime.

Edge events are typically used to model a discrete signal, where the arrival of the new signal value is not known in advance. Such a pattern entails the submission of an end event regarding the previous start event, followed by a start event for the new value. Note that the end event has to match the start time of the Start event as well as the payload. For more information, see NIB StreamInsight Server Concepts.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.