summaryrefslogtreecommitdiff
path: root/proto_lib/api_protocol.h
blob: 88195e2bf9c38c7851883ddb23fe892482d4751d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
// Copyright © 2013 sss
//.
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//.
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//.
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

#ifndef API_PROTOCOL_H
#define API_PROTOCOL_H


struct service_s
{
	struct cmd
	{
		std::string command, description;
	};
	std::string service;
	std::list<cmd> cmds;
};

enum packet_type {AUTH_REPLY, AUTH_REQUEST, SERVICES_REPLY, SERVICES_REQUEST, COMMAND_REPLY, COMMAND_REQUEST, UNKNOWN};
enum status {failure = 0x00, success = 0x01};

class packet
{
public:
	explicit packet(std::vector<unsigned char>&);
	const std::vector<unsigned char> &raw();
	packet_type get_type();
	bool is_good();
	bool check_status(); //false on fail
	bool is_server_packet();
	bool is_client_packet();
	bool is_status_packet();
	bool assign(packet&);
	bool assign(std::vector<unsigned char>&);
	
	//helper functions:
	//client functions
	static packet *cli_make_auth_packet(); //should be first packet to server
	static packet *cli_make_command_packet(std::string &service, std::string &command);
	static packet *cli_make_request_services_packet();
	
	static std::list<service_s> *cli_extract_services(packet&);
	static std::string cli_parse_command_reply(packet&);
	
	//server functions
	static bool serv_validate_client_proto(packet&); //false on fail
	static packet *serv_make_services_packet(std::list<service_s>&);
	static packet *serv_make_command_reply_packet(std::string&, status s);
	
	//generic
	static packet *make_status_packet(packet_type type, status s);
	
private:
	std::vector<unsigned char> data;
};




#endif