Socket

Socket

Object for sending and receiving messages the raw WebSocket. It is not recommended to use this object in your code, as it is used internally.

Accessable from a Server object via Server.socket.

Constructor

new Socket(server, host)

Source:

Socket.js, line 32

Properties:

Name	Type	Description
`host`	string	The host WebSocket address. Example: `ws://localhost:5050`
`connected`	bool	Will be true if the server is connected to the WebSocket, and false otherwise.
`server`	object	The `Server` object this belongs to.
`ws`	object	The WebSocket class provided by the `ws` module. Used for actually sending and receiving messages.
`acknowledgements`	array	List of acknowledgements received from the server. Used to recognize when the server successfully processes a message.

Parameters:

Name	Type	Description
`server`	Server	The `Server` object this belongs to.
`host`	string	Websocket address. Example: `ws://localhost:5050`

Methods

disconnect()

Source:

Socket.js, line 166

Disconnects from the WebSocket.

send(type, message)

Source:

Socket.js, line 140

Sends a raw message to the WebSocket

Parameters:

Name	Type	Description
`type`	string
`message`	object

Events

disconnect

Source:

Socket.js, line 171

Fired when the WebSocket disconnects.

error

Source:

Socket.js, line 48

Used internally for when the WebSocket experiences an error.

Parameters:

Name	Type	Description
`error`	Error	The error that occured.

event

Source:

Socket.js, line 80

Used internally for when a raw event is received from the server. It isn't recommended to use this event in your code.

Parameters:

Name	Type	Description
`json`	object	The message data sent by the server.

raw

Source:

Socket.js, line 66

Fired when a WebSocket packet is received.

Parameters:

Name	Type	Description
`data`	Buffer	Raw data sent by the server.

ready

Source:

Socket.js, line 58

Fired when the connection to the server has been established.