mirror of
https://github.com/aurora-opensource/xviz.git
synced 2026-01-25 14:16:45 +00:00
6a85f68a72
Proper module to replace our adhoc server script with a structured middleware-based implementation. Key documents are: - RFC ./dev-docs/004-server-module-rfc.md - User Docs ./docs/api-reference/server - Module Readme ./modules/server/README.md
14 lines
561 B
Markdown
14 lines
561 B
Markdown
# XVIZSession Interface
|
|
|
|
An object satisfying this interface is returned by an
|
|
[XVIZHandler](/docs/api-reference/server/overview-handler.md) to manage the socket and messages. The
|
|
session is responsible for for routing the socket message through the
|
|
[XVIZServerMiddlewareStack](/docs/api-reference/server/xviz-server-middleware-stack.md).
|
|
|
|
### Interface Methods
|
|
|
|
##### onConnect()
|
|
|
|
This marks the beginning of a connect that will be handled by this session. The concrete class
|
|
implementing this function should be passed all necessary state in the constructor.
|