PersistentSubscriptionSettings class

A class representing the settings of a persistent subscription.

Constructors

PersistentSubscriptionSettings({Position? startFrom, int readBatchSize = 20, int maxRetryCount = 10, int liveBufferSize = 500, bool resolveLinkTos = false, bool extraStatistics = false, int maxSubscriberCount = 0, int historyBufferSize = 500, int minCheckPointCount = 10, int maxCheckPointCount = 1000, Duration checkPointAfter = const Duration(seconds: 2), Duration messageTimeout = const Duration(seconds: 30), SystemConsumerStrategies consumerStrategy = SystemConsumerStrategies.roundRobin})
Construct a new PersistentSubscriptionSettings instance

Properties

checkPointAfter Duration
The amount of time to try to checkpoint after.
final
consumerStrategy SystemConsumerStrategies
The strategy to use for distributing events to client consumers. See SystemConsumerStrategies for system supported strategies.
final
extraStatistics bool
Whether to track latency statistics on this subscription.
final
hashCode int
The hash code for this object.
no setterinherited
historyBufferSize int
The number of events to cache when paging through history.
final
liveBufferSize int
The size of the buffer (in-memory) listening to live messages as they happen before paging occurs.
final
maxCheckPointCount int
The maximum number of messages not checkpointed before forcing a checkpoint.
final
maxRetryCount int
The maximum number of retries (due to timeout) before a message is considered to be parked.
final
maxSubscriberCount int
The maximum number of subscribers allowed.
final
messageTimeout Duration
The amount of time after which to consider a message as timed out and retried.
final
minCheckPointCount int
The minimum number of messages to write to a checkpoint.
final
readBatchSize int
The number of events read at a time when paging through history.
final
resolveLinkTos bool
Whether the PersistentSubscription should resolve linkTo events to their linked events.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
startFrom Position?
Which event position in the stream or transaction file the subscription should start from.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Properties

Default PersistentSubscriptionSettings
Get default settings
final