# tomargunjan/cs553-distributedalgorithms architecture

> Architecture diagram of the GitHub repository tomargunjan/cs553-distributedalgorithms, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/tomargunjan/cs553-distributedalgorithms
- Repository: https://github.com/tomargunjan/cs553-distributedalgorithms

## Overview

##### 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)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% CLI & Configuration Layer
    subgraph "CLI & Configuration Layer"
        Main["Main (CLI Launcher)"]:::cli
        AppProps["ApplicationProperties"]:::utility
        AppConf["application.conf"]:::resource
    end

    Main -->|reads| AppProps
    AppProps -->|loads| AppConf

    %% Resource Layer
    subgraph "Resource Layer"
        TopologyReader["TopologyReader"]:::utility
        GraphFiles[".dot Files"]:::resource
    end

    TopologyReader -->|parses| GraphFiles

    %% Algorithm Orchestration Layer
    subgraph "Algorithm Orchestration Layer"
        EchoAlg["EchoAlgorithm"]:::algorithm
        TarryAlg["TarrysAlgorithm"]:::algorithm
        TreeAlg["TreeAlgorithm"]:::algorithm
        ChangRobertsAlg["ChangRobertsAlgorithm"]:::algorithm
        FranklinAlg["FranklinAlgorithm"]:::algorithm
        LaiYangAlg["LaiYangAlgorithm"]:::algorithm
        ChandyLamportAlg["ChandyLamportAlgorithm"]:::algorithm
        BrachaTouegAlg["BrachaTouegAlgorithm"]:::algorithm
    end

    Main -->|selects| EchoAlg
    Main -->|selects| TarryAlg
    Main -->|selects| TreeAlg
    Main -->|selects| ChangRobertsAlg
    Main -->|selects| FranklinAlg
    Main -->|selects| LaiYangAlg
    Main -->|selects| ChandyLamportAlg
    Main -->|selects| BrachaTouegAlg

    AppProps -->|provides config| EchoAlg
    AppProps -->|provides config| TarryAlg
    AppProps -->|provides config| TreeAlg
    AppProps -->|provides config| ChangRobertsAlg
    AppProps -->|provides config| FranklinAlg
    AppProps -->|provides config| LaiYangAlg
    AppProps -->|provides config| ChandyLamportAlg
    AppProps -->|provides config| BrachaTouegAlg

    EchoAlg -->|uses| TopologyReader
    TarryAlg -->|uses| TopologyReader
    TreeAlg -->|uses| TopologyReader
    ChangRobertsAlg -->|uses| TopologyReader
    FranklinAlg -->|uses| TopologyReader
    LaiYangAlg -->|uses| TopologyReader
    ChandyLamportAlg -->|uses| TopologyReader
    BrachaTouegAlg -->|uses| TopologyReader

    %% Execution Layer
    subgraph "Execution Layer"
        ActorSystem["ActorSystem"]:::execution
        EchoProc["EchoProcess Actor"]:::execution
        TarryProc["TarryProcess Actor"]:::execution
        TreeProc["TreeProcess Actor"]:::execution
        ChangRobertsProc["ChangRobertsProcess Actor"]:::execution
        FranklinProc["FranklinProcess Actor"]:::execution
        LaiYangProc["LaiYangProcess Actor"]:::execution
        ChandyLamportProc["ChandyLamportProcess Actor"]:::execution
        BrachaTouegProc["BrachaTouegProcess Actor"]:::execution
        Terminator["Terminator"]:::utility
        SnapshotUtils["SnapshotUtils"]:::utility
        FranklinOrch["FranklinOrchestrator"]:::utility
        MsgTypes["MessageTypes"]:::utility
        ProcessRecord["ProcessRecord"]:::utility
    end

    EchoAlg -->|bootstraps| ActorSystem
    TarryAlg -->|bootstraps| ActorSystem
    TreeAlg -->|bootstraps| ActorSystem
    ChangRobertsAlg -->|bootstraps| ActorSystem
    FranklinAlg -->|bootstraps| ActorSystem
    LaiYangAlg -->|bootstraps| ActorSystem
    ChandyLamportAlg -->|bootstraps| ActorSystem
    BrachaTouegAlg -->|bootstraps| ActorSystem

    ActorSystem --> EchoProc
    ActorSystem --> TarryProc
    ActorSystem --> TreeProc
    ActorSystem --> ChangRobertsProc
    ActorSystem --> FranklinProc
    ActorSystem --> LaiYangProc
    ActorSystem --> ChandyLamportProc
    ActorSystem --> BrachaTouegProc

    ActorSystem --> Terminator
    ActorSystem --> SnapshotUtils
    ActorSystem --> FranklinOrch
    ActorSystem --> MsgTypes
    ActorSystem --> ProcessRecord

    %% Actor Interactions (broad representation)
    EchoProc <--> TarryProc
    TarryProc <--> TreeProc
    TreeProc <--> ChangRobertsProc
    ChangRobertsProc <--> FranklinProc
    FranklinProc <--> LaiYangProc
    LaiYangProc <--> ChandyLamportProc
    ChandyLamportProc <--> BrachaTouegProc

    EchoProc -->|sends state| SnapshotUtils
    AllProcs-->|notify| Terminator
    FranklinOrch -->|coordinates| FranklinProc

    %% Logging Component
    Logger["SLF4J Logger"]:::external
    ActorSystem -->|logs events| Logger

    %% Test Suite
    subgraph "Test Suite"
        EchoTest["EchoTest"]:::test
        TarryTest["TarryTest"]:::test
        TreeTest["TreeTest"]:::test
        ChangLamportTest["ChandyLamportTest"]:::test
        FranklinTest["FranklinTest"]:::test
        LaiYangTest["LaiYangTest"]:::test
        BrachaTouegTest["BrachaTouegTest"]:::test
    end

    EchoTest -->|invokes| Main
    TarryTest -->|invokes| Main
    TreeTest -->|invokes| Main
    ChangLamportTest -->|invokes| Main
    FranklinTest -->|invokes| Main
    LaiYangTest -->|invokes| Main
    BrachaTouegTest -->|invokes| Main

    %% Click Events
    click Main "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/Main.scala"
    click AppProps "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/utility/ApplicationProperties.scala"
    click AppConf "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/resources/application.conf"
    click TopologyReader "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/utility/TopologyReader.scala"
    click GraphFiles "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/resources/*.dot"
    click EchoAlg "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/algorithms/EchoAlgorithm.scala"
    click TarryAlg "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/algorithms/TarrysAlgorithm.scala"
    click TreeAlg "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/algorithms/TreeAlgorithm.scala"
    click ChangRobertsAlg "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/algorithms/ChangRobertsAlgorithm.scala"
    click FranklinAlg "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/algorithms/FranklinAlgorithm.scala"
    click LaiYangAlg "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/algorithms/LaiYangAlgorithm.scala"
    click ChandyLamportAlg "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/algorithms/ChandyLamportAlgorithm.scala"
    click BrachaTouegAlg "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/algorithms/BrachaTouegAlgorithm.scala"
    click EchoProc "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/processes/EchoProcess.scala"
    click TarryProc "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/processes/TarryProcess.scala"
    click TreeProc "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/processes/TreeProcess.scala"
    click ChangRobertsProc "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/processes/ChangRobertsProcess.scala"
    click FranklinProc "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/processes/FranklinProcess.scala"
    click LaiYangProc "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/processes/LaiYangProcess.scala"
    click ChandyLamportProc "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/processes/ChandyLamportProcess.scala"
    click BrachaTouegProc "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/processes/BrachaTouegProcess.scala"
    click Terminator "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/utility/Terminator.scala"
    click SnapshotUtils "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/utility/SnapshotUtils.scala"
    click FranklinOrch "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/utility/FranklinOrchestrator.scala"
    click MsgTypes "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/utility/MessageTypes.scala"
    click ProcessRecord "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/main/scala/main/utility/ProcessRecord.scala"
    click EchoTest "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/test/scala/EchoTest.scala"
    click TarryTest "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/test/scala/TarryTest.scala"
    click TreeTest "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/test/scala/TreeTest.scala"
    click ChangLamportTest "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/test/scala/chandyLamportTest.scala"
    click FranklinTest "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/test/scala/franklinTest.scala"
    click LaiYangTest "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/test/scala/laiYangTest.scala"
    click BrachaTouegTest "https://github.com/tomargunjan/cs553-distributedalgorithms/blob/master/src/test/scala/brachaTouegTest.scala"

    %% Styles
    classDef cli fill:#AED6F1,stroke:#1B4F72;
    classDef resource fill:#ABEBC6,stroke:#186A3B;
    classDef algorithm fill:#F9E79F,stroke:#B9770E;
    classDef execution fill:#F5B7B1,stroke:#78281F;
    classDef utility fill:#D5D8DC,stroke:#566573;
    classDef external fill:#F1948A,stroke:#C0392B;
    classDef test fill:#A3E4D7,stroke:#117A65;
```
