:memo: Ajout documentation

Client/rsx/BomberStudentClient.java

@@ -18,18 +18,43 @@ import rsx.udp.Broadcast;
  */
 public class BomberStudentClient {
 
+    /**
+     * Port pour le boradcast UDP
+     */
     protected int portUdp;
+    
+    /**
+     * Port pour la socket TCP
+     */
     protected int portTcp;
+    
+    /**
+     * Class pour broadcast
+     */
     protected Broadcast finder;
+    
+    /**
+     * Class pour le client TCP
+     */
     protected TcpClient socket;
 
     /* --- Constructeurs --- */
+    /**
+     * Creation d'un client BomberStudent
+     * Le port 18624 est utilisé pour le broadcast udp
+     * Le port 18642 est utilisé pour la socket TCP
+     */
     public BomberStudentClient() {
         this.portUdp = 18624;
         this.portTcp = 18642;
         this.finder = new Broadcast(this.portUdp);
     }
 
+    /**
+     * Creation d'un client BomberStudent
+     * @param portUdp Le port pour le broadcast UDP
+     * @param portTcp Le port pour la socket TCP
+     */
     public BomberStudentClient(int portUdp, int portTcp) {
         this.portUdp = portUdp;
         this.portTcp = portTcp;
@@ -37,11 +62,20 @@ public class BomberStudentClient {
     }
 
     /* --- Methodes --- */
+    /**
+     * Cherche un serveur par broadcast
+     * @return Le nombre de serveur trouvé
+     */
     public int findServer() {
         this.finder.search("i'm a bomberstudent server");
         return this.finder.getServers().size();
     }
 
+    /**
+     * Selectionne un serveur pour s'y connecter
+     * @param index Le numero du serveur dans la liste
+     * @return Reussite
+     */
     public boolean selectServer(int index) {
         ArrayList<InetAddress> serv = this.finder.getServers();
         System.out.println(serv.size());
@@ -53,10 +87,23 @@ public class BomberStudentClient {
         return this.socket.connect();
     }
 
+    /**
+     * Envoi requete sur le serveur
+     * @param method Methode d'envoi (POST ou GET)
+     * @param ressource Ressource demandée
+     * @return Reussite
+     */
     public boolean send(String method, String ressource) {
         return this.send(method, ressource, null);
     }
 
+    /**
+     * Envoi requete sur le serveur
+     * @param method Methode d'envoi (POST ou GET)
+     * @param ressource Ressource demandée
+     * @param param Parametre JSON à envoyer au serveur
+     * @return Reussite
+     */
     public boolean send(String method, String ressource, JSONObject param) {
         //Verif que la methode existe
         method = method.toUpperCase();
@@ -75,6 +122,10 @@ public class BomberStudentClient {
         return true;
     }
 
+    /**
+     * Attend une reponse du serveur
+     * @return La reponse analysée
+     */
     public BomberStudentReponse receive() {
         String msg = this.socket.receive();
         if (msg == null) {
@@ -84,6 +135,10 @@ public class BomberStudentClient {
         }
     }
 
+    /**
+     * Ferme la connexion
+     * @return Reussite
+     */
     public boolean close() {
         return this.socket.close();
     }

Client/rsx/BomberStudentReponse.java

@@ -10,16 +10,38 @@ import org.json.JSONException;
  */
 public class BomberStudentReponse {
 
+    /**
+     * Reponse valide ou non
+     */
     protected boolean error = true;
+    
+    /**
+     * Code du statut encoyé par le serveur
+     */
     protected int statut;
+    
+    /**
+     * Message du statut envoyé par le serveur
+     */
     protected String message;
+    
+    /**
+     * Information en JSON envoyé par le serveur
+     */
     protected JSONObject reponse = null;
 
     /* --- Constructeurs --- */
+    /**
+     * Constructeur par defaut en cas de reponse invalide
+     */
     public BomberStudentReponse() {
 
     }
 
+    /**
+     * Parse la reponse du serveur
+     * @param reponse La reponse en JSON à parser
+     */
     public BomberStudentReponse(String reponse) {
         this.error = false;
         //Parse reponse

Client/rsx/tcp/TcpClient.java

@@ -6,7 +6,6 @@
 package rsx.tcp;
 
 import java.io.BufferedReader;
-import java.io.DataOutputStream;
 import java.io.IOException;
 import java.io.InputStreamReader;
 import java.io.PrintWriter;
@@ -20,19 +19,49 @@ import java.net.UnknownHostException;
  */
 public class TcpClient {
     
+    /**
+     * Adresse du serveur
+     */
     protected InetAddress adr;
+    
+    /**
+     * Port du serveur
+     */
     protected int port;
+    
+    /**
+     * Socket TCP
+     */
     protected Socket socket;
+    
+    /**
+     * Flux d'entrée
+     */
     protected BufferedReader input;
+    
+    /**
+     * Flux de sorti
+     */
     protected PrintWriter output;
     
     /* --- Constructeurs --- */
     
+    /**
+     * Creation d'un client TCP
+     * @param ip L'ip du serveur
+     * @param port Le port du serveur
+     * @throws UnknownHostException 
+     */
     public TcpClient(String ip, int port) throws UnknownHostException{
         this.adr = InetAddress.getByName(ip);
         this.port = port;
     }
     
+    /**
+     * Creation d'un client TCP
+     * @param adr L'adresse du serveur
+     * @param port Le port du serveur
+     */
     public TcpClient(InetAddress adr, int port){
         this.adr = adr;
         this.port = port;
@@ -40,6 +69,10 @@ public class TcpClient {
     
     /* --- Methodes --- */
     
+    /**
+     * Connexion au serveur
+     * @return Reussite
+     */
     public boolean connect(){
         try {
             this.socket = new Socket(this.adr, this.port);
@@ -53,12 +86,21 @@ public class TcpClient {
         return true;
     }
     
+    /**
+     * Envoi message au serveur
+     * @param msg Le message
+     * @return Reussite
+     */
     public boolean send(String msg){
         output.print(msg);
         output.flush();
         return true;
     }
     
+    /**
+     * Reception d'un message du serveur
+     * @return Le message ou null en cas d'erreur
+     */
     public String receive(){
         try {
             return input.readLine();
@@ -68,6 +110,10 @@ public class TcpClient {
         }
     }
     
+    /**
+     * Ferme la connexion au serveur
+     * @return Reussite
+     */
     public boolean close(){
         try {
             input.close();

Client/rsx/udp/Broadcast.java

@@ -16,19 +16,47 @@ import java.util.ArrayList;
  */
 public class Broadcast {
 
+    /**
+     * Port pour la socket UDP
+     */
     protected int port;
+    
+    /**
+     * Le message à envoyer
+     */
     protected String msg;
+    
+    /**
+     * TImeout
+     */
     protected int timeout = 5000;
+    
+    /**
+     * Taille du buffer pour l'envoi
+     */
     protected int bufferSize = 1024;
+    
+    /**
+     * Liste des serveurs ayant répondu
+     */
     protected ArrayList<InetAddress> servers = new ArrayList<>();
     
     /* --- Constructeurs --- */
 
+    /**
+     * Creation d'un Broadcast
+     * @param port Le port à utiliser
+     */
     public Broadcast(int port) {
         this.port = port;
         this.msg = "looking for bomberstudent servers";
     }
 
+    /**
+     * Creation d'un Broadcast
+     * @param port Le port à utiliser
+     * @param msg Le message à envoyer
+     */
     public Broadcast(int port, String msg) {
         this.port = port;
         this.msg = msg;
@@ -36,6 +64,11 @@ public class Broadcast {
     
     /* --- Methodes --- */
 
+    /**
+     * Cherche les serveurs
+     * @param answer La reponse attendu du serveur
+     * @return Reussite
+     */
     public boolean search(String answer) {
         //Creation socket
         DatagramSocket socket = null;
@@ -87,6 +120,9 @@ public class Broadcast {
         return true;
     }
     
+    /**
+     * Vide la liste des serveurs
+     */
     public void clean(){
         this.servers = new ArrayList<>();
     }