VirtualBox

source: vbox/trunk/src/VBox/Main/include/EventImpl.h@ 106901

Last change on this file since 106901 was 106061, checked in by vboxsync, 3 months ago

Copyright year updates by scm.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.9 KB
Line 
1/* $Id: EventImpl.h 106061 2024-09-16 14:03:52Z vboxsync $ */
2/** @file
3 * VirtualBox COM IEvent implementation
4 */
5
6/*
7 * Copyright (C) 2010-2024 Oracle and/or its affiliates.
8 *
9 * This file is part of VirtualBox base platform packages, as
10 * available from https://www.virtualbox.org.
11 *
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation, in version 3 of the
15 * License.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, see <https://www.gnu.org/licenses>.
24 *
25 * SPDX-License-Identifier: GPL-3.0-only
26 */
27
28#ifndef MAIN_INCLUDED_EventImpl_h
29#define MAIN_INCLUDED_EventImpl_h
30#ifndef RT_WITHOUT_PRAGMA_ONCE
31# pragma once
32#endif
33
34#include "EventWrap.h"
35#include "EventSourceWrap.h"
36#include "VetoEventWrap.h"
37
38
39class ATL_NO_VTABLE VBoxEvent
40 : public EventWrap
41{
42public:
43 DECLARE_COMMON_CLASS_METHODS(VBoxEvent)
44
45 HRESULT FinalConstruct();
46 void FinalRelease();
47
48 // public initializer/uninitializer for internal purposes only
49 HRESULT init(IEventSource *aSource, VBoxEventType_T aType, BOOL aWaitable);
50 void uninit();
51
52private:
53 // wrapped IEvent properties
54 HRESULT getType(VBoxEventType_T *aType);
55 HRESULT getSource(ComPtr<IEventSource> &aSource);
56 HRESULT getWaitable(BOOL *aWaitable);
57
58 // wrapped IEvent methods
59 HRESULT setProcessed();
60 HRESULT waitProcessed(LONG aTimeout, BOOL *aResult);
61
62 struct Data;
63 Data* m;
64};
65
66
67class ATL_NO_VTABLE VBoxVetoEvent
68 : public VetoEventWrap
69{
70public:
71 DECLARE_COMMON_CLASS_METHODS(VBoxVetoEvent)
72
73 HRESULT FinalConstruct();
74 void FinalRelease();
75
76 // public initializer/uninitializer for internal purposes only
77 HRESULT init(IEventSource *aSource, VBoxEventType_T aType);
78 void uninit();
79
80private:
81 // wrapped IEvent properties
82 HRESULT getType(VBoxEventType_T *aType);
83 HRESULT getSource(ComPtr<IEventSource> &aSource);
84 HRESULT getWaitable(BOOL *aWaitable);
85
86 // wrapped IEvent methods
87 HRESULT setProcessed();
88 HRESULT waitProcessed(LONG aTimeout, BOOL *aResult);
89
90 // wrapped IVetoEvent methods
91 HRESULT addVeto(const com::Utf8Str &aReason);
92 HRESULT isVetoed(BOOL *aResult);
93 HRESULT getVetos(std::vector<com::Utf8Str> &aResult);
94 HRESULT addApproval(const com::Utf8Str &aReason);
95 HRESULT isApproved(BOOL *aResult);
96 HRESULT getApprovals(std::vector<com::Utf8Str> &aResult);
97
98 struct Data;
99 Data* m;
100};
101
102class ATL_NO_VTABLE EventSource :
103 public EventSourceWrap
104{
105public:
106 DECLARE_COMMON_CLASS_METHODS(EventSource)
107
108 HRESULT FinalConstruct();
109 void FinalRelease();
110
111 // public initializer/uninitializer for internal purposes only
112 HRESULT init();
113 void uninit();
114
115private:
116 // wrapped IEventSource methods
117 HRESULT createListener(ComPtr<IEventListener> &aListener);
118 HRESULT createAggregator(const std::vector<ComPtr<IEventSource> > &aSubordinates,
119 ComPtr<IEventSource> &aResult);
120 HRESULT registerListener(const ComPtr<IEventListener> &aListener,
121 const std::vector<VBoxEventType_T> &aInteresting,
122 BOOL aActive);
123 HRESULT unregisterListener(const ComPtr<IEventListener> &aListener);
124 HRESULT fireEvent(const ComPtr<IEvent> &aEvent,
125 LONG aTimeout,
126 BOOL *aResult);
127 HRESULT getEvent(const ComPtr<IEventListener> &aListener,
128 LONG aTimeout,
129 ComPtr<IEvent> &aEvent);
130 HRESULT eventProcessed(const ComPtr<IEventListener> &aListener,
131 const ComPtr<IEvent> &aEvent);
132
133
134 struct Data;
135 Data *m;
136
137 friend class ListenerRecord;
138};
139
140class VBoxEventDesc
141{
142public:
143 VBoxEventDesc() : mEvent(0), mEventSource(0)
144 {}
145
146 VBoxEventDesc(IEvent *aEvent, IEventSource *aSource)
147 : mEvent(aEvent), mEventSource(aSource)
148 {}
149
150 ~VBoxEventDesc()
151 {}
152
153 void init(IEvent *aEvent, IEventSource *aSource)
154 {
155 mEvent = aEvent;
156 mEventSource = aSource;
157 }
158
159 void uninit()
160 {
161 mEvent.setNull();
162 mEventSource.setNull();
163 }
164
165 void getEvent(IEvent **aEvent)
166 {
167 mEvent.queryInterfaceTo(aEvent);
168 }
169
170 BOOL fire(LONG aTimeout)
171 {
172 if (mEventSource && mEvent)
173 {
174 BOOL fDelivered = FALSE;
175 HRESULT hrc = mEventSource->FireEvent(mEvent, aTimeout, &fDelivered);
176 AssertComRCReturn(hrc, FALSE);
177 return fDelivered;
178 }
179 return FALSE;
180 }
181
182private:
183 ComPtr<IEvent> mEvent;
184 ComPtr<IEventSource> mEventSource;
185};
186
187
188#endif /* !MAIN_INCLUDED_EventImpl_h */
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette