Client class abstract
Constructors
- Client()
Properties
-
connected
→ Stream<
ConnectedEvent> -
no setter
-
connecting
→ Stream<
ConnectingEvent> -
no setter
-
disconnected
→ Stream<
DisconnectedEvent> -
no setter
-
error
→ Stream<
ErrorEvent> -
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
-
join
→ Stream<
ServerJoinEvent> -
no setter
-
leave
→ Stream<
ServerLeaveEvent> -
no setter
-
message
→ Stream<
MessageEvent> -
no setter
-
publication
→ Stream<
ServerPublicationEvent> -
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- state → State
-
State of client.
no setter
-
subscribed
→ Stream<
ServerSubscribedEvent> -
no setter
-
subscribing
→ Stream<
ServerSubscribingEvent> -
no setter
-
unsubscribed
→ Stream<
ServerUnsubscribedEvent> -
no setter
Methods
-
connect(
) → Future< void> - Connect to the server.
-
disconnect(
) → Future< void> - Disconnect from the server.
-
getSubscription(
String channel) → Subscription? - Get subscription to the channel.
-
history(
String channel, {int limit = 0, StreamPosition? since, bool reverse = false}) → Future< HistoryResult> - Send History command.
-
newSubscription(
String channel, [SubscriptionConfig? config]) → Subscription - Create new subscription.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
presence(
String channel) → Future< PresenceResult> - Send Presence command.
-
presenceStats(
String channel) → Future< PresenceStatsResult> - Send PresenceStats command.
-
publish(
String channel, List< int> data) → Future<PublishResult> - Publish data to the channel.
-
ready(
) → Future< void> - Ready resolves when client successfully connected. Throws exceptions if called not in connecting or connected state.
-
removeSubscription(
Subscription subscription) → Future< void> - Remove the Subscription from internal registry and unsubscribe from Subscription.channel.
-
rpc(
String method, List< int> data) → Future<RPCResult> - Send RPC command.
-
send(
List< int> data) → Future<void> -
setToken(
String token) → void - Set allows updating connection token.
-
subscriptions(
) → Map< String, Subscription> - Get map wirth all registered client-side subscriptions.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited