Skip to content

Commit c56f252

Browse files
committed
docs: add a readme on the examples folder
1 parent c233b60 commit c56f252

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

examples/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Examples
2+
3+
This directory has some example networks ready to be loaded into the simulator.
4+
We also include some information on each example here.
5+
6+
## [HTTP Client-Server](./httpClientServer.json)
7+
8+
This example includes three hosts and two routers, simulating a server and multiple clients that communicate through the internet.
9+
To see it in action, run the HTTP request program in one of the clients, selecting the HTTP server as the destination.
10+
11+
## [Local network](./localNetwork.json)
12+
13+
This example includes three hosts connected by a single switch, simulating a local area network.
14+
A good place to check how ARP requests work!
15+
16+
## [Misconfigured router](./misconfiguredRouter.json)
17+
18+
This example includes two hosts connected through a loop of three routers.
19+
One of the hosts is running the "Echo server" program, which regularly sends ICMP echo packets.
20+
However, the packets don't ever reach the other host, since one of the router's routing tables is misconfigured.
21+
The routing table entry for the receiving host instead points to the next router on the loop, causing the packet to be forever lost in the network.
22+
After a while, the packets are dropped due to their TTL decreasing to zero.
23+
24+
## [Subnetting](./subnetting.json)
25+
26+
This example includes multiple hosts, routers, and switches.
27+
Each host represents a group of hosts, shown in their tags.
28+
It was inspired by an exercise on subnet partitioning and routing table configuration.

0 commit comments

Comments
 (0)