Skip to content

Document production WebSocket reconnection, buffering and compression - #5

Merged
Lyptik merged 1 commit into
mainfrom
docs/websocket-production-practices
Oct 6, 2026
Merged

Lyptik merged 1 commit into
mainfrom
docs/websocket-production-practices

Conversation

@Lyptik

@Lyptik Lyptik commented Oct 5, 2026

Copy link
Copy Markdown
Contributor

Changes

Document recommended production integration practices in the SDK README:

  • compression should be an explicit application choice and is recommended when a Zstd decompressor is available
  • reconnect as a fresh Augmenta session and expect setup/state refresh
  • clear stale application-side pending frames across reconnect/setup replacement
  • ignore callbacks from superseded sockets
  • never use an unbounded FIFO of complete tracking frames
  • for render clients, use bounded latest-state-wins buffering per scene
  • preserve transient events separately when frame conflation could otherwise drop them
  • point developers to the Augmenta ThreeJS example as the browser reference implementation

The SDK remains transport/runtime neutral and does not impose a render buffering policy itself.

@Lyptik
Lyptik marked this pull request as ready for review October 6, 2026 06:36
@Lyptik
Lyptik merged commit 828e4b9 into main Oct 6, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant