Enum StreamStructure

The structural properties of a stream.

Namespace: PushTechnology.ClientInterface.Client.Features.TimeSeries
Assembly: Diffusion.Client.dll
Syntax
public enum StreamStructure : int
Remarks

Added in version 6.1.

Fields

Name Description
EDIT_EVENT_STREAM

The stream is presented in time series order.

The stream has the following properties:

  • The sequence of each event in the stream is unique.
  • The stream is ordered by sequence. The sequence of each subsequent event in the stream is greater than its predecessor.
  • Edit event timestamps may lie outside the query range.
  • The stream can have multiple edit events for the same original event.

VALUE_EVENT_STREAM

The stream is ordered by the original event sequence number, presenting edit events instead of the original events they replace.

The original event sequence number of an event e is e.OriginalMetadata.Sequence. It is equal to e.Sequence, if and only if e is an original event.

The stream has the following properties:

  • The sequence of each event in the stream is unique.
  • The original event sequence of each event in the stream is unique.
  • The stream is ordered by original event sequence. The original event sequence of each subsequent event in the stream is greater than its predecessor.
  • If no events have been removed from the time series, the original event sequence of each subsequent event is one greater than its predecessor.
  • If an event is an original event, the query found no corresponding edit events.
  • If an event is an edit event, its timestamp attribute may lie outside the query range. Consequentially, the sequence and timestamp attributes of the events may be non-sequential.