defold (official)
defold/extension-websocket/websocket
Functions and constants for using websockets. Supported on all platforms.
- GitHub: defold/extension-websocket — pinned to
4.2.4(released while Defold 1.13.1 was current)- Pick a release from defold/extension-websocket releases and add its Source code (zip) URL (or a packaged
.zipasset, if the library ships one) togame.projectunder[project]dependencies, then Fetch Libraries in the Defold editor. - Run
bunx @defold-typescript/cli resolveto materialize its types. - Import it under a namespace alias of your choice:
import * as websocket from "websocket"
- Pick a release from defold/extension-websocket releases and add its Source code (zip) URL (or a packaged
Functions
websocket.connect(url: string, params: table, callback: function): object
Connects to a remote address
local function websocket_callback(self, conn, data)
if data.event == websocket.EVENT_DISCONNECTED then
log("Disconnected: " .. tostring(conn))
self.connection = nil
update_gui(self)
elseif data.event == websocket.EVENT_CONNECTED then
update_gui(self)
log("Connected: " .. tostring(conn))
elseif data.event == websocket.EVENT_ERROR then
log("Error: '" .. data.message .. "'")
elseif data.event == websocket.EVENT_MESSAGE then
log("Receiving: '" .. tostring(data.message) .. "'")
end
end
function init(self)
self.url = "ws://echo.websocket.events"
local params = {
timeout = 3000,
headers = "Sec-WebSocket-Protocol: chat\r\nOrigin: mydomain.com\r\n"
}
self.connection = websocket.connect(self.url, params, websocket_callback)
end
function finalize(self)
if self.connection ~= nil then
websocket.disconnect(self.connection)
end
endParameters
url:string— url of the remote connectionparams:table— optional parameters as properties. The following parameters can be settimeout:number— Timeout for the connection sequence (milliseconds). Not used on HTML5. (Default is 3000)protocol:string— the protocol to use (e.g. 'chat'). If not set, noSec-WebSocket-Protocolheader is sent.headers:string— list of http headers. Each pair is separated with "\r\n". Not used on HTML5.
callback:function— callback that receives all messages from the connectionself:object— The script instance that was used to register the callbackconnection:object— the connectiondata:table— the event payloadevent:number— The current event. One of the followingwebsocket.EVENT_CONNECTEDwebsocket.EVENT_DISCONNECTEDwebsocket.EVENT_ERRORwebsocket.EVENT_MESSAGE
message:string— The received data if event iswebsocket.EVENT_MESSAGE. Error message otherwisehandshake_response:table— Handshake response information (status, headers etc)code:number— Status code received from the server if the server closed the connection. Only present if event isEVENT_DISCONNECTED.
Returns
connection:object— the connection
websocket.disconnect(connection: object)
Explicitly close a websocket
Parameters
connection:object— the websocket connection
websocket.send(connection: object, message: string, options: table)
Send data on a websocket
local function websocket_callback(self, conn, data)
if data.event == websocket.EVENT_CONNECTED then
websocket.send(conn, "Hello from the other side")
end
end
function init(self)
self.url = "ws://echo.websocket.org"
local params = {}
self.connection = websocket.connect(self.url, params, websocket_callback)
endParameters
connection:object— the websocket connectionmessage:string— the message to sendoptions:table— options for this particular message. May beniltype:number— The data type of the messagewebsocket.DATA_TYPE_BINARY(default)websocket.DATA_TYPE_TEXT
Constants
websocket.EVENT_CONNECTED
The websocket was connected
websocket.EVENT_DISCONNECTED
The websocket disconnected
websocket.EVENT_MESSAGE
The websocket received data
websocket.EVENT_ERROR
The websocket encountered an error