# ygjh/airshit architecture

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

- Interactive diagram: https://gitdiagram.com/ygjh/airshit
- Repository: https://github.com/ygjh/airshit

## Overview

##### Project Type and Purpose
- Project type: Desktop P2P LAN file-transfer tool (Java Swing GUI + networking).
- Purpose: Discover peers via UDP multicast, then perform direct TCP file transfers (single/multi-file or folder) with chunking and parallel threads.

##### File Structure
- Top-level artifacts:
– pom.xml / dependency-reduced-pom.xml: Maven build and packaging
– src/main/java/AirShit: Contains all application code, organized by layers
- Key packages in src/main/java/AirShit:
– ui/          ← Swing panels, dialogs, renderers
– (root)       ← Main.java, Client.java, TransferCallback.java
– Network Layer← FileReceiver.java, FileSender.java, ReceiverOptimized.java, SendFileOptimized.java
– File Processing← TarCompressor.java, TarExtractor.java, ChunkInfo.java
– Utilities    ← FolderSelector.java, GenerateTestFolder.java, NoFileSelectedException.java

##### README Insights
- Four logical layers are described:
1) GUI Layer (Swing + small JavaFX adapter)
2) Network Layer (UDP multicast discovery + TCP P2P transfer)
3) File Processing Layer (TAR compression, chunking, parallel threads)
4) Utilities Layer (file selectors, test data gen)
- Main features: automatic discovery, heartbeat, chunked multi-thread transfer, progress callbacks.

##### Defining the Main Components (to be shown
A. GUI Layer
– Entry point: Main.java
– SendFileGUI + panels under ui/: ClientPanel (peer list), FileSelectionPanel, SendControlPanel, ReceiveProgressPanel, LogPanel
– FXFileChooserAdapter for native file chooser integration
B. Network Layer
– Discovery service (Client.java): uses UDP Multicast on 239.255.42.99:50000 for HELLO/HEARTBEAT
– Transfer service:
- FileSender / SendFileOptimized: establishes TCP sockets to chosen peer, orchestrates chunked send
- FileReceiver / ReceiverOptimized: TCP server socket, receives metadata, chunks, and reconstructs file
– TransferCallback: interface for reporting progress & status back to GUI
C. File Processing Layer
– TarCompressor / TarExtractor: package/unpackage multi-file folder payloads
– ChunkInfo: metadata about file chunks (offset, size)
D. Utilities Layer
– FolderSelector: GUI wrapper for folder selection
– GenerateTestFolder: utility to create dummy payloads
– NoFileSelectedException: validation

E. External Dependencies / Systems
– Local LAN: handles UDP multicast and TCP connectivity
– File system: read/write source/destination files

##### Relationships & Data Flows
- At startup (Main → Client): GUI subscribes to Client’s peer-discovery events → displays in ClientPanel
- User selects file/folder (FileSelectionPanel → FolderSelector / FileChooserDialog)
- User clicks “Send” (SendControlPanel → triggers SendFileOptimized)
– SendFileOptimized uses TarCompressor (if folder) → divides into ChunkInfo objects → spins up multiple FileSender threads (based on CPU cores) → streams chunks over TCP → TransferCallback updates ReceiveProgressPanel & LogPanel
- On receiver side: Client automatically spawns FileReceiver threads → writes chunks to disk via TarExtractor (if needed) → acknowledges segments → UI progress updated via TransferCallback

##### Architectural Patterns & Design Principles
- Layered architecture (GUI ↔ Network ↔ Processing ↔ Utilities)
- Event-driven callbacks (TransferCallback) for decoupling network logic from UI
- Strategy for file chunking and thread-pool parallelism (scalable throughput)
- Use of UDP multicast for decentralized peer discovery (no central server)
- Modular packaging (separate Java packages for each layer)

##### Essential Elements
- Precise component names (e.g., SendFileOptimized, TarCompressor, Client)
- External systems and protocols clearly annotated (LAN, UDP multicast address, TCP ports)
- Event-driven interactions (heartbeats, callbacks)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Subgraphs for layers
    subgraph "GUI Layer"
        direction TB
        Main["Main"]:::gui
        SendFileGUI["SendFileGUI"]:::gui
        ClientPanel["ClientPanel"]:::gui
        FileSelectionPanel["FileSelectionPanel"]:::gui
        SendControlPanel["SendControlPanel"]:::gui
        ReceiveProgressPanel["ReceiveProgressPanel"]:::gui
        LogPanel["LogPanel"]:::gui
        ClientCellRenderer["ClientCellRenderer"]:::gui
        FXFileChooserAdapter["FXFileChooserAdapter"]:::gui
        FileChooserDialog["FileChooserDialog"]:::gui
    end

    subgraph "Network Layer"
        direction TB
        Client["Client"]:::net
        FileSender["FileSender (N threads)"]:::net
        SendFileOptimized["SendFileOptimized"]:::net
        FileReceiver["FileReceiver"]:::net
        ReceiverOptimized["ReceiverOptimized"]:::net
        TransferCallback["TransferCallback"]:::net
    end

    subgraph "File Processing Layer"
        direction TB
        TarCompressor["TarCompressor"]:::proc
        TarExtractor["TarExtractor"]:::proc
        ChunkInfo["ChunkInfo"]:::proc
    end

    subgraph "Utilities Layer"
        direction TB
        FolderSelector["FolderSelector"]:::util
        GenerateTestFolder["GenerateTestFolder"]:::util
        NoFileSelectedException["NoFileSelectedException"]:::util
    end

    subgraph "External Systems"
        direction TB
        LAN["Local LAN\n(239.255.42.99:50000 UDP)"]:::ext
        FileSystem["File System"]:::ext
        Resources["CSS & Icons"]:::ext
    end

    %% Connections GUI to Network
    Main -->|"starts"| Client
    Client -->|"peer discovery\nHELLO/HEARTBEAT (UDP)"| LAN
    LAN -->|"peers discovered"| Client
    Client -->|updates| ClientPanel
    ClientPanel -->|renders using| ClientCellRenderer

    FileSelectionPanel -->|"select folder"| FolderSelector
    FileSelectionPanel -->|"open dialog"| FXFileChooserAdapter
    FXFileChooserAdapter -->|"shows"| FileChooserDialog

    SendControlPanel -->|"trigger send"| SendFileOptimized
    SendFileOptimized -->|"uses"| TarCompressor
    TarCompressor -->|"creates chunks\nChunkInfo objects"| ChunkInfo
    SendFileOptimized -->|"spawns threads"| FileSender
    FileSender -->|"sendChunk() over TCP"| FileReceiver
    FileReceiver -->|"writes chunks"| TarExtractor
    TarExtractor -->|"reconstructs files"| FileSystem

    %% Callbacks to GUI
    FileSender ---|"onProgress() callback"| TransferCallback
    FileReceiver ---|"onProgress() callback"| TransferCallback
    TransferCallback ---|"update UI"| ReceiveProgressPanel
    TransferCallback ---|"log events"| LogPanel

    %% ReceiverOptimized handles optimized paths
    ReceiverOptimized -->|"alternative receiver"| FileReceiver
    SendFileOptimized -->|"alternative sender"| ReceiverOptimized

    %% Utilities
    GenerateTestFolder -->|"creates dummy data"| FileSystem
    NoFileSelectedException -.->|"exception"| FileSelectionPanel

    %% External resources
    Resources -->|provides| SendFileGUI

    %% Click events
    click Main "https://github.com/ygjh/airshit/blob/master/src/main/java/AirShit/Main.java"
    click SendFileGUI "https://github.com/ygjh/airshit/blob/master/src/main/java/AirShit/SendFileGUI.java"
    click ClientPanel "https://github.com/ygjh/airshit/blob/master/src/main/java/AirShit/ui/ClientPanel.java"
    click FileSelectionPanel "https://github.com/ygjh/airshit/blob/master/src/main/java/AirShit/ui/FileSelectionPanel.java"
    click SendControlPanel "https://github.com/ygjh/airshit/blob/master/src/main/java/AirShit/ui/SendControlPanel.java"
    click ReceiveProgressPanel "https://github.com/ygjh/airshit/blob/master/src/main/java/AirShit/ui/ReceiveProgressPanel.java"
    click LogPanel "https://github.com/ygjh/airshit/blob/master/src/main/java/AirShit/ui/LogPanel.java"
    click ClientCellRenderer "https://github.com/ygjh/airshit/blob/master/src/main/java/AirShit/ui/ClientCellRenderer.java"
    click FXFileChooserAdapter "https://github.com/ygjh/airshit/blob/master/src/main/java/AirShit/ui/FXFileChooserAdapter.java"
    click FileChooserDialog "https://github.com/ygjh/airshit/blob/master/src/main/java/AirShit/ui/FileChooserDialog.java"
    click Client "https://github.com/ygjh/airshit/blob/master/src/main/java/AirShit/Client.java"
    click FileSender "https://github.com/ygjh/airshit/blob/master/src/main/java/AirShit/FileSender.java"
    click SendFileOptimized "https://github.com/ygjh/airshit/blob/master/src/main/java/AirShit/SendFileOptimized.java"
    click FileReceiver "https://github.com/ygjh/airshit/blob/master/src/main/java/AirShit/FileReceiver.java"
    click ReceiverOptimized "https://github.com/ygjh/airshit/blob/master/src/main/java/AirShit/ReceiverOptimized.java"
    click TransferCallback "https://github.com/ygjh/airshit/blob/master/src/main/java/AirShit/TransferCallback.java"
    click TarCompressor "https://github.com/ygjh/airshit/blob/master/src/main/java/AirShit/TarCompressor.java"
    click TarExtractor "https://github.com/ygjh/airshit/blob/master/src/main/java/AirShit/TarExtractor.java"
    click ChunkInfo "https://github.com/ygjh/airshit/blob/master/src/main/java/AirShit/ChunkInfo.java"
    click FolderSelector "https://github.com/ygjh/airshit/blob/master/src/main/java/AirShit/FolderSelector.java"
    click GenerateTestFolder "https://github.com/ygjh/airshit/blob/master/src/main/java/AirShit/GenerateTestFolder.java"
    click NoFileSelectedException "https://github.com/ygjh/airshit/blob/master/src/main/java/AirShit/NoFileSelectedException.java"

    %% Styles
    classDef gui fill:#ADD8E6,stroke:#000
    classDef net fill:#90EE90,stroke:#000
    classDef proc fill:#FFA500,stroke:#000
    classDef util fill:#D3D3D3,stroke:#000
    classDef ext fill:#FFFFE0,stroke:#000
```
