EventHubSequenceToken Class

Definition

Namespace:

Orleans.Streaming.EventHubs

Assembly:

Orleans.Streaming.EventHubs.dll

Package:

Microsoft.Orleans.Streaming.EventHubs v8.2.0

Event Hub messages consist of a batch of application layer events, so EventHub tokens contain three pieces of information. EventHubOffset - this is a unique value per partition that is used to start reading from this message in the partition. SequenceNumber - EventHub sequence numbers are unique ordered message IDs for messages within a partition.
The SequenceNumber is required for uniqueness and ordering of EventHub messages within a partition. event Index - Since each EventHub message may contain more than one application layer event, this value indicates which application layer event this token is for, within an EventHub message. It is required for uniqueness and ordering of application layer events within an EventHub message.

[Orleans.GenerateSerializer]
[System.Serializable]
public class EventHubSequenceToken : Orleans.Providers.Streams.Common.EventSequenceToken, Orleans.Streaming.EventHubs.IEventHubPartitionLocation

[<Orleans.GenerateSerializer>]
[<System.Serializable>]
type EventHubSequenceToken = class
    inherit EventSequenceToken
    interface IEventHubPartitionLocation

Public Class EventHubSequenceToken
Inherits EventSequenceToken
Implements IEventHubPartitionLocation

Inheritance

Object

StreamSequenceToken

EventSequenceToken

EventHubSequenceToken

Derived

Orleans.Streaming.EventHubs.EventHubSequenceTokenV2

Attributes

GenerateSerializerAttribute SerializableAttribute

Implements

IEventHubPartitionLocation

Constructors

EventHubSequenceToken()	Initializes a new instance of the EventHubSequenceToken class.
EventHubSequenceToken(String, Int64, Int32)	Initializes a new instance of the EventHubSequenceToken class.

Properties

EventHubOffset	Offset of the message within an EventHub partition
EventIndex	Gets the number of events in batch prior to this event (Inherited from EventSequenceToken)
SequenceNumber	Gets the number of event batches in stream prior to this event batch (Inherited from EventSequenceToken)

Methods

CompareTo(StreamSequenceToken)	Compares the current object with another object of the same type. (Inherited from EventSequenceToken)
CreateSequenceTokenForEvent(Int32)	Creates a sequence token for a specific event in the current batch. (Inherited from EventSequenceToken)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from EventSequenceToken)
Equals(StreamSequenceToken)	Indicates whether the current object is equal to another object of the same type. (Inherited from EventSequenceToken)
GetHashCode()	GetHashCode method for current EventSequenceToken (Inherited from EventSequenceToken)
ToString()	Returns a string that represents the current object.

Extension Methods

Newer(StreamSequenceToken, StreamSequenceToken)	Returns true if the first token is newer than the second token.
Older(StreamSequenceToken, StreamSequenceToken)	Returns true if the first token is older than the second token.