EventImpl.h revision c2590a722c15520a45551ed7dc02d4831fb1a48e
6bc1c8274566f065e18c252f709143511be5276cvboxsync/* $Id$ */
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync/** @file
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync * VirtualBox COM IEvent implementation
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync */
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync/*
6bc1c8274566f065e18c252f709143511be5276cvboxsync * Copyright (C) 2010-2012 Oracle Corporation
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync *
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync * available from http://www.virtualbox.org. This file is free software;
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync * you can redistribute it and/or modify it under the terms of the GNU
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync * General Public License (GPL) as published by the Free Software
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync */
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync#ifndef ____H_EVENTIMPL
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync#define ____H_EVENTIMPL
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync#include "VirtualBoxBase.h"
7d913420297c8662dd9523fbf927125b3ed48814vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsyncclass ATL_NO_VTABLE VBoxEvent :
8532fcd8b260a1648f09ab3df65e5353aa148825vboxsync public VirtualBoxBase,
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync VBOX_SCRIPTABLE_IMPL(IEvent)
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync{
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsyncpublic:
e07acfb7f2dbb8bb40804024c79fd3139bdb3f24vboxsync VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(VBoxEvent, IEvent)
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync DECLARE_NOT_AGGREGATABLE(VBoxEvent)
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync DECLARE_PROTECT_FINAL_CONSTRUCT()
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync BEGIN_COM_MAP(VBoxEvent)
c7a378ed2fbad681c0b674351d698ef20a368935vboxsync VBOX_DEFAULT_INTERFACE_ENTRIES(IEvent)
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync END_COM_MAP()
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync VBoxEvent() {}
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync virtual ~VBoxEvent() {}
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync HRESULT FinalConstruct();
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync void FinalRelease();
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync // public initializer/uninitializer for internal purposes only
7d913420297c8662dd9523fbf927125b3ed48814vboxsync HRESULT init(IEventSource *aSource, VBoxEventType_T aType, BOOL aWaitable);
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync void uninit();
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync // IEvent properties
7d913420297c8662dd9523fbf927125b3ed48814vboxsync STDMETHOD(COMGETTER(Type))(VBoxEventType_T *aType);
7d913420297c8662dd9523fbf927125b3ed48814vboxsync STDMETHOD(COMGETTER(Source))(IEventSource * *aSource);
7d913420297c8662dd9523fbf927125b3ed48814vboxsync STDMETHOD(COMGETTER(Waitable))(BOOL *aWaitable);
8532fcd8b260a1648f09ab3df65e5353aa148825vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync // IEvent methods
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync STDMETHOD(SetProcessed)();
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync STDMETHOD(WaitProcessed)(LONG aTimeout, BOOL *aResult);
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsyncprivate:
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync struct Data;
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync Data* m;
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync};
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsyncclass ATL_NO_VTABLE VBoxVetoEvent :
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync public VBoxEvent,
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync VBOX_SCRIPTABLE_IMPL(IVetoEvent)
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync{
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsyncpublic:
e07acfb7f2dbb8bb40804024c79fd3139bdb3f24vboxsync VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(VBoxVetoEvent, IVetoEvent)
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync DECLARE_NOT_AGGREGATABLE(VBoxVetoEvent)
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync DECLARE_PROTECT_FINAL_CONSTRUCT()
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync
f730aae71d799e740589548575e2def3203beaccvboxsync BEGIN_COM_MAP(VBoxVetoEvent)
f730aae71d799e740589548575e2def3203beaccvboxsync COM_INTERFACE_ENTRY2(IEvent, IVetoEvent)
c7a378ed2fbad681c0b674351d698ef20a368935vboxsync VBOX_DEFAULT_INTERFACE_ENTRIES(IVetoEvent)
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync END_COM_MAP()
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync VBoxVetoEvent() {}
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync virtual ~VBoxVetoEvent() {}
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync HRESULT FinalConstruct();
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync void FinalRelease();
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync // public initializer/uninitializer for internal purposes only
7d913420297c8662dd9523fbf927125b3ed48814vboxsync HRESULT init(IEventSource *aSource, VBoxEventType_T aType);
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync void uninit();
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync
1cee507a10df8208ebb4a36db7073b312dff343fvboxsync // IEvent properties
7d913420297c8662dd9523fbf927125b3ed48814vboxsync STDMETHOD(COMGETTER(Type))(VBoxEventType_T *aType)
1cee507a10df8208ebb4a36db7073b312dff343fvboxsync {
1cee507a10df8208ebb4a36db7073b312dff343fvboxsync return VBoxEvent::COMGETTER(Type)(aType);
1cee507a10df8208ebb4a36db7073b312dff343fvboxsync }
7d913420297c8662dd9523fbf927125b3ed48814vboxsync STDMETHOD(COMGETTER(Source))(IEventSource * *aSource)
1cee507a10df8208ebb4a36db7073b312dff343fvboxsync {
1cee507a10df8208ebb4a36db7073b312dff343fvboxsync return VBoxEvent::COMGETTER(Source)(aSource);
1cee507a10df8208ebb4a36db7073b312dff343fvboxsync }
7d913420297c8662dd9523fbf927125b3ed48814vboxsync STDMETHOD(COMGETTER(Waitable))(BOOL *aWaitable)
1cee507a10df8208ebb4a36db7073b312dff343fvboxsync {
1cee507a10df8208ebb4a36db7073b312dff343fvboxsync return VBoxEvent::COMGETTER(Waitable)(aWaitable);
1cee507a10df8208ebb4a36db7073b312dff343fvboxsync }
1cee507a10df8208ebb4a36db7073b312dff343fvboxsync
1cee507a10df8208ebb4a36db7073b312dff343fvboxsync // IEvent methods
1cee507a10df8208ebb4a36db7073b312dff343fvboxsync STDMETHOD(SetProcessed)()
1cee507a10df8208ebb4a36db7073b312dff343fvboxsync {
1cee507a10df8208ebb4a36db7073b312dff343fvboxsync return VBoxEvent::SetProcessed();
1cee507a10df8208ebb4a36db7073b312dff343fvboxsync }
1cee507a10df8208ebb4a36db7073b312dff343fvboxsync STDMETHOD(WaitProcessed)(LONG aTimeout, BOOL *aResult)
1cee507a10df8208ebb4a36db7073b312dff343fvboxsync {
1cee507a10df8208ebb4a36db7073b312dff343fvboxsync return VBoxEvent::WaitProcessed(aTimeout, aResult);
1cee507a10df8208ebb4a36db7073b312dff343fvboxsync }
1cee507a10df8208ebb4a36db7073b312dff343fvboxsync
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync // IVetoEvent methods
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync STDMETHOD(AddVeto)(IN_BSTR aVeto);
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync STDMETHOD(IsVetoed)(BOOL *aResult);
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync STDMETHOD(GetVetos)(ComSafeArrayOut(BSTR, aVetos));
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsyncprivate:
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync struct Data;
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync Data* m;
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync};
2c7402dd06f73977076fdbc86bb9f1c0c2be17f9vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsyncclass ATL_NO_VTABLE EventSource :
94b7446cdceebfaf85efe6c4af03a57342a8031evboxsync public VirtualBoxBase,
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync VBOX_SCRIPTABLE_IMPL(IEventSource)
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync{
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsyncpublic:
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
e07acfb7f2dbb8bb40804024c79fd3139bdb3f24vboxsync VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(EventSource, IEventSource)
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync DECLARE_NOT_AGGREGATABLE(EventSource)
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync DECLARE_PROTECT_FINAL_CONSTRUCT()
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync BEGIN_COM_MAP(EventSource)
c7a378ed2fbad681c0b674351d698ef20a368935vboxsync VBOX_DEFAULT_INTERFACE_ENTRIES(IEventSource)
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync END_COM_MAP()
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
7d913420297c8662dd9523fbf927125b3ed48814vboxsync DECLARE_EMPTY_CTOR_DTOR(EventSource)
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync HRESULT FinalConstruct();
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync void FinalRelease();
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync // public initializer/uninitializer for internal purposes only
c2590a722c15520a45551ed7dc02d4831fb1a48evboxsync HRESULT init();
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync void uninit();
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync // IEventSource methods
7d913420297c8662dd9523fbf927125b3ed48814vboxsync STDMETHOD(CreateListener)(IEventListener **aListener);
7d913420297c8662dd9523fbf927125b3ed48814vboxsync STDMETHOD(CreateAggregator)(ComSafeArrayIn(IEventSource *, aSubordinates),
7d913420297c8662dd9523fbf927125b3ed48814vboxsync IEventSource **aAggregator);
7d913420297c8662dd9523fbf927125b3ed48814vboxsync STDMETHOD(RegisterListener)(IEventListener *aListener,
40e7dd58e01abf2e1b9df9588ea22f58846bf886vboxsync ComSafeArrayIn(VBoxEventType_T, aInterested),
7d913420297c8662dd9523fbf927125b3ed48814vboxsync BOOL aActive);
7d913420297c8662dd9523fbf927125b3ed48814vboxsync STDMETHOD(UnregisterListener)(IEventListener *aListener);
7d913420297c8662dd9523fbf927125b3ed48814vboxsync STDMETHOD(FireEvent)(IEvent *aEvent, LONG aTimeout, BOOL *aProcessed);
7d913420297c8662dd9523fbf927125b3ed48814vboxsync STDMETHOD(GetEvent)(IEventListener *aListener, LONG aTimeout,
7d913420297c8662dd9523fbf927125b3ed48814vboxsync IEvent **aEvent);
7d913420297c8662dd9523fbf927125b3ed48814vboxsync STDMETHOD(EventProcessed)(IEventListener *aListener, IEvent *aEvent);
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsyncprivate:
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync struct Data;
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync Data* m;
40e7dd58e01abf2e1b9df9588ea22f58846bf886vboxsync
40e7dd58e01abf2e1b9df9588ea22f58846bf886vboxsync friend class ListenerRecord;
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync};
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync
8532fcd8b260a1648f09ab3df65e5353aa148825vboxsyncclass VBoxEventDesc
8532fcd8b260a1648f09ab3df65e5353aa148825vboxsync{
8532fcd8b260a1648f09ab3df65e5353aa148825vboxsyncpublic:
7d913420297c8662dd9523fbf927125b3ed48814vboxsync VBoxEventDesc() : mEvent(0), mEventSource(0)
7d913420297c8662dd9523fbf927125b3ed48814vboxsync {}
7d913420297c8662dd9523fbf927125b3ed48814vboxsync
7d913420297c8662dd9523fbf927125b3ed48814vboxsync ~VBoxEventDesc()
7d913420297c8662dd9523fbf927125b3ed48814vboxsync {}
7d913420297c8662dd9523fbf927125b3ed48814vboxsync
7d913420297c8662dd9523fbf927125b3ed48814vboxsync /**
7d913420297c8662dd9523fbf927125b3ed48814vboxsync * This function to be used with some care, as arguments order must match
7d913420297c8662dd9523fbf927125b3ed48814vboxsync * attribute declaration order event class and its superclasses up to
7d913420297c8662dd9523fbf927125b3ed48814vboxsync * IEvent. If unsure, consult implementation in generated VBoxEvents.cpp.
7d913420297c8662dd9523fbf927125b3ed48814vboxsync */
7d913420297c8662dd9523fbf927125b3ed48814vboxsync HRESULT init(IEventSource* aSource, VBoxEventType_T aType, ...);
7d913420297c8662dd9523fbf927125b3ed48814vboxsync
7d913420297c8662dd9523fbf927125b3ed48814vboxsync /**
7d913420297c8662dd9523fbf927125b3ed48814vboxsync * Function similar to the above, but assumes that init() for this type
7d913420297c8662dd9523fbf927125b3ed48814vboxsync * already called once, so no need to allocate memory, and only reinit
7d913420297c8662dd9523fbf927125b3ed48814vboxsync * fields. Assumes event is subtype of IReusableEvent, asserts otherwise.
7d913420297c8662dd9523fbf927125b3ed48814vboxsync */
7d913420297c8662dd9523fbf927125b3ed48814vboxsync HRESULT reinit(VBoxEventType_T aType, ...);
7d913420297c8662dd9523fbf927125b3ed48814vboxsync
7d913420297c8662dd9523fbf927125b3ed48814vboxsync void uninit()
7d913420297c8662dd9523fbf927125b3ed48814vboxsync {
7d913420297c8662dd9523fbf927125b3ed48814vboxsync mEvent.setNull();
7d913420297c8662dd9523fbf927125b3ed48814vboxsync mEventSource.setNull();
7d913420297c8662dd9523fbf927125b3ed48814vboxsync }
7d913420297c8662dd9523fbf927125b3ed48814vboxsync
7d913420297c8662dd9523fbf927125b3ed48814vboxsync void getEvent(IEvent **aEvent)
7d913420297c8662dd9523fbf927125b3ed48814vboxsync {
7d913420297c8662dd9523fbf927125b3ed48814vboxsync mEvent.queryInterfaceTo(aEvent);
7d913420297c8662dd9523fbf927125b3ed48814vboxsync }
7d913420297c8662dd9523fbf927125b3ed48814vboxsync
7d913420297c8662dd9523fbf927125b3ed48814vboxsync BOOL fire(LONG aTimeout)
7d913420297c8662dd9523fbf927125b3ed48814vboxsync {
7d913420297c8662dd9523fbf927125b3ed48814vboxsync if (mEventSource && mEvent)
7d913420297c8662dd9523fbf927125b3ed48814vboxsync {
7d913420297c8662dd9523fbf927125b3ed48814vboxsync BOOL fDelivered = FALSE;
7d913420297c8662dd9523fbf927125b3ed48814vboxsync int rc = mEventSource->FireEvent(mEvent, aTimeout, &fDelivered);
7d913420297c8662dd9523fbf927125b3ed48814vboxsync AssertRCReturn(rc, FALSE);
7d913420297c8662dd9523fbf927125b3ed48814vboxsync return fDelivered;
7d913420297c8662dd9523fbf927125b3ed48814vboxsync }
7d913420297c8662dd9523fbf927125b3ed48814vboxsync return FALSE;
7d913420297c8662dd9523fbf927125b3ed48814vboxsync }
1cee507a10df8208ebb4a36db7073b312dff343fvboxsync
8532fcd8b260a1648f09ab3df65e5353aa148825vboxsyncprivate:
7d913420297c8662dd9523fbf927125b3ed48814vboxsync ComPtr<IEvent> mEvent;
7d913420297c8662dd9523fbf927125b3ed48814vboxsync ComPtr<IEventSource> mEventSource;
8532fcd8b260a1648f09ab3df65e5353aa148825vboxsync};
8532fcd8b260a1648f09ab3df65e5353aa148825vboxsync
a7d389fbff436fb217a78d48fab17adcaf43dc54vboxsync#endif // ____H_EVENTIMPL