ConnectionOptions class

Options for establishing server connection

Constructors

ConnectionOptions({bool? verbose, bool? pedantic, bool? tlsRequired, String? authToken, String? userName, String? password, String? name, String? language, String? version, int? protocol, bool? echo})

Properties

authToken ↔ String?

Client authorization token (if ServerInfo.authRequired is set)

getter/setter pair

echo ↔ bool?

If set to true, the server (version 1.2.0+) will not send originating messages from this connection to its own subscriptions. Clients should set this to true only for server supporting this feature, which is when protocol in the INFO protocol is set to at least 1

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

language ↔ String?

Language implementation of the client

getter/setter pair

name ↔ String?

Optional client name

getter/setter pair

password ↔ String?

Connection password (if ServerInfo.authRequired is set)

getter/setter pair

pedantic ↔ bool?

Turns on additional strict format checking, e.g. for properly formed subjects

getter/setter pair

protocol ↔ int?

Sending 0 (or absent) indicates client supports original protocol. Sending 1 indicates that the client supports dynamic reconfiguration of cluster topology changes by asynchronously receiving INFO messages with known servers it can reconnect to.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

tlsRequired ↔ bool?

Indicates whether the client requires an SSL connection

getter/setter pair

userName ↔ String?

Connection username (if ServerInfo.authRequired is set)

getter/setter pair

verbose ↔ bool?

Turns on +OK protocol acknowledgements

getter/setter pair

version ↔ String?

Version of the client

getter/setter pair

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