aboutsummaryrefslogtreecommitdiffstats
path: root/src/mds-server/interception-condition.h
blob: 78383f4d98683323458f5960817df50f090c3ebc (plain) (blame)
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
/**
 * mds — A micro-display server
 * Copyright © 2014, 2015, 2016, 2017  Mattias Andrée (maandree@kth.se)
 * 
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */
#ifndef MDS_MDS_SERVER_INTERCEPTION_CONDITION_H
#define MDS_MDS_SERVER_INTERCEPTION_CONDITION_H


#include <stddef.h>
#include <stdint.h>


#define INTERCEPTION_CONDITION_T_VERSION 0

/**
 * A condition for a message being intercepted by a client
 */
typedef struct interception_condition {
	/**
	 * The header of messages to intercept, optionally with a value,
	 * empty (most not be NULL) for all messages.
	 */
	char *condition;

	/**
	 * The hash of the header of messages to intercept
	 */
	size_t header_hash;

	/**
	 * The interception priority. The client should be
	 * consistent with the priority for conditions that
	 * are not mutually exclusive.
	 */
	int64_t priority;

	/**
	 * Whether the messages may get modified by the client
	 */
	int modifying;
} interception_condition_t;


/**
 * Calculate the buffer size need to marshal an interception condition
 * 
 * @param   this  The interception condition
 * @return        The number of bytes to allocate to the output buffer
 */
__attribute__((pure, nonnull))
size_t interception_condition_marshal_size(const interception_condition_t *restrict this);

/**
 * Marshals an interception condition
 * 
 * @param   this  The interception condition
 * @param   data  Output buffer for the marshalled data
 * @return        The number of bytes that have been written (everything will be written)
 */
__attribute__((nonnull))
size_t interception_condition_marshal(const interception_condition_t *restrict this, char *restrict data);

/**
 * Unmarshals an interception condition
 * 
 * @param   this  Memory slot in which to store the new interception condition
 * @param   data  In buffer with the marshalled data
 * @return        Zero on error, `errno` will be set accordingly, otherwise the
 *                number of read bytes. Destroy the interception condition on error.
 */
__attribute__((nonnull))
size_t interception_condition_unmarshal(interception_condition_t *restrict this, char *restrict data);

/**
 * Pretend to an interception condition
 * 
 * @param   data  In buffer with the marshalled data
 * @return        The number of read bytes
 */
__attribute__((pure, nonnull))
size_t interception_condition_unmarshal_skip(char *restrict data);


#endif