add doxygen

This commit is contained in:
2020-06-01 23:24:24 +02:00
parent f3a0bfed40
commit af365474a7
15 changed files with 241 additions and 10 deletions

View File

@@ -6,9 +6,27 @@
class conexion_ssl : public conexion
{
public:
/**
* @brief conexion_ssl
* Create a secure conexion
* @param conf Config file to give the parameters of conexion
*/
conexion_ssl(config_reader &conf);
ssize_t read_string(std::string &entrada, int size);
ssize_t write_string(std::string entrada);
/**
* @brief read_string
* Read a string in the SSL socket
* @param input String readed
* @param size Length to read
* @return Size of bytes readed
*/
ssize_t read_string(std::string &input, int size);
/**
* @brief write_string
* Write a sitring in the secure socket
* @param output String to send
* @return bytes sended
*/
ssize_t write_string(std::string output);
private:
SSL* ssl;
};