:memo: Ajout documentation

Serveur/bomberstudent_server.c

@@ -54,6 +54,11 @@ void* client_thread(void* data) {
     return NULL;
 }
 
+/**
+ * Thread de gestion des connexions UDP
+ * @param data
+ * @return 
+ */
 void* udp_thread(void* data) {
     Server s;
     char buffer[BUFFER_SIZE];
@@ -80,6 +85,11 @@ void* udp_thread(void* data) {
     return NULL;
 }
 
+/**
+ * Thread de gestion des connexions TCP
+ * @param data
+ * @return 
+ */
 void* tcp_thread(void* data) {
     Server* s;
     boolean res;

Serveur/bomberstudent_server.h

@@ -19,13 +19,66 @@
 #define PORT_TCP 18642
 
 /* --- Fonctions --- */
+/**
+ * Initialise les variables du serveur
+ */
 void ini_server();
+
+/**
+ * Ajoute un handler
+ * @param char* La methode lié au handler
+ * @param char* La ressource lié au handler
+ * @param int(*)(int, JsonParser*) La fonction à appeler
+ */
 void add_handler(char*, char*, int(*)(int, JsonParser*));
+
+/**
+ * Lance le serveur UDP pour permettre d'être trouver dans le reseau
+ * @param int Port UDP
+ * @return Reussite
+ */
 boolean launch_udp_server(int);
+
+/**
+ * Lance les serveurs TCP sur port et port + 1, pour respectivement communiquer
+ * et notifier le client
+ * @param int Le port
+ * @return Reussite
+ */
 boolean launch_tcp_server(int);
+
+/**
+ * Attente reception d'une requete du client
+ * @param Client* Le client dont ont attend une requete
+ * @return Reussite
+ */
 boolean receive_client(Client*);
+
+/**
+ * Repond au client
+ * @param int L'id du client
+ * @param JsonEncoder* Les données à envoyer
+ * @return Reussite
+ */
 boolean send_client(int, JsonEncoder*);
+
+/**
+ * Notifie les clients
+ * @param Client* Le client à notifier
+ * @param char* Méthode à utiliser (POST ou GET)
+ * @param char* La ressource demandé
+ * @param JsonEncoder* Les parametres
+ * @return Reussite
+ */
 boolean notify_client(Client*, char*, char*, JsonEncoder*);
+
+/**
+ * Notifie tous les clients connecté
+ * @param char* Méthode à utiliser (POST ou GET)
+ * @param char* La ressource demandé
+ * @param JsonEncoder* Les parametres
+ * @return Reussite
+ */
 boolean notify_all(char*, char*, JsonEncoder*);
 
 #endif /* BOMBERSTUDENT_SERVER_H */

Serveur/bomberstudent_server.log

@@ -11,3 +11,27 @@
 ----- Log processus 4152 (timestamp : 1542876516) -----
 ----- Log processus 4231 (timestamp : 1542876605) -----
 ----- Fin log processus 4231 (temps en seconde : 1) -----
+----- Log processus 4627 (timestamp : 1542877404) -----
+----- Fin log processus 4627 (temps en seconde : 25) -----
+----- Log processus 4699 (timestamp : 1542877518) -----
+----- Fin log processus 4699 (temps en seconde : 12) -----
+----- Log processus 4738 (timestamp : 1542877574) -----
+----- Fin log processus 4738 (temps en seconde : 10) -----
+----- Log processus 4804 (timestamp : 1542877617) -----
+----- Fin log processus 4804 (temps en seconde : 15) -----
+----- Log processus 4840 (timestamp : 1542877658) -----
+----- Fin log processus 4840 (temps en seconde : 20) -----
+----- Log processus 4894 (timestamp : 1542877751) -----
+----- Fin log processus 4894 (temps en seconde : 12) -----
+----- Log processus 4950 (timestamp : 1542877782) -----
+----- Fin log processus 4950 (temps en seconde : 20) -----
+----- Log processus 4984 (timestamp : 1542877816) -----
+----- Fin log processus 4984 (temps en seconde : 14) -----
+----- Log processus 5025 (timestamp : 1542877874) -----
+----- Fin log processus 5025 (temps en seconde : 17) -----
+----- Log processus 5082 (timestamp : 1542877903) -----
+----- Fin log processus 5082 (temps en seconde : 18) -----
+----- Log processus 5123 (timestamp : 1542877998) -----
+----- Fin log processus 5123 (temps en seconde : 14) -----
+----- Log processus 5156 (timestamp : 1542878017) -----
+----- Fin log processus 5156 (temps en seconde : 9) -----

Serveur/client.h

@@ -30,10 +30,36 @@ typedef struct{
 }ClientList;
 
 /* --- Fonctions --- */
+/**
+ * Ajoute un client dans lalsite
+ * @param Server Le serveur TCP à utiliser pour la connexion principale
+ * @param Server Le serveur TCP à utiliser pour notifier le client
+ * @return int L'id du client
+ */
 int add_client(Server, Server);
+
+/**
+ * Retourne un client
+ * @param int L'id du client
+ * @return Client* Le client
+ */
 Client* get_client(int);
+
+/**
+ * Supprime un client
+ * @param int L'id du client
+ */
 void remove_client(int);
+
+/**
+ * Vide la liste des clients
+ */
 void clean_clientlist();
+
+/**
+ * Retourne le nombre de client actuel dans la liste
+ * @return int Le nombre de client
+ */
 int get_number_client();
 
 #endif /* CLIENT_H */

Serveur/main.c

@@ -20,7 +20,6 @@ extern Error error;
 boolean stop = false;
 
 /* --- Fonctions privées --- */
-
 void handler(int sig){
     //Si SIGINT
     if(sig == SIGINT){

Serveur/main.h

@@ -16,6 +16,10 @@
 #define END_ERR 1
 
 /* --- Fonctions --- */
+/**
+ * Notifie tous les clients connecté que le serveur s'arrete
+ * @param int Status de fin du serveur
+ */
 void notify_close(int);
 
 

Serveur/server.h

@@ -36,10 +36,36 @@ struct server{
 };
 
 /* --- Fonction --- */
+/**
+ * Creation d'un serveur UDP
+ * @return Le serveur
+ */
 Server server_create_udp();
+
+/**
+ * Creation d'un serveur TCP
+ * @return Le serveur
+ */
 Server server_create_tcp();
+
+/**
+ * Ferme un serveur
+ * @param Server Le serveur à fermer
+ */
 void server_close(Server);
+
+/**
+ * Ferme la connexion avec un client d'une socket TCP
+ * @param Server Ferme le client d'un serveur TCP
+ * @return boolean Reussite
+ */
 boolean server_close_client(Server);
+
+/**
+ * Clone un serveur
+ * @param Server Le serveur à cloner
+ * @return Server Le serveur clonner
+ */
 Server server_clone(Server);
 
 #endif /* SERVER_H */