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
|
/** @file
* X11 Guest client - seamless mode, missing proper description while using the
* potentially confusing word 'host'.
*/
/*
* Copyright (C) 2006-2011 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*/
#ifndef __Additions_client_seamless_host_h
# define __Additions_client_seamless_host_h
#include <VBox/log.h>
#include <VBox/VBoxGuestLib.h> /* for the R3 guest library functions */
#include "seamless-glue.h" /* for VBoxGuestSeamlessObserver */
#include "thread.h" /* for VBoxGuestThread */
class VBoxGuestSeamlessHost;
/**
* Host event (i.e. enter or leave seamless mode) thread function for the main
* seamless class
*/
class VBoxGuestSeamlessHostThread : public VBoxGuestThreadFunction
{
private:
// Copying or assigning a thread object is not sensible
VBoxGuestSeamlessHostThread(const VBoxGuestSeamlessHostThread&);
VBoxGuestSeamlessHostThread& operator=(const VBoxGuestSeamlessHostThread&);
// Private member variables
/** The host proxy object */
VBoxGuestSeamlessHost *mHost;
/** The thread object running us. */
VBoxGuestThread *mThread;
public:
VBoxGuestSeamlessHostThread(VBoxGuestSeamlessHost *pHost)
{
mHost = pHost;
}
virtual ~VBoxGuestSeamlessHostThread(void) {}
/**
* The actual thread function.
*
* @returns iprt status code as thread return value
* @param pParent the VBoxGuestThread running this thread function
*/
virtual int threadFunction(VBoxGuestThread *pThread);
/**
* Send a signal to the thread function that it should exit
*/
virtual void stop(void);
};
/**
* Interface to the host
*/
class VBoxGuestSeamlessHost
{
friend class VBoxGuestSeamlessHostThread;
public:
/** Events which can be reported by this class */
enum meEvent
{
/** Empty event */
NONE,
/** Request to enable seamless mode */
ENABLE,
/** Request to disable seamless mode */
DISABLE
};
private:
// We don't want a copy constructor or assignment operator
VBoxGuestSeamlessHost(const VBoxGuestSeamlessHost&);
VBoxGuestSeamlessHost& operator=(const VBoxGuestSeamlessHost&);
/** Observer to connect guest and host and ferry events back and forth. */
VBoxGuestSeamlessObserver *mObserver;
/** Host seamless event (i.e. enter and leave) thread function. */
VBoxGuestSeamlessHostThread mThreadFunction;
/** Host seamless event thread. */
VBoxGuestThread mThread;
/** Is the service running? */
bool mRunning;
/** Last request issued by the host. */
meEvent mState;
/**
* Waits for a seamless state change events from the host and dispatch it. This is
* meant to be called by the host event monitor thread exclusively.
*
* @returns IRPT return code.
*/
int nextEvent(void);
/**
* Interrupt an event wait and cause nextEvent() to return immediately.
*/
void cancelEvent(void) { VbglR3InterruptEventWaits(); }
public:
/**
* Initialise the guest and ensure that it is capable of handling seamless mode
* @param pObserver Observer class to connect host and guest interfaces
*
* @returns iprt status code
*/
int init(VBoxGuestSeamlessObserver *pObserver)
{
LogRelFlowFunc(("\n"));
if (mObserver != 0) /* Assertion */
{
LogRel(("VBoxClient: ERROR: attempt to initialise seamless host object twice!\n"));
return VERR_INTERNAL_ERROR;
}
mObserver = pObserver;
LogRelFlowFunc(("returning VINF_SUCCESS\n"));
return VINF_SUCCESS;
}
/**
* Start the service.
* @returns iprt status value
*/
int start(void);
/**
* Stops the service.
* @param cMillies how long to wait for the thread to exit
*/
void stop(RTMSINTERVAL cMillies = RT_INDEFINITE_WAIT);
/** Returns the current state of the host - i.e. requesting seamless or not. */
meEvent getState(void) { return mState; }
/**
* Update the set of visible rectangles in the host.
*/
void updateRects(RTRECT *pRects, size_t cRects);
VBoxGuestSeamlessHost(void) : mThreadFunction(this),
mThread(&mThreadFunction, 0, RTTHREADTYPE_MSG_PUMP,
RTTHREADFLAGS_WAITABLE, "Host events")
{
mObserver = 0;
mRunning = false;
mState = NONE;
}
~VBoxGuestSeamlessHost()
{
LogRelFlowFunc(("\n"));
if (mRunning) /* Assertion */
{
LogRel(("VBoxClient: seamless host object still running! Stopping...\n"));
stop(2000);
}
LogRelFlowFunc(("returning\n"));
}
};
#endif /* __Additions_xclient_seamless_h not defined */
|
