Socket class

An abstraction on top of WebSockets to provide the fastest possible connection for peers.

Inheritance

Constructors

Socket(bool secure, String host, int port, String path, String key, {String clientType = 'websocket', int pingInterval = 5000})

Properties

clientType → String
final
hashCode → int
The hash code for this object.
no setterinherited
listeners → Set<EventListener>
List of all listeners active in the emitter.
finalinherited
pingInterval → int
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
socketio ↔ Socket?
getter/setter pair

Methods

addEventListener<T>(EventListener<T> listener) → bool
Adds a listener to the emitter. When an event is emitted, the listeners added will be matched.
inherited
close() → void
emit<T>(String type, [T? data]) → bool
Emit a event with a specific event type and data type. This will broadcast the message to all listeners that match the same event type and data type.
inherited
emitEvent<T extends Event>(T event) → bool
Emits an event to all listeners. This will broadcast the event to all listeners that match the same event type and data type.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
off<T>({String? type, EventCallback<T>? callback}) → bool
Remove an attached listener, by event type, data type and callback...
inherited
on<T>(String? type, EventCallback<T> callback) → EventListener<T>
Attach a listener to an emitter. Calls the callback whenever there's a new event of the specified event type and data type.
inherited
onAny<T>(EventCallback<T> callback) → EventListener<T>
Same as on but without a type.
inherited
once<T>(String? type, [EventCallback<T>? callback]) → Future<T>
Same as on but with a callback that is only called once.
inherited
removeEventListener<T>(EventListener<T> listener) → bool
Removes a listener from the emitter.
inherited
send(Map<String, dynamic> data) → void
start(String? id, String token) → Future<void>
toString() → String
A string representation of this object.
inherited

Operators

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