Class Offset

Used in IEventsByTagQuery implementations to signal to Akka.Persistence.Query where to begin and end event by tag queries.

For concrete implementations, see Sequence(long), NoOffset() and FromEnd.

Inheritance
object
Offset
FromEnd
NoOffset
Sequence
TimeBasedUuid
Implements
Inherited Members
Namespace: Akka.Persistence.Query
Assembly: Akka.Persistence.Query.dll
Syntax
public abstract class Offset : IComparable<Offset>

Methods

| Edit this page View Source

CompareTo(Offset)

Used to compare to other Offset implementations.

Declaration
public abstract int CompareTo(Offset other)
Parameters
Type Name Description
Offset other

The other offset to compare.
Returns
Type Description
int
| Edit this page View Source

FromEnd(int)

Factory to create an offset of type FromEnd, which begins the query at the count-th event from the end of history (inclusive), e.g. "the last 10 events".

Declaration
public static Offset FromEnd(int count)
Parameters
Type Name Description
int count

The number of events to read from the end of history. Must be greater than zero.
Returns
Type Description
Offset
| Edit this page View Source

NoOffset()

Used when retrieving all events.

Declaration
public static Offset NoOffset()
Returns
Type Description
Offset
| Edit this page View Source

Sequence(long)

Factory to create an offset of type Sequence

Declaration
public static Offset Sequence(long value)
Parameters
Type Name Description
long value
Returns
Type Description
Offset
| Edit this page View Source

TimeBasedUuid(Guid)

Factory to create an offset of type TimeBasedUuid(Guid)

Declaration
public static Offset TimeBasedUuid(Guid value)
Parameters
Type Name Description
Guid value
Returns
Type Description
Offset
| Edit this page View Source

ToString()

Used to log offset's value

Declaration
public override abstract string ToString()
Returns
Type Description
string
Overrides

Implements

Extension Methods