summaryrefslogtreecommitdiff
path: root/client/SslClient.h
diff options
context:
space:
mode:
Diffstat (limited to 'client/SslClient.h')
-rw-r--r--client/SslClient.h26
1 files changed, 19 insertions, 7 deletions
diff --git a/client/SslClient.h b/client/SslClient.h
index 24ccc94..77af070 100644
--- a/client/SslClient.h
+++ b/client/SslClient.h
@@ -16,15 +16,26 @@ class QString;
/**
* @brief Client-server communication class<br/>
* - Uses SSL protocol to communicate with server
- * - Requests config/static or generic proxy lists/firewall list
* - Server port - 13666
- * - Request format: [0x13 0x13 rcode 0x14 0x14]
- * - Reply format: [0x13 0x13 rcode [data] 0x14 0x14]
- * - Request codes:
+ * - Request/reply format (if not stated otherwise)
+ * -# request: [0x13 0x13 rcode 0x14 0x14]
+ * -# reply: [0x13 0x13 rcode [data] 0x14 0x14]
+ * - Request codes for configuration data (see samples in config/ dir)
* -# 0x01 - request client config
* -# 0x02 - request generic proxy list
- * -# 0x04 - request static proxy list
- * -# 0x08 - request firewall host list
+ * -# 0x03 - request static proxy list
+ * -# 0x04 - request firewall host list
+ * -# 0x05 - request list of file to be deleted
+ * -# 0x06 - request list of files to be uploaded
+ * -# 0x07 - request recent available client version
+ * - Capable of transferring binary files (request code > 0x10)<br/>
+ * Entire data file is split into 4k parts and this parts are transferred<br/>
+ * as [data] payload in reply packet. If file size is split into integer number of parts<br/>
+ * then client is sent all parts + empty packet (no data): [0x13 0x13 rcode 0x14 0x14]
+ * -# 0x11 - request client binary file
+ * -# 0x12 - request reqular file<br/>
+ * request: [0x13 0x13 rcode [path] 0x14 0x14]<br/>
+ * where path - path on client's machine where this file should be
*/
class SslClient: public QObject
{
@@ -70,7 +81,8 @@ public:
ClientBinary = 0x11,
/**
* @brief Request file upload (the list of this files is obtained via RequestType::UploadList)
- * @note Request should contain file path as specified in RequestType::UploadList
+ * @note Request should contain file path as specified in RequestType::UploadList<br/>
+ * Reply data is split into 4k parts and sent one by one
*/
RegularFile = 0x12
};