From 27592a92ad662ee5be2dfd4e11b066788e18dcfb Mon Sep 17 00:00:00 2001 From: Mark Fields Date: Wed, 30 Mar 2022 12:50:17 -0700 Subject: [PATCH] Existing names/meanings for #9677 discussion --- .../loader/container-loader/src/naming.md | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 packages/loader/container-loader/src/naming.md diff --git a/packages/loader/container-loader/src/naming.md b/packages/loader/container-loader/src/naming.md new file mode 100644 index 000000000000..6c6f4407830f --- /dev/null +++ b/packages/loader/container-loader/src/naming.md @@ -0,0 +1,28 @@ +* `IContainer` (public): + * `connectionState: ConnectionState` + * `Disconnected`: no socket connection to delta server + * `Connecting`: socket connection established but we're not caught up + * Unable to send outbound messages + * Maybe inbound is still paused too, depends on `IContainerLoadMode.opsBeforeReturn` + * `Connected`: connected and caught up + * Not quite true for Read connection, see PR #9377 + * ClientId may not yet be in audience, see Issue #7275 + * Inbound/Outbound are operational (...is there a possible race condition if `IContainerLoadMode.opsBeforeReturn === undefined`?) + * `connected: boolean` + * `connectionState === ConnectionState.Connected` + * `resume()` + * Calls `DeltaManager.connect` + * `setAutoReconnect(reconnect: boolean)` + * If false, will disconnect from delta stream. If true, will probably connect to delta stream + * events emitted: + * `connected`: when transitioned to Connected state + * `disconnected`: when transitioned to Disconnected state +* `IDeltaManager` (public): + * `active: boolean` + * Indicates `Container.connectionState === Connected` and mode is write + * events emitted + * `connect`: when socket is established. Triggers Container transition to `Connecting` state + * `disconnect`: when socket is disconnected. Triggers Container transition to `Disconnected` state +* `DeltaManager` class (private) + * `connect` + * Connect to delta stream