Skip to content

Commit

Permalink
Existing names/meanings for microsoft#9677 discussion
Browse files Browse the repository at this point in the history
  • Loading branch information
markfields committed Mar 30, 2022
1 parent 1c13fc0 commit 27592a9
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions packages/loader/container-loader/src/naming.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 27592a9

Please sign in to comment.