Skip to content

EveStreamOptions

NexusLabs.Eve

EveStreamOptions Class

Configures attachment to an existing eve session stream.

public sealed record EveStreamOptions : System.IEquatable<NexusLabs.Eve.EveStreamOptions>

Inheritance System.Object → EveStreamOptions

Implements System.IEquatable<EveStreamOptions>

Properties

EveStreamOptions.Follow Property

Gets a value indicating whether the stream keeps following live events (the default).

public bool Follow { get; init; }

Property Value

System.Boolean

Remarks

Set this to false for a bounded catch-up read. A bounded stream reads every event recorded through the durable tail observed when the stream opens, reconnects through interruptions without moving that bound, and then completes instead of waiting for future events. Bounded reads require a nonnegative effective start cursor and a server that reports the durable tail index. Each request sends follow=false; servers that support stranded-session history can serve recorded events without a runnable owner. Both live and bounded streams complete after yielding a session terminal event.

EveStreamOptions.ReconnectPolicy Property

Gets the stream reconnect policy.

public NexusLabs.Eve.EveStreamReconnectPolicy? ReconnectPolicy { get; init; }

Property Value

EveStreamReconnectPolicy

EveStreamOptions.StartIndex Property

Gets an optional absolute event index, or a negative index relative to the current tail.

public System.Nullable<int> StartIndex { get; init; }

Property Value

System.Nullable<System.Int32>