PulsarClientSettings class

(Optional) settings for the PulsarClient instance.

Constructors

PulsarClientSettings({String serviceUrl = 'pulsar://localhost:6650/', Future<String> authTokenProvider(String? value)?, bool authTokenRefreshSupported = true, bool forceTLS = false, SecurityContext? securityContext, bool onBadCertificate(X509Certificate)?, int maxConnectionAttempts = 1, Duration reconnectTime = const Duration(milliseconds: 2000), Duration rebalanceTime = const Duration(milliseconds: 1000), Duration rebalanceTimeMax = const Duration(milliseconds: 5000), int maxRedirects = 4})

Properties

authTokenProvider → (Future<String> Function(String? value)?)

Authentication token provider function (optional). Null value disables authentication support

final

authTokenRefreshSupported → bool

Authentication token refresh support flag

final

forceTLS → bool

Forced TLS-only mode enable flag

final

hashCode → int

The hash code for this object.

no setter, inherited

maxConnectionAttempts ↔ int

Silent socket-level reconnect attempts number

getter/setter pair

maxRedirects ↔ int

Maximum number of (nested) request redirects. Must be > number of brokers in the cluster

getter/setter pair

onBadCertificate → (bool Function(X509Certificate)?)

The onBadCertificate handler for underlying SecureSocket.connect calls

final

rebalanceTime ↔ Duration

Expected (topic) rebalance time

getter/setter pair

rebalanceTimeMax ↔ Duration

Maximum (topic) rebalance time from the producer/consumer (high-level) prospect

getter/setter pair

reconnectTime ↔ Duration

Silent socket-level reconnect time

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

securityContext → SecurityContext?

The context parameter for underlying SecureSocket.connect calls

final

serviceUrl → String

Service (discovery) URL string of the Pulsar cluster. This is an entry point for clients

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