eventstore.core.settings

Type members

Classlikes

@SerialVersionUID(1L)
final case
class ClusterSettings(gossipSeedsOrDns: GossipSeedsOrDns, dnsLookupTimeout: FiniteDuration, maxDiscoverAttempts: Int, discoverAttemptInterval: FiniteDuration, discoveryInterval: FiniteDuration, gossipTimeout: FiniteDuration)

Contains settings relating to a connection to a cluster.

Contains settings relating to a connection to a cluster.

Value Params
discoverAttemptInterval

The interval between cluster discovery attempts

discoveryInterval

The interval at which to keep discovering cluster

dnsLookupTimeout

The time given to resolve dns

gossipSeedsOrDns

Gossip seeds or DNS settings

gossipTimeout

Timeout for cluster gossip.

maxDiscoverAttempts

Maximum number of attempts for discovering endpoints

Companion
object
Companion
class
@SerialVersionUID(1L)
final case
class EsSettings(address: InetSocketAddress, connectionTimeout: FiniteDuration, maxReconnections: Int, reconnectionDelayMin: FiniteDuration, reconnectionDelayMax: FiniteDuration, defaultCredentials: Option[UserCredentials], heartbeatInterval: FiniteDuration, heartbeatTimeout: FiniteDuration, operationMaxRetries: Int, operationTimeout: FiniteDuration, resolveLinkTos: Boolean, requireMaster: Boolean, readBatchSize: Int, enableTcpTls: Boolean, cluster: Option[ClusterSettings], http: HttpSettings, serializationParallelism: Int, serializationOrdered: Boolean, connectionName: Option[String])
Value Params
address

IP & port of Event Store

cluster

see ClusterSettings

connectionName

Client identifier used to show a friendly name of client in Event Store.

connectionTimeout

The desired connection timeout

defaultCredentials

The UserCredentials to use for operations where other UserCredentials are not explicitly supplied.

enableTcpTls

Whether TLS should be enabled for TCP connections.

heartbeatInterval

The interval at which to send heartbeat messages.

heartbeatTimeout

The interval after which an unacknowledged heartbeat will cause the connection to be considered faulted and disconnect.

http

see HttpSettings

maxReconnections

Maximum number of reconnections before backing off, -1 to reconnect forever

operationMaxRetries

The maximum number of operation retries

operationTimeout

The amount of time before an operation is considered to have timed out

readBatchSize

Number of events to be retrieved by client as single message

reconnectionDelayMax

Maximum delay on reconnections

reconnectionDelayMin

Delay before first reconnection

requireMaster

Whether or not to require Event Store to refuse serving read or write request if it is not master

resolveLinkTos

Whether to resolve LinkTo events automatically

serializationOrdered

Serialization done asynchronously and these futures may complete in any order, but results will be used with preserved order if set to true

serializationParallelism

The number of serialization/deserialization functions to be run in parallel

Companion
object
object EsSettings
Companion
class
final case
class HttpSettings(protocol: String, host: String, port: Int, prefix: String)

Contains settings relating to a connection to Event Store HTTP server.

Contains settings relating to a connection to Event Store HTTP server.

Value Params
host

Hostname or address.

port

Port number used by Event Store

prefix

Prefix used that Event Store HTTP responds to.

protocol

Scheme, http or https.

Companion
object
Companion
class
@SerialVersionUID(1L)
final case
class PersistentSubscriptionSettings(resolveLinkTos: Boolean, startFrom: EventNumber, extraStatistics: Boolean, messageTimeout: FiniteDuration, maxRetryCount: Int, liveBufferSize: Int, readBatchSize: Int, historyBufferSize: Int, checkPointAfter: FiniteDuration, minCheckPointCount: Int, maxCheckPointCount: Int, maxSubscriberCount: Int, consumerStrategy: ConsumerStrategy)

Represents the settings for persistent subscription

Represents the settings for persistent subscription

You can use eventstore.j.PersistentSubscriptionSettingsBuilder) from Java

Value Params
checkPointAfter

The amount of time to try to checkpoint after

consumerStrategy

The ConsumerStrategy to use for distributing events to client consumers.

extraStatistics

Whether or not in depth latency statistics should be tracked on this subscription.

historyBufferSize

The number of events to cache when paging through history

liveBufferSize

The size of the buffer listening to live messages as they happen

maxCheckPointCount

maximum number of messages to checkpoint if this number is a reached a checkpoint will be forced.

maxRetryCount

The maximum number of retries (due to timeout) before a message get considered to be parked

maxSubscriberCount

The maximum number of subscribers allowed.

messageTimeout

The amount of time after which a message should be considered to be timedout and retried.

minCheckPointCount

The minimum number of messages to checkpoint

readBatchSize

The number of events read at a time when paging in history

resolveLinkTos

Whether to resolve LinkTo events automatically

startFrom

Where the subscription should start from, EventNumber

Companion
object