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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
/**
* mds — A micro-display server
* Copyright © 2014, 2015, 2016, 2017 Mattias Andrée (m@maandree.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_CLIENT_H
#define MDS_MDS_SERVER_CLIENT_H
#include "interception-condition.h"
#include "multicast.h"
#include <libmdsserver/mds-message.h>
#include <stdlib.h>
#include <pthread.h>
#include <stdint.h>
#include <unistd.h>
#define CLIENT_T_VERSION 0
/**
* Client information structure
*/
typedef struct client {
/**
* The client's entry in the list of clients
*/
ssize_t list_entry;
/**
* The socket file descriptor for the socket connected to the client
*/
int socket_fd;
/**
* Whether the socket is open
*/
int open;
/**
* Message read buffer for the client
*/
struct mds_message message;
/**
* The read thread for the client
*/
pthread_t thread;
/**
* The client's ID
*/
uint64_t id;
/**
* Mutex for sending data and other
* actions that only affacts this client
*/
pthread_mutex_t mutex;
/**
* Whether `mutex` has been initialised
*/
int mutex_created;
/**
* The messages interception conditions conditions
* for the client
*/
struct interception_condition *interception_conditions;
/**
* The number of interception conditions
*/
size_t interception_conditions_count;
/**
* Pending multicast messages
*/
struct multicast *multicasts;
/**
* The number of pending multicast messages
*/
size_t multicasts_count;
/**
* Messages pending to be sent (concatenated)
*/
char *send_pending;
/**
* The character length of the messages pending to be sent
*/
size_t send_pending_size;
/**
* Pending reply to the multicast interception
*/
struct mds_message *modify_message;
/**
* Mutex for `modify_message`
*/
pthread_mutex_t modify_mutex;
/**
* Condidition for `modify_message`
*/
pthread_cond_t modify_cond;
/**
* Whether `modify_mutex` has been initialised
*/
int modify_mutex_created;
/**
* Whether `modify_cond` has been initialised
*/
int modify_cond_created;
} client_t;
/**
* Initialise a client
*
* The following fields will not be initialised:
* - message
* - thread
* - mutex
* - modify_mutex
* - modify_cond
*
* The follow fields will be initialised to `-1`:
* - list_entry
* - socket_fd
*
* @param this Memory slot in which to store the new client information
*/
__attribute__((nonnull))
void client_initialise(client_t *restrict this);
/**
* Initialise fields that have to do with threading
*
* This method initialises the following fields:
* - thread
* - mutex
* - modify_mutex
* - modify_cond
*
* @param this The client information
* @return Zero on success, -1 on error
*/
__attribute__((nonnull))
int client_initialise_threading(client_t *restrict this);
/**
* Release all resources assoicated with a client
*
* @param this The client information
*/
__attribute__((nonnull))
void client_destroy(client_t *restrict this);
/**
* Calculate the buffer size need to marshal client information
*
* @param this The client information
* @return The number of bytes to allocate to the output buffer
*/
__attribute__((pure, nonnull))
size_t client_marshal_size(const client_t *restrict this);
/**
* Marshals client information
*
* @param this The client information
* @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 client_marshal(const client_t *restrict this, char *restrict data);
/**
* Unmarshals client information
*
* @param this Memory slot in which to store the new client information
* @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 client information on error.
*/
__attribute__((nonnull))
size_t client_unmarshal(client_t *restrict this, char *restrict data);
/**
* Pretend to unmarshal client information
*
* @param data In buffer with the marshalled data
* @return The number of read bytes
*/
__attribute__((pure, nonnull))
size_t client_unmarshal_skip(char *restrict data);
#endif
|
