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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
|
/* $Id: VBoxManageGuestCtrl.h $ */
/** @file
* VBoxManageGuestCtrl.h - Definitions for guest control.
*/
/*
* Copyright (C) 2013-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* 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, in version 3 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
* 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 <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
#ifndef VBOX_INCLUDED_SRC_VBoxManage_VBoxManageGuestCtrl_h
#define VBOX_INCLUDED_SRC_VBoxManage_VBoxManageGuestCtrl_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <VBox/com/com.h>
#include <VBox/com/listeners.h>
#include <VBox/com/VirtualBox.h>
#include <iprt/semaphore.h>
#include <iprt/time.h>
#include <map>
const char *gctlFileStatusToText(FileStatus_T enmStatus);
const char *gctlProcessStatusToText(ProcessStatus_T enmStatus);
const char *gctlGuestSessionStatusToText(GuestSessionStatus_T enmStatus);
using namespace com;
class GuestFileEventListener;
typedef ListenerImpl<GuestFileEventListener> GuestFileEventListenerImpl;
class GuestProcessEventListener;
typedef ListenerImpl<GuestProcessEventListener> GuestProcessEventListenerImpl;
class GuestSessionEventListener;
typedef ListenerImpl<GuestSessionEventListener> GuestSessionEventListenerImpl;
class GuestEventListener;
typedef ListenerImpl<GuestEventListener> GuestEventListenerImpl;
class GuestAdditionsRunlevelListener;
typedef ListenerImpl<GuestAdditionsRunlevelListener> GuestAdditionsRunlevelListenerImpl;
/** Simple statistics class for binding locally
* held data to a specific guest object. */
class GuestEventStats
{
public:
GuestEventStats(void)
: uLastUpdatedMS(RTTimeMilliTS())
{
}
/** @todo Make this more a class than a structure. */
public:
uint64_t uLastUpdatedMS;
};
class GuestFileStats : public GuestEventStats
{
public:
GuestFileStats(void) { }
GuestFileStats(ComObjPtr<GuestFileEventListenerImpl> pListenerImpl)
: mListener(pListenerImpl)
{
}
public: /** @todo */
ComObjPtr<GuestFileEventListenerImpl> mListener;
};
class GuestProcStats : public GuestEventStats
{
public:
GuestProcStats(void) { }
GuestProcStats(ComObjPtr<GuestProcessEventListenerImpl> pListenerImpl)
: mListener(pListenerImpl)
{
}
public: /** @todo */
ComObjPtr<GuestProcessEventListenerImpl> mListener;
};
class GuestSessionStats : public GuestEventStats
{
public:
GuestSessionStats(void) { }
GuestSessionStats(ComObjPtr<GuestSessionEventListenerImpl> pListenerImpl)
: mListener(pListenerImpl)
{
}
public: /** @todo */
ComObjPtr<GuestSessionEventListenerImpl> mListener;
};
/** Map containing all watched guest files. */
typedef std::map< ComPtr<IGuestFile>, GuestFileStats > GuestEventFiles;
/** Map containing all watched guest processes. */
typedef std::map< ComPtr<IGuestProcess>, GuestProcStats > GuestEventProcs;
/** Map containing all watched guest sessions. */
typedef std::map< ComPtr<IGuestSession>, GuestSessionStats > GuestEventSessions;
class GuestListenerBase
{
public:
GuestListenerBase(void);
virtual ~GuestListenerBase(void);
public:
HRESULT init(bool fVerbose = false);
protected:
/** Verbose flag. */
bool mfVerbose;
};
/**
* Handler for guest process events.
*/
class GuestFileEventListener : public GuestListenerBase
{
public:
GuestFileEventListener(void);
virtual ~GuestFileEventListener(void);
public:
void uninit(void);
STDMETHOD(HandleEvent)(VBoxEventType_T aType, IEvent *aEvent);
protected:
};
/**
* Handler for guest process events.
*/
class GuestProcessEventListener : public GuestListenerBase
{
public:
GuestProcessEventListener(void);
virtual ~GuestProcessEventListener(void);
public:
void uninit(void);
STDMETHOD(HandleEvent)(VBoxEventType_T aType, IEvent *aEvent);
protected:
};
/**
* Handler for guest session events.
*/
class GuestSessionEventListener : public GuestListenerBase
{
public:
GuestSessionEventListener(void);
virtual ~GuestSessionEventListener(void);
public:
void uninit(void);
STDMETHOD(HandleEvent)(VBoxEventType_T aType, IEvent *aEvent);
protected:
GuestEventFiles mFiles;
GuestEventProcs mProcs;
};
/**
* Handler for guest events.
*/
class GuestEventListener : public GuestListenerBase
{
public:
GuestEventListener(void);
virtual ~GuestEventListener(void);
public:
void uninit(void);
STDMETHOD(HandleEvent)(VBoxEventType_T aType, IEvent *aEvent);
protected:
GuestEventSessions mSessions;
};
/**
* Handler for Guest Additions runlevel change events.
*/
class GuestAdditionsRunlevelListener : public GuestListenerBase
{
public:
GuestAdditionsRunlevelListener(AdditionsRunLevelType_T enmRunLevel);
virtual ~GuestAdditionsRunlevelListener(void);
public:
void uninit(void);
STDMETHOD(HandleEvent)(VBoxEventType_T aType, IEvent *aEvent);
protected:
/** The run level target we're waiting for. */
AdditionsRunLevelType_T mRunLevelTarget;
};
#endif /* !VBOX_INCLUDED_SRC_VBoxManage_VBoxManageGuestCtrl_h */
|
