Socket
Related Docs:
object Socket
| package socketio
A reference to the underlying Client object.
A reference to the underlying Client object.
the Client object.
Sets a modifier for a subsequent event emission that the event data will only be compressed if the value is true.
Sets a modifier for a subsequent event emission that the event data will only be compressed if the value is true. Defaults to true when you don't call the method.
A reference to the underlying Client transport connection (engine.io Socket object).
A reference to the underlying Client transport connection (engine.io Socket object). This allows access to the IO transport layer, which still (mostly) abstracts the actual TCP/IP socket.
the underlying Client transport connection
Disconnects this client.
Disconnects this client.
If value of close is true, closes the underlying connection. Otherwise, it just disconnects the namespace.
Emits an event identified by the string name to the client.
Emits an event identified by the string name to the client. Any other parameters can be included. All data structures are supported, including Buffer. JavaScript functions can't be serialized/deserialized.
the event name
the event arguments
A unique identifier for the session, that comes from the underlying Client.
A unique identifier for the session, that comes from the underlying Client.
the unique identifier
Same as Socket.to()
Adds the client to the room, and fires optionally a callback fn with err signature (if any).
Adds the client to the room, and fires optionally a callback fn with err signature (if any). The client is automatically a member of a room identified with its session id (see Socket#id). The mechanics of joining rooms are handled by the Adapter that has been configured (see Server#adapter above), defaulting to socket.io-adapter.
Removes the client from room, and fires optionally a callback fn with err signature (if any).
A getter proxy that returns the reference to the request that originated the underlying engine.io Client.
A getter proxy that returns the reference to the request that originated the underlying engine.io Client. Useful for accessing request headers such as Cookie or User-Agent.
A hash of strings identifying the rooms this client is in, indexed by room name.
A hash of strings identifying the rooms this client is in, indexed by room name.
A hash of strings
Sets a modifier for a subsequent event emission that the event will only be broadcasted to clients that have joined the given room.
A Socket is the fundamental class for interacting with browser clients. A Socket belongs to a certain Namespace (by default /) and uses an underlying Client to communicate.
It should be noted the Socket doesn't relate directly to the actual underlying TCP/IP socket and it is only the name of the class.