Diffusion .NET Client Library  6.1.5
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Pages
Package PushTechnology.ClientInterface.Client.Features.TimeSeries

Classes

interface  ITimeSeries
 This feature allows a session to update and query time series topics. More...
 
interface  IEventMetadata
 The time series event metadata. More...
 
interface  IEvent< TValue >
 The event in a time series. More...
 
interface  IQueryResult< TValue >
 The query result providing a stream of events. More...
 
interface  IQuery< TValue >
 The configured query. More...
 
interface  IRangeQuery< TValue >
 The builder for queries that select a range of events from a time series. More...
 
class  InvalidQueryException
 Exception used to report a query that is invalid for the time series. More...
 
class  NoSuchEventException
 The exception used to report a time series topic does not have an original event with the sequence number provided by an ITimeSeries.EditAsync{TValue}(string, long, TValue) operation. More...
 

Enumerations

enum  StreamStructure { StreamStructure.VALUE_EVENT_STREAM, StreamStructure.EDIT_EVENT_STREAM }
 The structural properties of a stream. More...
 

Enumeration Type Documentation

The structural properties of a stream.

Added in version 6.1.

Enumerator
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.
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.