# discord4j/connect architecture

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

- Interactive diagram: https://gitdiagram.com/discord4j/connect
- Repository: https://github.com/discord4j/connect

## Overview

##### Main Components Identification

a. Core Components:
- Common Gateway Interface (from common/ directory)
- RabbitMQ Implementation (from rabbitmq/ directory)
- RSocket Implementation (from rsocket/ directory)

b. Gateway Components:
- Upstream Gateway Client
- Downstream Gateway Client
- Payload Processing System

##### Architectural Patterns

The project follows a distributed architecture with these key patterns:
- Leader-Worker pattern (visible in examples)
- Message broker integration (RabbitMQ)
- RSocket-based communication
- Gateway routing and coordination

**Top Level:**

- Discord API   |

- ↕
**Middle Layer:**

- Gateway Interface         |
- (UpstreamGatewayClient/         |
- DownstreamGatewayClient)       |

- ↕
**Communication Layer:**

- RabbitMQ     |    RSocket     |
- Connector    |    Connector   |

- ↕
**Bottom Layer:**

- Distributed Bot Instances    |

##### Component Details

- Rectangles: Main components
- Hexagons: Gateway components

##### Specific Implementation Details

Key elements:
- PayloadSource and PayloadSink interfaces
- Shard coordination system
- Global rate limiting
- Router implementations

##### Implementation Notes

- Scalability aspects
- Message flow between components
- Integration points for bot implementations
- Coordination mechanisms between distributed instances

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Discord API Layer"
        DiscordAPI[Discord API]
    end

    subgraph "Gateway Interface Layer"
        UpGW[Upstream Gateway Client]:::gateway
        DownGW[Downstream Gateway Client]:::gateway
        PayloadProc[Payload Processing System]:::core
    end

    subgraph "Communication Layer"
        RMQ[RabbitMQ Connector]:::rabbitmq
        RS[RSocket Connector]:::rsocket
    end

    subgraph "Coordination Layer"
        ShardCoord[Shard Coordinator]:::rsocket
        RateLimit[Global Rate Limiter]:::rsocket
        Router[Router Implementation]:::rsocket
    end

    subgraph "Bot Layer"
        Leader[Leader Node]:::node
        Worker1[Worker Node 1]:::node
        Worker2[Worker Node 2]:::node
    end

    %% Connections
    DiscordAPI <--> UpGW
    UpGW <--> PayloadProc
    PayloadProc <--> DownGW
    DownGW --> |Payload Transform| RMQ & RS
    RMQ --> Leader
    RS --> Leader
    Leader --> Worker1 & Worker2
    ShardCoord --> Leader & Worker1 & Worker2
    RateLimit --> Leader & Worker1 & Worker2
    Router --> Leader & Worker1 & Worker2

    %% Styles
    classDef core fill:#a2d2ff
    classDef gateway fill:#bde0fe
    classDef rabbitmq fill:#98c1d9
    classDef rsocket fill:#ee9b00
    classDef node fill:#606c38

    %% Click Events
    click UpGW "https://github.com/Discord4J/connect/blob/master/common/src/main/java/discord4j/connect/common/UpstreamGatewayClient.java"
    click DownGW "https://github.com/Discord4J/connect/blob/master/common/src/main/java/discord4j/connect/common/DownstreamGatewayClient.java"
    click PayloadProc "https://github.com/Discord4J/connect/blob/master/common/src/main/java/discord4j/connect/common/PayloadSource.java"
    click RMQ "https://github.com/Discord4J/connect/blob/master/rabbitmq/src/main/java/discord4j/connect/rabbitmq/ConnectRabbitMQ.java"
    click RS "https://github.com/Discord4J/connect/blob/master/rsocket/src/main/java/discord4j/connect/rsocket/ConnectRSocket.java"
    click ShardCoord "https://github.com/Discord4J/connect/blob/master/rsocket/src/main/java/discord4j/connect/rsocket/shard/RSocketShardCoordinator.java"
    click RateLimit "https://github.com/Discord4J/connect/blob/master/rsocket/src/main/java/discord4j/connect/rsocket/global/RSocketGlobalRateLimiter.java"
    click Router "https://github.com/Discord4J/connect/blob/master/rsocket/src/main/java/discord4j/connect/rsocket/router/RSocketRouter.java"
```
