docs » hs.websocket

Creates a new websocket connection.

• url - The URL to the websocket
• callback - A function that's triggered by websocket actions.

• The hs.websocket object

• The callback should accept two parameters.
• The first parameter is a string with the following possible options:
  • open - The websocket connection has been opened
  • closed - The websocket connection has been closed
  • fail - The websocket connection has failed
  • received - The websocket has received a message
  • pong - A pong request has been received
• The second parameter is a string with the received message or an error message.
• Given a path '/mysock' and a port of 8000, the websocket URL is as follows:
  • ws://localhost:8000/mysock
  • wss://localhost:8000/mysock (if SSL enabled)

Closes a websocket connection.

• None

• The hs.websocket object

Sends a message to the websocket client.

• message - A string containing the message to send.
• isData - An optional boolean that sends the message as binary data (defaults to true).

• The hs.websocket object

• Forcing a text representation by setting isData to false may alter the data if it

contains invalid UTF8 character sequences (the default string behavior is to make sure everything is "printable" by converting invalid sequences into the Unicode Invalid Character sequence).

Gets the status of a websocket.

• None

• A string containing one of the following options:
• connecting
• open
• closing
• closed
• unknown