Server and ChatHandler documentation

Author: vaspatrik

Server/GlobalClass.h

@@ -7,7 +7,7 @@
 #include <vector>
 #include <mutex>
 
-
+/*! Class with constants and some utility functions */
 class GlobalClass {
 private:
 	static std::mutex _muTrim;
@@ -19,28 +19,80 @@ class GlobalClass {
 	static const std::string DATABASE_USER;
 	static const std::string DATABASE_PASSWORD;
 
+	/**
+	* String which will be added to password before hashing, adding more security.
+	*/
 	static const std::string SALT;
 
 	static const int PORT_NUMBER;
-
+	/**
+	 *Delimiter which is used to separe the messages in the request
+	*/
 	static const char DELIMITER1;
+	/**
+	 *Delimiter which is used to separe the messages sub-parts.
+	*/
 	static const char DELIMITER2;
+	/**
+	 *Additional delimiter.
+	*/
 	static const char DELIMITER3;
 
+	/**
+	*	Common room user id.
+	*/
 	static const int COMMON_USER_ID;
+	
+	/**
+	*	Common room username
+	*/
 	static const std::string COMMON_ROOM_NAME;
 
+	/*
+	* Response code which indicates that the request was processed correctly.	*
+	*/
 	static const int REQUEST_OK;
 	static const int USER_NAME_ALREADY_EXIST;
+	/*
+	* Error code which means that the request format is invalide.
+	*/
 	static const int INCORRECT_REQUEST;
 	static const int INCORRECT_USER_OR_PASSWOROD;
 	static const int DATABASE_ERROR;
 
+	/*
+	* Time interval in which the online checker thread checks the users activity.
+	*/
 	static const std::chrono::milliseconds ONLINECHECK_SLEEPTIME;
 
+	 /**
+		* \param str string which will be trimed
+		* \param whitespace characters which should be considered white space.
+		* \return Trimed string
+		* 
+		* Remove space from the begining and ending of the string
+	*/
 	static std::string trim(const std::string& str, const std::string& whitespace = " \t\n");
+
+	/**
+		* \param s input string
+		* \param delim delimiter character, these wont be part of the return value
+		* \return a std::vector of strings, each of which is a substring of string formed by splitting it on boundaries formed by the char delimiter.
+		* 
+	*/
 	static std::vector<std::string> split(const std::string &s, char delim);
+
+	/**
+		Converts integer to string
+		* \param a input integer
+		* \return string interpretation of the parameter
+	*/
 	static std::string converter(int a);
+
+	/**
+		Time since epoch.
+		* \return milliseconds passed since 1970-1-1.
+	*/
 	static long currentTimeMillis();
 };
 

Server/Server/ChatHandler.h

@@ -16,10 +16,37 @@ class ChatHandler
 public:	
 	ChatHandler();
 	~ChatHandler();
+	/**
+		* \param request register string request sent by client, format: username:delimiter1:password:delimiter1:email@email.com.
+		* \return response string containing the code of the operation (success/fail)
+		* 
+		* Register an user in the database if the request data is correct, otherwise it returns with an error code.
+	*/
 	std::string registerUser(const std::string &request);
+	/**
+		* \param request login string request sent by client, format: username:delimiter1:password.
+		* \return response string containing the code of the operation (success/fail), and user random user token on success
+		* 
+		* If the username/password combination user exist in the database it returns a token. With the token the client can
+		* access the users messages and send messages to other users.
+	*/
 	std::string loginUser(const std::string &request);
+	/**
+		* \param token the user token generated on login
+		* \return response string containing the code of the operation (success/fail), and update data format: error_code:delimit1:online_users:delimit1:private_msg:public_msg 
+		* If the token a valid one, it will update user last activity time, 
+	*/
 	std::string updateUser(const std::string token);
+	/**
+		* \param request message string request sent by client, format: TOKEN:delimiter1:TARGET:delimiter1:This is the message:delimiter1:
+		* \return response string containing the code of the operation (success/fail)
+		* 
+		* If the request information is valid, it will send message from the token user to the target user
+	*/
 	std::string messageUser(const std::string &request);
+	/**
+	* It will remove all inactive user from the online user list.
+	*/
 	void checkOnlineUsers();
 private:
 	UserEntity createUserFromRequest(const std::string &request);

Server/Server/Server.h

@@ -12,8 +12,19 @@
 
 class Server {
 public:
+	/**
+	*	Binds server to port.
+	*/
 	Server(int port);
+	/**
+	* Closes server socket.
+	*/
 	~Server();
+	/**
+	*	\brief Server start waiting for clients on PORT and update existing clients.
+	*	Server objects handles clients and threads. For each client creats a thread, it also has a thread in which
+		checks the activity of user.
+	*/
 	void run();
 	const int PORT;
 private: