summaryrefslogtreecommitdiffstats
path: root/src/VBox/Main/include/EventImpl.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/VBox/Main/include/EventImpl.h')
-rw-r--r--src/VBox/Main/include/EventImpl.h188
1 files changed, 188 insertions, 0 deletions
diff --git a/src/VBox/Main/include/EventImpl.h b/src/VBox/Main/include/EventImpl.h
new file mode 100644
index 00000000..ee196402
--- /dev/null
+++ b/src/VBox/Main/include/EventImpl.h
@@ -0,0 +1,188 @@
+/* $Id: EventImpl.h $ */
+/** @file
+ * VirtualBox COM IEvent implementation
+ */
+
+/*
+ * Copyright (C) 2010-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 MAIN_INCLUDED_EventImpl_h
+#define MAIN_INCLUDED_EventImpl_h
+#ifndef RT_WITHOUT_PRAGMA_ONCE
+# pragma once
+#endif
+
+#include "EventWrap.h"
+#include "EventSourceWrap.h"
+#include "VetoEventWrap.h"
+
+
+class ATL_NO_VTABLE VBoxEvent
+ : public EventWrap
+{
+public:
+ DECLARE_COMMON_CLASS_METHODS(VBoxEvent)
+
+ HRESULT FinalConstruct();
+ void FinalRelease();
+
+ // public initializer/uninitializer for internal purposes only
+ HRESULT init(IEventSource *aSource, VBoxEventType_T aType, BOOL aWaitable);
+ void uninit();
+
+private:
+ // wrapped IEvent properties
+ HRESULT getType(VBoxEventType_T *aType);
+ HRESULT getSource(ComPtr<IEventSource> &aSource);
+ HRESULT getWaitable(BOOL *aWaitable);
+
+ // wrapped IEvent methods
+ HRESULT setProcessed();
+ HRESULT waitProcessed(LONG aTimeout, BOOL *aResult);
+
+ struct Data;
+ Data* m;
+};
+
+
+class ATL_NO_VTABLE VBoxVetoEvent
+ : public VetoEventWrap
+{
+public:
+ DECLARE_COMMON_CLASS_METHODS(VBoxVetoEvent)
+
+ HRESULT FinalConstruct();
+ void FinalRelease();
+
+ // public initializer/uninitializer for internal purposes only
+ HRESULT init(IEventSource *aSource, VBoxEventType_T aType);
+ void uninit();
+
+private:
+ // wrapped IEvent properties
+ HRESULT getType(VBoxEventType_T *aType);
+ HRESULT getSource(ComPtr<IEventSource> &aSource);
+ HRESULT getWaitable(BOOL *aWaitable);
+
+ // wrapped IEvent methods
+ HRESULT setProcessed();
+ HRESULT waitProcessed(LONG aTimeout, BOOL *aResult);
+
+ // wrapped IVetoEvent methods
+ HRESULT addVeto(const com::Utf8Str &aReason);
+ HRESULT isVetoed(BOOL *aResult);
+ HRESULT getVetos(std::vector<com::Utf8Str> &aResult);
+ HRESULT addApproval(const com::Utf8Str &aReason);
+ HRESULT isApproved(BOOL *aResult);
+ HRESULT getApprovals(std::vector<com::Utf8Str> &aResult);
+
+ struct Data;
+ Data* m;
+};
+
+class ATL_NO_VTABLE EventSource :
+ public EventSourceWrap
+{
+public:
+ DECLARE_COMMON_CLASS_METHODS(EventSource)
+
+ HRESULT FinalConstruct();
+ void FinalRelease();
+
+ // public initializer/uninitializer for internal purposes only
+ HRESULT init();
+ void uninit();
+
+private:
+ // wrapped IEventSource methods
+ HRESULT createListener(ComPtr<IEventListener> &aListener);
+ HRESULT createAggregator(const std::vector<ComPtr<IEventSource> > &aSubordinates,
+ ComPtr<IEventSource> &aResult);
+ HRESULT registerListener(const ComPtr<IEventListener> &aListener,
+ const std::vector<VBoxEventType_T> &aInteresting,
+ BOOL aActive);
+ HRESULT unregisterListener(const ComPtr<IEventListener> &aListener);
+ HRESULT fireEvent(const ComPtr<IEvent> &aEvent,
+ LONG aTimeout,
+ BOOL *aResult);
+ HRESULT getEvent(const ComPtr<IEventListener> &aListener,
+ LONG aTimeout,
+ ComPtr<IEvent> &aEvent);
+ HRESULT eventProcessed(const ComPtr<IEventListener> &aListener,
+ const ComPtr<IEvent> &aEvent);
+
+
+ struct Data;
+ Data *m;
+
+ friend class ListenerRecord;
+};
+
+class VBoxEventDesc
+{
+public:
+ VBoxEventDesc() : mEvent(0), mEventSource(0)
+ {}
+
+ VBoxEventDesc(IEvent *aEvent, IEventSource *aSource)
+ : mEvent(aEvent), mEventSource(aSource)
+ {}
+
+ ~VBoxEventDesc()
+ {}
+
+ void init(IEvent *aEvent, IEventSource *aSource)
+ {
+ mEvent = aEvent;
+ mEventSource = aSource;
+ }
+
+ void uninit()
+ {
+ mEvent.setNull();
+ mEventSource.setNull();
+ }
+
+ void getEvent(IEvent **aEvent)
+ {
+ mEvent.queryInterfaceTo(aEvent);
+ }
+
+ BOOL fire(LONG aTimeout)
+ {
+ if (mEventSource && mEvent)
+ {
+ BOOL fDelivered = FALSE;
+ HRESULT hrc = mEventSource->FireEvent(mEvent, aTimeout, &fDelivered);
+ AssertComRCReturn(hrc, FALSE);
+ return fDelivered;
+ }
+ return FALSE;
+ }
+
+private:
+ ComPtr<IEvent> mEvent;
+ ComPtr<IEventSource> mEventSource;
+};
+
+
+#endif /* !MAIN_INCLUDED_EventImpl_h */