From 131bfd623fb13f88cfbbe6fe443e819cd9d2c206 Mon Sep 17 00:00:00 2001 From: Justin Parsell Date: Tue, 1 Mar 2022 16:53:46 -0500 Subject: [PATCH] Add 'How it works' --- How-it-works.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 How-it-works.md diff --git a/How-it-works.md b/How-it-works.md new file mode 100644 index 0000000..6bbe73b --- /dev/null +++ b/How-it-works.md @@ -0,0 +1,16 @@ +## Logic +The program attempts to ping the requested device 5 times, and if it responds, report it up. Otherwise, report it down. +It saves this information to the console as well as an outputed file, `pingResults.csv`. + +## Program flow +The program does the following +1. The program attempts to read in from the file to a vector containing the device name and associated ip +2. The program sets up the output file, ensuring that it exsists and writes header information +3. The program iterates through each device and creates a runner job for each device +4. The program creates a logging thread that handles writing to the console and appending to the file +5. The program begins to execute the threads and writes the information out +6. The program closes the execuation stack and the logging thread +7. The program writes to the file and exits + +## Status information +The program attempts to ping each device 5 times, if more then 50% of the pings make it through, it reports the device as up \ No newline at end of file