RealtimeClientOptions class
Options to pass to the RealtimeClient.
Constructors
-
RealtimeClientOptions({RealtimeLogLevel? logLevel, Duration? timeout, Duration? connectionCloseTimeout, Duration? heartbeatInterval, TimerCalculation? reconnectAfter, WebSocketTransport? transport, Duration? disconnectOnEmptyChannelsAfter, RealtimeEncode? encode, RealtimeDecode? decode, Stream<
bool> ? networkReachability}) -
const
Properties
- connectionCloseTimeout → Duration?
-
The timeout to wait for the connection to close before dismissing the
result.
final
- decode → RealtimeDecode?
-
Deserializes incoming frames, for example on a background isolate.
final
- disconnectOnEmptyChannelsAfter → Duration?
-
The delay before the socket is disconnected once the last channel is
removed.
final
- encode → RealtimeEncode?
-
Serializes outgoing messages, for example on a background isolate so
that a large payload does not block the event loop.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- heartbeatInterval → Duration?
-
The interval at which to send a heartbeat message.
final
- logLevel → RealtimeLogLevel?
-
Level of realtime server logs to be logged
final
-
networkReachability
→ Stream<
bool> ? -
Reports from a platform network monitor whether the device can reach
the network, starting with the current state.
final
- reconnectAfter → TimerCalculation?
-
Returns the socket reconnect delay per attempt, starting at attempt 1.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- timeout → Duration?
-
the timeout to trigger push timeouts
final
- transport → WebSocketTransport?
-
Custom WebSocket transport factory for the RealtimeClient.
final
Methods
-
copyWith(
{RealtimeLogLevel? logLevel, Duration? timeout, Duration? connectionCloseTimeout, Duration? heartbeatInterval, TimerCalculation? reconnectAfter, WebSocketTransport? transport, Duration? disconnectOnEmptyChannelsAfter, RealtimeEncode? encode, RealtimeDecode? decode, Stream< bool> ? networkReachability}) → RealtimeClientOptions - Returns a copy with the given fields replaced.
-
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