WebSocket

WebSocket.connect

2 つの BindableEvents を作成し、指定された URL への WebSocket client WebSocket connection を開き、接続試行が完了するまで yield します。成功すると、OnMessage と OnClose events、methods から提供される Send と Close methods、connection state を持つ WebSocket table を返します。incoming message data は string として OnMessage から Fire されます。receive loop が終了すると、OnClose は arguments なしで Fire されます。接続に失敗すると、この関数は “WebSocket connection failed” で始まる error string を発生させます。

WebSocket.connect(url: string): WebSocket

エイリアス

WebSocket.Connect
websocket.connect
websocket.Connect

引数

string

必須

WebSocket client が WebSocket connection attempt を実行する前に CURLOPT_URL に渡される URL string。

戻り値

WebSocket

OnMessage、OnClose、connection state を含む WebSocket table。Send と Close は WebSocket object methods から解決されます。

例

WebSocket を開き、OnMessage と OnClose を接続し、socket methods で送信と終了を行います。

local socket = WebSocket.connect("wss://example.com/socket")

socket.OnMessage:Connect(function(message)
    print(message)
end)

socket.OnClose:Connect(function()
    print("closed")
end)

socket:Send("hello")
socket:Close()