Class TLSyncClient

packages/sync-core/src/lib/TLSyncClient.ts:365–977

 * @public
 */
export class TLSyncClient<R extends UnknownRecord, S extends Store<R> = Store<R>> {
	/** The last clock time from the most recent server update */
	private lastServerClock = -1
	private lastServerInteractionTimestamp = Date.now()

	/** The queue of in-flight push requests that have not yet been acknowledged by the server */
	private pendingPushRequests: TLPushRequest<R>[] = []
	private unsentChanges: {
		nextDiff?: RecordsDiff<R>
		nextPresence?: R | null
	} = { nextDiff: undefined, nextPresence: undefined }

	/**
	 * The diff of 'unconfirmed', 'optimistic' changes that have been made locally by the user if we
	 * take this diff, reverse it, and apply that to the store, our store will match exactly the most
	 * recent state of the server that we know about
	 */
	private speculativeChanges: RecordsDiff<R> = {
		added: {} as any,
		updated: {} as any,
		removed: {} as any,
	}

	private disposables: Array<() => void> = []

	/** Separate scheduler instance for network sync operations */
	private readonly fpsScheduler: FpsScheduler

	/** Send any unsent push requests to the server */
	private readonly sendUnsentChanges: {
		(): void
		cancel?(): void
	}

	/** Schedule a rebase operation */
	private readonly scheduleRebase: {
		(): void
		cancel?(): void
	}

	/** @internal */
	readonly store: S
	/** @internal */
	readonly socket: TLPersistentClientSocket<TLSocketClientSentEvent<R>, TLSocketServerSentEvent<R>>

	/** @internal */
	readonly presenceState: Signal<R | null> | undefined
	/** @internal */
	readonly presenceMode: Signal<TLPresenceMode> | undefined

	// isOnline is true when we have an open socket connection and we have
	// established a connection with the server room (i.e. we have received a 'connect' message)
	/** @internal */
	isConnectedToRoom = false

	/**
	 * The client clock is essentially a counter for push requests Each time a push request is created
	 * the clock is incremented. This clock is sent with the push request to the server, and the