SocketIoConnector class

This class creates a connector to a Socket.io server.

Inheritance

Constructors

SocketIoConnector(String host, {Map<String, String>? authHeaders, String? namespace, bool autoConnect = true, Map moreOptions = const {}})

Properties

channels ↔ Map<String, SocketIoChannel>
All of the subscribed channel names.
getter/setter pairinherited
client → Socket
getting the client
no setteroverride
hashCode → int
The hash code for this object.
no setterinherited
options ↔ ConnectorOptions<Socket>
Connector options.
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
socket → Socket
getting socket client
no setter
socketId → String?
Get the socket ID for the connection.
no setteroverride

Methods

channel(String name) → SocketIoChannel
Get a channel instance by name.
override
connect() → void
Create a fresh Socket.io connection.
override
disconnect() → void
Disconnect Socket.io connection.
override
encryptedPrivateChannel(String channel) → Channel?
inherited
leave(String name) → void
Leave the given channel, as well as its private and presence variants.
override
leaveChannel(String name) → void
Leave the given channel.
override
listen(String channel, String event, Function callback) → SocketIoChannel
Listen for an event on a channel instance.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onConnect(dynamic handler(dynamic data)) → void
listen to on connect event
override
onConnectError(dynamic handler(dynamic data)) → void
listen to on connect error event
override
onConnecting(dynamic handler(dynamic data)) → void
listen to on connecting event
override
onConnectTimeout(dynamic handler(dynamic data)) → void
listen to on connect timeout event
override
onDisconnect(dynamic handler(dynamic data)) → void
listen to on disconnect event
override
onError(dynamic handler(dynamic data)) → void
listen to on error event
override
onReconnect(dynamic handler(dynamic data)) → void
listen to on reconnect event
override
onReconnectAttempt(dynamic handler(dynamic data)) → void
listen to on reconnect attempt event
override
onReconnectError(dynamic handler(dynamic data)) → void
listen to on reconnect error event
override
onReconnectFailed(dynamic handler(dynamic data)) → void
listen to on reconnect failed event
override
onReconnecting(dynamic handler(dynamic data)) → void
listen to on reconnecting event
override
presenceChannel(String name) → SocketIoPresenceChannel
Get a presence channel instance by name.
override
privateChannel(String name) → SocketIoPrivateChannel
Get a private channel instance by name.
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited