-
autoReconnect
↔ bool
-
Auto reconnect, the client will auto reconnect if set true.
getter/setter pairinherited
-
averageCycleLatency
→ int?
-
The average latency of all ping/pong cycles in a connection period in
milliseconds. Cleared on disconnect.
no setterinherited
-
clientEventBus
↔ EventBus?
-
The event bus
getter/setter pairinherited
-
clientIdentifier
↔ String
-
Client identifier
getter/setter pairinherited
-
connectionHandler
↔ MqttConnectionHandlerBase?
-
The Handler that is managing the connection to the remote server.
getter/setter pairinherited
-
connectionMessage
↔ MqttConnectMessage?
-
getter/setter pairinherited
-
connectionState
→ MqttConnectionState?
-
Gets the current connection state of the Mqtt Client.
Will be removed, use connectionStatus
no setterinherited
-
connectionStatus
→ MqttClientConnectionStatus?
-
Gets the current connection status of the Mqtt Client.
This is the connection state as above also with the broker return code.
Set after every connection attempt.
no setterinherited
-
connectTimeoutPeriod
↔ int
-
getter/setter pairinherited
-
disconnectOnNoResponsePeriod
↔ int
-
The period of time to wait if the broker does not respond to a ping request
from keep alive processing, in seconds.
If this time period is exceeded the client is forcibly disconnected.
The default is 0, which disables this functionality.
Thi setting has no effect if keep alive is disabled.
getter/setter pairinherited
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
instantiationCorrect
↔ bool
-
Incorrect instantiation protection
getter/setter pairinherited
-
keepAlive
↔ MqttConnectionKeepAlive?
-
Handles the connection management while idle.
Not instantiated if keep alive is disabled.
getter/setter pairinherited
-
keepAlivePeriod
↔ int
-
Keep alive period, seconds.
Keep alive is defaulted to off, this must be set to a valid value to
enable keep alive.
getter/setter pairinherited
-
lastCycleLatency
→ int?
-
The latency of the last ping/pong cycle in milliseconds.
Cleared on disconnect.
no setterinherited
-
manuallyAcknowledgeQos1
↔ bool
-
getter/setter pairinherited
-
maxConnectionAttempts
→ int
-
Max connection attempts
final
-
messagesAwaitingManualAcknowledge
→ int
-
The number of QOS 1 messages awaiting manual acknowledge.
no setterinherited
-
onAutoReconnect
↔ AutoReconnectCallback?
-
Auto reconnect callback, if auto reconnect is selected this callback will
be called before auto reconnect processing is invoked to allow the user to
perform any pre auto reconnect actions.
getter/setter pairinherited
-
onAutoReconnected
↔ AutoReconnectCompleteCallback?
-
Auto reconnected callback, if auto reconnect is selected this callback will
be called after auto reconnect processing is completed to allow the user to
perform any post auto reconnect actions.
getter/setter pairinherited
-
onBadCertificate
↔ bool Function(X509Certificate certificate)?
-
Callback function to handle bad certificate. if true, ignore the error.
getter/setter pair
-
onConnected
↔ ConnectCallback?
-
Client connect callback, called on successful connect
getter/setter pairinherited
-
onDisconnected
↔ DisconnectCallback?
-
Client disconnect callback, called on unsolicited disconnect.
This will not be called even if set if [autoReconnect} is set,instead
AutoReconnectCallback will be called.
getter/setter pairinherited
-
onFailedConnectionAttempt
↔ FailedConnectionAttemptCallback?
-
Failed Connection attempt callback.
Called on every failed connection attempt, if maxConnectionAttempts is
set to 5 say this will be called 5 times if the connection fails,
one for every failed attempt. Note this is never called
if autoReconnect is set, also the NoConnectionException is not raised
if this callback is supplied.
getter/setter pairinherited
-
onSubscribed
↔ SubscribeCallback?
-
On subscribed
getter/setter pairinherited
-
onSubscribeFail
↔ SubscribeFailCallback?
-
On subscribed fail
getter/setter pairinherited
-
onUnsubscribed
↔ UnsubscribeCallback?
-
On unsubscribed
getter/setter pairinherited
-
pingCallback
↔ PingCallback?
-
The ping sent callback
getter/setter pairinherited
-
pongCallback
↔ PongCallback?
-
The ping received callback
getter/setter pairinherited
-
port
↔ int
-
Port number
getter/setter pairinherited
-
published
→ Stream<MqttPublishMessage>?
-
Published message stream. A publish message is added to this
stream on completion of the message publishing protocol for a Qos level.
Attach listeners only after connect has been called.
no setterinherited
-
publishingManager
↔ PublishingManager?
-
Handles everything to do with publication management.
getter/setter pairinherited
-
resubscribeOnAutoReconnect
↔ bool
-
Re subscribe on auto reconnect.
Auto reconnect will perform automatic re subscription of existing confirmed subscriptions
unless this is set to false.
In this case the caller must perform their own re subscriptions manually using unsubscribe,
subscribe and resubscribe as needed from the appropriate callbacks.
getter/setter pairinherited
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
secure
↔ bool
-
If set use a secure connection, note TCP only, do not use for
secure websockets(wss).
getter/setter pair
-
securityContext
↔ SecurityContext
-
The security context for secure usage
getter/setter pair
-
server
↔ String
-
Server name.
Note that a server name that is a host name must conform to the name
syntax described in RFC952
https://datatracker.ietf.org/doc/html/rfc952
getter/setter pairinherited
-
socketOptions
↔ List<RawSocketOption>
-
The client supports the setting of both integer and boolean raw socket options
as supported by the Dart IO library RawSocketOption class.
Please consult the documentation for the above class before using this.
getter/setter pair
-
subscriptionsManager
↔ SubscriptionsManager?
-
The subscriptions manager responsible for tracking subscriptions.
getter/setter pairinherited
-
updates
→ Stream<List<MqttReceivedMessage<MqttMessage>>>?
-
The stream on which all subscribed topic updates are published to
no setterinherited
-
useAlternateWebSocketImplementation
↔ bool
-
If set use the alternate websocket implementation
getter/setter pair
-
useWebSocket
↔ bool
-
If set use a websocket connection, otherwise use the default TCP one
getter/setter pair
-
no getter
-
User definable websocket headers.
This allows the specification of additional HTTP headers for setting up the connection
should a broker need specific headers.
The keys of the map are the header fields and the values are either String or List.
getter/setter pair
-
websocketProtocols
← List<String>
-
User definable websocket protocols. Use this for non default websocket
protocols only if your broker needs this. There are two defaults in
MqttWsConnection class, the multiple protocol is the default. Some brokers
will not accept a list and only expect a single protocol identifier,
in this case use the single protocol default. You can supply your own
list, or to disable this entirely set the protocols to an
empty list , i.e [].
no getterinherited
-
websocketProtocolString
↔ List<String>?
-
getter/setter pairinherited
