Stream Connector Spec¶
Stream connector is a client package that runs in a browser and game engine. Since it differs from the Framework host in deployment unit, execution environment, and dependency, it's distributed as a separate package. Wire and session behavior follows the Framework common contract.
| Document | Scope |
|---|---|
| 32 Stream Connector | Defines the execution environment, transport, wire, lifecycle, and deployment deliverable the Framework guarantees. |
This directory doesn't define the server-side public interface. The server session a connector connects to is owned by server/30 STREAM Server Session and server/31 Session Actor Dispatch.
Per-Language Public API¶
| Language | Document |
|---|---|
| C++ | 03 Stream Connector defines the exact public interface of plain C++, Unreal, Godot, and Cocos/Axmol. |
.NET |
03 Stream Connector defines the exact public interface of .NET, Unity, and Godot. |
| Java | 03 Stream Connector defines Java's exact public interface. |
| TypeScript | languages/typescript defines the browser connector's exact public interface. |
The browser connector and Node.js Framework are different packages. The browser connector isn't a public interface of the Node.js host (00 §4).
Usage Guide¶
This tree only owns the contract. For usage, check the per-language guide: C++, .NET, Java, Kotlin, Node.js/TypeScript.