How tomargunjan/cs553-distributedalgorithms works
Project type and purpose
• This is a Scala‐based, Akka‐powered simulation framework for teaching and experimenting with distributed algorithms (snapshot, wave, deadlock detection, election).
• It is a console/CLI application that reads graph topologies (DOT files), instantiates an ActorSystem, and executes one of eight algorithms, logging progress via SLF4J.
File structure
• Top level: build.sbt, project files, README → standard Scala/SBT project.
• src/main/scala/main/Main.scala → entry point & CLI menu.
• packages under main/scala/main:
– algorithms: “trigger” classes that read input, instantiate Actors, start the algorithm.
– processes: individual Actor implementations encapsulating per‐node behavior.
– utility: shared components (configuration reader, message types, orchestrators, snapshot utilities, terminator, topology reader).
• src/main/resources: application.conf + several .dot graph files → static test data & settings.
• src/test: unit tests per algorithm.
README for additional insights
• Confirms modularization: Main → algorithms package → processes package → utility package → resources.
• Highlights use of NetGameSim‐generated graphs and custom topologies.
• Describes the role of each utility class (TopologyReader builds neighbor lists, Terminator shuts down the system, FranklinOrchestrator sequences election rounds, SnapshotUtils gathers snapshot state).
Elements
• Clear labels: name each component (e.g., “TopologyReader”, “EchoAlgorithm”, “EchoProcess Actor”).
– from Main to Algorithm Trigger
– from Trigger to TopologyReader & ActorSystem
– from Processes to Utility Actors (snapshot, terminator)
– Rectangles for modules/packages (CLI, algorithms, processes, utilities)