stage-4, stage-5 polished

eXpServer · Mar 27, 2024 · ed25cb7 · ed25cb7
1 parent bd19913
commit ed25cb7
Show file tree

Hide file tree

Showing 12 changed files with 197 additions and 77 deletions.
diff --git a/...ase-1-overview/overview-filestructure.png → ...assets/phase-1-overview/filestructure.png b/...ase-1-overview/overview-filestructure.png → ...assets/phase-1-overview/filestructure.png
diff --git a/docs/assets/phase-1-overview/overview.png → docs/assets/phase-1-overview/modules.png b/docs/assets/phase-1-overview/overview.png → docs/assets/phase-1-overview/modules.png
diff --git a/docs/assets/stage-4/events.png b/docs/assets/stage-4/events.png
diff --git a/docs/assets/stage-4/implementation.png b/docs/assets/stage-4/implementation.png
diff --git a/docs/assets/stage-4/python-server.png b/docs/assets/stage-4/python-server.png
diff --git a/docs/assets/stage-4/tcp-proxy-2.png b/docs/assets/stage-4/tcp-proxy-2.png
diff --git a/docs/assets/stage-4/tcp-proxy.png b/docs/assets/stage-4/tcp-proxy.png
diff --git a/docs/assets/stage-5/implementation.png b/docs/assets/stage-5/implementation.png
diff --git a/docs/roadmap/phase-0/stage-3.md b/docs/roadmap/phase-0/stage-3.md
@@ -60,11 +60,12 @@ struct epoll_event event, events[MAX_EPOLL_EVENTS];
 int epoll_fd = epoll_create1(0);
 ```
 
-::: tip
+::: note
 Add this to global definitions:
 
 ```c
 #define MAX_EPOLL_EVENTS 10
+#define MAX_SOCKS 20
 ```
 
 :::

diff --git a/docs/roadmap/phase-0/stage-4.md b/docs/roadmap/phase-0/stage-4.md
diff --git a/docs/roadmap/phase-1/index.md b/docs/roadmap/phase-1/index.md
@@ -23,7 +23,7 @@ eXpServer is broken down into multiple modules. Given below are the modules that
 4. Upstream module
 5. File module
 
-![overview.png](/assets/phase-1-overview/overview.png)
+![modules.png](/assets/phase-1-overview/modules.png)
 
 There will be an apparent jump in the complexity of the code that we will be writing which is normal and expected. You will have to spend a bit more time than Phase 0 for this. Rest assured, this documentation will guide you throughout the process.
 
@@ -35,7 +35,7 @@ In order to maintain consistency, we will be providing you with the expected fil
 
 ### Phase 1 file structure
 
-![overview-filestructure.png](/assets/phase-1-overview/overview-filestructure.png)
+![overview-filestructure.png](/assets/phase-1-overview/filestructure.png)
 
 From Phase 1, we will be using a library called `vec` that provides dynamic array implementation. Read about `vec` more [here](https://www.notion.so/vec-c409d67ef38e4e4b9f3a1fe8b51956ca?pvs=21).
 

diff --git a/docs/roadmap/phase-1/stage-5.md b/docs/roadmap/phase-1/stage-5.md
@@ -53,8 +53,14 @@ main()
 					send()
 ```
 
+Don’t worry if this is very confusing now. We’ll break it down slowly and build it step by step.
+
 ## Implementation
 
+The figure below gives a high level view of what we’ll be doing in this stage:
+
+![implementation.png](/assets/stage-5/implementation.png)
+
 `xps.h` will consist of constants and user defined types that are common to all modules and will be used everywhere. Create a file `xps.h` under `expserver` folder and copy the below content to it.
 
 ::: details expserver/xps.h