EdgeEvent<TPayload> Class

An edge event represents either the start or end of a CEP event.

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

Inheritance Hierarchy

System.Object
  Microsoft.ComplexEventProcessing.EventInstance
    Microsoft.ComplexEventProcessing.TypedEvent<TPayload>
      Microsoft.ComplexEventProcessing.EdgeEvent<TPayload>

Syntax

public sealed class EdgeEvent<TPayload> : TypedEvent<TPayload>

generic<typename TPayload>
public ref class EdgeEvent sealed : TypedEvent<TPayload>

[<Sealed>]
type EdgeEvent<'TPayload> = 
    class
        inherit TypedEvent<'TPayload>
    end

Public NotInheritable Class EdgeEvent(Of TPayload)
    Inherits TypedEvent(Of TPayload)

Type Parameters

• TPayload
  Type of the payload of the edge event.

Properties

	Name	Description
	EdgeType	Gets the edge type.
	EndTime	Gets or sets the valid end time of the event. This value is ignored if this is a start edge event.
	EventKind	Gets the kind of the event.(Inherited from TypedEvent<TPayload>.)
	Payload	Gets or sets the payload of the event.(Inherited from TypedEvent<TPayload>.)
	StartTime	Gets or sets the valid start time of the event. This value is ignored if this is an end edge event.

Methods

	Name	Description
	CreateCti(DateTimeOffset)	Creates a CTI in a stream of edge events.
	CreateEnd(DateTimeOffset, DateTimeOffset, TPayload)	Creates an edge end event with the specified payload.
	CreateStart(DateTimeOffset, TPayload)	Creates an edge start event with the specified payload.
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

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. For more information on edge events, see NIB StreamInsight Server Concepts.

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 payload. For more information about creating event types, see Creating Event TypesEvent Structure.

Examples

EdgeEvent{TPayload} ev = CreateInsertEvent(EdgeType.Start);
ev.StartTime = DateTime.Now;
ev.Payload = ...
EnqueueOperationResult result = Enqueue(ref ev);

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.

See Also

Microsoft.ComplexEventProcessing Namespace

Return to top