ton/NATSBridge
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 7 Wiki Activity

update diagram

Browse Source
This commit is contained in:
narawat
2026-03-04 10:23:40 +07:00
parent ee2d2c7238
commit 95fe697501
1 changed files with 64 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
README.md
View File

@@ -60,33 +60,74 @@ NATSBridge enables seamless communication for Julia applications through NATS, w
### System Components ### System Components
```mermaid
flowchart TB
subgraph Sender["Julia Application (Sender)"]
SenderApp[App Code]
NATSBridge_Send[NATSBridge]
NATS_Client[<b>NATS.jl</b>]
end
subgraph Receiver["Julia Application (Receiver)"]
ReceiverApp[App Code]
NATSBridge_Recv[NATSBridge]
NATS_Client_Recv[<b>NATS.jl</b>]
end
subgraph Infrastructure["Infrastructure"]
NATS[<b>NATS Server</b><br/>Message Broker]
FileServer[<b>HTTP File Server</b><br/>Upload/Download]
end
SenderApp --> NATSBridge_Send
NATSBridge_Send --> NATS_Client
NATS_Client --> NATS
NATS --> NATS_Client_Recv
NATS_Client_Recv --> NATSBridge_Recv
NATSBridge_Recv --> ReceiverApp
NATSBridge_Send -.->|HTTP POST upload| FileServer
FileServer -.->|HTTP GET download| NATSBridge_Recv
style SenderApp fill:#e8f5e9
style ReceiverApp fill:#e8f5e9
style NATS fill:#fff3e0
style FileServer fill:#f3e5f5
``` ```
┌─────────────────────────────────────────────────────────────────────┐
│ NATSBridge Architecture │ ### Key Components
├─────────────────────────────────────────────────────────────────────┤
│ ┌──────────────┐ │ │ | Component | Description |
│ │ Julia │ ▼ │ |-----------|-------------|
│ │ (NATS.jl) │ ┌─────────────────────────┐ │ | **Julia Application** | Sender and receiver applications using the NATSBridge module |
│ └──────────────┘ │ NATS │ │ | **NATS Server** | Message broker for transporting message envelopes |
│ │ (Message Broker) │ │ | **HTTP File Server** | Independent HTTP server for large payload storage (e.g., Plik) |
│ └─────────────────────────┘ │
│ │ │
│ ▼ │
│ ┌──────────────────────┐ │
│ │ File Server │ │
│ │ (HTTP Upload/Get) │ │
│ └──────────────────────┘ │
└─────────────────────────────────────────────────────────────────────┘
```
### Message Flow ### Message Flow
1. **Sender** creates a message envelope with payloads 1. **Sender** creates a message envelope with payloads using `smartsend()`
2. **NATSBridge** serializes and encodes payloads based on type 2. **NATSBridge** serializes and encodes each payload based on type
3. **Transport Decision**: Small payloads go directly to NATS, large payloads are uploaded to file server 3. **Transport Decision**:
4. **NATS** routes messages to subscribers - **Direct** (< 1MB): Payload encoded as Base64, published to NATS
5. **Receiver** fetches payloads (from NATS or file server) - **Link** (≥ 1MB): Payload uploaded to HTTP file server, URL published to NATS
6. **NATSBridge** deserializes and decodes payloads 4. **NATS** routes message envelope to subscribers
5. **Receiver** receives message via NATS subscription callback
6. **NATSBridge** processes envelope:
- Decodes Base64 payloads from NATS message
- Fetches URLs from file server with exponential backoff
7. **Receiver** deserializes payloads based on their type
### File Server Handler Abstraction
The system uses handler functions to abstract file server operations:
| Handler | Purpose |
|---------|---------|
| `plik_oneshot_upload()` | Uploads payload bytes to file server, returns URL |
| `_fetch_with_backoff()` | Downloads data from URL with exponential backoff retry |
This abstraction allows support for different file server implementations (Plik, AWS S3, custom HTTP server).
--- ---