oriabyi / compression-work Goto Github PK

1.1. Messaging Format
All messages that flow over the socket share a common header that consists
of three fixed width integer fields in the following order:
• A 32 bit wide magic value which is always equal to 0x53545259.
• A 16 bit payload length
• A 16 bit request code / status code
The header may or may not be followed by a payload depending on the message type.
Lastly, all fields are in network byte order.

1.2. Requests
The compression service should support the following request types (request code noted in parenthesis):
• “Ping” (RC: 1)
	– Serves as a means to check that the service is operating normally.
• “Get Stats” (RC: 2)
	– Retrieves various internal statistics of the service.
• “Reset Stats” (RC: 3)
	– Resets the internal statistics to their appropriate default values.
• “Compress” (RC: 4)
	– Requests that some data be compressed using a particular compression scheme.
All other request codes should be considered invalid.

1.3 Compression Algorithm
a => a
aa => aa
aaa => 3a
aaaaabbb => 5a3b
aaaaabbbbbbaaabb => 5a6b3abb
abcdefg => abcdefg

3.1. Client
	3.1.1. Usage: ./client host port requestCode ;
	3.1.2. Check arguments ;
	3.1.3. Create io_service object, for represents program's link to the operating system's I/O services ;
	3.1.4. Create object of I/O for perform I/O operations (socket) ;
	3.1.5. Create object resolver for performs resolution of a query to a list of entries ;
	3.1.6. Connect endpoint and socket ;
	3.1.7. Work with server 
	  3.1.7.1. Initialize of header, if we get request code 4 (COMPRESS), we will set in header.length
		length of message, what we get ;
	  3.1.7.2. Send header, and if rq == 4, send message also (only after header) ;
	3.1.8. Wait for response of server ;
	3.1.9. Get header 
	  3.1.9.1. If we had rq == 1 (PING), we do nothing ;
	  3.1.9.2. If we had rq == 2 (GET STATS), we get structure of stats ;
	  3.1.9.3. If we had rq == 3 (RESET STATS), we do nothing ;
	  3.1.9.4. If we had rq == 4 (COMPRESS), we get compressed message.
	3.1.10. Close socket.

3.2. Server
	3.2.1. Usage: ./server port ;
	3.2.2. Check arguments ;
	3.2.3. Create io_service object, for represents program's link to the operating system's I/O services ;
	3.2.4. Create object acceptor for accepting new socket connections ;
	3.2.5. Accept new connection ;
	3.2.6. Separates the thread of execution from the thread object, allowing execution to continue independently ;
	3.2.7. When we get connection , get and check header
	  3.2.7.1. If header.magicValue != our magic value, we give an error WRONGMAGICVALUE_RQ (33) ;
	  3.2.7.2. If (header <= 0 || header.length > BUFFER_SIZE (32768)), we give an error WRONGLENGHT_RQ (2) ;
	  3.2.7.3. If (header.requestCode < 1 || header.requestCode > 4), we give an error WRONGREQUESCODE_RQ (3) ;
	3.2.8. Work regarding requests
	  3.2.8.1. If rq == 1 (PING), we send header and header.requestCode = OK (0), and also header.length = 0;
	  3.2.8.2. If rq == 2 (GET STATS), we send structure of stats
	  	(after header, where header.requestCode = OK (0), and also header.length = 0);
	  3.2.8.3. If rq == 3 (RESET STATS), we annul stats, and send header 
	  	(where header.requestCode = OK (0), and also header.length = 0);
	  3.2.8.4. If rq == 4 (COMPRESS), we compress message, and send it back to client
	  (after header, where header.requestCode = OK (0), and also header.length = (length of our compressed message)) ;
	3.2.9. Close socket ;
	3.2.10. Waiting for the next connection ...

0	-	OK
1	-	Unknown ERROR
2	-	Message Too Large
3	-	Wrong Request Code
33	-	Wrong Magic Number
34	-	Message contains numbers
35	-	Message contains capital characters
36	-	Message contains bad characters
37	-	Empty string ("\0")