Skip to content

Commit d97bdd9

Browse files
authored
chat: add missing connection status enum values (#2929)
We were missing Closing and Closed. [CHA-1225]
1 parent 8767ced commit d97bdd9

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

src/pages/docs/chat/connect.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ A connection can have any of the following statuses:
1616
| connected | A connection exists and is active. |
1717
| disconnected | A temporary failure condition when no current connection exists. The disconnected status is entered if an established connection is dropped, or if a connection attempt is unsuccessful. |
1818
| suspended | A long term failure condition when no current connection exists because there is no network connectivity or available host. The suspended status is entered after a failed connection attempt if there has then been no connection for a period of two minutes. In the suspended status, an SDK will periodically attempt to open a new connection every 30 seconds. Rooms will be reattached on a successful reconnection, however message history will not be automatically recovered. |
19+
| closing | An explicit request by the developer to close the connection has been sent to the Ably service. If a reply is not received from Ably within a short period of time, the connection is forcibly terminated and the connection status becomes Closed. |
20+
| closed | The connection has been explicitly closed by the client. In the closed state, no reconnection attempts are made automatically. No connection state is preserved by the service or the library. |
1921
| failed | This status is entered if the SDK encounters a failure condition that it cannot recover from. This may be a fatal connection error received from the Ably service, such as an attempt to connect with an incorrect API key, or some local terminal error, such as that the token in use has expired and the SDK does not have any way to renew it. |
2022

2123
<If lang="javascript,swift,kotlin">

0 commit comments

Comments
 (0)