SCEvent enum

Inheritance

Constructors

SCEvent()
const

Values

connecting → const SCEvent

Emitted whenever the socket initiates a connection to the server. This includes reconnects.

ready → const SCEvent

Emitted whenever the socket connection to the server is established and the SocketCluster handshake has completed. This includes reconnects.

disconnect → const SCEvent

Emitted whenever the socket disconnects or becomes disconnected from the server. One can read the SocketClusterClient.closeCode and the SocketClusterClient.closeReason from the socket to determine the close code and reason.

close → const SCEvent

Emitted when the socket is programmatically closed with a call to SocketClusterClient.close. This is triggered right before the socket closes unlike SCEvent.disconnect which is triggered right after the close is processed.

authStateChange → const SCEvent

Emitted whenever the authentication state changes. The new authentication state may be read from SocketClusterClient.authState.

connectionStateChange → const SCEvent

Emitted whenever the connection state changes. The new connection state may be read from SocketClusterClient.state.

Properties

hashCode int
The hash code for this object.
no setterinherited
index int
A numeric identifier for the enumerated value.
no setterinherited
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<SCEvent>
A constant List of the values in this enum, in order of their declaration.