Skip to content

Commit

Permalink
Update readme adding architecture
Browse files Browse the repository at this point in the history
  • Loading branch information
ndelvalle authored and gillchristian committed Sep 26, 2024
1 parent 36802bf commit b056298
Showing 1 changed file with 70 additions and 0 deletions.
70 changes: 70 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,73 @@ cargo run
```shell
cargo test
```
### Architecture

+--------------------------------------+
| Redis Client |
+-------------------+------------------+
|
| Request (e.g., SET key value)
v
+-------------------+------------------+
| Server |
| (module: server, function: run) |
+-------------------+------------------+
|
| Accept Connection
v
+-------------------+------------------+
| Connection |
| (module: connection, manages TCP |
| connections and streams) |
+-------------------+------------------+
|
| Read Data from TCP Stream
v
+-------------------+------------------+
| Codec |
| (module: codec, function: decode) |
+-------------------+------------------+
|
| Decode Request
v
+-------------------+------------------+
| Frame |
| (module: frame, function: parse) |
+-------------------+------------------+
|
| Parse Command and Data
v
+-------------------+------------------+
| Store |
| (module: store, manages key-value |
| data storage) |
+-------------------+------------------+
|
| Execute Command (e.g., set, get, incr_by)
v
+-------------------+------------------+
| Frame |
| (module: frame, function: serialize)|
+-------------------+------------------+
|
| Encode Response
v
+-------------------+------------------+
| Codec |
| (module: codec, function: encode) |
+-------------------+------------------+
|
| Write Data to TCP Stream
v
+-------------------+------------------+
| Connection |
| (module: connection, manages TCP |
| connections and streams) |
+-------------------+------------------+
|
| Send Response
v
+-------------------+------------------+
| Redis Client |
+--------------------------------------+

0 comments on commit b056298

Please sign in to comment.