WebStreamClientState¶
WebStreamClientState indicates the current state of a WebStreamClient object.
Not implemented in Nova
This enum is missing from Nova. Scripts that reference it will fail.
Description¶
WebStreamClientState describes the lifecycle state of a
WebStreamClient connection, readable through the
WebStreamClient.ConnectionState property.
A newly created WebStreamClient begins in the Connecting state. On a
successful handshake the state advances to Open, after which messages can be
received (and sent, for WebSocket connections). The connection terminates in
either Closed (clean shutdown) or Error (unrecoverable failure). Listening
to the WebStreamClient.Opened, WebStreamClient.Closed, and
WebStreamClient.Error events is the recommended way to react to these
transitions.
Items¶
| Item | Value | Status | Notes |
|---|---|---|---|
Connecting |
0 | Not yet | The client has sent a request to connect with the server and is waiting for a response. |
Open |
1 | Not yet | The client is connected to the server, allowing for data to be streamed between the server and client. |
Error |
2 | Not yet | An unrecoverable error has occured while setting up the connection orduring the connection lifetime, cutting off the stream. |
Closed |
3 | Not yet | The connection has run to completion without issues, either closed naturally by the server or manually by the user. |
Roblox reference: WebStreamClientState