# yashx37/grpc-chat-app architecture

> Architecture diagram of the GitHub repository yashx37/grpc-chat-app, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/yashx37/grpc-chat-app
- Repository: https://github.com/yashx37/grpc-chat-app

## Overview

This is a terminal-based gRPC chat application. A user enters commands in ChatClient, which encodes them as protobuf messages and sends them over a bidirectional stream to the server’s ChatServiceImpl. The service registers clients, routes global, private, and room messages, handles room membership and history requests, and persists supported messages through ChatDatabase. The README also documents unary, server-streaming, and client-streaming learning examples in the protocol. ChatDatabase was not excerpted, so its internal behavior is represented only as documented and referenced.

Main entry points: [`src/main/java/com/chat/service/ChatServiceImpl.java`](https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/service/ChatServiceImpl.java) (Chat Service), [`src/main/java/com/chat/client/ChatClient.java`](https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/client/ChatClient.java) (Chat Client), [`src/main/java/com/chat/storage/ChatDatabase.java`](https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/storage/ChatDatabase.java) (Message History Store), [`src/main/java/com/chat/server/ChatServer.java`](https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/server/ChatServer.java) (Chat Server)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Client Entry"]
  node_client["Chat Client<br/>[ChatClient.java]"]
end

subgraph group_transport["gRPC Transport"]
  node_server["Chat Server<br/>[ChatServer.java]"]
  node_protocol["RPC Protocol<br/>[chat.proto]"]
  node_service["Chat Service"]
end

subgraph group_messaging["Chat Routing"]
  node_global["Global Messaging"]
  node_private["Private Messaging"]
  node_room["Room Messaging"]
  node_history["History Requests"]
end

subgraph group_state["State and History"]
  node_sessions[("Client Sessions")]
  node_membership[("Room Membership")]
  node_database[("Message History Store<br/>[ChatDatabase.java]")]
end

node_user(("Terminal User"))

node_user -->|"enters commands"| node_client
node_client -->|"streams messages"| node_server
node_server -->|"registers service"| node_service
node_client -->|"encodes messages"| node_protocol
node_service -->|"implements RPC"| node_protocol
node_service -->|"routes global"| node_global
node_service -->|"routes private"| node_private
node_service -->|"routes room"| node_room
node_service -->|"handles history"| node_history
node_service -->|"tracks clients"| node_sessions
node_service -->|"tracks membership"| node_membership
node_service -->|"saves and queries"| node_database
node_global -->|"persists messages"| node_database
node_history -->|"loads history"| node_database

click node_client "https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/client/ChatClient.java"
click node_server "https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/server/ChatServer.java"
click node_protocol "https://github.com/yashx37/grpc-chat-app/blob/main/src/main/proto/chat.proto"
click node_service "https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/service/ChatServiceImpl.java"
click node_global "https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/service/ChatServiceImpl.java"
click node_private "https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/service/ChatServiceImpl.java"
click node_room "https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/service/ChatServiceImpl.java"
click node_history "https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/service/ChatServiceImpl.java"
click node_sessions "https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/service/ChatServiceImpl.java"
click node_membership "https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/service/ChatServiceImpl.java"
click node_database "https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/storage/ChatDatabase.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_client,node_user toneBlue
class node_server,node_protocol,node_service toneAmber
class node_global,node_private,node_room,node_history toneMint
class node_sessions,node_membership,node_database toneRose
```

## Components

### Client Entry

- [Chat Client](https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/client/ChatClient.java): `src/main/java/com/chat/client/ChatClient.java`

### gRPC Transport

- [Chat Server](https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/server/ChatServer.java): `src/main/java/com/chat/server/ChatServer.java`
- [RPC Protocol](https://github.com/yashx37/grpc-chat-app/blob/main/src/main/proto/chat.proto): `src/main/proto/chat.proto`
- [Chat Service](https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/service/ChatServiceImpl.java): `src/main/java/com/chat/service/ChatServiceImpl.java`

### Chat Routing

- [Global Messaging](https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/service/ChatServiceImpl.java): `src/main/java/com/chat/service/ChatServiceImpl.java`
- [Private Messaging](https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/service/ChatServiceImpl.java): `src/main/java/com/chat/service/ChatServiceImpl.java`
- [Room Messaging](https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/service/ChatServiceImpl.java): `src/main/java/com/chat/service/ChatServiceImpl.java`
- [History Requests](https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/service/ChatServiceImpl.java): `src/main/java/com/chat/service/ChatServiceImpl.java`

### State and History

- [Client Sessions](https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/service/ChatServiceImpl.java): `src/main/java/com/chat/service/ChatServiceImpl.java`
- [Room Membership](https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/service/ChatServiceImpl.java): `src/main/java/com/chat/service/ChatServiceImpl.java`
- [Message History Store](https://github.com/yashx37/grpc-chat-app/blob/main/src/main/java/com/chat/storage/ChatDatabase.java): `src/main/java/com/chat/storage/ChatDatabase.java`

### Other components

- **Terminal User**

## Connections

- Terminal User → Chat Client: enters commands (evidence: `src/main/java/com/chat/client/ChatClient.java`)
- Chat Client → Chat Server: streams messages (evidence: `readme.md`)
- Chat Server → Chat Service: registers service (evidence: `src/main/java/com/chat/server/ChatServer.java`)
- Chat Client → RPC Protocol: encodes messages (evidence: `src/main/java/com/chat/client/ChatClient.java`)
- Chat Service → RPC Protocol: implements RPC (evidence: `src/main/proto/chat.proto`)
- Chat Service → Global Messaging: routes global (evidence: `readme.md`)
- Chat Service → Private Messaging: routes private (evidence: `readme.md`)
- Chat Service → Room Messaging: routes room (evidence: `readme.md`)
- Chat Service → History Requests: handles history (evidence: `src/main/java/com/chat/service/ChatServiceImpl.java`)
- Chat Service → Client Sessions: tracks clients (evidence: `src/main/java/com/chat/service/ChatServiceImpl.java`)
- Chat Service → Room Membership: tracks membership (evidence: `src/main/java/com/chat/service/ChatServiceImpl.java`)
- Chat Service → Message History Store: saves and queries (evidence: `src/main/java/com/chat/service/ChatServiceImpl.java`)
- Global Messaging → Message History Store: persists messages (evidence: `src/main/java/com/chat/service/ChatServiceImpl.java`)
- History Requests → Message History Store: loads history (evidence: `src/main/java/com/chat/service/ChatServiceImpl.java`)
