WebSocket.OnClose

Signal that fires when the WebSocket connection is closed.

Syntax

WebSocket.OnClose:Connect(callback: () -> ()) -> VoltConnection

Returns

Type	Description
`VoltConnection`	A connection that can be disconnected

OnClose is a VoltSignal that fires after a local Close() or a remote close. Volt may reconnect automatically after a remote close; IsClosed becomes true only when the client is closed locally.

Example

local ws = WebSocket.connect("wss://your-server.example/socket")

ws.OnClose:Connect(function()
    print("Connection closed")
end)

-- Later...
ws:Close()

Reconnection Pattern

local function createConnection()
    local ws = WebSocket.connect("wss://your-server.example/socket")

    ws.OnClose:Connect(function()
        print("Disconnected, reconnecting in 5 seconds...")
        task.wait(5)
        createConnection()
    end)

    ws.OnMessage:Connect(function(msg)
        print("Message:", msg)
    end)

    return ws
end

local connection = createConnection()

Cleanup on Close

local ws = WebSocket.connect("wss://your-server.example/socket")

ws.OnClose:Connect(function()
    print("Cleaning up...")
    -- Perform cleanup tasks
end)

-- Check connection state before sending
if not ws.IsClosed then
    ws:Send("Hello!")
end

WebSocket.connect - Create connection
WebSocket:Close - Close connection
OnMessage - Message event

WebSocket.OnClose

Syntax

Callback Parameters

Returns

Description

Example

Reconnection Pattern

Cleanup on Close

On this page