RealtimeConnectionState enum
Represents the current lifecycle state of a RealtimeClient connection.
Values
- disconnected → const RealtimeConnectionState
-
No active connection to the server.
- connecting → const RealtimeConnectionState
-
In the process of opening the socket and completing protocol handshakes.
- connected → const RealtimeConnectionState
-
Connection established and ready to send and receive messages.
- reconnecting → const RealtimeConnectionState
-
Temporarily disconnected; attempting to reconnect according to the reconnection policy.
- disconnecting → const RealtimeConnectionState
-
Gracefully terminating the active connection.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- index → int
-
A numeric identifier for the enumerated value.
no setterinherited
- isConnected → bool
-
Whether the client is currently connected and able to communicate.
no setter
- isConnecting → bool
-
Whether the client is currently in an initial connection attempt.
no setter
- isDisconnected → bool
-
Whether the client is fully disconnected.
no setter
- isDisconnecting → bool
-
Whether the client is in the middle of a graceful disconnect.
no setter
- isPending → bool
-
Whether the client is either connecting or reconnecting.
no setter
- isReconnecting → bool
-
Whether the client is currently attempting to reconnect after a connection drop.
no setter
- name → String
-
Available on Enum, provided by the EnumName extension
The name of the enum value.no setter - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
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
Constants
-
values
→ const List<
RealtimeConnectionState> - A constant List of the values in this enum, in order of their declaration.