summaryrefslogtreecommitdiffstats
path: root/include/protocol.h
blob: c1b786cbae4cafa9563ca25c450d4208bc33215c (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
73
74
75
76
77
78
79
80
/*
 * Usurpataion --- client-server protocol interface.
 *
 * Copyright (C) 2019 Ramūnas Mažeikis
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; version 2.1
 * of the License.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 */

#ifdef PROTOCOL_H_INCLUDED
#define PROTOCOL_H_INCLUDED

#include <errno.h>

#define	SUCCESS		(0)
#define	TLV_OVERFLOW	(1 << 0)

enum packet_type {
	REGURAL,
	HEARTBEAT,
	DISCOVERY
};

enum tlv_type {
	TEXT,		/* NULL-terminated string. */
	FPI1,		/* Fixed point. 1 decimal digit of precision. */
	TIMESTAMP,
	REQUEST,
	REPLY,
	UUID
};

struct packet_data {
	enum packet_type type;
	size_t packet_size;
	char *data;	/* Bytes representing tlv's */
};

struct tlv {
	enum tlv_type type;
	size_t length;
	void *data;
};

/*
 * Reads last packets received, parses and stores them to be later retreived
 * via get_tlv.
 * */
void get_last_data(void);

/* Returns tlv's parsed by get_last_data. Returned tlv is only valid until
 * next call to get_tlv.
 * */
struct tlv * get_tlv(void);

/* Any modifications made to the pending outgoing packet are nullified.
 * */
void clear_data(void);

/* Appends data to the next packet to be sent. Type of data is determined by
 * enum tlv_type.
 * */
void push_data(char *data, enum tlv_type);

/* Sends packet towards the other end.
 * */
void flush_data(void);

#endif /* PROTOCOL_H_INCLUDED */