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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
/**
* xrdp: A Remote Desktop Protocol server.
*
* Copyright (C) Jay Sorg 2004-2022, all xrdp contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
*
* @file libipm/ercp.h
* @brief ERCP declarations
* @author Matt Burt
*
* Functions in this file use the following naming conventions:-
*
* E_ERCP_{msg}_REQUEST is sent by ercp_send_{msg}_request()
* E_ERCP_{msg}_REQUEST is parsed by ercp_get_{msg}_request()
* E_ERCP_{msg}_RESPONSE is sent by ercp_send_{msg}_response()
* E_ERCP_{msg}_RESPONSE is parsed by ercp_get_{msg}_response()
* E_ERCP_{msg}_EVENT is sent by ercp_send_{msg}_event()
* E_ERCP_{msg}_EVENT is parsed by ercp_get_{msg}_event()
*/
#ifndef ERCP_H
#define ERCP_H
#include "arch.h"
#include "scp_application_types.h"
#include "trans.h"
struct guid;
/* Message codes */
enum ercp_msg_code
{
E_ERCP_SESSION_ANNOUNCE_EVENT,
E_ERCP_SESSION_FINISHED_EVENT,
E_ERCP_SESSION_RECONNECT_EVENT
};
/* Common facilities */
/**
* Convert a message code to a string for output
* @param n Message code
* @param buff to contain string
* @param buff_size length of buff
* @return buff is returned for convenience.
*/
const char *
ercp_msgno_to_str(enum ercp_msg_code n, char *buff, unsigned int buff_size);
/* Connection management facilities */
/**
* Converts a standard trans connected to an ERCP endpoint to an ERCP transport
*
* @param trans connected endpoint
* @return != 0 for error
*/
int
ercp_init_trans(struct trans *trans);
/**
* Converts an EICP transport to an ERCP transport.
*
* This is done following successful transmission or receipt of an
* E_EICP_CREATE_SESSION_REQUEST.
*
* @param trans connected endpoint
* @param callback_func New callback function for ERCP messages.
* @param callback_data New argument for callback function
*/
void
ercp_trans_from_eicp_trans(struct trans *trans,
ttrans_data_in callback_func,
void *callback_data);
/**
* Checks an ERCP transport to see if a complete message is
* available for parsing
*
* @param trans ERCP transport
* @param[out] available != 0 if a complete message is available
* @return != 0 for error
*/
int
ercp_msg_in_check_available(struct trans *trans, int *available);
/**
* Waits on a single transport for an ERCP message to be available for
* parsing
*
* @param trans libipm transport
* @return != 0 for error
*
* While the call is active, data-in callbacks for the transport are
* disabled.
*
* Only use this call if you have nothing to do until a message
* arrives on the transport. If you have other transports to service, use
* ercp_msg_in_check_available()
*/
int
ercp_msg_in_wait_available(struct trans *trans);
/**
* Gets the ERCP message number of an incoming message
*
* @param trans ERCP transport
* @return message in the buffer
*
* The results of calling this routine before ercp_msg_in_check_available()
* states a message is available are undefined.
*/
enum ercp_msg_code
ercp_msg_in_get_msgno(const struct trans *trans);
/**
* Resets an ERCP message buffer ready to receive the next message
*
* @param trans libipm transport
*/
void
ercp_msg_in_reset(struct trans *trans);
/* -------------------- Session event messages-------------------- */
/**
* Send an E_ERCP_SESSION_ANNOUNCE_EVENT
*
* Direction : sesexec -> sesman
*
* This event contains all the information known about a session
*
* @param trans EICP transport
* @param display Display used by session
* @param uid UID of user logged in to session
* @param type Session type
* @param start_width Starting width of seenio
* @param start_height Starting height of session
* @param bpp Bits-per-pixel for session
* @param guid Session GUID
* @param start_ip_addr Starting IP address of client
* @param start_time Session start time
* @return != 0 for error
*/
int
ercp_send_session_announce_event(struct trans *trans,
unsigned int display,
uid_t uid,
enum scp_session_type type,
unsigned short start_width,
unsigned short start_height,
unsigned char bpp,
const struct guid *guid,
const char *start_ip_addr,
time_t start_time);
/**
* Parse an incoming E_ERCP_SESSION_ANNOUNCE_EVENT
*
* This event contains all the information known about a session
*
* @param trans EICP transport
* @param[out] display Display used by session.
* Pointer can be NULL if this is already known.
* @param[out] uid UID of user logged in to session
* @param[out] type Session type
* @param[out] start_width Starting width of seenio
* @param[out] start_height Starting height of session
* @param[out] bpp Bits-per-pixel for session
* @param[out] guid Session GUID
* @param[out] start_ip_addr Starting IP address of client
* @param[out] start_time Session start time
* @return != 0 for error
*/
int
ercp_get_session_announce_event(struct trans *trans,
unsigned int *display,
uid_t *uid,
enum scp_session_type *type,
unsigned short *start_width,
unsigned short *start_height,
unsigned char *bpp,
struct guid *guid,
const char **start_ip_addr,
time_t *start_time);
/**
* Send an E_ERCP_SESSION_FINISHED_EVENT
*
* Direction : sesexec -> sesman
*
* This event simply states the attached session has finished and can be
* removed from any data structures held by sesman
*
* @param trans EICP transport
* @return != 0 for error
*/
int
ercp_send_session_finished_event(struct trans *trans);
/**
* Send an E_ERCP_SESSION_RECONNECT_EVENT
*
* Direction : sesman -> sesexec
*
* This event tells sesexec that a reconnection is about to occur, and
* sesexec should run the reconnect script.
*
* @param trans EICP transport
* @return != 0 for error
*/
int
ercp_send_session_reconnect_event(struct trans *trans);
#endif /* ERCP_H */
|
