Reference Documentation
Get up to speed with SwimOS concepts to build streaming data applications. The concepts listed here form the basis of all SwimOS apps.
Some concepts have a corresponding cookbook with working examples. Please see the README for more information on how to run these projects.
Swim Libraries
Use SwimOS back-end and front-end components to build streaming data applications.
Web Agents
Learn about declaring, defining and utilizing Web Agents and their properties using configuration files.
Command Lanes
Remotely command Web Agents to take action, and observe the actions taken by others.
Value Lanes
Define persistent properties of Web Agents, and continuously stream real-time state changes.
Map Lanes
Define persistent collection properties of Web Agents, and consistently stream real-time updates and removes.
Join Value Lanes
Define properties for aggregating multiple value lanes and continuously stream their state changes.
Join Map Lanes
Define persistent collections of properties between multiple Web Agents, and consistently stream real-time updates.
Demand Value Lanes
Define persistent properties of Web Agents, and lazily generate events on state changes.
Demand Map Lanes
Define persistent collection properties of Web Agents, and lazily generate events on state changes.
Planes
Create vertically integrated, horizontally distributed Web Agent application bundles that can run almost anywhere.
Traits
Define and utilize 'trait' that can be used to share lanes across multiple agents.
Downlinks
Share data across Web Agents and clients through persistent, bidirectionally-streaming lane references.
Server Downlinks
Share data across Web Agents and servers through persistent, bidirectionally-streaming lane references.
Ingress Bridges
Feed data available from any network protocol into your Swim server.
HTTP Ingress Bridges
See our recommended approach to simple HTTP ingress.
Recon
Learn about the structural data model called Recon, which is used by Swim to exchange streaming messages.
WARP
The protocol for multiplexing bi-directional streams between large numbers of URIs over a single WebSocket connection