A Java framework for running interactive simulations across a network.
The problem:
- We have a large simulation that we want to run on several machines on a network
- Commands may be sent to the simulation at any time, by any machine
- Each machine must see the exact same simulation
There are two approaches:
- Client-server: One participant runs the whole simulation and sends periodic state-updates to all clients. The server is the single-source-of-truth.
- Peer-to-peer: Every participant runs the simulation deterministicly. Interactive commands must be coordinated to ensure everyone is in-sync.
The problem with the former approach is that it scales poorly with simulation size. The problem with the latter approach is that it scales poorly with participant count. The best trade-off will be application specific.
This is a framework for the peer-to-peer approach.
- Peers report their progress to each other
- Each peer only runs
nticks ahead of the slowest peer, waiting if necessary - Actions are scheduled
>nticks ahead of the slowest peer, ensuring they are always executed at the right time
The framework takes care of all of this.
The programmer must ensure:
- The simulation is deterministic
- Actions can be encoded and decoded properly
Lockstep/contains the framework;LockstepSample/contains an example application.- Each has an Ant build file, or they can be imported into Eclipse.
- See
io.njlr.lockstep.sample.Mainfor an example of how it fits together. - Take a look at
io.njlr.lockstep.sample.tests.SyncTestsfor an example of two peers running a simulation.
- Use sliding window protocol as the reliable transport mechanism for greater throughput
- Implement channel layers e.g. for fragmenting large packets
- Add a channel-timeout mechanism
- Allow for the coordinated dropping of peers (e.g. participant crashes, quits)
- Provide automatic state hash checking e.g. by including the hash with sequence number updates
- Build a more interesting example simulation