WebStreamClientState

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

Name	Value	Description
Connecting	0	The client has sent a request to connect with the server and is waiting for a response.
Open	1	The client is connected to the server, allowing for data to be streamed between the server and client.
Error	2	An unrecoverable error has occured while setting up the connection orduring the connection lifetime, cutting off the stream.
Closed	3	The connection has run to completion without issues, either closed naturally by the server or manually by the user.

Connecting

The client has sent a request to connect with the server and is waiting for a response.

Field	Value
value	0

Open

The client is connected to the server, allowing for data to be streamed between the server and client.

Field	Value
value	1

Error

An unrecoverable error has occured while setting up the connection orduring the connection lifetime, cutting off the stream.

Field	Value
value	2

Closed

The connection has run to completion without issues, either closed naturally by the server or manually by the user.

Field	Value
value	3