Improved readme documentation and diagrams

Author: gabrieldiem

README.md

@@ -2,79 +2,96 @@
 
 Este repositorio contiene la solución propuesta para la PoC detallada en la [consigna](./TP2_Threads_Enunciado.pdf).
 
-## Diagrama de hilos
+## Diagramas de hilos y queues
 
-El diagrama se puede ver con más detalle descargando la imagen ubicada en [./docs/threads_diagram.png](./docs/threads_diagram.png) o el mismo archivo drawio [./docs/threads_diagram.drawio](./docs/threads_diagram.drawio).
+### Manejo de mensajes con los clientes
 
-<img src="./docs/threads_diagram.png">
+Este diagrama refleja cómo se manejan los threads relacionados al envío y recepción de mensajes con un cliente, desde el thread main del server. Se ilustra un sólo cliente, nombrándolo con el sufijo "1", las interacciones serían las mismas con más clientes en sus respectivos threads. El cliente es single-threaded.
+
+<img src="./docs/client_thread.png">
+
+### Servidor
+
+El resto de la arquitectura / intercomunicación de threads con queues se representa en este diagrama:
+
+<img src="./docs/server_threads.png">
 
 ## Queues
 
-Todas las Queues utilizadas fueron del tipo unbounded, entendiendo que el sistema podrá tomar una cantidad virtualmente infinita de clientes.
+Todas las Queues utilizadas fueron del tipo unbounded, entendiendo que el sistema podrá tomar una cantidad virtualmente infinita de clientes, aunque en la práctica la cantidad máxima estaría delimitada por la memoria y otros recursos del sistema que hostee el servidor.
 
-Las queues de los ClientConnections son bloqueantes porque me interesa que esos threads no hagan busy wait.
+Las queues de las ClientConnections son bloqueantes porque me interesa que esos threads no hagan busy wait.
 
-Los pop de las queues con los que JazzJackrabbit2GameServer debe interactuar son no bloqueantes ya que no quiere bloquear el gameloop. Sin embargo, los push de las mismas son bloqueantes.
+Los pop de las queues con los que JazzJackrabbit2GameServer debe interactuar son no bloqueantes ya que no se quiere bloquear el gameloop. Sin embargo, los push de las mismas son bloqueantes.
 
 ## Tick system
 
-Para el servidor se utiliza un sistema de ticks, inspirado en el funcionamiento del motor Source by Valve. Así como un frame es una actualización de la imagen gráfica que renderiza un motor gráfico. Un tick o "gameframe" es una actualización de la lógica/estado del juego. 
+Para el servidor se utiliza un "sistema de ticks", inspirado en el funcionamiento del engine Source by Valve.
+
+Así como un frame es una actualización de la imagen gráfica que renderiza un motor gráfico. Un tick o "gameframe" es una actualización de la lógica/estado del juego.
 
 ## Setup
 
 Instalar pre-commit hooks:
+
 ```shell
 pre-commit install
 ```
 
 Para crear un commit sin correr los hooks se debe ejecutar:
+
 ```shell
 git commit --no-verify
 ```
 
 Para correr cppcheck sin necesidad de un commit se debe ejecutar:
+
 ```shell
 pre-commit run --all-files
 ```
 
 ## Compilación
 
 Compilación con código as-is:
+
 ```shell
 make
 ```
 
 Compilación con código con wrap randomizado de sockets:
+
 ```shell
 make wrapsocks=1
 ```
 
 ## Running multi client
 
 Correr tests sin valgrind:
+
 ```shell
 ./run_tests.sh ./ casos/ multi-client no-valgrind 60 10
 ```
 
 Correr tests con valgrind:
+
 ```shell
 ./run_tests.sh ./ casos/ multi-client valgrind 60 10
 ```
+
 ## Comparación outputs
 
 Comparar outputs:
+
 ```shell
 ./compare_outputs.sh casos/ salidas/
 ```
 
-
 ## Supresión de flags de cppcheck
 
 En algunos headers (.h) puntuales se suprimió el warning `unusedStructMember` de cppcheck. Esta decisión fue tomada porque es un falso positivo, en todos los casos que sucede, es sólo en headers de clases sobre variables privadas que sí se usan dentro del código (en el .cpp).
 
 En el método Army::receive_attack de la clase Army, se suprimió el flag `useStlAlgorithm`, dado que el algoritmo sugerido por cppcheck no cumplía con las necesidades del método. Así que se continuó usando un ranged-based for loop.
 
-
 ## Licencia
 
 GPL v2

casos/01_single_player_shoot_exit/__client_0_valgrind__

@@ -1,23 +1,23 @@
-==00:00:00:00.000 2296585== Memcheck, a memory error detector
-==00:00:00:00.000 2296585== Copyright (C) 2002-2022, and GNU GPL'd, by Julian Seward et al.
-==00:00:00:00.000 2296585== Using Valgrind-3.20.0 and LibVEX; rerun with -h for copyright info
-==00:00:00:00.000 2296585== Command: ./client 127.0.0.1 1501
-==00:00:00:00.000 2296585== Parent PID: 2296582
-==00:00:00:00.000 2296585== 
-==00:00:00:10.020 2296585== 
-==00:00:00:10.020 2296585== FILE DESCRIPTORS: 5 open (3 std) at exit.
-==00:00:00:10.020 2296585== Open file descriptor 63:
-==00:00:00:10.020 2296585==    <inherited from parent>
-==00:00:00:10.020 2296585== 
-==00:00:00:10.020 2296585== Open file descriptor 3: /mnt/62EE36AFEE367B7D/Users/Gabriel/Desktop/University/2024/Taller de Programación 1/TPs/TP2 - Threads/threads-2024c1-gabrieldiem/casos/01_single_player_shoot_exit/__client_0_valgrind__
-==00:00:00:10.020 2296585==    <inherited from parent>
-==00:00:00:10.020 2296585== 
-==00:00:00:10.020 2296585== 
-==00:00:00:10.021 2296585== HEAP SUMMARY:
-==00:00:00:10.021 2296585==     in use at exit: 0 bytes in 0 blocks
-==00:00:00:10.021 2296585==   total heap usage: 22 allocs, 22 frees, 78,730 bytes allocated
-==00:00:00:10.021 2296585== 
-==00:00:00:10.021 2296585== All heap blocks were freed -- no leaks are possible
-==00:00:00:10.021 2296585== 
-==00:00:00:10.021 2296585== For lists of detected and suppressed errors, rerun with: -s
-==00:00:00:10.021 2296585== ERROR SUMMARY: 0 errors from 0 contexts (suppressed: 0 from 0)
+==00:00:00:00.000 2451155== Memcheck, a memory error detector
+==00:00:00:00.000 2451155== Copyright (C) 2002-2022, and GNU GPL'd, by Julian Seward et al.
+==00:00:00:00.000 2451155== Using Valgrind-3.20.0 and LibVEX; rerun with -h for copyright info
+==00:00:00:00.000 2451155== Command: ./client 127.0.0.1 1501
+==00:00:00:00.000 2451155== Parent PID: 2451152
+==00:00:00:00.000 2451155== 
+==00:00:00:10.024 2451155== 
+==00:00:00:10.024 2451155== FILE DESCRIPTORS: 5 open (3 std) at exit.
+==00:00:00:10.024 2451155== Open file descriptor 63:
+==00:00:00:10.024 2451155==    <inherited from parent>
+==00:00:00:10.024 2451155== 
+==00:00:00:10.024 2451155== Open file descriptor 3: /mnt/62EE36AFEE367B7D/Users/Gabriel/Desktop/University/2024/Taller de Programación 1/TPs/TP2 - Threads/threads-2024c1-gabrieldiem/casos/01_single_player_shoot_exit/__client_0_valgrind__
+==00:00:00:10.024 2451155==    <inherited from parent>
+==00:00:00:10.024 2451155== 
+==00:00:00:10.024 2451155== 
+==00:00:00:10.024 2451155== HEAP SUMMARY:
+==00:00:00:10.024 2451155==     in use at exit: 0 bytes in 0 blocks
+==00:00:00:10.024 2451155==   total heap usage: 36 allocs, 36 frees, 92,771 bytes allocated
+==00:00:00:10.024 2451155== 
+==00:00:00:10.024 2451155== All heap blocks were freed -- no leaks are possible
+==00:00:00:10.025 2451155== 
+==00:00:00:10.025 2451155== For lists of detected and suppressed errors, rerun with: -s
+==00:00:00:10.025 2451155== ERROR SUMMARY: 0 errors from 0 contexts (suppressed: 0 from 0)

casos/01_single_player_shoot_exit/__client_descriptors__

@@ -1 +1 @@
-0 2296582 10
+0 2451152 10

casos/01_single_player_shoot_exit/__server_valgrind__

@@ -1,23 +1,23 @@
-==00:00:00:00.000 2296551== Memcheck, a memory error detector
-==00:00:00:00.000 2296551== Copyright (C) 2002-2022, and GNU GPL'd, by Julian Seward et al.
-==00:00:00:00.000 2296551== Using Valgrind-3.20.0 and LibVEX; rerun with -h for copyright info
-==00:00:00:00.000 2296551== Command: ./server 1500
-==00:00:00:00.000 2296551== Parent PID: 2296549
-==00:00:00:00.000 2296551== 
-==00:00:00:10.848 2296551== 
-==00:00:00:10.848 2296551== FILE DESCRIPTORS: 5 open (3 std) at exit.
-==00:00:00:10.848 2296551== Open file descriptor 63:
-==00:00:00:10.848 2296551==    <inherited from parent>
-==00:00:00:10.848 2296551== 
-==00:00:00:10.848 2296551== Open file descriptor 3: /mnt/62EE36AFEE367B7D/Users/Gabriel/Desktop/University/2024/Taller de Programación 1/TPs/TP2 - Threads/threads-2024c1-gabrieldiem/casos/01_single_player_shoot_exit/__server_valgrind__
-==00:00:00:10.848 2296551==    <inherited from parent>
-==00:00:00:10.848 2296551== 
-==00:00:00:10.848 2296551== 
-==00:00:00:10.848 2296551== HEAP SUMMARY:
-==00:00:00:10.848 2296551==     in use at exit: 0 bytes in 0 blocks
-==00:00:00:10.848 2296551==   total heap usage: 100 allocs, 100 frees, 90,729 bytes allocated
-==00:00:00:10.848 2296551== 
-==00:00:00:10.849 2296551== All heap blocks were freed -- no leaks are possible
-==00:00:00:10.849 2296551== 
-==00:00:00:10.849 2296551== For lists of detected and suppressed errors, rerun with: -s
-==00:00:00:10.849 2296551== ERROR SUMMARY: 0 errors from 0 contexts (suppressed: 0 from 0)
+==00:00:00:00.000 2451126== Memcheck, a memory error detector
+==00:00:00:00.000 2451126== Copyright (C) 2002-2022, and GNU GPL'd, by Julian Seward et al.
+==00:00:00:00.000 2451126== Using Valgrind-3.20.0 and LibVEX; rerun with -h for copyright info
+==00:00:00:00.000 2451126== Command: ./server 1500
+==00:00:00:00.000 2451126== Parent PID: 2451124
+==00:00:00:00.000 2451126== 
+==00:00:00:10.659 2451126== 
+==00:00:00:10.659 2451126== FILE DESCRIPTORS: 5 open (3 std) at exit.
+==00:00:00:10.659 2451126== Open file descriptor 63:
+==00:00:00:10.659 2451126==    <inherited from parent>
+==00:00:00:10.659 2451126== 
+==00:00:00:10.659 2451126== Open file descriptor 3: /mnt/62EE36AFEE367B7D/Users/Gabriel/Desktop/University/2024/Taller de Programación 1/TPs/TP2 - Threads/threads-2024c1-gabrieldiem/casos/01_single_player_shoot_exit/__server_valgrind__
+==00:00:00:10.659 2451126==    <inherited from parent>
+==00:00:00:10.659 2451126== 
+==00:00:00:10.659 2451126== 
+==00:00:00:10.659 2451126== HEAP SUMMARY:
+==00:00:00:10.659 2451126==     in use at exit: 0 bytes in 0 blocks
+==00:00:00:10.659 2451126==   total heap usage: 164 allocs, 164 frees, 105,720 bytes allocated
+==00:00:00:10.659 2451126== 
+==00:00:00:10.659 2451126== All heap blocks were freed -- no leaks are possible
+==00:00:00:10.660 2451126== 
+==00:00:00:10.660 2451126== For lists of detected and suppressed errors, rerun with: -s
+==00:00:00:10.660 2451126== ERROR SUMMARY: 0 errors from 0 contexts (suppressed: 0 from 0)

casos/02_single_player_shoot_read/__client_0_valgrind__

@@ -1,23 +1,23 @@
-==00:00:00:00.000 2296771== Memcheck, a memory error detector
-==00:00:00:00.000 2296771== Copyright (C) 2002-2022, and GNU GPL'd, by Julian Seward et al.
-==00:00:00:00.000 2296771== Using Valgrind-3.20.0 and LibVEX; rerun with -h for copyright info
-==00:00:00:00.000 2296771== Command: ./client 127.0.0.1 1503
-==00:00:00:00.000 2296771== Parent PID: 2296768
-==00:00:00:00.000 2296771== 
-==00:00:00:08.912 2296771== 
-==00:00:00:08.912 2296771== FILE DESCRIPTORS: 5 open (3 std) at exit.
-==00:00:00:08.912 2296771== Open file descriptor 63:
-==00:00:00:08.912 2296771==    <inherited from parent>
-==00:00:00:08.912 2296771== 
-==00:00:00:08.912 2296771== Open file descriptor 3: /mnt/62EE36AFEE367B7D/Users/Gabriel/Desktop/University/2024/Taller de Programación 1/TPs/TP2 - Threads/threads-2024c1-gabrieldiem/casos/02_single_player_shoot_read/__client_0_valgrind__
-==00:00:00:08.912 2296771==    <inherited from parent>
-==00:00:00:08.912 2296771== 
-==00:00:00:08.912 2296771== 
-==00:00:00:08.912 2296771== HEAP SUMMARY:
-==00:00:00:08.912 2296771==     in use at exit: 0 bytes in 0 blocks
-==00:00:00:08.912 2296771==   total heap usage: 45 allocs, 45 frees, 83,680 bytes allocated
-==00:00:00:08.912 2296771== 
-==00:00:00:08.912 2296771== All heap blocks were freed -- no leaks are possible
-==00:00:00:08.912 2296771== 
-==00:00:00:08.912 2296771== For lists of detected and suppressed errors, rerun with: -s
-==00:00:00:08.912 2296771== ERROR SUMMARY: 0 errors from 0 contexts (suppressed: 0 from 0)
+==00:00:00:00.000 2451307== Memcheck, a memory error detector
+==00:00:00:00.000 2451307== Copyright (C) 2002-2022, and GNU GPL'd, by Julian Seward et al.
+==00:00:00:00.000 2451307== Using Valgrind-3.20.0 and LibVEX; rerun with -h for copyright info
+==00:00:00:00.000 2451307== Command: ./client 127.0.0.1 1503
+==00:00:00:00.000 2451307== Parent PID: 2451304
+==00:00:00:00.000 2451307== 
+==00:00:00:08.904 2451307== 
+==00:00:00:08.904 2451307== FILE DESCRIPTORS: 5 open (3 std) at exit.
+==00:00:00:08.904 2451307== Open file descriptor 63:
+==00:00:00:08.904 2451307==    <inherited from parent>
+==00:00:00:08.904 2451307== 
+==00:00:00:08.904 2451307== Open file descriptor 3: /mnt/62EE36AFEE367B7D/Users/Gabriel/Desktop/University/2024/Taller de Programación 1/TPs/TP2 - Threads/threads-2024c1-gabrieldiem/casos/02_single_player_shoot_read/__client_0_valgrind__
+==00:00:00:08.904 2451307==    <inherited from parent>
+==00:00:00:08.904 2451307== 
+==00:00:00:08.904 2451307== 
+==00:00:00:08.904 2451307== HEAP SUMMARY:
+==00:00:00:08.904 2451307==     in use at exit: 0 bytes in 0 blocks
+==00:00:00:08.904 2451307==   total heap usage: 65 allocs, 65 frees, 97,835 bytes allocated
+==00:00:00:08.904 2451307== 
+==00:00:00:08.904 2451307== All heap blocks were freed -- no leaks are possible
+==00:00:00:08.904 2451307== 
+==00:00:00:08.904 2451307== For lists of detected and suppressed errors, rerun with: -s
+==00:00:00:08.904 2451307== ERROR SUMMARY: 0 errors from 0 contexts (suppressed: 0 from 0)

casos/02_single_player_shoot_read/__client_descriptors__

@@ -1 +1 @@
-0 2296768 10
+0 2451304 10

casos/02_single_player_shoot_read/__server_valgrind__

@@ -1,23 +1,23 @@
-==00:00:00:00.000 2296737== Memcheck, a memory error detector
-==00:00:00:00.000 2296737== Copyright (C) 2002-2022, and GNU GPL'd, by Julian Seward et al.
-==00:00:00:00.000 2296737== Using Valgrind-3.20.0 and LibVEX; rerun with -h for copyright info
-==00:00:00:00.000 2296737== Command: ./server 1502
-==00:00:00:00.000 2296737== Parent PID: 2296735
-==00:00:00:00.000 2296737== 
-==00:00:00:09.849 2296737== 
-==00:00:00:09.849 2296737== FILE DESCRIPTORS: 5 open (3 std) at exit.
-==00:00:00:09.849 2296737== Open file descriptor 63:
-==00:00:00:09.849 2296737==    <inherited from parent>
-==00:00:00:09.850 2296737== 
-==00:00:00:09.850 2296737== Open file descriptor 3: /mnt/62EE36AFEE367B7D/Users/Gabriel/Desktop/University/2024/Taller de Programación 1/TPs/TP2 - Threads/threads-2024c1-gabrieldiem/casos/02_single_player_shoot_read/__server_valgrind__
-==00:00:00:09.850 2296737==    <inherited from parent>
-==00:00:00:09.850 2296737== 
-==00:00:00:09.850 2296737== 
-==00:00:00:09.850 2296737== HEAP SUMMARY:
-==00:00:00:09.850 2296737==     in use at exit: 0 bytes in 0 blocks
-==00:00:00:09.850 2296737==   total heap usage: 100 allocs, 100 frees, 90,729 bytes allocated
-==00:00:00:09.850 2296737== 
-==00:00:00:09.850 2296737== All heap blocks were freed -- no leaks are possible
-==00:00:00:09.850 2296737== 
-==00:00:00:09.850 2296737== For lists of detected and suppressed errors, rerun with: -s
-==00:00:00:09.850 2296737== ERROR SUMMARY: 0 errors from 0 contexts (suppressed: 0 from 0)
+==00:00:00:00.000 2451263== Memcheck, a memory error detector
+==00:00:00:00.000 2451263== Copyright (C) 2002-2022, and GNU GPL'd, by Julian Seward et al.
+==00:00:00:00.000 2451263== Using Valgrind-3.20.0 and LibVEX; rerun with -h for copyright info
+==00:00:00:00.000 2451263== Command: ./server 1502
+==00:00:00:00.000 2451263== Parent PID: 2451261
+==00:00:00:00.000 2451263== 
+==00:00:00:09.841 2451263== 
+==00:00:00:09.841 2451263== FILE DESCRIPTORS: 5 open (3 std) at exit.
+==00:00:00:09.841 2451263== Open file descriptor 63:
+==00:00:00:09.842 2451263==    <inherited from parent>
+==00:00:00:09.842 2451263== 
+==00:00:00:09.842 2451263== Open file descriptor 3: /mnt/62EE36AFEE367B7D/Users/Gabriel/Desktop/University/2024/Taller de Programación 1/TPs/TP2 - Threads/threads-2024c1-gabrieldiem/casos/02_single_player_shoot_read/__server_valgrind__
+==00:00:00:09.842 2451263==    <inherited from parent>
+==00:00:00:09.842 2451263== 
+==00:00:00:09.842 2451263== 
+==00:00:00:09.842 2451263== HEAP SUMMARY:
+==00:00:00:09.842 2451263==     in use at exit: 0 bytes in 0 blocks
+==00:00:00:09.842 2451263==   total heap usage: 164 allocs, 164 frees, 105,720 bytes allocated
+==00:00:00:09.842 2451263== 
+==00:00:00:09.842 2451263== All heap blocks were freed -- no leaks are possible
+==00:00:00:09.842 2451263== 
+==00:00:00:09.842 2451263== For lists of detected and suppressed errors, rerun with: -s
+==00:00:00:09.842 2451263== ERROR SUMMARY: 0 errors from 0 contexts (suppressed: 0 from 0)

casos/03_three_players_all_read_once/__client_0_valgrind__

@@ -1,23 +1,23 @@
-==00:00:00:00.000 2296959== Memcheck, a memory error detector
-==00:00:00:00.000 2296959== Copyright (C) 2002-2022, and GNU GPL'd, by Julian Seward et al.
-==00:00:00:00.000 2296959== Using Valgrind-3.20.0 and LibVEX; rerun with -h for copyright info
-==00:00:00:00.000 2296959== Command: ./client 127.0.0.1 1505
-==00:00:00:00.000 2296959== Parent PID: 2296956
-==00:00:00:00.000 2296959== 
-==00:00:00:22.118 2296959== 
-==00:00:00:22.118 2296959== FILE DESCRIPTORS: 5 open (3 std) at exit.
-==00:00:00:22.118 2296959== Open file descriptor 63:
-==00:00:00:22.118 2296959==    <inherited from parent>
-==00:00:00:22.118 2296959== 
-==00:00:00:22.118 2296959== Open file descriptor 3: /mnt/62EE36AFEE367B7D/Users/Gabriel/Desktop/University/2024/Taller de Programación 1/TPs/TP2 - Threads/threads-2024c1-gabrieldiem/casos/03_three_players_all_read_once/__client_0_valgrind__
-==00:00:00:22.118 2296959==    <inherited from parent>
-==00:00:00:22.118 2296959== 
-==00:00:00:22.118 2296959== 
-==00:00:00:22.119 2296959== HEAP SUMMARY:
-==00:00:00:22.119 2296959==     in use at exit: 0 bytes in 0 blocks
-==00:00:00:22.119 2296959==   total heap usage: 33 allocs, 33 frees, 83,235 bytes allocated
-==00:00:00:22.119 2296959== 
-==00:00:00:22.119 2296959== All heap blocks were freed -- no leaks are possible
-==00:00:00:22.119 2296959== 
-==00:00:00:22.119 2296959== For lists of detected and suppressed errors, rerun with: -s
-==00:00:00:22.119 2296959== ERROR SUMMARY: 0 errors from 0 contexts (suppressed: 0 from 0)
+==00:00:00:00.000 2451435== Memcheck, a memory error detector
+==00:00:00:00.000 2451435== Copyright (C) 2002-2022, and GNU GPL'd, by Julian Seward et al.
+==00:00:00:00.000 2451435== Using Valgrind-3.20.0 and LibVEX; rerun with -h for copyright info
+==00:00:00:00.000 2451435== Command: ./client 127.0.0.1 1505
+==00:00:00:00.000 2451435== Parent PID: 2451432
+==00:00:00:00.000 2451435== 
+==00:00:00:22.127 2451435== 
+==00:00:00:22.127 2451435== FILE DESCRIPTORS: 5 open (3 std) at exit.
+==00:00:00:22.127 2451435== Open file descriptor 63:
+==00:00:00:22.127 2451435==    <inherited from parent>
+==00:00:00:22.128 2451435== 
+==00:00:00:22.128 2451435== Open file descriptor 3: /mnt/62EE36AFEE367B7D/Users/Gabriel/Desktop/University/2024/Taller de Programación 1/TPs/TP2 - Threads/threads-2024c1-gabrieldiem/casos/03_three_players_all_read_once/__client_0_valgrind__
+==00:00:00:22.128 2451435==    <inherited from parent>
+==00:00:00:22.128 2451435== 
+==00:00:00:22.128 2451435== 
+==00:00:00:22.128 2451435== HEAP SUMMARY:
+==00:00:00:22.128 2451435==     in use at exit: 0 bytes in 0 blocks
+==00:00:00:22.128 2451435==   total heap usage: 49 allocs, 49 frees, 97,314 bytes allocated
+==00:00:00:22.128 2451435== 
+==00:00:00:22.128 2451435== All heap blocks were freed -- no leaks are possible
+==00:00:00:22.128 2451435== 
+==00:00:00:22.128 2451435== For lists of detected and suppressed errors, rerun with: -s
+==00:00:00:22.128 2451435== ERROR SUMMARY: 0 errors from 0 contexts (suppressed: 0 from 0)