EventQueue.h revision 17bbfe820c22c3e599276890d8b7baa48c32abbb
/** @file
* MS COM / XPCOM Abstraction Layer - Event and EventQueue class declaration.
*/
/*
* Copyright (C) 2006-2012 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* 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.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
#ifndef ___VBox_com_EventQueue_h
#define ___VBox_com_EventQueue_h
#ifndef VBOX_WITH_XPCOM
# include <Windows.h>
#else // VBOX_WITH_XPCOM
# include <nsEventQueueUtils.h>
#endif // VBOX_WITH_XPCOM
{
/**
* Base class for all events. Intended to be subclassed to introduce new
* events and handlers for them.
*
* Subclasses usually reimplement virtual #handler() (that does nothing by
* default) and add new data members describing the event.
*/
{
Event() {}
/**
* Event handler. Called in the context of the event queue's thread.
* Always reimplemented by subclasses
*
* @return reserved, should be NULL.
*/
};
/**
* Simple event queue.
*
* When using XPCOM, this will map onto the default XPCOM queue for the thread.
* So, if a queue is created on the main thread, it automatically processes
*
* When using Windows, Darwin and OS/2, this will map onto the native thread
* waiting for events.
*
* @note It is intentional that there is no way to retrieve arbitrary
* events and controlling their processing. There is no use case which
* warrants introducing the complexity of platform independent events.
*/
{
EventQueue();
~EventQueue(); /** @todo r=andy Why not virtual? */
int getSelectFD();
static int init();
static int uninit();
static EventQueue *getMainEventQueue();
#ifdef VBOX_WITH_XPCOM
{
}
#else
#endif
static EventQueue *sMainQueue;
#ifndef VBOX_WITH_XPCOM
/** The thread which the queue belongs to. */
/** Duplicated thread handle for MsgWaitForMultipleObjects. */
#else // VBOX_WITH_XPCOM
/** Whether it was created (and thus needs destroying) or if a queue already
* associated with the thread was used. */
bool mEQCreated;
/** Whether event processing should be interrupted. */
bool mInterrupted;
#endif // VBOX_WITH_XPCOM
};
} /* namespace com */
#endif